#### 10 Map
In the map element you can display a configured network map.
To configure, select *Map* as resource:
You may set the following specific options:
| | |
|---|---|
|*Map*|Select the map to display.|
#### 10 Map
In the map element you can display a configured network map.
To configure, select *Map* as resource:
You may set the following specific options:
| | |
|---|---|
|*Map*|Select the map to display.|
# 10 Upgrade notes for 4.0.1
This minor version does not have any upgrade notes.
# 10 Upgrade notes for 4.0.1
This minor version does not have any upgrade notes.
# 10 What's new in Zabbix 4.0.5
# 10 What's new in Zabbix 4.0.5
#### 11 Plain text
In the plain text element you can display latest item data in plain
text.
To configure, select *Plain text* as resource:
You may set the following specific options:
| | |
|---|---|
|*Item*|Select the item.|
|*Show lines*|Set how many latest data lines will be displayed in the screen cell.|
|*Show text as HTML*|Set to display text as HTML.|
|*Dynamic item*|Set to display different data depending on the selected host.|
#### 11 Plain text
In the plain text element you can display latest item data in plain
text.
To configure, select *Plain text* as resource:
You may set the following specific options:
| | |
|---|---|
|*Item*|Select the item.|
|*Show lines*|Set how many latest data lines will be displayed in the screen cell.|
|*Show text as HTML*|Set to display text as HTML.|
|*Dynamic item*|Set to display different data depending on the selected host.|
# 11 Upgrade notes for 4.0.2
# 11 Upgrade notes for 4.0.2
# 11 What's new in Zabbix 4.0.6
# 11 What's new in Zabbix 4.0.6
#### 12 Screen
In the screen element you can display another Zabbix screen. One screen
may contain other screens inside.
To configure, select *Screen* as resource:
You may set the following specific options:
| | |
|---|---|
|*Screen*|Select the screen to display.|
#### 12 Screen
In the screen element you can display another Zabbix screen. One screen
may contain other screens inside.
To configure, select *Screen* as resource:
You may set the following specific options:
| | |
|---|---|
|*Screen*|Select the screen to display.|
# 12 Upgrade notes for 4.0.3
# 12 Upgrade notes for 4.0.3
# 12 What's new in Zabbix 4.0.7
# 12 What's new in Zabbix 4.0.7
#### 13 Simple graph
In the simple graph element you can display a single simple graph.
To configure, select *Simple graph* as resource:
You may set the following specific options:
| | |
|---|---|
|*Item*|Select the item for the simple graph.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
#### 13 Simple graph
In the simple graph element you can display a single simple graph.
To configure, select *Simple graph* as resource:
You may set the following specific options:
| | |
|---|---|
|*Item*|Select the item for the simple graph.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
# 13 Supported JSONPath functionality
::: noteimportant
The full JSONPath functionality as described in
this page is available starting with Zabbix 4.0.11.
:::
# 13 Supported JSONPath functionality
::: noteimportant
The full JSONPath functionality as described in
this page is available starting with Zabbix 4.0.11.
:::
# 13 What's new in Zabbix 4.0.8
# 13 What's new in Zabbix 4.0.8
#### 14 Simple graph prototype
In the simple graph prototype element you can display a simple graph
based on an item generated by low-level discovery.
To configure, select *Simple graph prototype* as resource:
You may set the following specific options:
| | |
|---|---|
|*Item prototype*|Select the item prototype for the simple graph.|
|*Max columns*|In how many columns generated graphs should be displayed in the screen cell.<br>Useful when there are many LLD-generated graphs.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
#### 14 Simple graph prototype
In the simple graph prototype element you can display a simple graph
based on an item generated by low-level discovery.
To configure, select *Simple graph prototype* as resource:
You may set the following specific options:
| | |
|---|---|
|*Item prototype*|Select the item prototype for the simple graph.|
|*Max columns*|In how many columns generated graphs should be displayed in the screen cell.<br>Useful when there are many LLD-generated graphs.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
# 14 Upgrade notes for 4.0.5
This minor version does not have any upgrade notes.
# 14 Upgrade notes for 4.0.5
This minor version does not have any upgrade notes.
# 14 What's new in Zabbix 4.0.9
This minor version does not have any functional changes.
# 14 What's new in Zabbix 4.0.9
This minor version does not have any functional changes.
# 15 Remote monitoring of Zabbix stats
# 15 Remote monitoring of Zabbix stats
#### 15 System information
In the system information element you can display high-level Zabbix and
Zabbix server information.
To configure, select *System information* as resource:
#### 15 System information
In the system information element you can display high-level Zabbix and
Zabbix server information.
To configure, select *System information* as resource:
# 15 Upgrade notes for 4.0.6
# 15 Upgrade notes for 4.0.6
# 15 What's new in Zabbix 4.0.10
# 15 What's new in Zabbix 4.0.10
#### 16 Problems by severity
In this element you can display problems by severity similarly as in the
Dashboard widget.
To configure, select *Problems by severity* as resource:
#### 16 Problems by severity
In this element you can display problems by severity similarly as in the
Dashboard widget.
To configure, select *Problems by severity* as resource:
# 16 Upgrade notes for 4.0.7
# 16 Upgrade notes for 4.0.7
# 16 What's new in Zabbix 4.0.11
# 16 What's new in Zabbix 4.0.11
#### 17 Trigger info
In the trigger info element you can display high-level information about
trigger states.
To configure, select *Trigger info* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select the host group(s).|
|*Style*|Select vertical or horizontal display.|
#### 17 Trigger info
In the trigger info element you can display high-level information about
trigger states.
To configure, select *Trigger info* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select the host group(s).|
|*Style*|Select vertical or horizontal display.|
# 17 Upgrade notes for 4.0.8
# 17 Upgrade notes for 4.0.8
# 17 What's new in Zabbix 4.0.12
# 17 What's new in Zabbix 4.0.12
#### 18 Trigger overview
In the trigger overview element you can display the trigger states for a
group of hosts. It replicates information from *Monitoring → Overview*
(when *Triggers* is selected as Type there).
To configure, select *Trigger overview* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select the host group(s).|
|*Application*|Enter the application name.|
|*Hosts location*|Select host location - left or top.|
#### 18 Trigger overview
In the trigger overview element you can display the trigger states for a
group of hosts. It replicates information from *Monitoring → Overview*
(when *Triggers* is selected as Type there).
To configure, select *Trigger overview* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select the host group(s).|
|*Application*|Enter the application name.|
|*Hosts location*|Select host location - left or top.|
# 18 Upgrade notes for 4.0.9
This minor version does not have any upgrade notes.
# 18 Upgrade notes for 4.0.9
This minor version does not have any upgrade notes.
# 18 What's new in Zabbix 4.0.13
# 18 What's new in Zabbix 4.0.13
# 19. API
# 19. API
# 19 Upgrade notes for 4.0.10
This minor version does not have any upgrade notes.
# 19 Upgrade notes for 4.0.10
This minor version does not have any upgrade notes.
#### 19 URL
The URL element displays the content retrieved from the specified URL.
To configure, select *URL* as resource:
You may set the following specific options:
| | |
|---|---|
|*URL*|Enter the URL to display. Relative paths are allowed since Zabbix 4.0.20.|
|*Width*|Select window width.|
|*Height*|Select window width.|
|*Dynamic item*|Set to display different URL content depending on the selected host.|
::: noteimportant
Browsers might not load an HTTP page included in a
screen (using URL element), if Zabbix frontend is accessed over
HTTPS.
:::
#### 19 URL
The URL element displays the content retrieved from the specified URL.
To configure, select *URL* as resource:
You may set the following specific options:
| | |
|---|---|
|*URL*|Enter the URL to display. Relative paths are allowed since Zabbix 4.0.20.|
|*Width*|Select window width.|
|*Height*|Select window width.|
|*Dynamic item*|Set to display different URL content depending on the selected host.|
::: noteimportant
Browsers might not load an HTTP page included in a
screen (using URL element), if Zabbix frontend is accessed over
HTTPS.
:::
# 19 What's new in Zabbix 4.0.14
# 19 What's new in Zabbix 4.0.14
#### 1 Action log
In the action log element you can display details of action operations
(notifications, remote commands). It replicates information from
*Reports → Audit*.
To configure, select *Action log* as resource:
All mandatory input fields are marked with a red asterisk.
You may set the following specific options:
| | |
|---|---|
|*Show lines*|Set how many action log lines will be displayed in the screen cell.|
|*Sort entries by*|Sort entries by:<br>**Time** (descending or ascending)<br>**Type** (descending or ascending)<br>**Status** (descending or ascending)<br>**Recipient** (descending or ascending).|
#### 1 Action log
In the action log element you can display details of action operations
(notifications, remote commands). It replicates information from
*Reports → Audit*.
To configure, select *Action log* as resource:
All mandatory input fields are marked with a red asterisk.
You may set the following specific options:
| | |
|---|---|
|*Show lines*|Set how many action log lines will be displayed in the screen cell.|
|*Sort entries by*|Sort entries by:<br>**Time** (descending or ascending)<br>**Type** (descending or ascending)<br>**Status** (descending or ascending)<br>**Recipient** (descending or ascending).|
# 1 Configuring a network map
# 1 Configuring a network map
# 1 Discovery of mounted filesystems
# 1 Discovery of mounted filesystems
# 1 E-mail
# 1 E-mail
# 1 Graphs
# 1 Graphs
# 1 Red Hat Enterprise Linux/CentOS
# 1 Red Hat Enterprise Linux/CentOS
# 1 Red Hat Enterprise Linux/CentOS
# 1 Red Hat Enterprise Linux/CentOS
# 1 Screen elements
# 1 Screen elements
# 1 Server
# 1 Server
# 1 Simple graphs
# 1 Simple graphs
# 20 Upgrade notes for 4.0.11
This minor version does not have any upgrade notes.
# 20 Upgrade notes for 4.0.11
This minor version does not have any upgrade notes.
# 20 What's new in Zabbix 4.0.15
# 20 What's new in Zabbix 4.0.15
# 21 Upgrade notes for 4.0.12
# 21 Upgrade notes for 4.0.12
# 21 What's new in Zabbix 4.0.16
# 21 What's new in Zabbix 4.0.16
# 22 Upgrade notes for 4.0.13
# 22 Upgrade notes for 4.0.13
# 22 What's new in Zabbix 4.0.17
# 22 What's new in Zabbix 4.0.17
# 23 Upgrade notes for 4.0.14
# 23 Upgrade notes for 4.0.14
# 23 What's new in Zabbix 4.0.18
# 23 What's new in Zabbix 4.0.18
# 24 Upgrade notes for 4.0.15
This minor version does not have any upgrade notes.
# 24 Upgrade notes for 4.0.15
This minor version does not have any upgrade notes.
# 24 What's new in Zabbix 4.0.19
# 24 What's new in Zabbix 4.0.19
# 25 Upgrade notes for 4.0.16
# 25 Upgrade notes for 4.0.16
# 25 What's new in Zabbix 4.0.20
# 25 What's new in Zabbix 4.0.20
# 26 Upgrade notes for 4.0.17
# 26 Upgrade notes for 4.0.17
# 26 What's new in Zabbix 4.0.21
# 26 What's new in Zabbix 4.0.21
# 27 Upgrade notes for 4.0.18
# 27 Upgrade notes for 4.0.18
# 27 What's new in Zabbix 4.0.22
# 27 What's new in Zabbix 4.0.22
# 28 Upgrade notes for 4.0.19
This minor version does not have any upgrade notes.
# 28 Upgrade notes for 4.0.19
This minor version does not have any upgrade notes.
# 28 What's new in Zabbix 4.0.23
# 28 What's new in Zabbix 4.0.23
# 29 Upgrade notes for 4.0.20
# 29 Upgrade notes for 4.0.20
# 29 What's new in Zabbix 4.0.24
This minor version contains no functional changes.
# 29 What's new in Zabbix 4.0.24
This minor version contains no functional changes.
# 2 Agent
# 2 Agent
#### 2 Clock
In the clock element you may display local, server or specified host
time.
To configure, select *Clock* as resource:
You may set the following specific options:
| | |
|---|---|
|*Time type*|Select local, server or specified host time.|
|*Item*|Select the item for displaying time. To display host time, use the `system.localtime[local]` item. This item must exist on the host.<br>This field is available only when *Host time* is selected.|
|*Width*|Select clock width.|
|*Height*|Select clock height.|
#### 2 Clock
In the clock element you may display local, server or specified host
time.
To configure, select *Clock* as resource:
You may set the following specific options:
| | |
|---|---|
|*Time type*|Select local, server or specified host time.|
|*Item*|Select the item for displaying time. To display host time, use the `system.localtime[local]` item. This item must exist on the host.<br>This field is available only when *Host time* is selected.|
|*Width*|Select clock width.|
|*Height*|Select clock height.|
# 2 Custom graphs
# 2 Custom graphs
# 2 Debian/Ubuntu
# 2 Debian/Ubuntu
# 2 Host group elements
# 2 Host group elements
# 2 Network maps
# 2 Network maps
# 2 Proxies
# 2 Proxies
# 2 Repairing Zabbix database character set and collation
# 2 Repairing Zabbix database character set and collation
# 2 Setup from RHEL/CentOS packages
# 2 Setup from RHEL/CentOS packages
# 2 SMS
# 2 SMS
# 2 Zabbix proxy
# 2 Zabbix proxy
# 30 Upgrade notes for 4.0.21
This minor version has no upgrade notes.
# 30 Upgrade notes for 4.0.21
This minor version has no upgrade notes.
# 30 What's new in Zabbix 4.0.25
# 30 What's new in Zabbix 4.0.25
# 31 Upgrade notes for 4.0.22
# 31 Upgrade notes for 4.0.22
# 31 What's new in Zabbix 4.0.26
This minor version contains no functional changes.
# 31 What's new in Zabbix 4.0.26
This minor version contains no functional changes.
# 32 Upgrade notes for 4.0.23
This minor version does not have any upgrade notes.
# 32 Upgrade notes for 4.0.23
This minor version does not have any upgrade notes.
# 32 What's new in Zabbix 4.0.27
# 32 What's new in Zabbix 4.0.27
# 33 Upgrade notes for 4.0.24
This minor version does not have any upgrade notes.
# 33 Upgrade notes for 4.0.24
This minor version does not have any upgrade notes.
# 33 What's new in Zabbix 4.0.28
# 33 What's new in Zabbix 4.0.28
# 34 Upgrade notes for 4.0.25
This minor version does not have any upgrade notes.
# 34 Upgrade notes for 4.0.25
This minor version does not have any upgrade notes.
# 34 What's new in Zabbix 4.0.29
This minor version does not have any functional changes.
# 34 What's new in Zabbix 4.0.29
This minor version does not have any functional changes.
# 35 Upgrade notes for 4.0.26
# 35 Upgrade notes for 4.0.26
# 35 What's new in Zabbix 4.0.30
This minor version does not have any functional changes.
# 35 What's new in Zabbix 4.0.30
This minor version does not have any functional changes.
# 36 Upgrade notes for 4.0.27
# 36 Upgrade notes for 4.0.27
# 36 What's new in Zabbix 4.0.31
This minor version does not have any functional changes.
# 36 What's new in Zabbix 4.0.31
This minor version does not have any functional changes.
# 37 Upgrade notes for 4.0.28
# 37 Upgrade notes for 4.0.28
# 37 What's new in Zabbix 4.0.32
# 37 What's new in Zabbix 4.0.32
# 38 What's new in Zabbix 4.0.33
This minor version does not have any functional changes.
# 38 What's new in Zabbix 4.0.33
This minor version does not have any functional changes.
# 39 What's new in Zabbix 4.0.34
# 39 What's new in Zabbix 4.0.34
# 3 Ad-hoc graphs
# 3 Ad-hoc graphs
#### 3 Data overview
In the data overview element you can display the latest data for a group
of hosts. It replicates information from *Monitoring → Overview* (when
*Data* is selected as Type there).
To configure, select *Data overview* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select host group.|
|*Application*|Enter application name.|
|*Hosts location*|Select host location - left or top.|
#### 3 Data overview
In the data overview element you can display the latest data for a group
of hosts. It replicates information from *Monitoring → Overview* (when
*Data* is selected as Type there).
To configure, select *Data overview* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select host group.|
|*Application*|Enter application name.|
|*Hosts location*|Select host location - left or top.|
# 3 Hosts
# 3 Hosts
# 3 Jabber
# 3 Jabber
# 3 Link indicators
# 3 Link indicators
# 3 MIB files
# 3 MIB files
# 3 Screens
# 3 Screens
# 3 Setup from Debian/Ubuntu packages
# 3 Setup from Debian/Ubuntu packages
# 3 Windows agent installation from MSI
# 3 Windows agent installation from MSI
### 4.0.13
### 4.0.13
### 4.0.16
### 4.0.16
### 4.0.17
### 4.0.17
### 4.0.2
### 4.0.2
### 4.0.32
### 4.0.32
### 4.0.34
### 4.0.34
### 4.0.7
### 4.0.7
### 4.0.8
### 4.0.8
# 4 Ez Texting
# 4 Ez Texting
#### 4 Graph
In the graph element you can display a single custom graph.
To configure, select *Graph* as resource:
You may set the following specific options:
| | |
|---|---|
|*Graph*|Select the graph to display.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
#### 4 Graph
In the graph element you can display a single custom graph.
To configure, select *Graph* as resource:
You may set the following specific options:
| | |
|---|---|
|*Graph*|Select the graph to display.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
# 4 Java gateway
# 4 Java gateway
# 4 Mac OS agent installation from PKG
# 4 Mac OS agent installation from PKG
# 4 Slide shows
# 4 Slide shows
# 4 Update operations
# 4 Update operations
#### 5 Graph prototype
In the graph prototype element you can display a custom graph from a
low-level discovery rule.
To configure, select *Graph prototype* as resource:
You may set the following specific options:
| | |
|---|---|
|*Graph prototype*|Select the graph prototype to display.|
|*Max columns*|In how many columns generated graphs should be displayed in the screen cell.<br>Useful when there are many LLD-generated graphs.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
#### 5 Graph prototype
In the graph prototype element you can display a custom graph from a
low-level discovery rule.
To configure, select *Graph prototype* as resource:
You may set the following specific options:
| | |
|---|---|
|*Graph prototype*|Select the graph prototype to display.|
|*Max columns*|In how many columns generated graphs should be displayed in the screen cell.<br>Useful when there are many LLD-generated graphs.|
|*Width*|Select graph width.<br>Note that a line graph may actually take up more space due to legend text.|
|*Height*|Select graph height.<br>Note that a line graph may actually take up more space due to legend text.|
|*Dynamic item*|Set graph to display different data depending on the selected host.|
# 5 Host screens
# 5 Host screens
# 5 Minimum permission level for Windows agent items
# 5 Minimum permission level for Windows agent items
# 5 Running Agent as root
Starting with version **4.0.15** systemd service file for Zabbix agent
in official packages (<https://www.zabbix.com/download>) was updated to
explicitly include directives for `User` and `Group`. Both are set to
`zabbix`.
This means that old functionality of configuring which user Zabbix agent
runs as via `zabbix_agentd.conf` file is bypassed and agent will always
run as the user specified in the systemd service file.
To override this new behavior create file
`/etc/systemd/system/zabbix-agent.service.d/override.conf` with the
following content.
[Service]
User=root
Group=root
Reload daemons and restart zabbix-agent service.
systemctl daemon-reload
systemctl restart zabbix-agent
For **agent2** this completely determines the user that it runs as.
For old **agent** this only re-enables the functionality of configuring
user in `zabbix_agentd.conf` file. Therefore in order to run zabbix
agent as root you still have to edit `zabbix_agentd.conf` and specify
`User=root` as well as `AllowRoot=1` options. More on this here:
<https://www.zabbix.com/documentation/4.0/manual/appendix/config/zabbix_agentd>.
# 5 Running Agent as root
Starting with version **4.0.15** systemd service file for Zabbix agent
in official packages (<https://www.zabbix.com/download>) was updated to
explicitly include directives for `User` and `Group`. Both are set to
`zabbix`.
This means that old functionality of configuring which user Zabbix agent
runs as via `zabbix_agentd.conf` file is bypassed and agent will always
run as the user specified in the systemd service file.
To override this new behavior create file
`/etc/systemd/system/zabbix-agent.service.d/override.conf` with the
following content.
[Service]
User=root
Group=root
Reload daemons and restart zabbix-agent service.
systemctl daemon-reload
systemctl restart zabbix-agent
For **agent2** this completely determines the user that it runs as.
For old **agent** this only re-enables the functionality of configuring
user in `zabbix_agentd.conf` file. Therefore in order to run zabbix
agent as root you still have to edit `zabbix_agentd.conf` and specify
`User=root` as well as `AllowRoot=1` options. More on this here:
<https://www.zabbix.com/documentation/4.0/manual/appendix/config/zabbix_agentd>.
# 5 Sender
# 5 Sender
# 6 Get
# 6 Get
#### 6 History of events
In the history of events element you can display latest events.
To configure, select *History of events* as resource:
You may set the following specific option:
| | |
|---|---|
|*Show lines*|Set how many event lines will be displayed in the screen cell.|
#### 6 History of events
In the history of events element you can display latest events.
To configure, select *History of events* as resource:
You may set the following specific option:
| | |
|---|---|
|*Show lines*|Set how many event lines will be displayed in the screen cell.|
# 6 Visualization
# 6 Visualization
# 6 What's new in Zabbix 4.0.1
# 6 What's new in Zabbix 4.0.1
# 7 Additional frontend languages
# 7 Additional frontend languages
#### 7 Host group issues
In the host group issue element you can display problem details filtered
by the selected host group.
The problem severity color displayed is originally from the underlying
trigger, but can be adjusted in the [problem
update](/manual/acknowledges#updating_problems) screen.
To configure, select *Host group issues* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select host group.|
|*Show lines*|Set how many problem lines will be displayed in the screen cell.|
|*Sort triggers by*|Select from the dropdown to sort problems by last change, severity (both descending) or host (ascending).|
#### 7 Host group issues
In the host group issue element you can display problem details filtered
by the selected host group.
The problem severity color displayed is originally from the underlying
trigger, but can be adjusted in the [problem
update](/manual/acknowledges#updating_problems) screen.
To configure, select *Host group issues* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select host group.|
|*Show lines*|Set how many problem lines will be displayed in the screen cell.|
|*Sort triggers by*|Select from the dropdown to sort problems by last change, severity (both descending) or host (ascending).|
# 7 What's new in Zabbix 4.0.2
# 7 What's new in Zabbix 4.0.2
#### 8 Host info
In the host information element you can display high-level information
about host availability.
To configure, select *Host info* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select host group(s).|
|*Style*|Select vertical or horizontal display.|
#### 8 Host info
In the host information element you can display high-level information
about host availability.
To configure, select *Host info* as resource:
You may set the following specific options:
| | |
|---|---|
|*Group*|Select host group(s).|
|*Style*|Select vertical or horizontal display.|
# 8 What's new in Zabbix 4.0.3
# 8 What's new in Zabbix 4.0.3
# 9 Cookies used by Zabbix
# 9 Cookies used by Zabbix
#### 9 Host issues
In the host issue element you can display problem details filtered by
the selected host.
The problem severity color displayed is originally from the underlying
trigger, but can be adjusted in the [problem
update](/manual/acknowledges#updating_problems) screen.
To configure, select *Host issues* as resource:
You may set the following specific options:
| | |
|---|---|
|*Host*|Select the host.|
|*Show lines*|Set how many problem lines will be displayed in the screen cell.|
|*Sort triggers by*|Select from the dropdown to sort problems by last change, severity (both descending) or host (ascending).|
#### 9 Host issues
In the host issue element you can display problem details filtered by
the selected host.
The problem severity color displayed is originally from the underlying
trigger, but can be adjusted in the [problem
update](/manual/acknowledges#updating_problems) screen.
To configure, select *Host issues* as resource:
You may set the following specific options:
| | |
|---|---|
|*Host*|Select the host.|
|*Show lines*|Set how many problem lines will be displayed in the screen cell.|
|*Sort triggers by*|Select from the dropdown to sort problems by last change, severity (both descending) or host (ascending).|
# 9 What's new in Zabbix 4.0.4
# 9 What's new in Zabbix 4.0.4
#### Absence of data
For items with a regular update interval, nothing is displayed in the
graph if item data are not collected.
However, for trapper items and items with a scheduled update interval
(and regular update interval set to 0), a straight line is drawn leading
up to the first collected value and from the last collected value to the
end of graph; the line is on the level of the first/last value
respectively.
#### Absence of data
For items with a regular update interval, nothing is displayed in the
graph if item data are not collected.
However, for trapper items and items with a scheduled update interval
(and regular update interval set to 0), a straight line is drawn leading
up to the first collected value and from the last collected value to the
end of graph; the line is on the level of the first/last value
respectively.
#### Accessing host screens
Access to host screens is provided:
- From the [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu)
that is available in many frontend locations:
- click on the host name and then select *Host screens* from the
drop-down menu
- When searching for a host name in [global
search](/manual/web_interface/global_search):
- click on the *Screens* link provided in search results
```{=html}
<!-- -->
```
- When clicking on a host name in *Inventory* →
*[Hosts](/manual/web_interface/frontend_sections/inventory/hosts)*:
- click on the *Screens* link provided
#### Accessing host screens
Access to host screens is provided:
- From the [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu)
that is available in many frontend locations:
- click on the host name and then select *Host screens* from the
drop-down menu
- When searching for a host name in [global
search](/manual/web_interface/global_search):
- click on the *Screens* link provided in search results
```{=html}
<!-- -->
```
- When clicking on a host name in *Inventory* →
*[Hosts](/manual/web_interface/frontend_sections/inventory/hosts)*:
- click on the *Screens* link provided
#### Acknowledged problems in trigger overview
The icon that indicates an acknowledged problem in Monitoring → Overview
now is displayed only if all problems or resolved problems of the
trigger are acknowledged. Previously it was enough for the last problem
to be acknowledged.
#### Acknowledged problems in trigger overview
The icon that indicates an acknowledged problem in Monitoring → Overview
now is displayed only if all problems or resolved problems of the
trigger are acknowledged. Previously it was enough for the last problem
to be acknowledged.
# action.create
# action.create
# action.delete
# action.delete
# action.get
# action.get
# action.update
# action.update
#### Adding elements
To add elements to the screen, click on *Constructor* next to the screen
name in the list.
On a new screen you probably only see links named *Change*. Clicking
those links opens a form whereby you set what to display in each cell.
On an existing screen you click on the existing elements to open the
form whereby you set what to display.
{width="600"}
All mandatory input fields are marked with a red asterisk.
Screen element attributes:
|Parameter|Description|
|---------|-----------|
|*Resource*|Information displayed in the cell:<br>**Action log** - history of recent actions<br>**Clock** - digital or analog clock displaying current server or local time<br>**Data overview** - latest data for a group of hosts<br>**Graph** - single custom graph<br>**Graph prototype** - custom graph from low-level discovery rule<br>**History of events** - latest events<br>**Host group issues** - status of triggers filtered by the host group (includes triggers without events, since Zabbix 2.2)<br>**Host info** - high level host related information<br>**Host issues** - status of triggers filtered by the host (includes triggers without events, since Zabbix 2.2)<br>**Map** - single map<br>**Plain text** - plain text data<br>**Screen** - screen (one screen may contain other screens inside)<br>**Simple graph** - single simple graph<br>**Simple graph prototype** - simple graph based on item generated by low-level discovery<br>**System information** - high-level information about Zabbix server<br>**Problems by severity** - displays problems by severity (similar to the Dashboard)<br>**Trigger info** - high level trigger related information<br>**Trigger overview** - status of triggers for a host group<br>**URL** - include content from the specified resource<br>See also more information on configuring [each resource](/manual/config/visualization/screens/elements).|
|*Horizontal align*|Possible values:<br>**Center**<br>**Left**<br>**Right**|
|*Vertical align*|Possible values:<br>**Middle**<br>**Top**<br>**Bottom**|
|*Column span*|Extend cell to a number of columns, same way as HTML column spanning works.|
|*Row span*|Extend cell to a number of rows, same way as HTML row spanning works.|
Take note of the '+' and '-' controls on each side of the table.
Clicking on '+' above the table will add a column. Clicking on '-'
beneath the table will remove a column.
Clicking on '+' on the left side of the table will add a row. Clicking
on '-' on the right side of the table will remove a row.
::: noteimportant
If graph height is set as less than 120 pixels, no
trigger will be displayed in the legend.
:::
#### Adding elements
To add elements to the screen, click on *Constructor* next to the screen
name in the list.
On a new screen you probably only see links named *Change*. Clicking
those links opens a form whereby you set what to display in each cell.
On an existing screen you click on the existing elements to open the
form whereby you set what to display.
{width="600"}
All mandatory input fields are marked with a red asterisk.
Screen element attributes:
|Parameter|Description|
|---------|-----------|
|*Resource*|Information displayed in the cell:<br>**Action log** - history of recent actions<br>**Clock** - digital or analog clock displaying current server or local time<br>**Data overview** - latest data for a group of hosts<br>**Graph** - single custom graph<br>**Graph prototype** - custom graph from low-level discovery rule<br>**History of events** - latest events<br>**Host group issues** - status of triggers filtered by the host group (includes triggers without events, since Zabbix 2.2)<br>**Host info** - high level host related information<br>**Host issues** - status of triggers filtered by the host (includes triggers without events, since Zabbix 2.2)<br>**Map** - single map<br>**Plain text** - plain text data<br>**Screen** - screen (one screen may contain other screens inside)<br>**Simple graph** - single simple graph<br>**Simple graph prototype** - simple graph based on item generated by low-level discovery<br>**System information** - high-level information about Zabbix server<br>**Problems by severity** - displays problems by severity (similar to the Dashboard)<br>**Trigger info** - high level trigger related information<br>**Trigger overview** - status of triggers for a host group<br>**URL** - include content from the specified resource<br>See also more information on configuring [each resource](/manual/config/visualization/screens/elements).|
|*Horizontal align*|Possible values:<br>**Center**<br>**Left**<br>**Right**|
|*Vertical align*|Possible values:<br>**Middle**<br>**Top**<br>**Bottom**|
|*Column span*|Extend cell to a number of columns, same way as HTML column spanning works.|
|*Row span*|Extend cell to a number of rows, same way as HTML row spanning works.|
Take note of the '+' and '-' controls on each side of the table.
Clicking on '+' above the table will add a column. Clicking on '-'
beneath the table will remove a column.
Clicking on '+' on the left side of the table will add a row. Clicking
on '-' on the right side of the table will remove a row.
::: noteimportant
If graph height is set as less than 120 pixels, no
trigger will be displayed in the legend.
:::
#### Adding lines
In addition to shapes, it is also possible to add some lines. Lines can
be used to link elements or shapes in a map.
To add a line, click on *Add* next to Shape. A new shape will appear at
the top left corner of the map. Select it and click on *Line* in the
editing form to change the shape into a line. Then adjust line
properties, such as line type, width, color, etc.
{width="600"}
#### Adding lines
In addition to shapes, it is also possible to add some lines. Lines can
be used to link elements or shapes in a map.
To add a line, click on *Add* next to Shape. A new shape will appear at
the top left corner of the map. Select it and click on *Line* in the
editing form to change the shape into a line. Then adjust line
properties, such as line type, width, color, etc.
{width="600"}
#### Adding shapes
In addition to map elements, it is also possible to add some shapes.
Shapes are not map elements; they are just a visual representation. For
example, a rectangle shape can be used as a background to group some
hosts. Rectangle and ellipse shapes can be added.
To add a shape, click on *Add* next to Shape. The new shape will appear
at the top left corner of the map. Drag and drop it wherever you like.
A new shape is added with default colors. By clicking on the shape, a
form is displayed and you can customize the way a shape looks, add text,
etc.
{width="600"}
To select shapes, select one and then hold down *Ctrl* to select the
others. With several shapes selected, common properties can be mass
updated, similarly as with elements.
Text can be added in the shapes. To display text only the shape can be
made invisible by removing the shape border (select 'None' in the
*Border* field). For example, take note of how the {MAP.NAME} macro,
visible in the screenshot above, is actually a rectangle shape with
text, which can be seen when clicking on the macro:
{MAP.NAME} resolves to the configured map name, when viewing the map.
If hyperlinks are used in the text, they become clickable when viewing
the map.
Line wrapping for text is always "on" within shapes. However, within an
ellipse the lines are wrapped as though the ellipse were a rectangle.
Word wrapping is not implemented, so long words (words that do not fit
the shape) are not wrapped, but are masked (constructor page) or clipped
(other pages with maps).
#### Adding shapes
In addition to map elements, it is also possible to add some shapes.
Shapes are not map elements; they are just a visual representation. For
example, a rectangle shape can be used as a background to group some
hosts. Rectangle and ellipse shapes can be added.
To add a shape, click on *Add* next to Shape. The new shape will appear
at the top left corner of the map. Drag and drop it wherever you like.
A new shape is added with default colors. By clicking on the shape, a
form is displayed and you can customize the way a shape looks, add text,
etc.
{width="600"}
To select shapes, select one and then hold down *Ctrl* to select the
others. With several shapes selected, common properties can be mass
updated, similarly as with elements.
Text can be added in the shapes. To display text only the shape can be
made invisible by removing the shape border (select 'None' in the
*Border* field). For example, take note of how the {MAP.NAME} macro,
visible in the screenshot above, is actually a rectangle shape with
text, which can be seen when clicking on the macro:
{MAP.NAME} resolves to the configured map name, when viewing the map.
If hyperlinks are used in the text, they become clickable when viewing
the map.
Line wrapping for text is always "on" within shapes. However, within an
ellipse the lines are wrapped as though the ellipse were a rectangle.
Word wrapping is not implemented, so long words (words that do not fit
the shape) are not wrapped, but are masked (constructor page) or clipped
(other pages with maps).
### Agent installation
To install the agent, run
# apt install zabbix-agent
To start the agent, run:
# service zabbix-agent start
If you want to run Zabbix agent as root, see
[here](/manual/appendix/install/run_agent_as_root).
### Agent installation
To install the agent, run
# apt install zabbix-agent
To start the agent, run:
# service zabbix-agent start
If you want to run Zabbix agent as root, see
[here](/manual/appendix/install/run_agent_as_root).
#### Aggregate item helper
The item key selector for [aggregate
items](/manual/config/items/itemtypes/aggregate) in the frontend now
lists all available aggregate keys (grpavg,grpmax,grpmin,grpsum) and
their descriptions.
#### Aggregate item helper
The item key selector for [aggregate
items](/manual/config/items/itemtypes/aggregate) in the frontend now
lists all available aggregate keys (grpavg,grpmax,grpmin,grpsum) and
their descriptions.
#### alert
Changes:\
[ZBX-11272](https://support.zabbix.com/browse/ZBX-11272) `alert.get`:
added support of two new options `mediatypeid` and `sendto` in the
`sortfield` parameter\
#### alert
Changes:\
[ZBX-11272](https://support.zabbix.com/browse/ZBX-11272) `alert.get`:
added support of two new options `mediatypeid` and `sendto` in the
`sortfield` parameter\
# alert.get
# alert.get
### API improvements
From now on
[user.checkAuthentication](/manual/api/reference/user/user.checkauthentication)
method contains additional parameter "extend".
### API improvements
From now on
[user.checkAuthentication](/manual/api/reference/user/user.checkauthentication)
method contains additional parameter "extend".
# apiinfo.version
# apiinfo.version
#### API login
A large number of open user sessions can be created when using custom
scripts with the `user.login` [method](/manual/api/reference/user/login)
without a following `user.logout`.
#### API login
A large number of open user sessions can be created when using custom
scripts with the `user.login` [method](/manual/api/reference/user/login)
without a following `user.logout`.
#### API
The **output** parameter does not work properly with the `history.get`
method (fixed in 4.0.11).
#### API
The **output** parameter does not work properly with the `history.get`
method (fixed in 4.0.11).
# Appendix 1. Reference commentary
# Appendix 1. Reference commentary
# Appendix 2. Changes from 3.4 to 4.0
# Appendix 2. Changes from 3.4 to 4.0
# application.create
# application.create
# application.delete
# application.delete
# application.get
# application.get
# application.massadd
# application.massadd
# application.update
# application.update
#### Attempting to use Zabbix sender compiled with TLS support to send data to Zabbix server/proxy compiled without TLS
#### Attempting to use Zabbix sender compiled with TLS support to send data to Zabbix server/proxy compiled without TLS
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
# Building Windows agent binaries with/without TLS
# Building Windows agent binaries with/without TLS
#### Building with libxml2
When building with libxml2, pkg-config is now used instead of
xml2-config to detect and use libxml2, as xml2-config is to be removed
from libxml2 in the future.
#### Building with libxml2
When building with libxml2, pkg-config is now used instead of
xml2-config to detect and use libxml2, as xml2-config is to be removed
from libxml2 in the future.
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
||Additional information on the page content is displayed if you roll the mouse over this button.|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
||Additional information on the page content is displayed if you roll the mouse over this button.|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Add graph to the favorites widget in the [Dashboard](dashboard).|
||The graph is in the favorites widget in the [Dashboard](dashboard). Click to remove graph from the favorites widget.|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Add graph to the favorites widget in the [Dashboard](dashboard).|
||The graph is in the favorites widget in the [Dashboard](dashboard). Click to remove graph from the favorites widget.|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Go to the slide show properties.|
||Add slide show to the favorites widget in the [Dashboard](dashboard).|
||The slide show is in the favorites widget in the [Dashboard](dashboard). Click to remove slide show from the favorites widget.|
||Slow down or speed up a slide show.|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
##### Buttons
Buttons to the right offer the following options:
| | |
|---|---|
||Go to the slide show properties.|
||Add slide show to the favorites widget in the [Dashboard](dashboard).|
||The slide show is in the favorites widget in the [Dashboard](dashboard). Click to remove slide show from the favorites widget.|
||Slow down or speed up a slide show.|
||Display page in fullscreen mode.|
||Display page in kiosk mode. In this mode only page content displayed.<br>The kiosk mode button appears when the fullscreen mode is activated.<br>To exit kiosk mode, move the mouse cursor until the  exit button appears and click on it. Note that you will be taken back to normal mode (not fullscreen mode).|
#### Cache size configuration parameter
The maximum value of the CacheSize configuration parameter for Zabbix
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
has been increased from 8GB to 64GB.
#### Cache size configuration parameter
The maximum value of the CacheSize configuration parameter for Zabbix
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
has been increased from 8GB to 64GB.
#### Cannot support audio notification notice
“Cannot support notification audio for this device.” message will be
displayed when [notification
sounds](/manual/web_interface/user_profile/sound) on the device cannot
be played.
#### Cannot support audio notification notice
“Cannot support notification audio for this device.” message will be
displayed when [notification
sounds](/manual/web_interface/user_profile/sound) on the device cannot
be played.
### Changes in 4.0.0
### Changes in 4.0.0
### Changes in 4.0.13
### Changes in 4.0.13
### Changes in 4.0.14
### Changes in 4.0.14
### Changes in 4.0.15
Low-level **discovery rules** have been split from the parent template
*Template Module HOST-RESOURCES-MIB SNMPv2* into separate linked
templates:
- Template Module HOST-RESOURCES-MIB storage SNMPv2
- Template Module HOST-RESOURCES-MIB memory SNMPv2
- Template Module HOST-RESOURCES-MIB CPU SNMPv2
Other changes:
- A CPU utilization item has been added to *Template Module
HOST-RESOURCES-MIB CPU SNMPv2*;
- The filesystem discovery filter has been improved to exclude some
unnecessary values in *Template Module HOST-RESOURCES-MIB storage
SNMPv2* (linked to *Template OS Windows SNMPv2*, *Template Net
Arista SNMPv2*);
- The network interface discovery filter has been improved to exclude
some unnecessary values in *Template Module Interfaces Windows
SNMPv2* (linked to *Template OS Windows SNMPv2*);
- Discovery filters in several templates are now defined by
template-level user macros (for example {$VFS.FS.FSNAME.MATCHES} and
{$VFS.FS.FSNAME.NOT\_MATCHES}) that can be overridden on host or
linked-template level for flexibility:
- *Template Module HOST-RESOURCES-MIB storage SNMPv2*
- *Template Module HOST-RESOURCES-MIB memory SNMPv2*
- *Template Module HOST-RESOURCES-MIB CPU SNMPv2*
- *Template Module Interfaces Windows SNMPv2*
### Changes in 4.0.15
Low-level **discovery rules** have been split from the parent template
*Template Module HOST-RESOURCES-MIB SNMPv2* into separate linked
templates:
- Template Module HOST-RESOURCES-MIB storage SNMPv2
- Template Module HOST-RESOURCES-MIB memory SNMPv2
- Template Module HOST-RESOURCES-MIB CPU SNMPv2
Other changes:
- A CPU utilization item has been added to *Template Module
HOST-RESOURCES-MIB CPU SNMPv2*;
- The filesystem discovery filter has been improved to exclude some
unnecessary values in *Template Module HOST-RESOURCES-MIB storage
SNMPv2* (linked to *Template OS Windows SNMPv2*, *Template Net
Arista SNMPv2*);
- The network interface discovery filter has been improved to exclude
some unnecessary values in *Template Module Interfaces Windows
SNMPv2* (linked to *Template OS Windows SNMPv2*);
- Discovery filters in several templates are now defined by
template-level user macros (for example {$VFS.FS.FSNAME.MATCHES} and
{$VFS.FS.FSNAME.NOT\_MATCHES}) that can be overridden on host or
linked-template level for flexibility:
- *Template Module HOST-RESOURCES-MIB storage SNMPv2*
- *Template Module HOST-RESOURCES-MIB memory SNMPv2*
- *Template Module HOST-RESOURCES-MIB CPU SNMPv2*
- *Template Module Interfaces Windows SNMPv2*
### Changes in 4.0.2
### Changes in 4.0.2
### Changes in 4.0.25
### Changes in 4.0.25
### Changes in 4.0.3
### Changes in 4.0.3
### Changes in 4.0.5
### Changes in 4.0.5
### Changes in 4.0.6
### Changes in 4.0.6
### Changes in 4.0.7
### Changes in 4.0.7
#### Cisco UCS server template
A Cisco UCS server monitoring template - *Template Server Cisco UCS
SNMPv2* has been added.
It will be available in *Configuration* → *Templates* in new
installations. If you are upgrading from previous versions, you can find
this template in the `templates` directory of the downloaded latest
Zabbix version. Then, while in *Configuration* → *Templates* you can
import it manually into Zabbix.
#### Cisco UCS server template
A Cisco UCS server monitoring template - *Template Server Cisco UCS
SNMPv2* has been added.
It will be available in *Configuration* → *Templates* in new
installations. If you are upgrading from previous versions, you can find
this template in the `templates` directory of the downloaded latest
Zabbix version. Then, while in *Configuration* → *Templates* you can
import it manually into Zabbix.
#### Command-line based installation
#### Command-line based installation
#### Compatibility issue with PHP 7.0
It has been observed that with PHP 7.0 importing a template with web
monitoring triggers may fail due to incorrectly added double quotes to
the web monitoring items in the trigger expressions. The issue goes away
when upgrading PHP to 7.1.
#### Compatibility issue with PHP 7.0
It has been observed that with PHP 7.0 importing a template with web
monitoring triggers may fail due to incorrectly added double quotes to
the web monitoring items in the trigger expressions. The issue goes away
when upgrading PHP to 7.1.
#### Compiling OpenSSL
The following steps will help you to compile OpenSSL from sources on MS
Windows 10 (64-bit).
1. For compiling OpenSSL you will need on Windows machine:
1. C compiler (e.g. VS 2017 RC),
2. NASM (<https://www.nasm.us/>),
3. Perl (e.g. Strawberry Perl from <http://strawberryperl.com/>),
4. Perl module Text::Template (cpan Text::Template).
2. Get OpenSSL sources from <https://www.openssl.org/>. OpenSSL 1.1.1
is used here.
3. Unpack OpenSSL sources, for example, in E:\\openssl-1.1.1.
4. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 RC.
5. Go to the OpenSSL source directory, e.g. E:\\openssl-1.1.1.
1. Verify that NASM can be found:`e:\openssl-1.1.1> nasm --version
NASM version 2.13.01 compiled on May 1 2017
`
6. Configure OpenSSL, for
example:`e:\openssl-1.1.1> perl E:\openssl-1.1.1\Configure VC-WIN64A no-shared no-capieng no-srp no-gost no-dgram no-dtls1-method no-dtls1_2-method --api=1.1.0 --prefix=C:\OpenSSL-Win64-111-static --openssldir=C:\OpenSSL-Win64-111-static
`
- Note the option 'no-shared': if 'no-shared' is used then the
OpenSSL static libraries libcrypto.lib and libssl.lib will be
'self-sufficient' and resulting Zabbix binaries will include
OpenSSL in themselves, no need for external OpenSSL DLLs.
Advantage: Zabbix binaries can be copied to other Windows
machines without OpenSSL libraries. Disadvantage: when a new
OpenSSL bugfix version is released, Zabbix agent needs to
recompiled and reinstalled.
- If 'no-shared' is not used, then the static libraries
libcrypto.lib and libssl.lib will be using OpenSSL DLLs at
runtime. Advantage: when a new OpenSSL bugfix version is
released, probably you can upgrade only OpenSSL DLLs, without
recompiling Zabbix agent. Disadvantage: copying Zabbix agent to
another machine requires copying OpenSSL DLLs, too.
7. Compile OpenSSL, run tests, install:`e:\openssl-1.1.1> nmake
e:\openssl-1.1.1> nmake test
...
All tests successful.
Files=152, Tests=1152, 501 wallclock secs ( 0.67 usr + 0.61 sys = 1.28 CPU)
Result: PASS
e:\openssl-1.1.1> nmake install_sw
`'install\_sw' installs only software components (i.e. libraries,
header files, but no documentation). If you want everything, use
"nmake install".
#### Compiling OpenSSL
The following steps will help you to compile OpenSSL from sources on MS
Windows 10 (64-bit).
1. For compiling OpenSSL you will need on Windows machine:
1. C compiler (e.g. VS 2017 RC),
2. NASM (<https://www.nasm.us/>),
3. Perl (e.g. Strawberry Perl from <http://strawberryperl.com/>),
4. Perl module Text::Template (cpan Text::Template).
2. Get OpenSSL sources from <https://www.openssl.org/>. OpenSSL 1.1.1
is used here.
3. Unpack OpenSSL sources, for example, in E:\\openssl-1.1.1.
4. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 RC.
5. Go to the OpenSSL source directory, e.g. E:\\openssl-1.1.1.
1. Verify that NASM can be found:`e:\openssl-1.1.1> nasm --version
NASM version 2.13.01 compiled on May 1 2017
`
6. Configure OpenSSL, for
example:`e:\openssl-1.1.1> perl E:\openssl-1.1.1\Configure VC-WIN64A no-shared no-capieng no-srp no-gost no-dgram no-dtls1-method no-dtls1_2-method --api=1.1.0 --prefix=C:\OpenSSL-Win64-111-static --openssldir=C:\OpenSSL-Win64-111-static
`
- Note the option 'no-shared': if 'no-shared' is used then the
OpenSSL static libraries libcrypto.lib and libssl.lib will be
'self-sufficient' and resulting Zabbix binaries will include
OpenSSL in themselves, no need for external OpenSSL DLLs.
Advantage: Zabbix binaries can be copied to other Windows
machines without OpenSSL libraries. Disadvantage: when a new
OpenSSL bugfix version is released, Zabbix agent needs to
recompiled and reinstalled.
- If 'no-shared' is not used, then the static libraries
libcrypto.lib and libssl.lib will be using OpenSSL DLLs at
runtime. Advantage: when a new OpenSSL bugfix version is
released, probably you can upgrade only OpenSSL DLLs, without
recompiling Zabbix agent. Disadvantage: copying Zabbix agent to
another machine requires copying OpenSSL DLLs, too.
7. Compile OpenSSL, run tests, install:`e:\openssl-1.1.1> nmake
e:\openssl-1.1.1> nmake test
...
All tests successful.
Files=152, Tests=1152, 501 wallclock secs ( 0.67 usr + 0.61 sys = 1.28 CPU)
Result: PASS
e:\openssl-1.1.1> nmake install_sw
`'install\_sw' installs only software components (i.e. libraries,
header files, but no documentation). If you want everything, use
"nmake install".
#### Compiling Zabbix
The following steps will help you to compile Zabbix from sources on MS
Windows 10 (64-bit). When compiling Zabbix with/without TLS support the
only significant difference is in step 4.
Support for OpenSSL 1.1.1 was added in 4.0.1, some additional fixes - in
4.0.2rc1.
1. On a Linux machine check out the source from
git:`` $ git clone https://git.zabbix.com/scm/zbx/zabbix.git
$ cd zabbix
$ git checkout 4.0.22 -b 4.0.22 # replace 4.0.22 with the latest release available
$ ./bootstrap.sh
$ ./configure --enable-agent --enable-ipv6 --prefix=`pwd`
$ make dbschema
$ make dist
``
2. Copy and unpack the archive, e.g. zabbix-4.0.2.tar.gz, on a Windows
machine.
3. Let's assume that sources are in e:\\zabbix-4.0.2. Open a
commandline window e.g. the x64 Native Tools Command Prompt for VS
2017 RC. Go to E:\\zabbix-4.0.2\\build\\win32\\project.
4. Compile zabbix\_get, zabbix\_sender and zabbix\_agent.
- without TLS:
`E:\zabbix-4.0.2\build\win32\project> nmake /K PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
`
- with TLS:
`E:\zabbix-4.0.2\build\win32\project> nmake /K -f Makefile_get TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
E:\zabbix-4.0.2\build\win32\project> nmake /K -f Makefile_sender TLS=openssl TLSINCDIR="C:\OpenSSL-Win64-111-static\include TLSLIBDIR="C:\OpenSSL-Win64-111-static\lib" PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
E:\zabbix-4.0.2\build\win32\project> nmake /K -f Makefile_agent TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
`
5. New binaries are located in e:\\zabbix-4.0.2\\bin\\win64. Since
OpenSSL was compiled with 'no-shared' option, Zabbix binaries
contain OpenSSL within themselves and can be copied to other
machines that do not have OpenSSL.
#### Compiling Zabbix
The following steps will help you to compile Zabbix from sources on MS
Windows 10 (64-bit). When compiling Zabbix with/without TLS support the
only significant difference is in step 4.
Support for OpenSSL 1.1.1 was added in 4.0.1, some additional fixes - in
4.0.2rc1.
1. On a Linux machine check out the source from
git:`` $ git clone https://git.zabbix.com/scm/zbx/zabbix.git
$ cd zabbix
$ git checkout 4.0.22 -b 4.0.22 # replace 4.0.22 with the latest release available
$ ./bootstrap.sh
$ ./configure --enable-agent --enable-ipv6 --prefix=`pwd`
$ make dbschema
$ make dist
``
2. Copy and unpack the archive, e.g. zabbix-4.0.2.tar.gz, on a Windows
machine.
3. Let's assume that sources are in e:\\zabbix-4.0.2. Open a
commandline window e.g. the x64 Native Tools Command Prompt for VS
2017 RC. Go to E:\\zabbix-4.0.2\\build\\win32\\project.
4. Compile zabbix\_get, zabbix\_sender and zabbix\_agent.
- without TLS:
`E:\zabbix-4.0.2\build\win32\project> nmake /K PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
`
- with TLS:
`E:\zabbix-4.0.2\build\win32\project> nmake /K -f Makefile_get TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
E:\zabbix-4.0.2\build\win32\project> nmake /K -f Makefile_sender TLS=openssl TLSINCDIR="C:\OpenSSL-Win64-111-static\include TLSLIBDIR="C:\OpenSSL-Win64-111-static\lib" PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
E:\zabbix-4.0.2\build\win32\project> nmake /K -f Makefile_agent TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre-8.41-install\include PCRELIBDIR=E:\pcre-8.41-install\lib
`
5. New binaries are located in e:\\zabbix-4.0.2\\bin\\win64. Since
OpenSSL was compiled with 'no-shared' option, Zabbix binaries
contain OpenSSL within themselves and can be copied to other
machines that do not have OpenSSL.
#### Compiling Zabbix with LibreSSL
The process is similar to compiling with OpenSSL, but you need to make
small changes in files located in the `build\win32\project` directory:
* In ''Makefile_tls'' delete ''/DHAVE_OPENSSL_WITH_PSK''. i.e. find <code>
CFLAGS = $(CFLAGS) /DHAVE\_OPENSSL
/DHAVE\_OPENSSL\_WITH\_PSK</code>and replace it with
`CFLAGS = $(CFLAGS) /DHAVE_OPENSSL`
* In ''Makefile_common.inc'' add ''/NODEFAULTLIB:LIBCMT'' i.e. find <code>
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO
/PDB:$(TARGETDIR)\\$(TARGETNAME).pdb</code>and replace it with
`/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb /NODEFAULTLIB:LIBCMT`
#### Compiling Zabbix with LibreSSL
The process is similar to compiling with OpenSSL, but you need to make
small changes in files located in the `build\win32\project` directory:
* In ''Makefile_tls'' delete ''/DHAVE_OPENSSL_WITH_PSK''. i.e. find <code>
CFLAGS = $(CFLAGS) /DHAVE\_OPENSSL
/DHAVE\_OPENSSL\_WITH\_PSK</code>and replace it with
`CFLAGS = $(CFLAGS) /DHAVE_OPENSSL`
* In ''Makefile_common.inc'' add ''/NODEFAULTLIB:LIBCMT'' i.e. find <code>
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO
/PDB:$(TARGETDIR)\\$(TARGETNAME).pdb</code>and replace it with
`/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb /NODEFAULTLIB:LIBCMT`
#### Configurable session cookie name
The session cookie name that Zabbix frontend uses for internal
authentication is now configurable in ZBX\_SESSION\_NAME of the frontend
[definitions](/manual/web_interface/definitions).
#### Configurable session cookie name
The session cookie name that Zabbix frontend uses for internal
authentication is now configurable in ZBX\_SESSION\_NAME of the frontend
[definitions](/manual/web_interface/definitions).
#### Configuration
#### Configuration
#### configuration
Bug fixes:\
[ZBX-8999](https://support.zabbix.com/browse/ZBX-8999)
`configuration.export`: fixed exporting of images separately from other
objects\
#### configuration
Bug fixes:\
[ZBX-8999](https://support.zabbix.com/browse/ZBX-8999)
`configuration.export`: fixed exporting of images separately from other
objects\
#### configuration
Changes:\
[ZBXNEXT-5271](https://support.zabbix.com/browse/ZBXNEXT-5271)
`configuration.import`: implemented `deleteMissing` option for
`templateLinkage`\
#### configuration
Changes:\
[ZBXNEXT-5271](https://support.zabbix.com/browse/ZBXNEXT-5271)
`configuration.import`: implemented `deleteMissing` option for
`templateLinkage`\
#### Configuration
Event tags are defined in trigger configuration. Event tags can be
defined for triggers, template triggers and trigger prototypes.
#### Configuration
Event tags are defined in trigger configuration. Event tags can be
defined for triggers, template triggers and trigger prototypes.
# configuration.export
# configuration.export
# configuration.import
# configuration.import
#### Configuration parameters
The [LoadModule](/manual/appendix/config/zabbix_server)
server/proxy/agent parameter now supports specifying relative or
absolute path to the module.
#### Configuration parameters
The [LoadModule](/manual/appendix/config/zabbix_server)
server/proxy/agent parameter now supports specifying relative or
absolute path to the module.
#### Configuration
To assign triggers as link indicators, do the following:
- select a map element
- click on *Edit* in the *Links* section for the appropriate link
- click on *Add* in the *Link indicators* block and select one or more
triggers
{width="600"}
All mandatory input fields are marked with a red asterisk.
Added triggers can be seen in the *Link indicators* list.
You can set the link type and color for each trigger directly from the
list. When done, click on *Apply*, close the form and click on *Update*
to save the map changes.
#### Configuration
To assign triggers as link indicators, do the following:
- select a map element
- click on *Edit* in the *Links* section for the appropriate link
- click on *Add* in the *Link indicators* block and select one or more
triggers
{width="600"}
All mandatory input fields are marked with a red asterisk.
Added triggers can be seen in the *Link indicators* list.
You can set the link type and color for each trigger directly from the
list. When done, click on *Apply*, close the form and click on *Update*
to save the map changes.
#### Configuration
To create an ad-hoc graph, do the following:
- Go to *Monitoring* → *Latest data*
- Use filter to display items that you want
- Mark checkboxes of the items you want to graph
- Click on *Display stacked graph* or *Display graph* buttons
{width="600"}
Your graph is created instantly:
{width="600"}
Note that to avoid displaying too many lines in the graph, only the
average value for each item is displayed (min/max value lines are not
displayed). Triggers and trigger information is not displayed in the
graph.
In the created graph window you have the [time period
selector](/manual/config/visualization/graphs/simple#time_period_selector)
available and the possibility to switch from the "normal" line graph to
a stacked one (and back).
{width="600"}
#### Configuration
To create an ad-hoc graph, do the following:
- Go to *Monitoring* → *Latest data*
- Use filter to display items that you want
- Mark checkboxes of the items you want to graph
- Click on *Display stacked graph* or *Display graph* buttons
{width="600"}
Your graph is created instantly:
{width="600"}
Note that to avoid displaying too many lines in the graph, only the
average value for each item is displayed (min/max value lines are not
displayed). Triggers and trigger information is not displayed in the
graph.
In the created graph window you have the [time period
selector](/manual/config/visualization/graphs/simple#time_period_selector)
available and the possibility to switch from the "normal" line graph to
a stacked one (and back).
{width="600"}
#### Configuration
To create a slide show, do the following:
- Go to *Monitoring → Screens*
- Select *Slide shows* in the dropdown
- Go to the view with all slide shows
- Click on *Create slide show*
The **Slide** tab contains general slide show attributes:
{width="600"}
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|---------|-----------|
|*Owner*|Select the slide show owner. Specifying owner is mandatory.|
|*Name*|Unique name of the slide show.|
|*Default delay*|How long one screen is displayed by default, before rotating to the next.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 30s, 5m, 2h, 1d.|
|*Slides*|List of screens to be rotated. Click on *Add* to select screens.<br>The *Up/Down* arrow before the screen allows to drag a screen up and down in the sort order of display.<br>If you want to display only, say, a single graph in the slide show, create a screen containing just that one graph.|
|*Screen*|Screen name.|
|*Delay*|A custom value for how long the screen will be displayed, in seconds.<br>If set to 0, the *Default delay* value will be used.|
|*Action*|Click on *Remove* to remove a screen from the slide show.|
The slide show in this example consists of two screens which will be
displayed in the following order:
Zabbix server ⇒ Displayed for 30 seconds ⇒ Zabbix server2 ⇒ Displayed
for 15 seconds ⇒ Zabbix server ⇒ Displayed for 30 seconds ⇒ Zabbix
server2 ⇒ …
The **Sharing** tab contains the slide show type as well as sharing
options (user groups, users) for private slide shows:
|Parameter|Description|
|---------|-----------|
|*Type*|Select slide show type:<br>**Private** - slide show is visible only to selected user groups and users<br>**Public** - slide show is visible to all|
|*List of user group shares*|Select user groups that the slide show is accessible to.<br>You may allow read-only or read-write access.|
|*List of user shares*|Select users that the slide show is accessible to.<br>You may allow read-only or read-write access.|
Click on *Add* to save the slide show.
#### Configuration
To create a slide show, do the following:
- Go to *Monitoring → Screens*
- Select *Slide shows* in the dropdown
- Go to the view with all slide shows
- Click on *Create slide show*
The **Slide** tab contains general slide show attributes:
{width="600"}
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|---------|-----------|
|*Owner*|Select the slide show owner. Specifying owner is mandatory.|
|*Name*|Unique name of the slide show.|
|*Default delay*|How long one screen is displayed by default, before rotating to the next.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 30s, 5m, 2h, 1d.|
|*Slides*|List of screens to be rotated. Click on *Add* to select screens.<br>The *Up/Down* arrow before the screen allows to drag a screen up and down in the sort order of display.<br>If you want to display only, say, a single graph in the slide show, create a screen containing just that one graph.|
|*Screen*|Screen name.|
|*Delay*|A custom value for how long the screen will be displayed, in seconds.<br>If set to 0, the *Default delay* value will be used.|
|*Action*|Click on *Remove* to remove a screen from the slide show.|
The slide show in this example consists of two screens which will be
displayed in the following order:
Zabbix server ⇒ Displayed for 30 seconds ⇒ Zabbix server2 ⇒ Displayed
for 15 seconds ⇒ Zabbix server ⇒ Displayed for 30 seconds ⇒ Zabbix
server2 ⇒ …
The **Sharing** tab contains the slide show type as well as sharing
options (user groups, users) for private slide shows:
|Parameter|Description|
|---------|-----------|
|*Type*|Select slide show type:<br>**Private** - slide show is visible only to selected user groups and users<br>**Public** - slide show is visible to all|
|*List of user group shares*|Select user groups that the slide show is accessible to.<br>You may allow read-only or read-write access.|
|*List of user shares*|Select users that the slide show is accessible to.<br>You may allow read-only or read-write access.|
Click on *Add* to save the slide show.
#### Configuring and running Java gateway
By default, Java gateway listens on port 10052. If you plan on running
Java gateway on a different port, you can specify that in settings.sh
script. See the description of [Java gateway configuration
file](/manual/appendix/config/zabbix_java) for how to specify this and
other options.
::: notewarning
Port 10052 is not [IANA
registered](http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt).
:::
Once you are comfortable with the settings, you can start Java gateway
by running the startup script:
$ ./startup.sh
Likewise, once you no longer need Java gateway, run the shutdown script
to stop it:
$ ./shutdown.sh
Note that unlike server or proxy, Java gateway is lightweight and does
not need a database.
#### Configuring and running Java gateway
By default, Java gateway listens on port 10052. If you plan on running
Java gateway on a different port, you can specify that in settings.sh
script. See the description of [Java gateway configuration
file](/manual/appendix/config/zabbix_java) for how to specify this and
other options.
::: notewarning
Port 10052 is not [IANA
registered](http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt).
:::
Once you are comfortable with the settings, you can start Java gateway
by running the startup script:
$ ./startup.sh
Likewise, once you no longer need Java gateway, run the shutdown script
to stop it:
$ ./shutdown.sh
Note that unlike server or proxy, Java gateway is lightweight and does
not need a database.
#### Configuring and running Java gateway
Configuration parameters of Zabbix Java gateway may be tuned in the
file:
/etc/zabbix/zabbix_java_gateway.conf
For more details, see Zabbix Java gateway configuration
[parameters](/manual/appendix/config/zabbix_java).
To start Zabbix Java gateway:
# service zabbix-java-gateway restart
To automatically start Zabbix Java gateway on boot:
RHEL 7 and later:
# systemctl enable zabbix-java-gateway
RHEL prior to 7:
# chkconfig --level 12345 zabbix-java-gateway on
#### Configuring and running Java gateway
Configuration parameters of Zabbix Java gateway may be tuned in the
file:
/etc/zabbix/zabbix_java_gateway.conf
For more details, see Zabbix Java gateway configuration
[parameters](/manual/appendix/config/zabbix_java).
To start Zabbix Java gateway:
# service zabbix-java-gateway restart
To automatically start Zabbix Java gateway on boot:
RHEL 7 and later:
# systemctl enable zabbix-java-gateway
RHEL prior to 7:
# chkconfig --level 12345 zabbix-java-gateway on
#### Configuring and running Java gateway
Java gateway configuration may be tuned in the file:
/etc/zabbix/zabbix_java_gateway.conf
For more details, see Zabbix Java gateway configuration
[parameters](/manual/appendix/config/zabbix_java).
To start Zabbix Java gateway:
# service zabbix-java-gateway restart
To automatically start Zabbix Java gateway on boot:
# systemctl enable zabbix-java-gateway
#### Configuring and running Java gateway
Java gateway configuration may be tuned in the file:
/etc/zabbix/zabbix_java_gateway.conf
For more details, see Zabbix Java gateway configuration
[parameters](/manual/appendix/config/zabbix_java).
To start Zabbix Java gateway:
# service zabbix-java-gateway restart
To automatically start Zabbix Java gateway on boot:
# systemctl enable zabbix-java-gateway
#### Configuring an update operation
To configure an update operation:
- Go to the *Update operations* tab in action
[configuration](/manual/config/notifications/action)
- Click on *New* in the Operations block
- Edit the operation details and click on *Add*
Several operations can be added.
Update operation attributes:
|Parameter|<|<|<|<|Description|
|---------|-|-|-|-|-----------|
|*Default subject*|<|<|<|<|Default message subject for update notifications. The subject may contain [macros](/manual/config/notifications/action/operation/macros).|
|*Default message*|<|<|<|<|Default message for update notifications. The message may contain [macros](/manual/config/notifications/action/operation/macros).|
|*Operations*|<|<|<|<|Update operation details are displayed.<br>To configure a new update operation, click on *New*.<br>|
|*Operation details*|<|<|<|<|This block is used to configure the details of an update operation.|
|<|*Operation type*|<|<|<|Three operation types are available for update operations:<br>**Send message** - send update message to specified user when event is updated, for example, acknowledged<br>**Remote command** - execute a remote command when event is updated, for example, acknowledged<br>**Notify all involved** - send notification message to all users who received notification about the problem appearing and/or have updated the problem event.<br>If the same recipient with unchanged default subject/message is defined in several operation types, duplicate notifications are not sent.<br>The person who updates a problem does not receive notification about their own update.|
|^|<|Operation type: [send message](/manual/config/notifications/action/operation/message)|<|<|<|
|^|^|*Send to user groups*|<|<|Click on *Add* to select user groups to send the update message to.<br>The user group must have at least "read" [permissions](/manual/config/users_and_usergroups/permissions) to the host in order to be notified.|
|^|^|*Send to users*|<|<|Click on *Add* to select users to send the update message to.<br>The user must have at least "read" [permissions](/manual/config/users_and_usergroups/permissions) to the host in order to be notified.|
|^|^|*Send only to*|<|<|Send update message to all defined media types or a selected one only.|
|^|^|*Default message*|<|<|If selected, the default message will be used (see above).|
|^|^|*Subject*|<|<|Subject of the custom message. The subject may contain macros.|
|^|^|*Message*|<|<|The custom message. The message may contain macros.|
|^|^|Operation type: [remote command](/manual/config/notifications/action/operation/remote_command)|<|<|<|
|^|^|*Target list*|<|<|Select targets to execute the command on:<br>**Current host** - command is executed on the host of the trigger that caused the problem event. This option will not work if there are multiple hosts in the trigger.<br>**Host** - select host(s) to execute the command on.<br>**Host group** - select host group(s) to execute the command on. Specifying a parent host group implicitly selects all nested host groups. Thus the remote command will also be executed on hosts from nested groups.<br>A command on a host is executed only once, even if the host matches more than once (e.g. from several host groups; individually and from a host group).<br>The target list is meaningless if the command is executed on Zabbix server. Selecting more targets in this case only results in the command being executed on the server more times.<br>Note that for global scripts, the target selection also depends on the *Host group* setting in global script [configuration](/manual/web_interface/frontend_sections/administration/scripts#configuring_a_global_script).|
|^|^|*Type*|<|<|Select the command type:<br>**IPMI** - execute an [IPMI command](/manual/config/notifications/action/operation/remote_command#ipmi_remote_commands)<br>**Custom script** - execute a custom set of commands<br>**SSH** - execute an SSH command<br>**Telnet** - execute a Telnet command<br>**Global script** - execute one of the global scripts defined in *Administration→Scripts*.|
|^|^|*Execute on*|<|<|Execute a custom script on:<br>**Zabbix agent** - the script will be executed by Zabbix agent on the host<br>**Zabbix server (proxy)** - the script will be executed by Zabbix server or proxy - depending on whether the host is monitored by server or proxy<br>**Zabbix server** - the script will be executed by Zabbix server only<br>To execute scripts on the agent, it must be [configured](/manual/appendix/config/zabbix_agentd) to allow remote commands from the server.<br>This field is available if 'Custom script' is selected as *Type*.|
|^|^|*Commands*|<|<|Enter the command(s).<br>Supported macros will be resolved based on the trigger expression that caused the event. For example, host macros will resolve to the hosts of the trigger expression (and not of the target list).|
|^|<|Operation type: notify all involved|<|<|<|
|^|^|*Default media type*|<|<|Users who update a problem but have not received notifications about the problem appearing will receive notifications about further updates on the selected default media type - Email, Jabber or SMS.<br>This field is available since Zabbix 3.4.2.|
|^|^|*Default message*|<|<|If selected, the default message will be used (see above).|
|^|^|*Subject*|<|<|Subject of the custom message. The subject may contain macros.|
|^|^|*Message*|<|<|The custom message. The message may contain macros.|
#### Configuring an update operation
To configure an update operation:
- Go to the *Update operations* tab in action
[configuration](/manual/config/notifications/action)
- Click on *New* in the Operations block
- Edit the operation details and click on *Add*
Several operations can be added.
Update operation attributes:
|Parameter|<|<|<|<|Description|
|---------|-|-|-|-|-----------|
|*Default subject*|<|<|<|<|Default message subject for update notifications. The subject may contain [macros](/manual/config/notifications/action/operation/macros).|
|*Default message*|<|<|<|<|Default message for update notifications. The message may contain [macros](/manual/config/notifications/action/operation/macros).|
|*Operations*|<|<|<|<|Update operation details are displayed.<br>To configure a new update operation, click on *New*.<br>|
|*Operation details*|<|<|<|<|This block is used to configure the details of an update operation.|
|<|*Operation type*|<|<|<|Three operation types are available for update operations:<br>**Send message** - send update message to specified user when event is updated, for example, acknowledged<br>**Remote command** - execute a remote command when event is updated, for example, acknowledged<br>**Notify all involved** - send notification message to all users who received notification about the problem appearing and/or have updated the problem event.<br>If the same recipient with unchanged default subject/message is defined in several operation types, duplicate notifications are not sent.<br>The person who updates a problem does not receive notification about their own update.|
|^|<|Operation type: [send message](/manual/config/notifications/action/operation/message)|<|<|<|
|^|^|*Send to user groups*|<|<|Click on *Add* to select user groups to send the update message to.<br>The user group must have at least "read" [permissions](/manual/config/users_and_usergroups/permissions) to the host in order to be notified.|
|^|^|*Send to users*|<|<|Click on *Add* to select users to send the update message to.<br>The user must have at least "read" [permissions](/manual/config/users_and_usergroups/permissions) to the host in order to be notified.|
|^|^|*Send only to*|<|<|Send update message to all defined media types or a selected one only.|
|^|^|*Default message*|<|<|If selected, the default message will be used (see above).|
|^|^|*Subject*|<|<|Subject of the custom message. The subject may contain macros.|
|^|^|*Message*|<|<|The custom message. The message may contain macros.|
|^|^|Operation type: [remote command](/manual/config/notifications/action/operation/remote_command)|<|<|<|
|^|^|*Target list*|<|<|Select targets to execute the command on:<br>**Current host** - command is executed on the host of the trigger that caused the problem event. This option will not work if there are multiple hosts in the trigger.<br>**Host** - select host(s) to execute the command on.<br>**Host group** - select host group(s) to execute the command on. Specifying a parent host group implicitly selects all nested host groups. Thus the remote command will also be executed on hosts from nested groups.<br>A command on a host is executed only once, even if the host matches more than once (e.g. from several host groups; individually and from a host group).<br>The target list is meaningless if the command is executed on Zabbix server. Selecting more targets in this case only results in the command being executed on the server more times.<br>Note that for global scripts, the target selection also depends on the *Host group* setting in global script [configuration](/manual/web_interface/frontend_sections/administration/scripts#configuring_a_global_script).|
|^|^|*Type*|<|<|Select the command type:<br>**IPMI** - execute an [IPMI command](/manual/config/notifications/action/operation/remote_command#ipmi_remote_commands)<br>**Custom script** - execute a custom set of commands<br>**SSH** - execute an SSH command<br>**Telnet** - execute a Telnet command<br>**Global script** - execute one of the global scripts defined in *Administration→Scripts*.|
|^|^|*Execute on*|<|<|Execute a custom script on:<br>**Zabbix agent** - the script will be executed by Zabbix agent on the host<br>**Zabbix server (proxy)** - the script will be executed by Zabbix server or proxy - depending on whether the host is monitored by server or proxy<br>**Zabbix server** - the script will be executed by Zabbix server only<br>To execute scripts on the agent, it must be [configured](/manual/appendix/config/zabbix_agentd) to allow remote commands from the server.<br>This field is available if 'Custom script' is selected as *Type*.|
|^|^|*Commands*|<|<|Enter the command(s).<br>Supported macros will be resolved based on the trigger expression that caused the event. For example, host macros will resolve to the hosts of the trigger expression (and not of the target list).|
|^|<|Operation type: notify all involved|<|<|<|
|^|^|*Default media type*|<|<|Users who update a problem but have not received notifications about the problem appearing will receive notifications about further updates on the selected default media type - Email, Jabber or SMS.<br>This field is available since Zabbix 3.4.2.|
|^|^|*Default message*|<|<|If selected, the default message will be used (see above).|
|^|^|*Subject*|<|<|Subject of the custom message. The subject may contain macros.|
|^|^|*Message*|<|<|The custom message. The message may contain macros.|
#### Configuring custom graphs
To create a custom graph, do the following:
- Go to *Configuration → Hosts (or Templates)*
- Click on *Graphs* in the row next to the desired host or template
- In the Graphs screen click on *Create graph*
- Edit graph attributes
{width="600"}
All mandatory input fields are marked with a red asterisk.
Graph attributes:
|Parameter|<|Description|
|---------|-|-----------|
|*Name*|<|Unique graph name.<br>Starting with Zabbix 2.2, item values can be referenced in the name by using simple macros with the standard `{host:key.func(param)}` syntax. Only **avg**, **last**, **max** and **min** as functions with seconds as parameter are supported within this macro. {HOST.HOST<1-9>} macros are supported for the use within this macro, referencing the first, second, third, etc. host in the graph, for example `{{HOST.HOST1}:key.func(param)}`.|
|*Width*|<|Graph width in pixels (for preview and pie/exploded graphs only).|
|*Height*|<|Graph height in pixels.|
|*Graph type*|<|Graph type:<br>**Normal** - normal graph, values displayed as lines<br>**Stacked** - stacked graph, filled areas displayed<br>**Pie** - pie graph<br>**Exploded** - "exploded" pie graph, portions displayed as "cut out" of the pie|
|*Show legend*|<|Checking this box will set to display the graph legend.|
|*Show working time*|<|If selected, non-working hours will be shown with gray background. Not available for pie and exploded pie graphs.|
|*Show triggers*|<|If selected, simple triggers will be displayed as lines with black dashes over trigger severity color. Not available for pie and exploded pie graphs.|
|*Percentile line (left)*|<|Display percentile for left Y axis. If, for example, 95% percentile is set, then the percentile line will be at the level where 95 per cent of the values fall under. Displayed as a bright green line. Only available for normal graphs.|
|*Percentile line (right)*|<|Display percentile for right Y axis. If, for example, 95% percentile is set, then the percentile line will be at the level where 95 per cent of the values fall under. Displayed as a bright red line. Only available for normal graphs.|
|*Y axis MIN value*|<|Minimum value of Y axis:<br>**Calculated** - Y axis minimum value will be automatically calculated<br>**Fixed** - fixed minimum value for Y axis. Not available for pie and exploded pie graphs.<br>**Item** - last value of the selected item will be the minimum value|
|*Y axis MAX value*|<|Maximum value of Y axis:<br>**Calculated** - Y axis maximum value will be automatically calculated<br>**Fixed** - fixed maximum value for Y axis. Not available for pie and exploded pie graphs.<br>**Item** - last value of the selected item will be the maximum value|
|*3D view*|<|Enable 3D style. For pie and exploded pie graphs only.|
|*Items*|<|Items, data of which are to be displayed in this graph. Click on *Add* to select items. You can also select various displaying options (function, draw style, left/right axis display, color).|
|<|*Sort order (0→100)*|Draw order. 0 will be processed first. Can be used to draw lines or regions behind (or in front of) another.<br>You can drag and drop items by the arrow in the beginning of line to set the sort order or which item is displayed in front of the other.|
|^|*Name*|Name of the selected item is displayed as a link. Clicking on the link opens the list of other available items.|
|^|*Type*|Type (only available for pie and exploded pie graphs):<br>**Simple** - value of the item is represented proportionally on the pie<br>**Graph sum** - value of the item represents the whole pie<br>Note that colouring of the "graph sum" item will only be visible to the extent that it is not taken up by "proportional" items.|
|^|*Function*|Select what values will be displayed when more than one value exists per vertical graph pixel for an item:<br>**all** - display all possible values (minimum, maximum, average) in the graph. Note that for shorter periods this setting has no effect; only for longer periods, when data congestion in a vertical graph pixel increases, 'all' starts displaying minimum, maximum and average values. This function is only available for *Normal* graph type. See also: Generating graphs [from history/trends](/manual/config/visualization/graphs/simple#generating_from_historytrends).<br>**avg** - display the average values<br>**last** - display the latest values. This function is only available if either *Pie/Exploded pie* is selected as graph type.<br>**max** - display the maximum values<br>**min** - display the minimum values|
|^|*Draw style*|Select the draw style (only available for normal graphs; for stacked graphs filled region is always used) to apply to the item data - *Line*, *Bold line*, *Filled region*, *Dot*, *Dashed line*, *Gradient line*.|
|^|*Y axis side*|Select the Y axis side to show the item data - *Left*, *Right*.|
|^|*Color*|Select the color to apply to the item data.|
#### Configuring custom graphs
To create a custom graph, do the following:
- Go to *Configuration → Hosts (or Templates)*
- Click on *Graphs* in the row next to the desired host or template
- In the Graphs screen click on *Create graph*
- Edit graph attributes
{width="600"}
All mandatory input fields are marked with a red asterisk.
Graph attributes:
|Parameter|<|Description|
|---------|-|-----------|
|*Name*|<|Unique graph name.<br>Starting with Zabbix 2.2, item values can be referenced in the name by using simple macros with the standard `{host:key.func(param)}` syntax. Only **avg**, **last**, **max** and **min** as functions with seconds as parameter are supported within this macro. {HOST.HOST<1-9>} macros are supported for the use within this macro, referencing the first, second, third, etc. host in the graph, for example `{{HOST.HOST1}:key.func(param)}`.|
|*Width*|<|Graph width in pixels (for preview and pie/exploded graphs only).|
|*Height*|<|Graph height in pixels.|
|*Graph type*|<|Graph type:<br>**Normal** - normal graph, values displayed as lines<br>**Stacked** - stacked graph, filled areas displayed<br>**Pie** - pie graph<br>**Exploded** - "exploded" pie graph, portions displayed as "cut out" of the pie|
|*Show legend*|<|Checking this box will set to display the graph legend.|
|*Show working time*|<|If selected, non-working hours will be shown with gray background. Not available for pie and exploded pie graphs.|
|*Show triggers*|<|If selected, simple triggers will be displayed as lines with black dashes over trigger severity color. Not available for pie and exploded pie graphs.|
|*Percentile line (left)*|<|Display percentile for left Y axis. If, for example, 95% percentile is set, then the percentile line will be at the level where 95 per cent of the values fall under. Displayed as a bright green line. Only available for normal graphs.|
|*Percentile line (right)*|<|Display percentile for right Y axis. If, for example, 95% percentile is set, then the percentile line will be at the level where 95 per cent of the values fall under. Displayed as a bright red line. Only available for normal graphs.|
|*Y axis MIN value*|<|Minimum value of Y axis:<br>**Calculated** - Y axis minimum value will be automatically calculated<br>**Fixed** - fixed minimum value for Y axis. Not available for pie and exploded pie graphs.<br>**Item** - last value of the selected item will be the minimum value|
|*Y axis MAX value*|<|Maximum value of Y axis:<br>**Calculated** - Y axis maximum value will be automatically calculated<br>**Fixed** - fixed maximum value for Y axis. Not available for pie and exploded pie graphs.<br>**Item** - last value of the selected item will be the maximum value|
|*3D view*|<|Enable 3D style. For pie and exploded pie graphs only.|
|*Items*|<|Items, data of which are to be displayed in this graph. Click on *Add* to select items. You can also select various displaying options (function, draw style, left/right axis display, color).|
|<|*Sort order (0→100)*|Draw order. 0 will be processed first. Can be used to draw lines or regions behind (or in front of) another.<br>You can drag and drop items by the arrow in the beginning of line to set the sort order or which item is displayed in front of the other.|
|^|*Name*|Name of the selected item is displayed as a link. Clicking on the link opens the list of other available items.|
|^|*Type*|Type (only available for pie and exploded pie graphs):<br>**Simple** - value of the item is represented proportionally on the pie<br>**Graph sum** - value of the item represents the whole pie<br>Note that colouring of the "graph sum" item will only be visible to the extent that it is not taken up by "proportional" items.|
|^|*Function*|Select what values will be displayed when more than one value exists per vertical graph pixel for an item:<br>**all** - display all possible values (minimum, maximum, average) in the graph. Note that for shorter periods this setting has no effect; only for longer periods, when data congestion in a vertical graph pixel increases, 'all' starts displaying minimum, maximum and average values. This function is only available for *Normal* graph type. See also: Generating graphs [from history/trends](/manual/config/visualization/graphs/simple#generating_from_historytrends).<br>**avg** - display the average values<br>**last** - display the latest values. This function is only available if either *Pie/Exploded pie* is selected as graph type.<br>**max** - display the maximum values<br>**min** - display the minimum values|
|^|*Draw style*|Select the draw style (only available for normal graphs; for stacked graphs filled region is always used) to apply to the item data - *Line*, *Bold line*, *Filled region*, *Dot*, *Dashed line*, *Gradient line*.|
|^|*Y axis side*|Select the Y axis side to show the item data - *Left*, *Right*.|
|^|*Color*|Select the color to apply to the item data.|
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
##### Copying items, triggers, graphs
The form for item/trigger/graph copying to other targets has been
changed:
- The *Target type* field is now a radio button type, instead of a
dropdown;
- The *Target* field allows to multiselect, rather than displaying all
possible targets in what could be an endless list. Starting to type
in the *Target* field will show all available corresponding targets.
|<|
|<|
|-|
|<|
##### Copying items, triggers, graphs
The form for item/trigger/graph copying to other targets has been
changed:
- The *Target type* field is now a radio button type, instead of a
dropdown;
- The *Target* field allows to multiselect, rather than displaying all
possible targets in what could be an endless list. Starting to type
in the *Target* field will show all available corresponding targets.
|<|
|<|
|-|
|<|
#### Creating a map
To create a map, do the following:
- Go to *Monitoring → Maps*
- Go to the view with all maps
- Click on *Create map*
You can also use the *Clone* and *Full clone* buttons in the
configuration form of an existing map to create a new map. Clicking on
*Clone* will retain general layout attributes of the original map, but
no elements. *Full clone* will retain both the general layout attributes
and all elements of the original map.
The **Map** tab contains general map attributes:
{width="600"}
All mandatory input fields are marked with a red asterisk.
General map attributes:
|Parameter|Description|
|---------|-----------|
|*Owner*|Name of map owner.|
|*Name*|Unique map name.|
|*Width*|Map width in pixels.|
|*Height*|Map height in pixels.|
|*Background image*|Use background image:<br>**No image** - no background image (white background)<br>**Image** - selected image to be used as a background image. No scaling is performed. You may use a geographical map or any other image to enhance your map.|
|*Automatic icon mapping*|You can set to use an automatic icon mapping, configured in *Administration → General → Icon mapping*. Icon mapping allows to map certain icons against certain host inventory fields.|
|*Icon highlighting*|If you check this box, map elements will receive highlighting.<br>Elements with an active trigger will receive a round background, in the same color as the highest severity trigger. Moreover, a thick green line will be displayed around the circle, if all problems are acknowledged.<br>Elements with "disabled" or "in maintenance" status will get a square background, gray and orange respectively.<br>See also: [Viewing maps](/manual/web_interface/frontend_sections/monitoring/maps#viewing_maps)|
|*Mark elements on trigger status change*|A recent change of trigger status (recent problem or resolution) will be highlighted with markers (inward-pointing red triangles) on the three sides of the element icon that are free of the label. Markers are displayed for 30 minutes.|
|*Display problems*|Select how problems are displayed with a map element:<br>**Expand single problem** - name of the most critical problem is displayed<br>**Number of problems** - the total number of problems is displayed<br>**Number of problems and expand most critical one** - name of the most critical problem and the total number of problems is displayed.<br>'Most critical' is determined based on problem severity and, if equal, problem event ID (higher ID or later problem displayed first). (Note that trigger ID instead of problem event ID was evaluated before 4.0.7.)<br>*For trigger map element* it is based on problem severity and, if equal, trigger position in the trigger list. In case of multiple problems of the same trigger, the most recent one will be displayed.|
|*Advanced labels*|If you check this box you will be able to define separate label types for separate element types.|
|*Map element label type*|Label type used for map elements:<br>**Label** - map element label<br>**IP address** - IP address<br>**Element name** - element name (for example, host name)<br>**Status only** - status only (OK or PROBLEM)<br>**Nothing** - no labels are displayed|
|*Map element label location*|Label location in relation to the map element:<br>**Bottom** - beneath the map element<br>**Left** - to the left<br>**Right** - to the right<br>**Top** - above the map element|
|*Problem display*|Display problem count as:<br>**All** - full problem count will be displayed<br>**Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count<br>**Unacknowledged only** - only the unacknowledged problem count will be displayed|
|*Minimum trigger severity*|Problems below the selected minimum severity level will not be displayed in the map.<br>For example, with *Warning* selected, changes with *Information* and *Not classified* level triggers will not be reflected in the map.<br>This parameter is supported starting with Zabbix 2.2.|
|*Show suppressed problems*|Mark the checkbox to display problems which would otherwise be suppressed (not shown) because of host maintenance.|
|*URLs*|URLs for each element type can be defined (with a label). These will be displayed as links when a user clicks on the element in the map viewing mode.<br>[Macros](/manual/config/macros) that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID}, {HOST.ID}, {TRIGGER.ID}|
#### Creating a map
To create a map, do the following:
- Go to *Monitoring → Maps*
- Go to the view with all maps
- Click on *Create map*
You can also use the *Clone* and *Full clone* buttons in the
configuration form of an existing map to create a new map. Clicking on
*Clone* will retain general layout attributes of the original map, but
no elements. *Full clone* will retain both the general layout attributes
and all elements of the original map.
The **Map** tab contains general map attributes:
{width="600"}
All mandatory input fields are marked with a red asterisk.
General map attributes:
|Parameter|Description|
|---------|-----------|
|*Owner*|Name of map owner.|
|*Name*|Unique map name.|
|*Width*|Map width in pixels.|
|*Height*|Map height in pixels.|
|*Background image*|Use background image:<br>**No image** - no background image (white background)<br>**Image** - selected image to be used as a background image. No scaling is performed. You may use a geographical map or any other image to enhance your map.|
|*Automatic icon mapping*|You can set to use an automatic icon mapping, configured in *Administration → General → Icon mapping*. Icon mapping allows to map certain icons against certain host inventory fields.|
|*Icon highlighting*|If you check this box, map elements will receive highlighting.<br>Elements with an active trigger will receive a round background, in the same color as the highest severity trigger. Moreover, a thick green line will be displayed around the circle, if all problems are acknowledged.<br>Elements with "disabled" or "in maintenance" status will get a square background, gray and orange respectively.<br>See also: [Viewing maps](/manual/web_interface/frontend_sections/monitoring/maps#viewing_maps)|
|*Mark elements on trigger status change*|A recent change of trigger status (recent problem or resolution) will be highlighted with markers (inward-pointing red triangles) on the three sides of the element icon that are free of the label. Markers are displayed for 30 minutes.|
|*Display problems*|Select how problems are displayed with a map element:<br>**Expand single problem** - name of the most critical problem is displayed<br>**Number of problems** - the total number of problems is displayed<br>**Number of problems and expand most critical one** - name of the most critical problem and the total number of problems is displayed.<br>'Most critical' is determined based on problem severity and, if equal, problem event ID (higher ID or later problem displayed first). (Note that trigger ID instead of problem event ID was evaluated before 4.0.7.)<br>*For trigger map element* it is based on problem severity and, if equal, trigger position in the trigger list. In case of multiple problems of the same trigger, the most recent one will be displayed.|
|*Advanced labels*|If you check this box you will be able to define separate label types for separate element types.|
|*Map element label type*|Label type used for map elements:<br>**Label** - map element label<br>**IP address** - IP address<br>**Element name** - element name (for example, host name)<br>**Status only** - status only (OK or PROBLEM)<br>**Nothing** - no labels are displayed|
|*Map element label location*|Label location in relation to the map element:<br>**Bottom** - beneath the map element<br>**Left** - to the left<br>**Right** - to the right<br>**Top** - above the map element|
|*Problem display*|Display problem count as:<br>**All** - full problem count will be displayed<br>**Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count<br>**Unacknowledged only** - only the unacknowledged problem count will be displayed|
|*Minimum trigger severity*|Problems below the selected minimum severity level will not be displayed in the map.<br>For example, with *Warning* selected, changes with *Information* and *Not classified* level triggers will not be reflected in the map.<br>This parameter is supported starting with Zabbix 2.2.|
|*Show suppressed problems*|Mark the checkbox to display problems which would otherwise be suppressed (not shown) because of host maintenance.|
|*URLs*|URLs for each element type can be defined (with a label). These will be displayed as links when a user clicks on the element in the map viewing mode.<br>[Macros](/manual/config/macros) that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID}, {HOST.ID}, {TRIGGER.ID}|
#### Creating a screen
To create a screen, do the following:
- Go to *Monitoring → Screens*
- Go to the view with all screens
- Click on *Create Screen*
The **Screen** tab contains general screen attributes:
All mandatory input fields are marked with a red asterisk.
Give your screen a unique name and set the number of columns (vertical
cells) and rows (horizontal cells).
The **Sharing** tab contains the screen type as well as sharing options
(user groups, users) for private screens:
|Parameter|Description|
|---------|-----------|
|*Owner*|Select the screen owner.|
|*Type*|Select screen type:<br>**Private** - screen is visible only to selected user groups and users<br>**Public** - screen is visible to all|
|*List of user group shares*|Select user groups that the screen is accessible to.<br>You may allow read-only or read-write access.|
|*List of user shares*|Select users that the screen is accessible to.<br>You may allow read-only or read-write access.|
Click on *Add* to save the screen.
#### Creating a screen
To create a screen, do the following:
- Go to *Monitoring → Screens*
- Go to the view with all screens
- Click on *Create Screen*
The **Screen** tab contains general screen attributes:
All mandatory input fields are marked with a red asterisk.
Give your screen a unique name and set the number of columns (vertical
cells) and rows (horizontal cells).
The **Sharing** tab contains the screen type as well as sharing options
(user groups, users) for private screens:
|Parameter|Description|
|---------|-----------|
|*Owner*|Select the screen owner.|
|*Type*|Select screen type:<br>**Private** - screen is visible only to selected user groups and users<br>**Public** - screen is visible to all|
|*List of user group shares*|Select user groups that the screen is accessible to.<br>You may allow read-only or read-write access.|
|*List of user shares*|Select users that the screen is accessible to.<br>You may allow read-only or read-write access.|
Click on *Add* to save the screen.
#### Custom headers in web scenarios/HTTP checks
The length of custom header value fields has been increased from 255 to
1000 characters.
#### Custom headers in web scenarios/HTTP checks
The length of custom header value fields has been increased from 255 to
1000 characters.
#### Custom multiplier preprocessing step
Custom multiplier [preprocessing
step](/manual/config/items/item#item_value_preprocessing) now accepts
strings with macros (a macro must resolve as an integer or a
floating-point number).
#### Custom multiplier preprocessing step
Custom multiplier [preprocessing
step](/manual/config/items/item#item_value_preprocessing) now accepts
strings with macros (a macro must resolve as an integer or a
floating-point number).
#### Daemon improvements
- Daemons and commandline utilities when showing version information
(with '-V' option) now also display the crypto library version.
#### Daemon improvements
- Daemons and commandline utilities when showing version information
(with '-V' option) now also display the crypto library version.
#### Daemon improvements
- Support of OpenSSL 1.1.1 has been added.
#### Daemon improvements
- Support of OpenSSL 1.1.1 has been added.
### Daemons
### Daemons
#### Daemons
#### Daemons
#### Date and time on hover in graph widget
Date and time is now also displayed, in addition to displaying item
values, when hovering over a point in time in the graph
[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#graph).
Note that this is the date and time of the point in graph, not of the
actual values. However, this change still allows to know more precisely
when something (e.g. a peak) happened:
#### Date and time on hover in graph widget
Date and time is now also displayed, in addition to displaying item
values, when hovering over a point in time in the graph
[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#graph).
Note that this is the date and time of the point in graph, not of the
actual values. However, this change still allows to know more precisely
when something (e.g. a peak) happened:
#### DB character set and collation check
A check for the correct character set and collation is now performed on
the database, database tables and table fields during the initial
frontend installation. If the check fails a warning message is
displayed.
A warning message is also displayed in *Reports* → *System information*.
#### DB character set and collation check
A check for the correct character set and collation is now performed on
the database, database tables and table fields during the initial
frontend installation. If the check fails a warning message is
displayed.
A warning message is also displayed in *Reports* → *System information*.
#### DB character set and collation check
A check for the correct character set and collation is now performed on
the database, database tables and table fields during the initial
frontend installation. If the check fails a warning message is
displayed.
A warning message is also displayed in *Reports* → *System information*.
See also instructions for [changing database character set and
collation](/manual/appendix/install/db_scripts?rev=1582206793#mysql) in
MySQL.
#### DB character set and collation check
A check for the correct character set and collation is now performed on
the database, database tables and table fields during the initial
frontend installation. If the check fails a warning message is
displayed.
A warning message is also displayed in *Reports* → *System information*.
See also instructions for [changing database character set and
collation](/manual/appendix/install/db_scripts?rev=1582206793#mysql) in
MySQL.
#### Debugging Java gateway
In case there are any problems with Java gateway or an error message
that you see about an item in the frontend is not descriptive enough,
you might wish to take a look at Java gateway log file.
By default, Java gateway logs its activities into /tmp/zabbix\_java.log
file with log level "info". Sometimes that information is not enough and
there is a need for information at log level "debug". In order to
increase logging level, modify file lib/logback.xml and change the level
attribute of <root> tag to "debug":
<root level="debug">
<appender-ref ref="FILE" />
</root>
Note that unlike Zabbix server or Zabbix proxy, there is no need to
restart Zabbix Java gateway after changing logback.xml file - changes in
logback.xml will be picked up automatically. When you are done with
debugging, you can return the logging level to "info".
If you wish to log to a different file or a completely different medium
like database, adjust logback.xml file to meet your needs. See [Logback
Manual](http://logback.qos.ch/manual/) for more details.
Sometimes for debugging purposes it is useful to start Java gateway as a
console application rather than a daemon. To do that, comment out
PID\_FILE variable in settings.sh. If PID\_FILE is omitted, startup.sh
script starts Java gateway as a console application and makes Logback
use lib/logback-console.xml file instead, which not only logs to
console, but has logging level "debug" enabled as well.
Finally, note that since Java gateway uses SLF4J for logging, you can
replace Logback with the framework of your choice by placing an
appropriate JAR file in lib directory. See [SLF4J
Manual](http://www.slf4j.org/manual.html) for more details.
#### Debugging Java gateway
In case there are any problems with Java gateway or an error message
that you see about an item in the frontend is not descriptive enough,
you might wish to take a look at Java gateway log file.
By default, Java gateway logs its activities into /tmp/zabbix\_java.log
file with log level "info". Sometimes that information is not enough and
there is a need for information at log level "debug". In order to
increase logging level, modify file lib/logback.xml and change the level
attribute of <root> tag to "debug":
<root level="debug">
<appender-ref ref="FILE" />
</root>
Note that unlike Zabbix server or Zabbix proxy, there is no need to
restart Zabbix Java gateway after changing logback.xml file - changes in
logback.xml will be picked up automatically. When you are done with
debugging, you can return the logging level to "info".
If you wish to log to a different file or a completely different medium
like database, adjust logback.xml file to meet your needs. See [Logback
Manual](http://logback.qos.ch/manual/) for more details.
Sometimes for debugging purposes it is useful to start Java gateway as a
console application rather than a daemon. To do that, comment out
PID\_FILE variable in settings.sh. If PID\_FILE is omitted, startup.sh
script starts Java gateway as a console application and makes Logback
use lib/logback-console.xml file instead, which not only logs to
console, but has logging level "debug" enabled as well.
Finally, note that since Java gateway uses SLF4J for logging, you can
replace Logback with the framework of your choice by placing an
appropriate JAR file in lib directory. See [SLF4J
Manual](http://www.slf4j.org/manual.html) for more details.
#### Debugging Java gateway
Zabbix Java gateway log file is:
/var/log/zabbix/zabbix_java_gateway.log
If you like to increase the logging, edit the file:
/etc/zabbix/zabbix_java_gateway_logback.xml
and change `level="info"` to "debug" or even "trace" (for deep
troubleshooting):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### Debugging Java gateway
Zabbix Java gateway log file is:
/var/log/zabbix/zabbix_java_gateway.log
If you like to increase the logging, edit the file:
/etc/zabbix/zabbix_java_gateway_logback.xml
and change `level="info"` to "debug" or even "trace" (for deep
troubleshooting):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### Debugging Java gateway
Zabbix Java gateway log file is:
/var/log/zabbix/zabbix_java_gateway.log
If you like to increase the logging, edit the file:
/etc/zabbix/zabbix_java_gateway_logback.xml
and change `level="info"` to "debug" or even "trace" (for deep
troubleshooting):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### Debugging Java gateway
Zabbix Java gateway log file is:
/var/log/zabbix/zabbix_java_gateway.log
If you like to increase the logging, edit the file:
/etc/zabbix/zabbix_java_gateway_logback.xml
and change `level="info"` to "debug" or even "trace" (for deep
troubleshooting):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
##### Dependent item prototype
Create an item prototype with "Dependent item" type in this LLD rule. As
master item for this prototype select the `vfs.fs.get` item we created.
Note the use of macros in the item prototype name and key:
- *Name*: Free disk space on {\#FSNAME}, type: {\#FSTYPE}
- *Key*: Free\[{\#FSNAME}\]
As type of information, use:
- *Numeric (unsigned)* for metrics like 'free', 'total', 'used'
- *Numeric (float)* for metrics like 'pfree', 'pused' (percentage)
In the item prototype "Preprocessing" tab select JSONPath and use the
following JSONPath expression as parameter:
$.[?(@.fsname=='{#FSNAME}')].bytes.free.first()
When discovery starts, one item per each mountpoint will be created.
This item will return the number of free bytes for the given mountpoint.
##### Dependent item prototype
Create an item prototype with "Dependent item" type in this LLD rule. As
master item for this prototype select the `vfs.fs.get` item we created.
Note the use of macros in the item prototype name and key:
- *Name*: Free disk space on {\#FSNAME}, type: {\#FSTYPE}
- *Key*: Free\[{\#FSNAME}\]
As type of information, use:
- *Numeric (unsigned)* for metrics like 'free', 'total', 'used'
- *Numeric (float)* for metrics like 'pfree', 'pused' (percentage)
In the item prototype "Preprocessing" tab select JSONPath and use the
following JSONPath expression as parameter:
$.[?(@.fsname=='{#FSNAME}')].bytes.free.first()
When discovery starts, one item per each mountpoint will be created.
This item will return the number of free bytes for the given mountpoint.
### Description
`object triggerprototype.create(object/array triggerPrototypes)`
This method allows to create new trigger prototypes.
### Description
`object triggerprototype.create(object/array triggerPrototypes)`
This method allows to create new trigger prototypes.
### Description
`object user.checkAuthentication`
This method checks and prolongs user session.
### Description
`object user.checkAuthentication`
This method checks and prolongs user session.
## DESCRIPTION
**zabbix\_agentd** is a daemon for monitoring of various server
parameters. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_agentd** is a daemon for monitoring of various server
parameters. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_get** is a command line utility for getting data from Zabbix
agent. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_get** is a command line utility for getting data from Zabbix
agent. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_proxy** is a daemon that collects monitoring data from devices
and sends it to Zabbix server. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_proxy** is a daemon that collects monitoring data from devices
and sends it to Zabbix server. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_sender** is a command line utility for sending monitoring data
to Zabbix server or proxy. On the Zabbix server an item of type **Zabbix
trapper** should be created with corresponding key. Note that incoming
values will only be accepted from hosts specified in **Allowed hosts**
field for this item. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_sender** is a command line utility for sending monitoring data
to Zabbix server or proxy. On the Zabbix server an item of type **Zabbix
trapper** should be created with corresponding key. Note that incoming
values will only be accepted from hosts specified in **Allowed hosts**
field for this item. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_server** is the core daemon of Zabbix software. [ ]{#lbAE}
## DESCRIPTION
**zabbix\_server** is the core daemon of Zabbix software. [ ]{#lbAE}
#### Disabled autocomplete attribute for sensitive fields
To avoid potential exposure of data, the autocomplete attribute is now
turned off for many fields containing sensitive information, such as a
user's password for logging into Zabbix, pre-shared keys (PSK), macro
values, usernames and passwords used for data collection by various
items and hosts, SNMPv3 authentication and privacy passphrases,
passwords for media types; SSL key password and HTTP proxy fields used
in web scenarios and HTTP items; usernames, passwords and key
passphrases in remote commands. This setting shall prevent most browsers
from using autocompletion in the affected fields.
#### Disabled autocomplete attribute for sensitive fields
To avoid potential exposure of data, the autocomplete attribute is now
turned off for many fields containing sensitive information, such as a
user's password for logging into Zabbix, pre-shared keys (PSK), macro
values, usernames and passwords used for data collection by various
items and hosts, SNMPv3 authentication and privacy passphrases,
passwords for media types; SSL key password and HTTP proxy fields used
in web scenarios and HTTP items; usernames, passwords and key
passphrases in remote commands. This setting shall prevent most browsers
from using autocompletion in the affected fields.
#### Disabling default web server error pages
It is recommended to disable default error pages to avoid information
exposure. Web server is using built-in error pages by default:
Default error pages should be replaced/removed as part of the web server
hardening process. The "ErrorDocument" directive can be used to define a
custom error page/text for Apache web server (used as an example).
Please refer to documentation of your web server to find help on how to
replace/remove default error pages.
#### Disabling default web server error pages
It is recommended to disable default error pages to avoid information
exposure. Web server is using built-in error pages by default:
Default error pages should be replaced/removed as part of the web server
hardening process. The "ErrorDocument" directive can be used to define a
custom error page/text for Apache web server (used as an example).
Please refer to documentation of your web server to find help on how to
replace/remove default error pages.
#### Disabling web server information exposure
It is recommended to disable all web server signatures as part of the
web server hardening process. The web server is exposing software
signature by default:
The signature can be disabled by adding two lines to the Apache (used as
an example) configuration file:
ServerSignature Off
ServerTokens Prod
PHP signature (X-Powered-By HTTP header) can be disabled by changing the
php.ini configuration file (signature is disabled by default):
expose_php = Off
Web server restart is required for configuration file changes to be
applied.
Additional security level can be achieved by using the mod\_security
(package libapache2-mod-security2) with Apache. mod\_security allows to
remove server signature instead of only removing version from server
signature. Signature can be altered to any value by changing
"SecServerSignature" to any desired value after installing
mod\_security.
Please refer to documentation of your web server to find help on how to
remove/change software signatures.
#### Disabling web server information exposure
It is recommended to disable all web server signatures as part of the
web server hardening process. The web server is exposing software
signature by default:
The signature can be disabled by adding two lines to the Apache (used as
an example) configuration file:
ServerSignature Off
ServerTokens Prod
PHP signature (X-Powered-By HTTP header) can be disabled by changing the
php.ini configuration file (signature is disabled by default):
expose_php = Off
Web server restart is required for configuration file changes to be
applied.
Additional security level can be achieved by using the mod\_security
(package libapache2-mod-security2) with Apache. mod\_security allows to
remove server signature instead of only removing version from server
signature. Signature can be altered to any value by changing
"SecServerSignature" to any desired value after installing
mod\_security.
Please refer to documentation of your web server to find help on how to
remove/change software signatures.
#### Discovered items disallowed as master item
Discovered items no longer can be set as the master item for dependent
items.
#### Discovered items disallowed as master item
Discovered items no longer can be set as the master item for dependent
items.
#### discoveryrule
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861)
`discoveryrule.create`, `discoveryrule.update`: changed "username" and
"password" fields to optional for HTTP agent type discovery rules and
using authentication\
#### discoveryrule
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861)
`discoveryrule.create`, `discoveryrule.update`: changed "username" and
"password" fields to optional for HTTP agent type discovery rules and
using authentication\
# discoveryrule.copy
# discoveryrule.copy
# discoveryrule.create
# discoveryrule.create
# discoveryrule.delete
# discoveryrule.delete
##### Discovery rule filtering
A filter has been added for discovery rule filtering in *Monitoring* →
*Discovery*. The filter replaces the dropdown from previous Zabbix
versions. If you start typing the name in the filter, all matching
enabled discovery rules will be listed for selection.
{width="600"}
More than one discovery rule can be selected now.
{width="600"}
##### Discovery rule filtering
A filter has been added for discovery rule filtering in *Monitoring* →
*Discovery*. The filter replaces the dropdown from previous Zabbix
versions. If you start typing the name in the filter, all matching
enabled discovery rules will be listed for selection.
{width="600"}
More than one discovery rule can be selected now.
{width="600"}
# discoveryrule.get
# discoveryrule.get
# discoveryrule.update
# discoveryrule.update
#### Displaying latest values of problem triggers
Latest values of items in trigger expressions that caused a problem can
now be seen in *Monitoring* → *Problems* and in the *Problems* and
*Problems by severity* dashboard widgets if configured.
In *Monitoring* → *Problems*, latest item values are an additional
column if the *Show latest values* checkbox is marked in the filter.
{width="600"}
In the *Problems* dashboard widget, latest item values are an additional
column if the *Show latest values* checkbox is marked in the widget
configuration.
In the *Problems by severity* dashboard widget, latest value column is
added in the problem detail popup if the *Show latest values* checkbox
is marked in the widget configuration.
#### Displaying latest values of problem triggers
Latest values of items in trigger expressions that caused a problem can
now be seen in *Monitoring* → *Problems* and in the *Problems* and
*Problems by severity* dashboard widgets if configured.
In *Monitoring* → *Problems*, latest item values are an additional
column if the *Show latest values* checkbox is marked in the filter.
{width="600"}
In the *Problems* dashboard widget, latest item values are an additional
column if the *Show latest values* checkbox is marked in the widget
configuration.
In the *Problems by severity* dashboard widget, latest value column is
added in the problem detail popup if the *Show latest values* checkbox
is marked in the widget configuration.
##### Displaying suppressed problems
Normally problems for hosts in maintenance are suppressed, i.e. not
displayed in the frontend. However, it is also possible to configure
that suppressed problems are shown, by selecting the *Show suppressed
problems* option in these locations:
- *Monitoring* → *Dashboard* (in *Problem hosts*, *Problems*,
*Problems by severity*, *Trigger overview* widget configuration)
- *Monitoring* → *Problems* (in the filter)
- *Monitoring* → *Overview* (in the filter; with 'Triggers' as *Type*)
- *Monitoring* → *Maps* (in map configuration)
- Global
[notifications](/manual/web_interface/user_profile/global_notifications)
(in user profile configuration)
When suppressed problems are displayed, the following icon is displayed:
. Rolling a
mouse over the icon displays more details:
##### Displaying suppressed problems
Normally problems for hosts in maintenance are suppressed, i.e. not
displayed in the frontend. However, it is also possible to configure
that suppressed problems are shown, by selecting the *Show suppressed
problems* option in these locations:
- *Monitoring* → *Dashboard* (in *Problem hosts*, *Problems*,
*Problems by severity*, *Trigger overview* widget configuration)
- *Monitoring* → *Problems* (in the filter)
- *Monitoring* → *Overview* (in the filter; with 'Triggers' as *Type*)
- *Monitoring* → *Maps* (in map configuration)
- Global
[notifications](/manual/web_interface/user_profile/global_notifications)
(in user profile configuration)
When suppressed problems are displayed, the following icon is displayed:
. Rolling a
mouse over the icon displays more details:
#### Displaying URL content in the sandbox
Since version 4.0.22, some Zabbix frontend elements (for example, the
[URL
widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#url))
are preconfigured to sandbox content retrieved from the URL. It is
recommended to keep all sandboxing restrictions enabled to ensure
protection against XSS attacks.
#### Displaying URL content in the sandbox
Since version 4.0.22, some Zabbix frontend elements (for example, the
[URL
widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#url))
are preconfigured to sandbox content retrieved from the URL. It is
recommended to keep all sandboxing restrictions enabled to ensure
protection against XSS attacks.
#### Display
In *Monitoring → Maps* the respective color will be displayed on the
link if the trigger goes into a problem state.
::: noteclassic
If multiple triggers go into a problem state, the problem
with the highest severity will determine the link style and color. If
multiple triggers with the same severity are assigned to the same map
link, the one with the lowest ID takes precedence. Note also that:\
\
1. *Minimimum trigger severity* and *Show suppressed problem* settings
from map configuration affect which problems are taken into account.\
2. In case with triggers with multiple problems (multiple problem
generation), each problem may have severity that differs from trigger
severity (changed manually), may have different tags (due to macros) and
may be suppressed.
:::
#### Display
In *Monitoring → Maps* the respective color will be displayed on the
link if the trigger goes into a problem state.
::: noteclassic
If multiple triggers go into a problem state, the problem
with the highest severity will determine the link style and color. If
multiple triggers with the same severity are assigned to the same map
link, the one with the lowest ID takes precedence. Note also that:\
\
1. *Minimimum trigger severity* and *Show suppressed problem* settings
from map configuration affect which problems are taken into account.\
2. In case with triggers with multiple problems (multiple problem
generation), each problem may have severity that differs from trigger
severity (changed manually), may have different tags (due to macros) and
may be suppressed.
:::
#### Display
Slide shows that are ready can be viewed in *Monitoring → Screens*, then
choosing *Slide shows* from the dropdown and clicking on the slide show
name.
With the Menu option next to the dropdown, you can accelerate or slow
down the display by choosing a slide delay multiplier:
::: noteimportant
If a delay ends up as being less than 5 seconds
(either by having entered a delay less than 5 seconds or by using the
slide delay multiplier), a 5-second minimum delay will be
used.
:::
#### Display
Slide shows that are ready can be viewed in *Monitoring → Screens*, then
choosing *Slide shows* from the dropdown and clicking on the slide show
name.
With the Menu option next to the dropdown, you can accelerate or slow
down the display by choosing a slide delay multiplier:
::: noteimportant
If a delay ends up as being less than 5 seconds
(either by having entered a delay less than 5 seconds or by using the
slide delay multiplier), a 5-second minimum delay will be
used.
:::
#### Docker appliance support dropped
Zabbix Docker Appliance image has been decommissioned and will not be
available for 4.0.20 and newer releases. Please use a separate Docker
image for each component instead of the all-in-one solution.
#### Docker appliance support dropped
Zabbix Docker Appliance image has been decommissioned and will not be
available for 4.0.20 and newer releases. Please use a separate Docker
image for each component instead of the all-in-one solution.
#### Dropping values outside history/trend periods
From now on values older than the configured history and trend storage
period will be rejected, even if the internal housekeeping is disabled.
You may want to adjust history/trend storage periods after the upgrade.
#### Dropping values outside history/trend periods
From now on values older than the configured history and trend storage
period will be rejected, even if the internal housekeeping is disabled.
You may want to adjust history/trend storage periods after the upgrade.
# drule.create
# drule.create
# drule.delete
# drule.delete
# drule.get
# drule.get
# drule.update
# drule.update
#### dservice
Bug fixes:\
[ZBX-14833](https://support.zabbix.com/browse/ZBX-14833) `dservice.get`:
fixed "selectHosts" option to return correct hosts that are monitored by
current proxy or server\
#### dservice
Bug fixes:\
[ZBX-14833](https://support.zabbix.com/browse/ZBX-14833) `dservice.get`:
fixed "selectHosts" option to return correct hosts that are monitored by
current proxy or server\
#### Dynamic elements
For some of the elements there is an extra option called *Dynamic item*.
Checking this box at first does not to seem to change anything.
However, once you go to *Monitoring → Screens*, you may realize that now
you have extra dropdowns there for selecting the host. Thus you have a
screen where some elements display the same information while others
display information depending on the currently selected host.
The benefit of this is that you do not need to create extra screens just
because you want to see the same graphs containing data from various
hosts.
*Dynamic item* option is available for several screen elements:
- Graphs (custom graphs)
- Graph prototypes
- Simple graphs
- Simple graph prototypes
- Plain text
- URL
::: noteclassic
Clicking on a dynamic graph opens it in full view; although
with custom graphs and graph prototypes that is currently supported with
the default host only (i.e. with host 'not selected' in the dropdown).
When selecting another host in the dropdown, the dynamic graph is
created using item data of that host and the resulting graph is not
clickable.
:::
::: noteclassic
Dynamic URL elements will not be displayed in *Monitoring* →
*Screens*, unless a host is selected. Without a selected host the "No
host selected" message will be visible only.
:::
#### Dynamic elements
For some of the elements there is an extra option called *Dynamic item*.
Checking this box at first does not to seem to change anything.
However, once you go to *Monitoring → Screens*, you may realize that now
you have extra dropdowns there for selecting the host. Thus you have a
screen where some elements display the same information while others
display information depending on the currently selected host.
The benefit of this is that you do not need to create extra screens just
because you want to see the same graphs containing data from various
hosts.
*Dynamic item* option is available for several screen elements:
- Graphs (custom graphs)
- Graph prototypes
- Simple graphs
- Simple graph prototypes
- Plain text
- URL
::: noteclassic
Clicking on a dynamic graph opens it in full view; although
with custom graphs and graph prototypes that is currently supported with
the default host only (i.e. with host 'not selected' in the dropdown).
When selecting another host in the dropdown, the dynamic graph is
created using item data of that host and the resulting graph is not
clickable.
:::
::: noteclassic
Dynamic URL elements will not be displayed in *Monitoring* →
*Screens*, unless a host is selected. Without a selected host the "No
host selected" message will be visible only.
:::
#### Element tags
Element tag values are explained in the table below.
#### Element tags
Element tag values are explained in the table below.
#### Enabling MIB files
On RedHat-based systems the mib files should be enabled by default. On
Debian-based systems you have to edit file `/etc/snmp/snmp.conf` and
comment out the line that says `mibs :`
# As the snmp packages come without MIB files due to license reasons, loading
# of MIBs is disabled by default. If you added the MIBs you can re-enable
# loading them by commenting out the following line.
#mibs :
#### Enabling MIB files
On RedHat-based systems the mib files should be enabled by default. On
Debian-based systems you have to edit file `/etc/snmp/snmp.conf` and
comment out the line that says `mibs :`
# As the snmp packages come without MIB files due to license reasons, loading
# of MIBs is disabled by default. If you added the MIBs you can re-enable
# loading them by commenting out the following line.
#mibs :
#### Encryption
User-configured [ciphersuites](/manual/encryption#ciphersuites) are now
supported for GnuTLS and OpenSSL.
#### Encryption
User-configured [ciphersuites](/manual/encryption#ciphersuites) are now
supported for GnuTLS and OpenSSL.
#### Enhanced URL widget security
The URL dashboard widget and the URL screen element now put retrieved
URL content into the sandbox. By default, all sandbox restrictions are
enabled. It is possible to modify `sandbox` attribute settings in the
*defines.inc.php* file, however turning sandboxing off is not
recommended for security reasons. To learn more about the sandbox
attribute, please see the
[sandbox](https://www.w3.org/TR/2010/WD-html5-20100624/the-iframe-element.html#attr-iframe-sandbox)
section of the iframe HTML element description.
#### Enhanced URL widget security
The URL dashboard widget and the URL screen element now put retrieved
URL content into the sandbox. By default, all sandbox restrictions are
enabled. It is possible to modify `sandbox` attribute settings in the
*defines.inc.php* file, however turning sandboxing off is not
recommended for security reasons. To learn more about the sandbox
attribute, please see the
[sandbox](https://www.w3.org/TR/2010/WD-html5-20100624/the-iframe-element.html#attr-iframe-sandbox)
section of the iframe HTML element description.
#### Enhanced URL widget security
The URL dashboard widget and the URL screen element now put retrieved
URL content into the sandbox. By default, all sandbox restrictions are
enabled. It is possible to modify `sandbox` attribute settings in the
*defines.inc.php* file, however turning sandboxing off is not
recommended for security reasons. To learn more about the sandbox
attribute, please see the
[sandbox](https://www.w3.org/TR/2010/WD-html5-20100624/the-iframe-element.html#attr-iframe-sandbox)
section of the iframe HTML element description.
#### Enhanced URL widget security
The URL dashboard widget and the URL screen element now put retrieved
URL content into the sandbox. By default, all sandbox restrictions are
enabled. It is possible to modify `sandbox` attribute settings in the
*defines.inc.php* file, however turning sandboxing off is not
recommended for security reasons. To learn more about the sandbox
attribute, please see the
[sandbox](https://www.w3.org/TR/2010/WD-html5-20100624/the-iframe-element.html#attr-iframe-sandbox)
section of the iframe HTML element description.
# event.acknowledge
# event.acknowledge
# event.get
# event.get
#### Event menu
Clicking on the problem name brings up the event menu:
The event menu allows to filter the problems of the trigger, access the
trigger description (if available) and the trigger configuration. Access
to simple graph/item history of the underlying item(s) is also
available.
::: noteimportant
Resolved values of {ITEM.VALUE} and
{ITEM.LASTVALUE} macros in trigger descriptions are truncated to 20
characters. To see the entire values you may use [macro
functions](/manual/config/macros/macro_functions) with these macros,
e.g. `{{ITEM.VALUE}.regsub("(.*)", \1)}`,
`{{ITEM.LASTVALUE}.regsub("(.*)", \1)}` as a workaround.
:::
#### Event menu
Clicking on the problem name brings up the event menu:
The event menu allows to filter the problems of the trigger, access the
trigger description (if available) and the trigger configuration. Access
to simple graph/item history of the underlying item(s) is also
available.
::: noteimportant
Resolved values of {ITEM.VALUE} and
{ITEM.LASTVALUE} macros in trigger descriptions are truncated to 20
characters. To see the entire values you may use [macro
functions](/manual/config/macros/macro_functions) with these macros,
e.g. `{{ITEM.VALUE}.regsub("(.*)", \1)}`,
`{{ITEM.LASTVALUE}.regsub("(.*)", \1)}` as a workaround.
:::
# Event tags
# Event tags
##### Example 3
Checking if Zabbix API is alive, using
[apiinfo.version](/manual/api/reference/apiinfo/version).
- Item configuration:
Note the use of the POST method with JSON data, setting request headers
and asking to return headers only:
- Item value preprocessing with regular expression to get HTTP code:
- Checking the result in *Latest data*:
{width="600"}
##### Example 3
Checking if Zabbix API is alive, using
[apiinfo.version](/manual/api/reference/apiinfo/version).
- Item configuration:
Note the use of the POST method with JSON data, setting request headers
and asking to return headers only:
- Item value preprocessing with regular expression to get HTTP code:
- Checking the result in *Latest data*:
{width="600"}
##### Example 4
Retrieving weather information by connecting to the Openweathermap
public service.
- Configure a master item for bulk data collection in a single JSON:
Note the usage of macros in query fields. Refer to the [Openweathermap
API](https://openweathermap.org/current) for how to fill them.
Sample JSON returned in response to HTTP agent:
``` {.json}
{
"body": {
"coord": {
"lon": 40.01,
"lat": 56.11
},
"weather": [{
"id": 801,
"main": "Clouds",
"description": "few clouds",
"icon": "02n"
}],
"base": "stations",
"main": {
"temp": 15.14,
"pressure": 1012.6,
"humidity": 66,
"temp_min": 15.14,
"temp_max": 15.14,
"sea_level": 1030.91,
"grnd_level": 1012.6
},
"wind": {
"speed": 1.86,
"deg": 246.001
},
"clouds": {
"all": 20
},
"dt": 1526509427,
"sys": {
"message": 0.0035,
"country": "RU",
"sunrise": 1526432608,
"sunset": 1526491828
},
"id": 487837,
"name": "Stavrovo",
"cod": 200
}
}
```
The next task is to configure dependent items that extract data from the
JSON.
- Configure a sample dependent item for humidity:
Other weather metrics such as 'Temperature' are added in the same
manner.
- Sample dependent item value preprocessing with JSONPath:
- Check the result of weather data in *Latest data*:
{width="600"}
##### Example 4
Retrieving weather information by connecting to the Openweathermap
public service.
- Configure a master item for bulk data collection in a single JSON:
Note the usage of macros in query fields. Refer to the [Openweathermap
API](https://openweathermap.org/current) for how to fill them.
Sample JSON returned in response to HTTP agent:
``` {.json}
{
"body": {
"coord": {
"lon": 40.01,
"lat": 56.11
},
"weather": [{
"id": 801,
"main": "Clouds",
"description": "few clouds",
"icon": "02n"
}],
"base": "stations",
"main": {
"temp": 15.14,
"pressure": 1012.6,
"humidity": 66,
"temp_min": 15.14,
"temp_max": 15.14,
"sea_level": 1030.91,
"grnd_level": 1012.6
},
"wind": {
"speed": 1.86,
"deg": 246.001
},
"clouds": {
"all": 20
},
"dt": 1526509427,
"sys": {
"message": 0.0035,
"country": "RU",
"sunrise": 1526432608,
"sunset": 1526491828
},
"id": 487837,
"name": "Stavrovo",
"cod": 200
}
}
```
The next task is to configure dependent items that extract data from the
JSON.
- Configure a sample dependent item for humidity:
Other weather metrics such as 'Temperature' are added in the same
manner.
- Sample dependent item value preprocessing with JSONPath:
- Check the result of weather data in *Latest data*:
{width="600"}
##### Example 5
Connecting to Nginx status page and getting its metrics in bulk.
- Configure Nginx following the [official
guide](https://nginx.ru/en/docs/http/ngx_http_stub_status_module.html).
```{=html}
<!-- -->
```
- Configure a master item for bulk data collection:
{width="500"}
Sample Nginx stub status output:
Active connections: 1 Active connections:
server accepts handled requests
52 52 52
Reading: 0 Writing: 1 Waiting: 0
The next task is to configure dependent items that extract data.
- Configure a sample dependent item for requests per second:
- Sample dependent item value preprocessing with regular expression:
{width="600"}
- Check the complete result from stub module in *Latest data*:
{width="600"}
##### Example 5
Connecting to Nginx status page and getting its metrics in bulk.
- Configure Nginx following the [official
guide](https://nginx.ru/en/docs/http/ngx_http_stub_status_module.html).
```{=html}
<!-- -->
```
- Configure a master item for bulk data collection:
{width="500"}
Sample Nginx stub status output:
Active connections: 1 Active connections:
server accepts handled requests
52 52 52
Reading: 0 Writing: 1 Waiting: 0
The next task is to configure dependent items that extract data.
- Configure a sample dependent item for requests per second:
- Sample dependent item value preprocessing with regular expression:
{width="600"}
- Check the complete result from stub module in *Latest data*:
{width="600"}
### Examples
### Examples
#### Examples
#### Examples
### Examples
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"sessionid": "8C8447FF6F61D134CEAC740CCA1BC90D"
},
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"alias": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "ru_RU",
"refresh": "0",
"type": "3",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "127.0.0.1",
"attempt_clock": "1355919038",
"rows_per_page": "50",
"debug_mode": true,
"userip": "127.0.0.1",
"sessionid": "8C8447FF6F61D134CEAC740CCA1BC90D",
"gui_access": "0"
},
"id": 1
}
```
::: noteclassic
Response is similar to
[User.login](/manual/api/reference/user/login) call response with
"userData" parameter set to true (the difference is that user data is
retrieved by session id and not by username / password).
:::
### Examples
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"sessionid": "8C8447FF6F61D134CEAC740CCA1BC90D"
},
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"alias": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "ru_RU",
"refresh": "0",
"type": "3",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "127.0.0.1",
"attempt_clock": "1355919038",
"rows_per_page": "50",
"debug_mode": true,
"userip": "127.0.0.1",
"sessionid": "8C8447FF6F61D134CEAC740CCA1BC90D",
"gui_access": "0"
},
"id": 1
}
```
::: noteclassic
Response is similar to
[User.login](/manual/api/reference/user/login) call response with
"userData" parameter set to true (the difference is that user data is
retrieved by session id and not by username / password).
:::
## EXAMPLES
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"**\
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-agent-cert-issuer "CN=Signing CA,OU=IT operations,O=Example
Corp,DC=example,DC=com" --tls-agent-cert-subject "CN=server1,OU=IT
operations,O=Example Corp,DC=example,DC=com" --tls-cert-file
/home/zabbix/zabbix\_get.crt --tls-key-file
/home/zabbix/zabbix\_get.key\
zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk** [ ]{#lbAH}
## EXAMPLES
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"**\
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-agent-cert-issuer "CN=Signing CA,OU=IT operations,O=Example
Corp,DC=example,DC=com" --tls-agent-cert-subject "CN=server1,OU=IT
operations,O=Example Corp,DC=example,DC=com" --tls-cert-file
/home/zabbix/zabbix\_get.crt --tls-key-file
/home/zabbix/zabbix\_get.key\
zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk** [ ]{#lbAH}
## EXAMPLES
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -k mysql.queries -o
342.45**\
Send **342.45** as the value for **mysql.queries** item of monitored
host. Use monitored host and Zabbix server defined in agent
configuration file.
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -s "Monitored Host"
-k mysql.queries -o 342.45**\
Send **342.45** as the value for **mysql.queries** item of **Monitored
Host** host using Zabbix server defined in agent configuration file.
\
**zabbix\_sender -z 192.168.1.113 -i data\_values.txt**
\
Send values from file **data\_values.txt** to Zabbix server with IP
**192.168.1.113**. Host names and keys are defined in the file.
\
**echo "- hw.serial.number 1287872261 SQ4321ASDF" | zabbix\_sender -c
/usr/local/etc/zabbix\_agentd.conf -T -i -**\
Send a timestamped value from the commandline to Zabbix server,
specified in the agent configuration file. Dash in the input data
indicates that hostname also should be used from the same configuration
file.
\
**echo '"Zabbix server" trapper.item ""' | zabbix\_sender -z
192.168.1.113 -p 10000 -i -**\
Send empty value of an item to the Zabbix server with IP address
**192.168.1.113** on port **10000** from the commandline. Empty values
must be indicated by empty double quotes.
**zabbix\_sender -z 192.168.1.113 -s "Monitored Host" -k mysql.queries
-o 342.45 --tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-cert-file /home/zabbix/zabbix\_agentd.crt --tls-key-file
/home/zabbix/zabbix\_agentd.key**\
Send **342.45** as the value for **mysql.queries** item in **Monitored
Host** host to server with IP **192.168.1.113** using TLS with
certificate.
**zabbix\_sender -z 192.168.1.113 -s "Monitored Host" -k mysql.queries
-o 342.45 --tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk**\
Send **342.45** as the value for **mysql.queries** item in **Monitored
Host** host to server with IP **192.168.1.113** using TLS with
pre-shared key (PSK).
[ ]{#lbAI}
## EXAMPLES
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -k mysql.queries -o
342.45**\
Send **342.45** as the value for **mysql.queries** item of monitored
host. Use monitored host and Zabbix server defined in agent
configuration file.
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -s "Monitored Host"
-k mysql.queries -o 342.45**\
Send **342.45** as the value for **mysql.queries** item of **Monitored
Host** host using Zabbix server defined in agent configuration file.
\
**zabbix\_sender -z 192.168.1.113 -i data\_values.txt**
\
Send values from file **data\_values.txt** to Zabbix server with IP
**192.168.1.113**. Host names and keys are defined in the file.
\
**echo "- hw.serial.number 1287872261 SQ4321ASDF" | zabbix\_sender -c
/usr/local/etc/zabbix\_agentd.conf -T -i -**\
Send a timestamped value from the commandline to Zabbix server,
specified in the agent configuration file. Dash in the input data
indicates that hostname also should be used from the same configuration
file.
\
**echo '"Zabbix server" trapper.item ""' | zabbix\_sender -z
192.168.1.113 -p 10000 -i -**\
Send empty value of an item to the Zabbix server with IP address
**192.168.1.113** on port **10000** from the commandline. Empty values
must be indicated by empty double quotes.
**zabbix\_sender -z 192.168.1.113 -s "Monitored Host" -k mysql.queries
-o 342.45 --tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-cert-file /home/zabbix/zabbix\_agentd.crt --tls-key-file
/home/zabbix/zabbix\_agentd.key**\
Send **342.45** as the value for **mysql.queries** item in **Monitored
Host** host to server with IP **192.168.1.113** using TLS with
certificate.
**zabbix\_sender -z 192.168.1.113 -s "Monitored Host" -k mysql.queries
-o 342.45 --tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk**\
Send **342.45** as the value for **mysql.queries** item in **Monitored
Host** host to server with IP **192.168.1.113** using TLS with
pre-shared key (PSK).
[ ]{#lbAI}
#### Execution of external check script
Upon completion of an [external check
script](/manual/config/items/itemtypes/external), arguments are wrapped
to single quotes **`'`** instead of double quotes **`"`**. This change
allows Zabbix to accept more signs in an external check parameter's
name. For example, the `$` sign is no longer ignored.
#### Execution of external check script
Upon completion of an [external check
script](/manual/config/items/itemtypes/external), arguments are wrapped
to single quotes **`'`** instead of double quotes **`"`**. This change
allows Zabbix to accept more signs in an external check parameter's
name. For example, the `$` sign is no longer ignored.
#### Exit code
Before version 2.2 Zabbix agent returned 0 in case of successful exit
and 255 in case of failure. Starting from version 2.2 and higher Zabbix
agent returns 0 in case of successful exit and 1 in case of failure.
#### Exit code
Before version 2.2 Zabbix agent returned 0 in case of successful exit
and 255 in case of failure. Starting from version 2.2 and higher Zabbix
agent returns 0 in case of successful exit and 1 in case of failure.
## EXIT STATUS
The exit status is 0 if the values were sent and all of them were
successfully processed by server. If data was sent, but processing of at
least one of the values failed, the exit status is 2. If data sending
failed, the exit status is 1.
[ ]{#lbAH}
## EXIT STATUS
The exit status is 0 if the values were sent and all of them were
successfully processed by server. If data was sent, but processing of at
least one of the values failed, the exit status is 2. If data sending
failed, the exit status is 1.
[ ]{#lbAH}
#### Export format
``` {.xml}
<?xml version="1.0" encoding="UTF-8"?>
<zabbix_export>
<version>4.0</version>
<date>2018-04-03T08:11:42Z</date>
<groups>
<group>
<name>Zabbix servers</name>
</group>
</groups>
<hosts>
<host>
<host>Export host</host>
<name>Export host</name>
<description/>
<proxy/>
<status>0</status>
<ipmi_authtype>-1</ipmi_authtype>
<ipmi_privilege>2</ipmi_privilege>
<ipmi_username/>
<ipmi_password/>
<tls_connect>1</tls_connect>
<tls_accept>1</tls_accept>
<tls_issuer/>
<tls_subject/>
<tls_psk_identity/>
<tls_psk/>
<templates/>
<groups>
<group>
<name>Zabbix servers</name>
</group>
</groups>
<interfaces>
<interface>
<default>1</default>
<type>1</type>
<useip>1</useip>
<ip>127.0.0.1</ip>
<dns/>
<port>10050</port>
<bulk>1</bulk>
<interface_ref>if1</interface_ref>
</interface>
</interfaces>
<applications>
<application>
<name>Application</name>
</application>
</applications>
<items>
<item>
<name>Item</name>
<type>0</type>
<snmp_community/>
<snmp_oid/>
<key>item.key</key>
<delay>30s</delay>
<history>90d</history>
<trends>365d</trends>
<status>0</status>
<value_type>3</value_type>
<allowed_hosts/>
<units/>
<snmpv3_contextname/>
<snmpv3_securityname/>
<snmpv3_securitylevel>0</snmpv3_securitylevel>
<snmpv3_authprotocol>0</snmpv3_authprotocol>
<snmpv3_authpassphrase/>
<snmpv3_privprotocol>0</snmpv3_privprotocol>
<snmpv3_privpassphrase/>
<params/>
<ipmi_sensor/>
<authtype>0</authtype>
<username/>
<password/>
<publickey/>
<privatekey/>
<port/>
<description/>
<inventory_link>0</inventory_link>
<applications>
<application>
<name>Application</name>
</application>
</applications>
<valuemap>
<name>Host status</name>
</valuemap>
<logtimefmt/>
<preprocessing/>
<interface_ref>if1</interface_ref>
<jmx_endpoint/>
<master_item/>
<timeout>3s</timeout>
<url/>
<query_fields/>
<posts/>
<status_codes>200</status_codes>
<follow_redirects>1</follow_redirects>
<post_type>0</post_type>
<http_proxy/>
<headers/>
<retrieve_mode>0</retrieve_mode>
<request_method>1</request_method>
<output_format>0</output_format>
<allow_traps>0</allow_traps>
<ssl_cert_file/>
<ssl_key_file/>
<ssl_key_password/>
<verify_peer>0</verify_peer>
<verify_host>0</verify_host>
</item>
</items>
<discovery_rules/>
<httptests/>
<macros/>
<inventory/>
</host>
</hosts>
<triggers>
<trigger>
<expression>{Export host:item.key.last()}<>0</expression>
<recovery_mode>0</recovery_mode>
<recovery_expression/>
<correlation_mode>0</correlation_mode>
<correlation_tag/>
<name>Item value not 0</name>
<url/>
<status>0</status>
<priority>2</priority>
<description/>
<type>0</type>
<manual_close>0</manual_close>
<dependencies/>
<tags/>
</trigger>
</triggers>
<graphs>
<graph>
<name>Example graph</name>
<width>900</width>
<height>200</height>
<yaxismin>0.0000</yaxismin>
<yaxismax>100.0000</yaxismax>
<show_work_period>1</show_work_period>
<show_triggers>1</show_triggers>
<type>0</type>
<show_legend>1</show_legend>
<show_3d>0</show_3d>
<percent_left>0.0000</percent_left>
<percent_right>0.0000</percent_right>
<ymin_type_1>0</ymin_type_1>
<ymax_type_1>0</ymax_type_1>
<ymin_item_1>0</ymin_item_1>
<ymax_item_1>0</ymax_item_1>
<graph_items>
<graph_item>
<sortorder>0</sortorder>
<drawtype>0</drawtype>
<color>1A7C11</color>
<yaxisside>0</yaxisside>
<calc_fnc>2</calc_fnc>
<type>0</type>
<item>
<host>Export host</host>
<key>item.key</key>
</item>
</graph_item>
</graph_items>
</graph>
</graphs>
<value_maps>
<value_map>
<name>Host status</name>
<mappings>
<mapping>
<value>0</value>
<newvalue>Up</newvalue>
</mapping>
<mapping>
<value>2</value>
<newvalue>Unreachable</newvalue>
</mapping>
</mappings>
</value_map>
</value_maps>
</zabbix_export>
```
#### Export format
``` {.xml}
<?xml version="1.0" encoding="UTF-8"?>
<zabbix_export>
<version>4.0</version>
<date>2018-04-03T08:11:42Z</date>
<groups>
<group>
<name>Zabbix servers</name>
</group>
</groups>
<hosts>
<host>
<host>Export host</host>
<name>Export host</name>
<description/>
<proxy/>
<status>0</status>
<ipmi_authtype>-1</ipmi_authtype>
<ipmi_privilege>2</ipmi_privilege>
<ipmi_username/>
<ipmi_password/>
<tls_connect>1</tls_connect>
<tls_accept>1</tls_accept>
<tls_issuer/>
<tls_subject/>
<tls_psk_identity/>
<tls_psk/>
<templates/>
<groups>
<group>
<name>Zabbix servers</name>
</group>
</groups>
<interfaces>
<interface>
<default>1</default>
<type>1</type>
<useip>1</useip>
<ip>127.0.0.1</ip>
<dns/>
<port>10050</port>
<bulk>1</bulk>
<interface_ref>if1</interface_ref>
</interface>
</interfaces>
<applications>
<application>
<name>Application</name>
</application>
</applications>
<items>
<item>
<name>Item</name>
<type>0</type>
<snmp_community/>
<snmp_oid/>
<key>item.key</key>
<delay>30s</delay>
<history>90d</history>
<trends>365d</trends>
<status>0</status>
<value_type>3</value_type>
<allowed_hosts/>
<units/>
<snmpv3_contextname/>
<snmpv3_securityname/>
<snmpv3_securitylevel>0</snmpv3_securitylevel>
<snmpv3_authprotocol>0</snmpv3_authprotocol>
<snmpv3_authpassphrase/>
<snmpv3_privprotocol>0</snmpv3_privprotocol>
<snmpv3_privpassphrase/>
<params/>
<ipmi_sensor/>
<authtype>0</authtype>
<username/>
<password/>
<publickey/>
<privatekey/>
<port/>
<description/>
<inventory_link>0</inventory_link>
<applications>
<application>
<name>Application</name>
</application>
</applications>
<valuemap>
<name>Host status</name>
</valuemap>
<logtimefmt/>
<preprocessing/>
<interface_ref>if1</interface_ref>
<jmx_endpoint/>
<master_item/>
<timeout>3s</timeout>
<url/>
<query_fields/>
<posts/>
<status_codes>200</status_codes>
<follow_redirects>1</follow_redirects>
<post_type>0</post_type>
<http_proxy/>
<headers/>
<retrieve_mode>0</retrieve_mode>
<request_method>1</request_method>
<output_format>0</output_format>
<allow_traps>0</allow_traps>
<ssl_cert_file/>
<ssl_key_file/>
<ssl_key_password/>
<verify_peer>0</verify_peer>
<verify_host>0</verify_host>
</item>
</items>
<discovery_rules/>
<httptests/>
<macros/>
<inventory/>
</host>
</hosts>
<triggers>
<trigger>
<expression>{Export host:item.key.last()}<>0</expression>
<recovery_mode>0</recovery_mode>
<recovery_expression/>
<correlation_mode>0</correlation_mode>
<correlation_tag/>
<name>Item value not 0</name>
<url/>
<status>0</status>
<priority>2</priority>
<description/>
<type>0</type>
<manual_close>0</manual_close>
<dependencies/>
<tags/>
</trigger>
</triggers>
<graphs>
<graph>
<name>Example graph</name>
<width>900</width>
<height>200</height>
<yaxismin>0.0000</yaxismin>
<yaxismax>100.0000</yaxismax>
<show_work_period>1</show_work_period>
<show_triggers>1</show_triggers>
<type>0</type>
<show_legend>1</show_legend>
<show_3d>0</show_3d>
<percent_left>0.0000</percent_left>
<percent_right>0.0000</percent_right>
<ymin_type_1>0</ymin_type_1>
<ymax_type_1>0</ymax_type_1>
<ymin_item_1>0</ymin_item_1>
<ymax_item_1>0</ymax_item_1>
<graph_items>
<graph_item>
<sortorder>0</sortorder>
<drawtype>0</drawtype>
<color>1A7C11</color>
<yaxisside>0</yaxisside>
<calc_fnc>2</calc_fnc>
<type>0</type>
<item>
<host>Export host</host>
<key>item.key</key>
</item>
</graph_item>
</graph_items>
</graph>
</graphs>
<value_maps>
<value_map>
<name>Host status</name>
<mappings>
<mapping>
<value>0</value>
<newvalue>Up</newvalue>
</mapping>
<mapping>
<value>2</value>
<newvalue>Unreachable</newvalue>
</mapping>
</mappings>
</value_map>
</value_maps>
</zabbix_export>
```
#### Exporting
To export hosts, do the following:
- Go to: *Configuration* → *Hosts*
- Mark the checkboxes of the hosts to export
- Click on *Export* below the list
Selected hosts are exported to a local XML file with default name
*zbx\_export\_hosts.xml*.
#### Exporting
To export hosts, do the following:
- Go to: *Configuration* → *Hosts*
- Mark the checkboxes of the hosts to export
- Click on *Export* below the list
Selected hosts are exported to a local XML file with default name
*zbx\_export\_hosts.xml*.
#### Exposed metrics
The stats items gather the statistics in bulk and return a JSON, which
is the basis for dependent items to get their data from. The following
[internal metrics](/manual/config/items/itemtypes/internal) are returned
by either of the two items:
- `zabbix[boottime]`
- `zabbix[hosts]`
- `zabbix[items]`
- `zabbix[items_unsupported]`
- `zabbix[preprocessing_queue]` (server only)
- `zabbix[process,<type>,<mode>,<state>]` (only process type based
statistics)
- `zabbix[rcache,<cache>,<mode>]`
- `zabbix[requiredperformance]`
- `zabbix[triggers]` (server only)
- `zabbix[uptime]`
- `zabbix[vcache,buffer,<mode>]` (server only)
- `zabbix[vcache,cache,<parameter>]`
- `zabbix[vmware,buffer,<mode>]`
- `zabbix[wcache,<cache>,<mode>]` ('trends' cache type server only)
#### Exposed metrics
The stats items gather the statistics in bulk and return a JSON, which
is the basis for dependent items to get their data from. The following
[internal metrics](/manual/config/items/itemtypes/internal) are returned
by either of the two items:
- `zabbix[boottime]`
- `zabbix[hosts]`
- `zabbix[items]`
- `zabbix[items_unsupported]`
- `zabbix[preprocessing_queue]` (server only)
- `zabbix[process,<type>,<mode>,<state>]` (only process type based
statistics)
- `zabbix[rcache,<cache>,<mode>]`
- `zabbix[requiredperformance]`
- `zabbix[triggers]` (server only)
- `zabbix[uptime]`
- `zabbix[vcache,buffer,<mode>]` (server only)
- `zabbix[vcache,cache,<parameter>]`
- `zabbix[vmware,buffer,<mode>]`
- `zabbix[wcache,<cache>,<mode>]` ('trends' cache type server only)
## FILES
*/usr/local/etc/zabbix\_agentd.conf*
Default location of Zabbix agent configuration file (if not modified
during compile time).
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_agentd.conf*
Default location of Zabbix agent configuration file (if not modified
during compile time).
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_proxy.conf*
Default location of Zabbix proxy configuration file (if not modified
during compile time).
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_proxy.conf*
Default location of Zabbix proxy configuration file (if not modified
during compile time).
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_server.conf*
Default location of Zabbix server configuration file (if not modified
during compile time).
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_server.conf*
Default location of Zabbix server configuration file (if not modified
during compile time).
[ ]{#lbAI}
#### Filter expression
Filter expression is a arithmetical expression in infix notation.
Supported operands:
|Operand|Description|Example|
|-------|-----------|-------|
|`"<text>"`<br>`'<text>'`|Text constant.|'value: \\'1\\''<br>"value: '1'"|
|`<number>`|Numeric constant supporting scientific notation.|123|
|`<jsonpath starting with $>`|Value referred to by the JSONPath from the input document root node; only definite paths are supported.|$.object.name|
|`<jsonpath starting with @>`|Value referred to by the JSONPath from the current object/element; only definite paths are supported.|@.name|
Supported operators:
|Operator|Type|Description|Result|
|--------|----|-----------|------|
|`-`|binary|Subtraction.|Number.|
|`+`|binary|Addition.|Number.|
|`/`|binary|Division.|Number.|
|`*`|binary|Multiplication.|Number.|
|`==`|binary|Is equal to.|Boolean (1 or 0).|
|`!=`|binary|Is not equal to.|Boolean (1 or 0).|
|`<`|binary|Is less than.|Boolean (1 or 0).|
|`<=`|binary|Is less than or equal to.|Boolean (1 or 0).|
|`>`|binary|Is greater than.|Boolean (1 or 0).|
|`>=`|binary|Is greater than or equal to.|Boolean (1 or 0).|
|`=~`|binary|Matches regular expression.|Boolean (1 or 0).|
|`!`|unary|Boolean not.|Boolean (1 or 0).|
|`\|\|`|binary|Boolean or.|Boolean (1 or 0).|
|`&&`|binary|Boolean and.|Boolean (1 or 0).|
#### Filter expression
Filter expression is a arithmetical expression in infix notation.
Supported operands:
|Operand|Description|Example|
|-------|-----------|-------|
|`"<text>"`<br>`'<text>'`|Text constant.|'value: \\'1\\''<br>"value: '1'"|
|`<number>`|Numeric constant supporting scientific notation.|123|
|`<jsonpath starting with $>`|Value referred to by the JSONPath from the input document root node; only definite paths are supported.|$.object.name|
|`<jsonpath starting with @>`|Value referred to by the JSONPath from the current object/element; only definite paths are supported.|@.name|
Supported operators:
|Operator|Type|Description|Result|
|--------|----|-----------|------|
|`-`|binary|Subtraction.|Number.|
|`+`|binary|Addition.|Number.|
|`/`|binary|Division.|Number.|
|`*`|binary|Multiplication.|Number.|
|`==`|binary|Is equal to.|Boolean (1 or 0).|
|`!=`|binary|Is not equal to.|Boolean (1 or 0).|
|`<`|binary|Is less than.|Boolean (1 or 0).|
|`<=`|binary|Is less than or equal to.|Boolean (1 or 0).|
|`>`|binary|Is greater than.|Boolean (1 or 0).|
|`>=`|binary|Is greater than or equal to.|Boolean (1 or 0).|
|`=~`|binary|Matches regular expression.|Boolean (1 or 0).|
|`!`|unary|Boolean not.|Boolean (1 or 0).|
|`\|\|`|binary|Boolean or.|Boolean (1 or 0).|
|`&&`|binary|Boolean and.|Boolean (1 or 0).|
#### Filtering
#### Filtering
##### Filtering by host
In the *by host* mode results can be filtered by host or by host group.
Specifying a parent host group implicitly selects all nested host
groups.
##### Filtering by host
In the *by host* mode results can be filtered by host or by host group.
Specifying a parent host group implicitly selects all nested host
groups.
##### Filtering by trigger template
In the *by trigger template* mode results can be filtered by one or
several parameters listed below.
|Parameter|Description|
|---------|-----------|
|*Template group*|Select all hosts with triggers from templates belonging to that group. Any host group that includes at least one template can be selected.|
|*Template*|Select hosts with triggers from chosen template and all nested templates. Only triggers inherited from the selected template will be displayed. If a nested template has additional own triggers, those triggers will not be displayed.|
|//Template trigger //|Select hosts with chosen trigger. Other triggers of the selected hosts will not be displayed.|
|*Host group*|Select hosts belonging to the group.|
##### Filtering by trigger template
In the *by trigger template* mode results can be filtered by one or
several parameters listed below.
|Parameter|Description|
|---------|-----------|
|*Template group*|Select all hosts with triggers from templates belonging to that group. Any host group that includes at least one template can be selected.|
|*Template*|Select hosts with triggers from chosen template and all nested templates. Only triggers inherited from the selected template will be displayed. If a nested template has additional own triggers, those triggers will not be displayed.|
|//Template trigger //|Select hosts with chosen trigger. Other triggers of the selected hosts will not be displayed.|
|*Host group*|Select hosts belonging to the group.|
#### Flipping frontend locales
It has been observed that frontend locales may flip without apparent
logic, i. e. some pages (or parts of pages) are displayed in one
language while other pages (or parts of pages) in a different language.
Typically the problem may appear when there are several users, some of
whom use one locale, while others use another.
A known workaround to this is to disable multithreading in PHP and
Apache.
The problem is related to how setting the locale works [in
PHP](https://www.php.net/manual/en/function.setlocale): locale
information is maintained per process, not per thread. So in a
multi-thread environment, when there are several projects run by same
Apache process, it is possible that the locale gets changed in another
thread and that changes how data can be processed in the Zabbix thread.
For more information, please see related problem reports:
- [ZBX-10911](https://support.zabbix.com/browse/ZBX-10911) (Problem
with flipping frontend locales)
- [ZBX-16297](https://support.zabbix.com/browse/ZBX-16297) (Problem
with number processing in graphs using the `bcdiv` function of BC
Math functions)
#### Flipping frontend locales
It has been observed that frontend locales may flip without apparent
logic, i. e. some pages (or parts of pages) are displayed in one
language while other pages (or parts of pages) in a different language.
Typically the problem may appear when there are several users, some of
whom use one locale, while others use another.
A known workaround to this is to disable multithreading in PHP and
Apache.
The problem is related to how setting the locale works [in
PHP](https://www.php.net/manual/en/function.setlocale): locale
information is maintained per process, not per thread. So in a
multi-thread environment, when there are several projects run by same
Apache process, it is possible that the locale gets changed in another
thread and that changes how data can be processed in the Zabbix thread.
For more information, please see related problem reports:
- [ZBX-10911](https://support.zabbix.com/browse/ZBX-10911) (Problem
with flipping frontend locales)
- [ZBX-16297](https://support.zabbix.com/browse/ZBX-16297) (Problem
with number processing in graphs using the `bcdiv` function of BC
Math functions)
##### Footnotes
^**1**^ If multiple macros in a field or macros mixed with text are not
supported for the location, a single macro has to fill the whole field.
##### Footnotes
^**1**^ If multiple macros in a field or macros mixed with text are not
supported for the location, a single macro has to fill the whole field.
##### Footnotes
^**1**^ In the fields marked with ^[1](lld_macros#footnotes)^ a single
macro has to fill the whole field. Multiple macros in a field or macros
mixed with text are not supported.
##### Footnotes
^**1**^ In the fields marked with ^[1](lld_macros#footnotes)^ a single
macro has to fill the whole field. Multiple macros in a field or macros
mixed with text are not supported.
##### Footnotes
^**1**^ Note that too many data gathering processes (pollers,
unreachable pollers, HTTP pollers, Java pollers, pingers, trappers,
proxypollers) together with IPMI manager, SNMP trapper and preprocessing
workers can **exhaust** the per-process file descriptor limit for the
preprocessing manager.
::: notewarning
This will cause Zabbix server to stop (usually
shortly after the start, but sometimes it can take more time). The
configuration file should be revised or the limit should be raised to
avoid this situation.
:::
^**2**^ When a lot of items are deleted it increases the load to the
database, because the housekeeper will need to remove all the history
data that these items had. For example, if we only have to remove 1 item
prototype, but this prototype is linked to 50 hosts and for every host
the prototype is expanded to 100 real items, 5000 items in total have to
be removed (1\*50\*100). If 500 is set for MaxHousekeeperDelete
(MaxHousekeeperDelete=500), the housekeeper process will have to remove
up to 2500000 values (5000\*500) for the deleted items from history and
trends tables in one cycle.
##### Footnotes
^**1**^ Note that too many data gathering processes (pollers,
unreachable pollers, HTTP pollers, Java pollers, pingers, trappers,
proxypollers) together with IPMI manager, SNMP trapper and preprocessing
workers can **exhaust** the per-process file descriptor limit for the
preprocessing manager.
::: notewarning
This will cause Zabbix server to stop (usually
shortly after the start, but sometimes it can take more time). The
configuration file should be revised or the limit should be raised to
avoid this situation.
:::
^**2**^ When a lot of items are deleted it increases the load to the
database, because the housekeeper will need to remove all the history
data that these items had. For example, if we only have to remove 1 item
prototype, but this prototype is linked to 50 hosts and for every host
the prototype is expanded to 100 real items, 5000 items in total have to
be removed (1\*50\*100). If 500 is set for MaxHousekeeperDelete
(MaxHousekeeperDelete=500), the housekeeper process will have to remove
up to 2500000 values (5000\*500) for the deleted items from history and
trends tables in one cycle.
#### Form buttons
Buttons at the bottom of the form allow to perform several operations.
| | |
|---|---|
||Add an item. This button is only available for new items.|
||Update the properties of an item.|
||Create another item based on the properties of the current item.|
||Execute a check for a new item value immediately. Supported for **passive** checks only (see [more details](/manual/config/items/check_now)).<br>*Note* that when checking for a value immediately, configuration cache is not updated, thus the value will not reflect very recent changes to item configuration.|
||Delete the item history and trends.|
||Delete the item.|
||Cancel the editing of item properties.|
#### Form buttons
Buttons at the bottom of the form allow to perform several operations.
| | |
|---|---|
||Add an item. This button is only available for new items.|
||Update the properties of an item.|
||Create another item based on the properties of the current item.|
||Execute a check for a new item value immediately. Supported for **passive** checks only (see [more details](/manual/config/items/check_now)).<br>*Note* that when checking for a value immediately, configuration cache is not updated, thus the value will not reflect very recent changes to item configuration.|
||Delete the item history and trends.|
||Delete the item.|
||Cancel the editing of item properties.|
#### Frontend
#### Frontend
#### Frontend
#### Frontend
#### Frontend changes
- Frontend no longer enforces HTTP Strict Transport Security (HSTS)
policy, introduced in 4.0.0. To protect Zabbix frontend against
protocol downgrade attacks, it is recommended to [enable HSTS
policy](/manual/installation/requirements/best_practices#enabling_http_strict_transport_security_hsts_on_web_server)
on the webserver.
#### Frontend changes
- Frontend no longer enforces HTTP Strict Transport Security (HSTS)
policy, introduced in 4.0.0. To protect Zabbix frontend against
protocol downgrade attacks, it is recommended to [enable HSTS
policy](/manual/installation/requirements/best_practices#enabling_http_strict_transport_security_hsts_on_web_server)
on the webserver.
#### Frontend changes
- Host group selection window no longer offers to select host groups
with templates only in the following locations:
- *Monitoring* → *Problems* filter
- *Monitoring* → *Dashboard* widgets:
- Problems, Problems by hosts, Problems by severity, Data
overview, Trigger overview, Web monitoring
- *Monitoring* → *Screens*:
- Host issues, Host group issues, Data overview, Trigger
overview, Host info, Trigger info
- *Reports* → *Triggers top 100* filter
#### Frontend changes
- Host group selection window no longer offers to select host groups
with templates only in the following locations:
- *Monitoring* → *Problems* filter
- *Monitoring* → *Dashboard* widgets:
- Problems, Problems by hosts, Problems by severity, Data
overview, Trigger overview, Web monitoring
- *Monitoring* → *Screens*:
- Host issues, Host group issues, Data overview, Trigger
overview, Host info, Trigger info
- *Reports* → *Triggers top 100* filter
#### Frontend changes
- The *Info* column is now also displayed in the item list for
template items. Previously it was only displayed in the host item
list.
- The [Trigger
menu](/manual/web_interface/frontend_sections/monitoring/problems#trigger_menu)
is now also accessible by clicking on the trigger information in the
event detail page:
#### Frontend changes
- The *Info* column is now also displayed in the item list for
template items. Previously it was only displayed in the host item
list.
- The [Trigger
menu](/manual/web_interface/frontend_sections/monitoring/problems#trigger_menu)
is now also accessible by clicking on the trigger information in the
event detail page:
#### Frontend
If Zabbix web interface is opened in one of the languages available on
the Zabbix website, clicking the Support link will open the Support page
in the appropriate language. For all other languages, including English,
the Support page will be opened in English.
#### Frontend
If Zabbix web interface is opened in one of the languages available on
the Zabbix website, clicking the Support link will open the Support page
in the appropriate language. For all other languages, including English,
the Support page will be opened in English.
#### Frontend improvements
- Cookie names and values are now properly URI-encoded.
- HTTP agent items are now also listed in *Administration* → *Queue*.
- Radio buttons now immediately display the correct color when in
focus and clicked on.
Previously they would first turn dark blue, before displaying the
correct color when out of focus.
#### Frontend improvements
- Cookie names and values are now properly URI-encoded.
- HTTP agent items are now also listed in *Administration* → *Queue*.
- Radio buttons now immediately display the correct color when in
focus and clicked on.
Previously they would first turn dark blue, before displaying the
correct color when out of focus.
#### Frontend improvements
- If the *[Check now](/manual/config/items/check_now)* request is
performed from the item list for items that do not support it
(template items, active agent items, etc.), a corresponding error
message is now displayed. Previously it would display a 'Request
sent successfully' message even though the functionality would not
work for these items.
#### Frontend improvements
- If the *[Check now](/manual/config/items/check_now)* request is
performed from the item list for items that do not support it
(template items, active agent items, etc.), a corresponding error
message is now displayed. Previously it would display a 'Request
sent successfully' message even though the functionality would not
work for these items.
#### Frontend
- In this version only, *write* permissions to the `assets` directory
are required for the web server user. (See also [known
issues](/manual/installation/known_issues#known_issues_in_408).)
- The `styles` folder has been moved to the `assets` directory, which
is important if creating a [custom
theme](/manual/web_interface/theming).
- Media types in the *Action log* dashboard
[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#action_log)/screen
[element](/manual/config/visualization/screens/elements#action_log)
are now sorted by media type ID instead of media type name.
#### Frontend
- In this version only, *write* permissions to the `assets` directory
are required for the web server user. (See also [known
issues](/manual/installation/known_issues#known_issues_in_408).)
- The `styles` folder has been moved to the `assets` directory, which
is important if creating a [custom
theme](/manual/web_interface/theming).
- Media types in the *Action log* dashboard
[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#action_log)/screen
[element](/manual/config/visualization/screens/elements#action_log)
are now sorted by media type ID instead of media type name.
#### Full JSONPath functionality supported
Full support of [JSONPath
functionality](/manual/appendix/items/jsonpath) has been added in item
value preprocessing.
#### Full JSONPath functionality supported
Full support of [JSONPath
functionality](/manual/appendix/items/jsonpath) has been added in item
value preprocessing.
#### Fullscreen/kiosk mode
Fullscreen and kiosk modes in supported frontend pages can be activated
using URL parameters. For example, in dashboards:
- `/zabbix.php?action=dashboard.view&fullscreen=1` - activate
fullscreen mode
- `/zabbix.php?action=dashboard.view&kiosk=1` - activate kiosk mode
- `/zabbix.php?action=dashboard.view&fullscreen=0` - activate normal
mode
#### Fullscreen/kiosk mode
Fullscreen and kiosk modes in supported frontend pages can be activated
using URL parameters. For example, in dashboards:
- `/zabbix.php?action=dashboard.view&fullscreen=1` - activate
fullscreen mode
- `/zabbix.php?action=dashboard.view&kiosk=1` - activate kiosk mode
- `/zabbix.php?action=dashboard.view&fullscreen=0` - activate normal
mode
#### Functions
Functions can be used at the end of JSONPath. Multiple functions can be
chained if the preceding function returns value that is accepted by the
following function.
Supported functions:
|Function|Description|Input|Output|
|--------|-----------|-----|------|
|`avg`|Average value of numbers in input array.|Array of numbers.|Number.|
|`min`|Minimum value of numbers in input array.|Array of numbers.|Number.|
|`max`|Maximum value of numbers in input array.|Array of numbers.|Number.|
|`sum`|Sum of numbers in input array.|Array of numbers.|Number.|
|`length`|Number of elements in input array.|Array.|Number.|
|`first`|The first array element.|Array.|A JSON construct (object, array, value) depending on input array contents.|
Quoted numeric values are accepted by the JSONPath aggregate functions
since Zabbix 4.0.14. It means that the values are converted from string
type to numeric if aggregation is required.
Incompatible input will cause the function to generate error.
#### Functions
Functions can be used at the end of JSONPath. Multiple functions can be
chained if the preceding function returns value that is accepted by the
following function.
Supported functions:
|Function|Description|Input|Output|
|--------|-----------|-----|------|
|`avg`|Average value of numbers in input array.|Array of numbers.|Number.|
|`min`|Minimum value of numbers in input array.|Array of numbers.|Number.|
|`max`|Maximum value of numbers in input array.|Array of numbers.|Number.|
|`sum`|Sum of numbers in input array.|Array of numbers.|Number.|
|`length`|Number of elements in input array.|Array.|Number.|
|`first`|The first array element.|Array.|A JSON construct (object, array, value) depending on input array contents.|
Quoted numeric values are accepted by the JSONPath aggregate functions
since Zabbix 4.0.14. It means that the values are converted from string
type to numeric if aggregation is required.
Incompatible input will cause the function to generate error.
##### Generating from history/trends
Graphs can be drawn based on either item [history or
trends](/manual/config/items/history_and_trends).
For the users who have frontend [debug
mode](/manual/web_interface/debug_mode) activated, a gray, vertical
caption is displayed at the bottom right of a graph indicating where the
data come from.
Several factors influence whether history of trends is used:
- longevity of item history. For example, item history can be kept for
14 days. In that case, any data older than the fourteen days will be
coming from trends.
```{=html}
<!-- -->
```
- data congestion in the graph. If the amount of seconds to display in
a horizontal graph pixel exceeds 3600/16, trend data are displayed
(even if item history is still available for the same period).
```{=html}
<!-- -->
```
- if trends are disabled, item history is used for graph building - if
available for that period. This is supported starting with Zabbix
2.2.1 (before, disabled trends would mean an empty graph for the
period even if item history was available).
##### Generating from history/trends
Graphs can be drawn based on either item [history or
trends](/manual/config/items/history_and_trends).
For the users who have frontend [debug
mode](/manual/web_interface/debug_mode) activated, a gray, vertical
caption is displayed at the bottom right of a graph indicating where the
data come from.
Several factors influence whether history of trends is used:
- longevity of item history. For example, item history can be kept for
14 days. In that case, any data older than the fourteen days will be
coming from trends.
```{=html}
<!-- -->
```
- data congestion in the graph. If the amount of seconds to display in
a horizontal graph pixel exceeds 3600/16, trend data are displayed
(even if item history is still available for the same period).
```{=html}
<!-- -->
```
- if trends are disabled, item history is used for graph building - if
available for that period. This is supported starting with Zabbix
2.2.1 (before, disabled trends would mean an empty graph for the
period even if item history was available).
#### Getting Zabbix source code
There are several ways of getting Zabbix source code:
- You can
[download](https://www.zabbix.com/download_sources#tab:40LTS) the
released stable versions from the official Zabbix website
- You can [download](https://www.zabbix.com/developers) nightly builds
from the official Zabbix website developer page
- You can get the latest development version from the Git source code
repository system:
- The primary location of the full repository is at
<https://git.zabbix.com/scm/zbx/zabbix.git>
- Master and supported releases are also mirrored to Github at
<https://github.com/zabbix/zabbix>
A Git client must be installed to clone the repository. The official
commandline Git client package is commonly called **git** in
distributions. To install, for example, on Debian/Ubuntu, run:
sudo apt-get update
sudo apt-get install git
To grab all Zabbix source, change to the directory you want to place the
code in and execute:
git clone https://git.zabbix.com/scm/zbx/zabbix.git
#### Getting Zabbix source code
There are several ways of getting Zabbix source code:
- You can
[download](https://www.zabbix.com/download_sources#tab:40LTS) the
released stable versions from the official Zabbix website
- You can [download](https://www.zabbix.com/developers) nightly builds
from the official Zabbix website developer page
- You can get the latest development version from the Git source code
repository system:
- The primary location of the full repository is at
<https://git.zabbix.com/scm/zbx/zabbix.git>
- Master and supported releases are also mirrored to Github at
<https://github.com/zabbix/zabbix>
A Git client must be installed to clone the repository. The official
commandline Git client package is commonly called **git** in
distributions. To install, for example, on Debian/Ubuntu, run:
sudo apt-get update
sudo apt-get install git
To grab all Zabbix source, change to the directory you want to place the
code in and execute:
git clone https://git.zabbix.com/scm/zbx/zabbix.git
#### Global notifications
Default audio clips are now in MP3 (it used to be wave files). An
embedded media player is not used any more (it was used for Internet
Explorer only), so now, in case of custom audio files, you must be sure
that your browser can play them (or just use the MP3 format).
#### Global notifications
Default audio clips are now in MP3 (it used to be wave files). An
embedded media player is not used any more (it was used for Internet
Explorer only), so now, in case of custom audio files, you must be sure
that your browser can play them (or just use the MP3 format).
#### Global notifications
Several improvements have been made to [global
notification](/manual/web_interface/user_profile/global_notifications)
messages and sounds:
- Notifications are synchronized across tabs and windows. Any changes
to the list of notifications are immediately rendered into other
tabs.
- Notification timeout is calculated since the first rendering time of
the notification.
- The *Display OK triggers for*
[setting](/manual/web_interface/frontend_sections/administration/general#trigger_displaying_options)
is now applied to recovery type notifications. That becomes relevant
if it is shorter than the regular problem notification message
timeout thus the notification disappears sooner.
- Default audio clips are now in MP3 (it used to be wave files). An
embedded media player is not used any more (it was used for Internet
Explorer only), so now, in case of custom audio files, you must be
sure that your browser can play them (or just use the MP3 format).
- The sound tends to follow the focused tab/window, except when *Play
sound* is set to 'Once'.
- When *Play sound* is set to 'Once' it will not replay the sound on
page reload.
- In case of several notifications, the sound of the most severe or
the most recent notification is played.
- There is now an icon next to each snoozed notification.
- It is possible to snooze a whole list of notifications of *High*
severity and be assured to receive an alarm when an *Average*
severity notification arrives, meanwhile keeping the notification
list with all event links open.
- If you snooze a notification in problem state, it will not play
audio when the particular problem becomes resolved.
- Regardless of how many tabs are opened the server is polled by only
one of them, reducing server load. Additionally the server response
traffic is minimized, by not containing the message body and title
in response, if the client receives the same notification ID.
- Recovery of a crashed tab is implemented. Any tab that is still able
to execute JavaStript will detect a crashed tab and would continue
to be the one who polls server. In case of a slow connection and
heavy page load during the request, any other tab would continue to
poll for notifications. Thus with a notification timeout (30
seconds) and a performed request (40 seconds) one can be assured
that no notifications will miss the eye if there is another tab..
- Slide animations are improved. Fade out will happen when all
remaining notifications reach the message timeout at once, else the
consecutive slide-up transition is applied.
- Updated user settings, such as the timeout and audiofile, are
applied to the list of notifications dynamically.
#### Global notifications
Several improvements have been made to [global
notification](/manual/web_interface/user_profile/global_notifications)
messages and sounds:
- Notifications are synchronized across tabs and windows. Any changes
to the list of notifications are immediately rendered into other
tabs.
- Notification timeout is calculated since the first rendering time of
the notification.
- The *Display OK triggers for*
[setting](/manual/web_interface/frontend_sections/administration/general#trigger_displaying_options)
is now applied to recovery type notifications. That becomes relevant
if it is shorter than the regular problem notification message
timeout thus the notification disappears sooner.
- Default audio clips are now in MP3 (it used to be wave files). An
embedded media player is not used any more (it was used for Internet
Explorer only), so now, in case of custom audio files, you must be
sure that your browser can play them (or just use the MP3 format).
- The sound tends to follow the focused tab/window, except when *Play
sound* is set to 'Once'.
- When *Play sound* is set to 'Once' it will not replay the sound on
page reload.
- In case of several notifications, the sound of the most severe or
the most recent notification is played.
- There is now an icon next to each snoozed notification.
- It is possible to snooze a whole list of notifications of *High*
severity and be assured to receive an alarm when an *Average*
severity notification arrives, meanwhile keeping the notification
list with all event links open.
- If you snooze a notification in problem state, it will not play
audio when the particular problem becomes resolved.
- Regardless of how many tabs are opened the server is polled by only
one of them, reducing server load. Additionally the server response
traffic is minimized, by not containing the message body and title
in response, if the client receives the same notification ID.
- Recovery of a crashed tab is implemented. Any tab that is still able
to execute JavaStript will detect a crashed tab and would continue
to be the one who polls server. In case of a slow connection and
heavy page load during the request, any other tab would continue to
poll for notifications. Thus with a notification timeout (30
seconds) and a performed request (40 seconds) one can be assured
that no notifications will miss the eye if there is another tab..
- Slide animations are improved. Fade out will happen when all
remaining notifications reach the message timeout at once, else the
consecutive slide-up transition is applied.
- Updated user settings, such as the timeout and audiofile, are
applied to the list of notifications dynamically.
##### Global search
The [global search](/manual/web_interface/global_search) field in the
top-right corner has been improved. Starting to type in it will show all
hosts with matching strings in any part of the name, not only in the
beginning of the name as before.
The global search field can now also match the technical name to the
visible name of the host. In this case the matching visible name is
listed as an option, but not highlighted:
##### Global search
The [global search](/manual/web_interface/global_search) field in the
top-right corner has been improved. Starting to type in it will show all
hosts with matching strings in any part of the name, not only in the
beginning of the name as before.
The global search field can now also match the technical name to the
visible name of the host. In this case the matching visible name is
listed as an option, but not highlighted:
#### graph
Bug fixes:\
[ZBX-19388](https://support.zabbix.com/browse/ZBX-19388) `graph.update`:
fixed method to properly change values on template graph instead of
making a new inherited graph if case user has no permissions to child
host or template\
#### graph
Bug fixes:\
[ZBX-19388](https://support.zabbix.com/browse/ZBX-19388) `graph.update`:
fixed method to properly change values on template graph instead of
making a new inherited graph if case user has no permissions to child
host or template\
# graph.create
# graph.create
# graph.delete
# graph.delete
# graph.get
# graph.get
# graphitem.get
# graphitem.get
##### Graph preview
In the *Preview* tab, a preview of the graph is displayed so you can
immediately see what you are creating.
{width="600"}
Note that the preview will not show any data for template items.
{width="600"}
In this example, pay attention to the dashed bold line displaying the
trigger level and the trigger information displayed in the legend.
::: noteclassic
No more than 3 trigger lines can be displayed. If there are
more triggers then the triggers with lower severity are prioritized for
display.\
\
If graph height is set as less than 120 pixels, no trigger will be
displayed in the legend.
:::
##### Graph preview
In the *Preview* tab, a preview of the graph is displayed so you can
immediately see what you are creating.
{width="600"}
Note that the preview will not show any data for template items.
{width="600"}
In this example, pay attention to the dashed bold line displaying the
trigger level and the trigger information displayed in the legend.
::: noteclassic
No more than 3 trigger lines can be displayed. If there are
more triggers then the triggers with lower severity are prioritized for
display.\
\
If graph height is set as less than 120 pixels, no trigger will be
displayed in the legend.
:::
#### graphprototype
Bug fixes:\
[ZBX-19388](https://support.zabbix.com/browse/ZBX-19388)
`graphprototype.update`: fixed method to properly change values on
template graph prototype instead of making a new inherited graph
prototype if case user has no permissions to child host or template\
#### graphprototype
Bug fixes:\
[ZBX-19388](https://support.zabbix.com/browse/ZBX-19388)
`graphprototype.update`: fixed method to properly change values on
template graph prototype instead of making a new inherited graph
prototype if case user has no permissions to child host or template\
# graphprototype.create
# graphprototype.create
# graphprototype.delete
# graphprototype.delete
# graphprototype.get
# graphprototype.get
# graphprototype.update
# graphprototype.update
#### Graphs
Changes to Daylight Saving Time (DST) result in irregularities when
displaying X axis labels (date duplication, date missing, etc).
#### Graphs
Changes to Daylight Saving Time (DST) result in irregularities when
displaying X axis labels (date duplication, date missing, etc).
#### Graphs
Previously, two data points were needed for a line/staircase graph to
draw a line in an SVG
[graph](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#graph).
Now, if there's only one data point it is drawn as point regardless of
draw type. The point size is calculated from line width, but it cannot
be smaller than 3 pixels, even if line width is less.
#### Graphs
Previously, two data points were needed for a line/staircase graph to
draw a line in an SVG
[graph](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#graph).
Now, if there's only one data point it is drawn as point regardless of
draw type. The point size is calculated from line width, but it cannot
be smaller than 3 pixels, even if line width is less.
# graph.update
# graph.update
#### Guest user disabled
The "guest" user is now disabled by default in new installations.
#### Guest user disabled
The "guest" user is now disabled by default in new installations.
#### Guest user info
In previous versions, when logged in as guest, there was no way to tell
what user you were logged in as, because the profile icon was hidden for
the guest user. In the new version a slightly different version of the
profile icon is displayed when you are logged in as guest -
. This icon is
not clickable and does not lead to the user profile. When the mouse is
positioned over it, info is displayed with the name 'guest' to suggest
the currently logged in user.
#### Guest user info
In previous versions, when logged in as guest, there was no way to tell
what user you were logged in as, because the profile icon was hidden for
the guest user. In the new version a slightly different version of the
profile icon is displayed when you are logged in as guest -
. This icon is
not clickable and does not lead to the user profile. When the mouse is
positioned over it, info is displayed with the name 'guest' to suggest
the currently logged in user.
#### Host column always displayed
The host column is now always displayed even if only one host is
selected in:
- *Monitoring* → *Latest data*
- *Monitoring* → *Web*
- *Reports* → *Availability*
The benefits of this change are:
- The [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu)
in the latest data page is now always available with links to useful
options
- It is clear which host is displayed when using a screenreader
#### Host column always displayed
The host column is now always displayed even if only one host is
selected in:
- *Monitoring* → *Latest data*
- *Monitoring* → *Web*
- *Reports* → *Availability*
The benefits of this change are:
- The [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu)
in the latest data page is now always available with links to useful
options
- It is clear which host is displayed when using a screenreader
#### Host column always displayed
The host column is now always displayed even if only one host is
selected in:
- *Monitoring* → *Latest data*
- *Monitoring* → *Web*
- *Reports* → *Availability*
This results in a wider page than previously with one host data. For
more information, see the [What's
new](/manual/introduction/whatsnew400#host_column_always_displayed)
section.
#### Host column always displayed
The host column is now always displayed even if only one host is
selected in:
- *Monitoring* → *Latest data*
- *Monitoring* → *Web*
- *Reports* → *Availability*
This results in a wider page than previously with one host data. For
more information, see the [What's
new](/manual/introduction/whatsnew400#host_column_always_displayed)
section.
##### Host filtering based on linked templates
Hosts can now be filtered based on the template that they are linked to.
Multiple templates can be specified.
This functionality may be useful to filter hosts and then mass update
their properties (including the template linkage).
##### Host filtering based on linked templates
Hosts can now be filtered based on the template that they are linked to.
Multiple templates can be specified.
This functionality may be useful to filter hosts and then mass update
their properties (including the template linkage).
##### Host graph tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|graphs|<|<|<|Root element for graphs.|
|graph|<|<|<|Individual graph.|
|<|name|`string`|<|Graph name.|
|<|width|`integer`|<|Graph width, in pixels. Used for preview and for pie/exploded graphs.|
|<|height|`integer`|<|Graph height, in pixels. Used for preview and for pie/exploded graphs.|
|<|yaxismin|`double`|<|Value of Y axis minimum if 'ymin\_type\_1' is 1.|
|<|yaxismax|`double`|<|Value of Y axis maximum if 'ymax\_type\_1' is 1.|
|<|show\_work\_period|`integer`|0 - no<br>1 - yes|Highlight non-working hours if 'type' is 0,1.|
|<|show\_triggers|`integer`|0 - no<br>1 - yes|Display simple trigger values as a line if 'type' is 0,1.|
|<|type|`integer`|0 - normal<br>1 - stacked<br>2 - pie<br>3 - exploded<br>4 - 3D pie<br>5 - 3D exploded|Graph type.|
|<|show\_legend|`integer`|0 - no<br>1 - yes|Display graph legend.|
|<|show\_3d|`integer`|0 - 2D<br>1 - 3D|Enable 3D style if 'type' is 2,3.|
|<|percent\_left|`double`|<|Show the percentile line for left axis if 'type' is 0.|
|<|percent\_right|`double`|<|Show the percentile line for right axis if 'type' is 0.|
|<|ymin\_type\_1|`integer`|0 - calculated<br>1 - fixed<br>2 - last value of the selected item|Minimum value of Y axis if 'type' is 0,1.|
|<|ymax\_type\_1|`integer`|0 - calculated<br>1 - fixed<br>2 - last value of the selected item|Maximum value of Y axis if 'type' is 0,1.|
|<|ymin\_item\_1|`string`|null or item details|Item details if 'ymin\_type\_1' is 2.|
|<|ymax\_item\_1|`string`|null or item details|Item details if 'ymax\_type\_1' is 2.|
|graph\_items|<|<|<|Root element for graph items.|
|graph\_item|<|<|<|Individual graph item.|
|<|sortorder|`integer`|<|Draw order. The smaller value is drawn first. Can be used to draw lines or regions behind (or in front of) another.|
|<|drawtype|`integer`|0 - single line<br>1 - filled region<br>2 - bold line<br>3 - dotted line<br>4 - dashed line|Draw style if graph 'type' is 0.|
|<|color|`string`|<|Element color (6 symbols, hex).|
|<|yaxisside|`integer`|0 - left axis<br>1 - right axis|Y axis position (left or right) the element belongs to if graph 'type' is 0,1.|
|<|calc\_fnc|`integer`|1 - minimum<br>2 - average<br>4 - maximum<br>7 - all (minimum, average and maximum, if graph 'type' is 0)<br>9 - last (if graph 'type' is not 0,1)|Data to draw if more than one value exists for an item.|
|<|type|`integer`|1 - value of the item is represented proportionally on the pie<br>2 - value of the item represents the whole pie (graph sum)|Draw type for pie/exploded graphs.|
|item|<|<|<|Individual item.|
|<|host|`string`|<|Item host.|
|<|key|`string`|<|Item key.|
##### Host graph tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|graphs|<|<|<|Root element for graphs.|
|graph|<|<|<|Individual graph.|
|<|name|`string`|<|Graph name.|
|<|width|`integer`|<|Graph width, in pixels. Used for preview and for pie/exploded graphs.|
|<|height|`integer`|<|Graph height, in pixels. Used for preview and for pie/exploded graphs.|
|<|yaxismin|`double`|<|Value of Y axis minimum if 'ymin\_type\_1' is 1.|
|<|yaxismax|`double`|<|Value of Y axis maximum if 'ymax\_type\_1' is 1.|
|<|show\_work\_period|`integer`|0 - no<br>1 - yes|Highlight non-working hours if 'type' is 0,1.|
|<|show\_triggers|`integer`|0 - no<br>1 - yes|Display simple trigger values as a line if 'type' is 0,1.|
|<|type|`integer`|0 - normal<br>1 - stacked<br>2 - pie<br>3 - exploded<br>4 - 3D pie<br>5 - 3D exploded|Graph type.|
|<|show\_legend|`integer`|0 - no<br>1 - yes|Display graph legend.|
|<|show\_3d|`integer`|0 - 2D<br>1 - 3D|Enable 3D style if 'type' is 2,3.|
|<|percent\_left|`double`|<|Show the percentile line for left axis if 'type' is 0.|
|<|percent\_right|`double`|<|Show the percentile line for right axis if 'type' is 0.|
|<|ymin\_type\_1|`integer`|0 - calculated<br>1 - fixed<br>2 - last value of the selected item|Minimum value of Y axis if 'type' is 0,1.|
|<|ymax\_type\_1|`integer`|0 - calculated<br>1 - fixed<br>2 - last value of the selected item|Maximum value of Y axis if 'type' is 0,1.|
|<|ymin\_item\_1|`string`|null or item details|Item details if 'ymin\_type\_1' is 2.|
|<|ymax\_item\_1|`string`|null or item details|Item details if 'ymax\_type\_1' is 2.|
|graph\_items|<|<|<|Root element for graph items.|
|graph\_item|<|<|<|Individual graph item.|
|<|sortorder|`integer`|<|Draw order. The smaller value is drawn first. Can be used to draw lines or regions behind (or in front of) another.|
|<|drawtype|`integer`|0 - single line<br>1 - filled region<br>2 - bold line<br>3 - dotted line<br>4 - dashed line|Draw style if graph 'type' is 0.|
|<|color|`string`|<|Element color (6 symbols, hex).|
|<|yaxisside|`integer`|0 - left axis<br>1 - right axis|Y axis position (left or right) the element belongs to if graph 'type' is 0,1.|
|<|calc\_fnc|`integer`|1 - minimum<br>2 - average<br>4 - maximum<br>7 - all (minimum, average and maximum, if graph 'type' is 0)<br>9 - last (if graph 'type' is not 0,1)|Data to draw if more than one value exists for an item.|
|<|type|`integer`|1 - value of the item is represented proportionally on the pie<br>2 - value of the item represents the whole pie (graph sum)|Draw type for pie/exploded graphs.|
|item|<|<|<|Individual item.|
|<|host|`string`|<|Item host.|
|<|key|`string`|<|Item key.|
#### Host information in VMware event log
The information returned by the `vmware.eventlog[<url>,<mode>]` item now
contains information about the source host, if such information is
detected in the log.
#### Host information in VMware event log
The information returned by the `vmware.eventlog[<url>,<mode>]` item now
contains information about the source host, if such information is
detected in the log.
##### Host item tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|items|<|<|<|Root element for items.|
|item|<|<|<|Individual item.|
|<|name|`string`|<|Item name.|
|<|type|`integer`|0 - Zabbix agent<br>1 - SNMPv1 agent<br>2 - Zabbix trapper<br>3 - simple check<br>4 - SNMPv2 agent<br>5 - internal<br>6 - SNMPv3 agent<br>7 - Zabbix agent (active)<br>8 - aggregate<br>9 - HTTP test (web monitoring scenario step)<br>10 - external<br>11 - database monitor<br>12 - IPMI agent<br>13 - SSH agent<br>14 - Telnet agent<br>15 - calculated<br>16 - JMX agent<br>17 - SNMP trap<br>18 - Dependent item<br>19 - HTTP agent item|Item type.|
|<|snmp\_community|`string`|<|SNMP community name if 'type' is 1,4.|
|<|snmp\_oid|`string`|<|SNMP object ID.|
|<|key|`string`|<|Item key.|
|<|delay|`string`|<|Update interval of the item. Seconds, time unit with suffix, custom intervals or user macros.<br><br>Note that `delay` will be always '0' for trapper items.|
|<|history|`string`|<|A time unit of how long the history data should be stored. Time unit with suffix or user macro.|
|<|trends|`string`|<|A time unit of how long the trends data should be stored. Time unit with suffix or user macro.|
|<|status|`integer`|0 - enabled<br>1 - disabled|Item status.|
|<|value\_type|`integer`|0 - float<br>1 - character<br>2 - log<br>3 - unsigned integer<br>4 - text|Received value type.|
|<|allowed\_hosts|`string`|<|List of IP addresses (comma delimited) of hosts allowed sending data for the item if 'type' is 2 or 19.|
|<|units|`string`|<|Units of returned values (bps, B).|
|<|snmpv3\_contextname|`string`|<|SNMPv3 context name.|
|<|snmpv3\_securityname|`string`|<|SNMPv3 security name.|
|<|snmpv3\_securitylevel|`integer`|0 - noAuthNoPriv<br>1 - authNoPriv<br>2 - authPriv|SNMPv3 security level.|
|<|snmpv3\_authprotocol|`integer`|0 - MD5<br>1 - SHA|SNMPv3 authentication protocol.|
|<|snmpv3\_authpassphrase|`string`|<|SNMPv3 authentication passphrase.|
|<|snmpv3\_privprotocol|`integer`|0 - DES<br>1 - AES|SNMPv3 privacy protocol.|
|<|snmpv3\_privpassphrase|`string`|<|SNMPv3 privacy passphrase.|
|<|params|`text`|<|Name of the "Executed script" if 'type' is 13,14<br>"SQL query" field if 'type' is 11<br>"Formula" field if 'type' is 15.|
|<|ipmi\_sensor|`string`|<|IPMI sensor ID if 'type' is 12.|
|<|authtype|`integer`|Authentication type for SSH agent items:<br>0 - password<br>1 - key<br><br>Authentication type for HTTP agent items:<br>0 - none<br>1 - basic<br>2 - NTLM|Authentication type if 'type' is 13 or 19.|
|<|username|`string`|<|User name if 'type' is 11,13,14,19.|
|<|password|`string`|<|Password if 'type' is 11,13,14,19.|
|<|publickey|`string`|<|Name of the public key file if 'type' is 13.|
|<|privatekey|`string`|<|Name of the private key file if 'type' is 13.|
|<|port|`string`|<|Custom port for the item.|
|<|description|`text`|<|Item description.|
|<|inventory\_link|`integer`|0 - no link<br>*number* - number of field in the 'host\_inventory' table|Use item value to populate this inventory field.|
|<|logtimefmt|`string`|<|Format of the time in log entries. Used only by log items.|
|<|interface\_ref|`string`|<|Reference to host interface.|
|<|jmx\_endpoint|`string`|<|JMX endpoint if 'type' is 16.|
|<|url|`string`|<|URL string if 'type' is 19.|
|<|allow\_traps|`integer`|0 - Do not allow trapping.<br>1 - Allow trapping.|Property to allow to send data to item if 'type' is 19.|
|<|follow\_redirects|`integer`|0 - Do not follow redirects.<br>1 - Follow redirects.|Follow HTTP redirects if 'type' is 19.|
|<|headers|`object`|<|Object with HTTP(S) request headers if 'type' is 19.|
|<|http\_proxy|`string`|<|HTTP(S) proxy connection string if 'type' is 19.|
|<|output\_format|`integer`|0 - Store as is.<br>1 - Convert to JSON.|How to process response if 'type' is 19.|
|<|post\_type|`integer`|0 - Raw data.<br>2 - JSON data.<br>3 - XML data.|Type of request body if 'type' is 19.|
|<|posts|`text`|<|Request body if 'type' is 19.|
|<|query\_fields|`array`|<|Array of objects for request query fields if 'type' is 19.|
|<|request\_method|`integer`|0 - GET<br>1 - POST<br>2 - PUT<br>3 - HEAD|Request method if 'type' is 19.|
|<|retrieve\_mode|`integer`|0 - Body.<br>1 - Headers.<br>2 - Both body and headers will be stored.|What part of response should be stored if 'type' is 19.|
|<|ssl\_cert\_file|`string`|<|Public SSL Key file path if 'type' is 19.|
|<|ssl\_key\_file|`string`|<|Private SSL Key file path if 'type' is 19.|
|<|ssl\_key\_password|`string`|<|Password for SSL Key file if 'type' is 19.|
|<|status\_codes|`string`|<|Ranges of required HTTP status codes separated by commas if 'type' is 19.|
|<|timeout|`string`|<|Item data polling request timeout if 'type' is 19.|
|<|verify\_host|`integer`|0 - Do not validate.<br>1 - Validate.|Validate host name in URL is in Common Name field or a Subject Alternate Name field of host certificate if 'type' is 19.|
|<|verify\_peer|`integer`|0 - Do not validate.<br>1 - Validate.|Validate is host certificate authentic if 'type' is 19.|
|value map|<|<|<|Value map.|
|<|name|`string`|<|Name of the value map to use for the item.|
|applications|<|<|<|Root element for applications.|
|application|<|<|<|Individual application.|
|<|name|<|<|Application name.|
|preprocessing|<|<|<|Item value preprocessing.|
|step|<|<|<|Individual item value preprocessing step.|
|<|type|`integer`|1 - custom multiplier<br>2 - right trim<br>3 - left trim<br>4 - trim from both sides<br>5 - regular expression matching<br>6 - boolean to decimal<br>7 - octal to decimal<br>8 - hexadecimal to decimal<br>9 - simple change; calculated as (received value-previous value)<br>10 - change per second; calculated as (received value-previous value)/(time now-time of last check)<br>11 - XML Path<br>12 - JSONPath|Type of the item value preprocessing step.|
|<|params|`string`|<|Parameters of the item value preprocessing step.|
|master\_item|<|<|<|Individual item master item data.|
|<|key|`string`|<|Dependent item master item key value.|
##### Host item tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|items|<|<|<|Root element for items.|
|item|<|<|<|Individual item.|
|<|name|`string`|<|Item name.|
|<|type|`integer`|0 - Zabbix agent<br>1 - SNMPv1 agent<br>2 - Zabbix trapper<br>3 - simple check<br>4 - SNMPv2 agent<br>5 - internal<br>6 - SNMPv3 agent<br>7 - Zabbix agent (active)<br>8 - aggregate<br>9 - HTTP test (web monitoring scenario step)<br>10 - external<br>11 - database monitor<br>12 - IPMI agent<br>13 - SSH agent<br>14 - Telnet agent<br>15 - calculated<br>16 - JMX agent<br>17 - SNMP trap<br>18 - Dependent item<br>19 - HTTP agent item|Item type.|
|<|snmp\_community|`string`|<|SNMP community name if 'type' is 1,4.|
|<|snmp\_oid|`string`|<|SNMP object ID.|
|<|key|`string`|<|Item key.|
|<|delay|`string`|<|Update interval of the item. Seconds, time unit with suffix, custom intervals or user macros.<br><br>Note that `delay` will be always '0' for trapper items.|
|<|history|`string`|<|A time unit of how long the history data should be stored. Time unit with suffix or user macro.|
|<|trends|`string`|<|A time unit of how long the trends data should be stored. Time unit with suffix or user macro.|
|<|status|`integer`|0 - enabled<br>1 - disabled|Item status.|
|<|value\_type|`integer`|0 - float<br>1 - character<br>2 - log<br>3 - unsigned integer<br>4 - text|Received value type.|
|<|allowed\_hosts|`string`|<|List of IP addresses (comma delimited) of hosts allowed sending data for the item if 'type' is 2 or 19.|
|<|units|`string`|<|Units of returned values (bps, B).|
|<|snmpv3\_contextname|`string`|<|SNMPv3 context name.|
|<|snmpv3\_securityname|`string`|<|SNMPv3 security name.|
|<|snmpv3\_securitylevel|`integer`|0 - noAuthNoPriv<br>1 - authNoPriv<br>2 - authPriv|SNMPv3 security level.|
|<|snmpv3\_authprotocol|`integer`|0 - MD5<br>1 - SHA|SNMPv3 authentication protocol.|
|<|snmpv3\_authpassphrase|`string`|<|SNMPv3 authentication passphrase.|
|<|snmpv3\_privprotocol|`integer`|0 - DES<br>1 - AES|SNMPv3 privacy protocol.|
|<|snmpv3\_privpassphrase|`string`|<|SNMPv3 privacy passphrase.|
|<|params|`text`|<|Name of the "Executed script" if 'type' is 13,14<br>"SQL query" field if 'type' is 11<br>"Formula" field if 'type' is 15.|
|<|ipmi\_sensor|`string`|<|IPMI sensor ID if 'type' is 12.|
|<|authtype|`integer`|Authentication type for SSH agent items:<br>0 - password<br>1 - key<br><br>Authentication type for HTTP agent items:<br>0 - none<br>1 - basic<br>2 - NTLM|Authentication type if 'type' is 13 or 19.|
|<|username|`string`|<|User name if 'type' is 11,13,14,19.|
|<|password|`string`|<|Password if 'type' is 11,13,14,19.|
|<|publickey|`string`|<|Name of the public key file if 'type' is 13.|
|<|privatekey|`string`|<|Name of the private key file if 'type' is 13.|
|<|port|`string`|<|Custom port for the item.|
|<|description|`text`|<|Item description.|
|<|inventory\_link|`integer`|0 - no link<br>*number* - number of field in the 'host\_inventory' table|Use item value to populate this inventory field.|
|<|logtimefmt|`string`|<|Format of the time in log entries. Used only by log items.|
|<|interface\_ref|`string`|<|Reference to host interface.|
|<|jmx\_endpoint|`string`|<|JMX endpoint if 'type' is 16.|
|<|url|`string`|<|URL string if 'type' is 19.|
|<|allow\_traps|`integer`|0 - Do not allow trapping.<br>1 - Allow trapping.|Property to allow to send data to item if 'type' is 19.|
|<|follow\_redirects|`integer`|0 - Do not follow redirects.<br>1 - Follow redirects.|Follow HTTP redirects if 'type' is 19.|
|<|headers|`object`|<|Object with HTTP(S) request headers if 'type' is 19.|
|<|http\_proxy|`string`|<|HTTP(S) proxy connection string if 'type' is 19.|
|<|output\_format|`integer`|0 - Store as is.<br>1 - Convert to JSON.|How to process response if 'type' is 19.|
|<|post\_type|`integer`|0 - Raw data.<br>2 - JSON data.<br>3 - XML data.|Type of request body if 'type' is 19.|
|<|posts|`text`|<|Request body if 'type' is 19.|
|<|query\_fields|`array`|<|Array of objects for request query fields if 'type' is 19.|
|<|request\_method|`integer`|0 - GET<br>1 - POST<br>2 - PUT<br>3 - HEAD|Request method if 'type' is 19.|
|<|retrieve\_mode|`integer`|0 - Body.<br>1 - Headers.<br>2 - Both body and headers will be stored.|What part of response should be stored if 'type' is 19.|
|<|ssl\_cert\_file|`string`|<|Public SSL Key file path if 'type' is 19.|
|<|ssl\_key\_file|`string`|<|Private SSL Key file path if 'type' is 19.|
|<|ssl\_key\_password|`string`|<|Password for SSL Key file if 'type' is 19.|
|<|status\_codes|`string`|<|Ranges of required HTTP status codes separated by commas if 'type' is 19.|
|<|timeout|`string`|<|Item data polling request timeout if 'type' is 19.|
|<|verify\_host|`integer`|0 - Do not validate.<br>1 - Validate.|Validate host name in URL is in Common Name field or a Subject Alternate Name field of host certificate if 'type' is 19.|
|<|verify\_peer|`integer`|0 - Do not validate.<br>1 - Validate.|Validate is host certificate authentic if 'type' is 19.|
|value map|<|<|<|Value map.|
|<|name|`string`|<|Name of the value map to use for the item.|
|applications|<|<|<|Root element for applications.|
|application|<|<|<|Individual application.|
|<|name|<|<|Application name.|
|preprocessing|<|<|<|Item value preprocessing.|
|step|<|<|<|Individual item value preprocessing step.|
|<|type|`integer`|1 - custom multiplier<br>2 - right trim<br>3 - left trim<br>4 - trim from both sides<br>5 - regular expression matching<br>6 - boolean to decimal<br>7 - octal to decimal<br>8 - hexadecimal to decimal<br>9 - simple change; calculated as (received value-previous value)<br>10 - change per second; calculated as (received value-previous value)/(time now-time of last check)<br>11 - XML Path<br>12 - JSONPath|Type of the item value preprocessing step.|
|<|params|`string`|<|Parameters of the item value preprocessing step.|
|master\_item|<|<|<|Individual item master item data.|
|<|key|`string`|<|Dependent item master item key value.|
##### Host low-level discovery rule tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|discovery\_rules|<|<|<|Root element for low-level discovery rules.|
|discovery\_rule|<|<|<|Individual low-level discovery rule.|
|<|*For most of the element tag values, see element tag values for a regular item. Only the tags that are specific to low-level discovery rules, are described below.*|<|<|<|
|<|lifetime|`string`|<|Time period after which items that are no longer discovered will be deleted. Seconds, time unit with suffix or user macro.|
|filter|<|<|<|Individual filter.|
|<|evaltype|`integer`|0 - And/or logic<br>1 - And logic<br>2 - Or logic<br>3 - custom formula|Logic to use for checking low-level discovery rule filter conditions.|
|<|formula|`string`|<|Custom calculation formula for filter conditions.|
|<|conditions|<|<|Root element for filter conditions.|
|condition|<|<|<|Individual filter condition.|
|<|macro|`string`|<|Low-level discovery macro name.|
|<|value|`string`|<|Filter value: regular expression or global regular expression.|
|<|operator|`integer`|<|<|
|<|formulaid|`character`|<|Filter condition ID. Used in the custom calculation formula.|
|item\_prototypes|<|<|<|Root element for item\_prototypes.|
|item\_prototype|<|<|<|Individual item\_prototype.|
|<|*For most of the element tag values, see element tag values for a regular item. Only the tags that are specific to item\_prototypes, are described below.*|<|<|<|
|application\_prototypes|<|<|<|Root element for application prototypes.|
|application\_prototype|<|<|<|Individual application prototype.|
|<|name|<|<|Application prototype name.|
|master\_item|<|<|<|Individual item prototype master item/item prototype data.|
|<|key|`string`|<|Dependent item prototype master item/item prototype key value.|
##### Host low-level discovery rule tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|discovery\_rules|<|<|<|Root element for low-level discovery rules.|
|discovery\_rule|<|<|<|Individual low-level discovery rule.|
|<|*For most of the element tag values, see element tag values for a regular item. Only the tags that are specific to low-level discovery rules, are described below.*|<|<|<|
|<|lifetime|`string`|<|Time period after which items that are no longer discovered will be deleted. Seconds, time unit with suffix or user macro.|
|filter|<|<|<|Individual filter.|
|<|evaltype|`integer`|0 - And/or logic<br>1 - And logic<br>2 - Or logic<br>3 - custom formula|Logic to use for checking low-level discovery rule filter conditions.|
|<|formula|`string`|<|Custom calculation formula for filter conditions.|
|<|conditions|<|<|Root element for filter conditions.|
|condition|<|<|<|Individual filter condition.|
|<|macro|`string`|<|Low-level discovery macro name.|
|<|value|`string`|<|Filter value: regular expression or global regular expression.|
|<|operator|`integer`|<|<|
|<|formulaid|`character`|<|Filter condition ID. Used in the custom calculation formula.|
|item\_prototypes|<|<|<|Root element for item\_prototypes.|
|item\_prototype|<|<|<|Individual item\_prototype.|
|<|*For most of the element tag values, see element tag values for a regular item. Only the tags that are specific to item\_prototypes, are described below.*|<|<|<|
|application\_prototypes|<|<|<|Root element for application prototypes.|
|application\_prototype|<|<|<|Individual application prototype.|
|<|name|<|<|Application prototype name.|
|master\_item|<|<|<|Individual item prototype master item/item prototype data.|
|<|key|`string`|<|Dependent item prototype master item/item prototype key value.|
##### Host tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|groups|<|<|<|Root element for groups.|
|group|<|<|<|Individual group.|
|<|name|`string`|<|Unique group name.|
|hosts|<|<|<|Root element for hosts.|
|host|<|<|<|Individual host.|
|<|host|`string`|<|Unique host name.|
|<|name|`string`|<|Visible host name.|
|<|description|`text`|<|Host description.|
|<|status|`integer`|0 - monitored<br>1 - not monitored|Host status.|
|<|ipmi\_authtype|`integer`|-1 - default<br>0 - none<br>1 - MD2<br>2 - MD5<br>4 - straight<br>5 - OEM<br>6 - RMCP+|IPMI session authentication type.|
|<|ipmi\_privilege|`integer`|1 - callback<br>2 - user<br>3 - operator<br>4 - admin<br>5 - OEM|IPMI session privilege level.|
|<|ipmi\_username|`string`|<|Username for IPMI checks.|
|<|ipmi\_password|`string`|<|Password for IPMI checks.|
|<|tls\_connect|`integer`|1 - unencrypted<br>2 - TLS with PSK<br>4 - TLS with certificate|Type of outgoing connection.|
|<|tls\_accept|`integer`|1 - unencrypted<br>2 - TLS with PSK<br>3 - unencrypted and TLS with PSK<br>4 - TLS with certificate<br>5 - unencrypted and TLS with certificate<br>6 - TLS with PSK or certificate<br>7 - unencrypted and TLS with PSK or certificate|Type of incoming connection.|
|<|tls\_issuer|`string`|<|Allowed agent/proxy certificate issuer.|
|<|tls\_subject|`string`|<|Allowed agent/proxy certificate subject.|
|<|tls\_psk\_indentity|`string`|<|PSK identity string.|
|<|tls\_psk|`string`|<|PSK value string.|
|proxy|<|<|<|Proxy.|
|<|name|`string`|<|Name of the proxy (if any) that monitors the host.|
|templates|<|<|<|Root element for linked templates.|
|template|<|<|<|Individual template.|
|<|name|`string`|<|Template name.|
|interfaces|<|<|<|Root element for host interfaces.|
|interface|<|<|<|Individual interface.|
|<|default|`integer`|0 - secondary<br>1 - primary (default)|Interface status.<br>Only one primary interface of one type can be on a host.|
|<|type|`integer`|0 - unknown<br>1 - Zabbix agent<br>2 - SNMP<br>3 - IPMI<br>4 - JMX|Interface type.|
|<|useip|`integer`|0 - use DNS name<br>1 - use IP address|Interface to use for connecting to the host.|
|<|ip|`string`|<|IP address, can be either IPv4 or IPv6.|
|<|dns|`string`|<|DNS name.|
|<|port|`string`|<|Port number.|
|<|bulk|`integer`|0 - disable<br>1 - enable|Use bulk requests for SNMP.|
|<|interface\_ref|`string`|<|Interface reference name to be used in items.|
|applications|<|<|<|Root element for applications.|
|application|<|<|<|Individual application.|
|<|name|<|<|Application name.|
|macros|<|<|<|Root element for macros.|
|macro|<|<|<|Individual macro.|
|<|name|<|<|User macro name.|
|<|value|<|<|User macro value.|
##### Host tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|groups|<|<|<|Root element for groups.|
|group|<|<|<|Individual group.|
|<|name|`string`|<|Unique group name.|
|hosts|<|<|<|Root element for hosts.|
|host|<|<|<|Individual host.|
|<|host|`string`|<|Unique host name.|
|<|name|`string`|<|Visible host name.|
|<|description|`text`|<|Host description.|
|<|status|`integer`|0 - monitored<br>1 - not monitored|Host status.|
|<|ipmi\_authtype|`integer`|-1 - default<br>0 - none<br>1 - MD2<br>2 - MD5<br>4 - straight<br>5 - OEM<br>6 - RMCP+|IPMI session authentication type.|
|<|ipmi\_privilege|`integer`|1 - callback<br>2 - user<br>3 - operator<br>4 - admin<br>5 - OEM|IPMI session privilege level.|
|<|ipmi\_username|`string`|<|Username for IPMI checks.|
|<|ipmi\_password|`string`|<|Password for IPMI checks.|
|<|tls\_connect|`integer`|1 - unencrypted<br>2 - TLS with PSK<br>4 - TLS with certificate|Type of outgoing connection.|
|<|tls\_accept|`integer`|1 - unencrypted<br>2 - TLS with PSK<br>3 - unencrypted and TLS with PSK<br>4 - TLS with certificate<br>5 - unencrypted and TLS with certificate<br>6 - TLS with PSK or certificate<br>7 - unencrypted and TLS with PSK or certificate|Type of incoming connection.|
|<|tls\_issuer|`string`|<|Allowed agent/proxy certificate issuer.|
|<|tls\_subject|`string`|<|Allowed agent/proxy certificate subject.|
|<|tls\_psk\_indentity|`string`|<|PSK identity string.|
|<|tls\_psk|`string`|<|PSK value string.|
|proxy|<|<|<|Proxy.|
|<|name|`string`|<|Name of the proxy (if any) that monitors the host.|
|templates|<|<|<|Root element for linked templates.|
|template|<|<|<|Individual template.|
|<|name|`string`|<|Template name.|
|interfaces|<|<|<|Root element for host interfaces.|
|interface|<|<|<|Individual interface.|
|<|default|`integer`|0 - secondary<br>1 - primary (default)|Interface status.<br>Only one primary interface of one type can be on a host.|
|<|type|`integer`|0 - unknown<br>1 - Zabbix agent<br>2 - SNMP<br>3 - IPMI<br>4 - JMX|Interface type.|
|<|useip|`integer`|0 - use DNS name<br>1 - use IP address|Interface to use for connecting to the host.|
|<|ip|`string`|<|IP address, can be either IPv4 or IPv6.|
|<|dns|`string`|<|DNS name.|
|<|port|`string`|<|Port number.|
|<|bulk|`integer`|0 - disable<br>1 - enable|Use bulk requests for SNMP.|
|<|interface\_ref|`string`|<|Interface reference name to be used in items.|
|applications|<|<|<|Root element for applications.|
|application|<|<|<|Individual application.|
|<|name|<|<|Application name.|
|macros|<|<|<|Root element for macros.|
|macro|<|<|<|Individual macro.|
|<|name|<|<|User macro name.|
|<|value|<|<|User macro value.|
#### Host/template cloning
Long lists of objects to be cloned (items, triggers, graphs, etc) have
been removed from host and template full clone forms.
#### Host/template cloning
Long lists of objects to be cloned (items, triggers, graphs, etc) have
been removed from host and template full clone forms.
##### Host trigger tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|triggers|<|<|<|Root element for triggers.|
|trigger|<|<|<|Individual trigger.|
|<|expression|`string`|<|Trigger expression.|
|<|recovery\_mode|`integer`|0 - expression<br>1 - recovery expression<br>2 - none|Basis for generating OK events.|
|<|recovery\_expression|`string`|<|Trigger recovery expression.|
|<|name|`string`|<|Trigger name.|
|<|correlation\_mode|`integer`|0 - no event correlation<br>1 - event correlation by tag|Correlation mode.|
|<|correlation\_tag|`string`|<|The tag name to be used for event correlation.|
|<|url|`string`|<|Trigger URL.|
|<|status|`integer`|0 - enabled<br>1 - disabled|Trigger status.|
|<|priority|`integer`|0 - not classified<br>1 - information<br>2 - warning<br>3 - average<br>4 - high<br>5 - disaster|Trigger severity.|
|<|description|`text`|<|Trigger description.|
|<|type|`integer`|0 - single problem event<br>1 - multiple problem events|Event generation type.|
|<|manual\_close|`integer`|0 - not allowed<br>1 - allowed|Manual closing of problem events.|
|dependencies|<|<|<|Root element for dependencies.|
|dependency|<|<|<|Individual dependency.|
|<|name|`string`|<|Dependency trigger name.|
|<|expression|`string`|<|Dependency trigger expression.|
|<|recovery\_expression|`string`|<|Dependency trigger recovery expression.|
|tags|<|<|<|Root element for event tags.|
|tag|<|<|<|Individual event tag.|
|<|tag|`string`|<|Tag name.|
|<|value|`string`|<|Tag value.|
##### Host trigger tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|triggers|<|<|<|Root element for triggers.|
|trigger|<|<|<|Individual trigger.|
|<|expression|`string`|<|Trigger expression.|
|<|recovery\_mode|`integer`|0 - expression<br>1 - recovery expression<br>2 - none|Basis for generating OK events.|
|<|recovery\_expression|`string`|<|Trigger recovery expression.|
|<|name|`string`|<|Trigger name.|
|<|correlation\_mode|`integer`|0 - no event correlation<br>1 - event correlation by tag|Correlation mode.|
|<|correlation\_tag|`string`|<|The tag name to be used for event correlation.|
|<|url|`string`|<|Trigger URL.|
|<|status|`integer`|0 - enabled<br>1 - disabled|Trigger status.|
|<|priority|`integer`|0 - not classified<br>1 - information<br>2 - warning<br>3 - average<br>4 - high<br>5 - disaster|Trigger severity.|
|<|description|`text`|<|Trigger description.|
|<|type|`integer`|0 - single problem event<br>1 - multiple problem events|Event generation type.|
|<|manual\_close|`integer`|0 - not allowed<br>1 - allowed|Manual closing of problem events.|
|dependencies|<|<|<|Root element for dependencies.|
|dependency|<|<|<|Individual dependency.|
|<|name|`string`|<|Dependency trigger name.|
|<|expression|`string`|<|Dependency trigger expression.|
|<|recovery\_expression|`string`|<|Dependency trigger recovery expression.|
|tags|<|<|<|Root element for event tags.|
|tag|<|<|<|Individual event tag.|
|<|tag|`string`|<|Tag name.|
|<|value|`string`|<|Tag value.|
##### Host web scenario tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|httptests|<|<|<|Root element for web scenarios.|
|httptest|<|<|<|Individual web scenario.|
|<|name|`string`|<|Web scenario name.|
|<|delay|`string`|<|Frequency of executing the web scenario. Seconds, time unit with suffix or user macro.|
|<|attempts|`integer`|1-10|The number of attempts for executing web scenario steps.|
|<|agent|`string`|<|Client agent. Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.|
|<|http\_proxy|`string`|<|Specify an HTTP proxy to use, using the format: `http://[username[:password]@]proxy.example.com[:port]`|
|<|variables|`text`|<|List of scenario-level variables (macros) that may be used in scenario steps.|
|<|headers|`text`|<|HTTP headers that will be sent when performing a request.|
|<|status|`integer`|0 - enabled<br>1 - disabled|Web scenario status.|
|<|authentication|`integer`|0 - none<br>1 - basic<br>2 - NTLM|Authentication method.|
|<|http\_user|`string`|<|Authentication user name.|
|<|http\_password|`string`|<|Authentication password for specified user name.|
|<|verify\_peer|`integer`|0 - no<br>1 - yes|Verify the SSL certificate of the web server.|
|<|verify\_host|`integer`|0 - no<br>1 - yes|Verify that the Common Name field or the Subject Alternate Name field of the web server certificate matches.|
|<|ssl\_cert\_file|`string`|<|Name of the SSL certificate file used for client authentication.|
|<|ssl\_key\_file|`string`|<|Name of the SSL private key file used for client authentication.|
|<|ssl\_key\_password|`string`|<|SSL private key file password.|
|steps|<|<|<|Root element for web scenario steps.|
|step|<|<|<|Individual web scenario step.|
|<|name|`string`|<|Web scenario step name.|
|<|url|`string`|<|URL for monitoring.|
|<|posts|`text`|<|List of 'Post' variables.|
|<|variables|`text`|<|List of step-level variables (macros) that should be applied after this step.<br><br>If the variable value has a 'regex:' prefix, then its value is extracted from the data returned by this step according to the regular expression pattern following the 'regex:' prefix|
|<|headers|`text`|<|HTTP headers that will be sent when performing a request.|
|<|follow\_redirects|`integer`|0 - no<br>1 - yes|Follow HTTP redirects.|
|<|retrieve\_mode|`integer`|0 - content<br>1 - headers only|HTTP response retrieve mode.|
|<|timeout|`string`|<|Timeout of step execution. Seconds, time unit with suffix or user macro.|
|<|required|`string`|<|Required string. Ignored if empty.|
|<|status\_codes|`string`|<|A comma delimited list of accepted status codes. Ignored if empty. For example: 200-201,210-299|
##### Host web scenario tags
|Element|Element property|Type|Range|Description|
|-------|----------------|----|-----|-----------|
|httptests|<|<|<|Root element for web scenarios.|
|httptest|<|<|<|Individual web scenario.|
|<|name|`string`|<|Web scenario name.|
|<|delay|`string`|<|Frequency of executing the web scenario. Seconds, time unit with suffix or user macro.|
|<|attempts|`integer`|1-10|The number of attempts for executing web scenario steps.|
|<|agent|`string`|<|Client agent. Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.|
|<|http\_proxy|`string`|<|Specify an HTTP proxy to use, using the format: `http://[username[:password]@]proxy.example.com[:port]`|
|<|variables|`text`|<|List of scenario-level variables (macros) that may be used in scenario steps.|
|<|headers|`text`|<|HTTP headers that will be sent when performing a request.|
|<|status|`integer`|0 - enabled<br>1 - disabled|Web scenario status.|
|<|authentication|`integer`|0 - none<br>1 - basic<br>2 - NTLM|Authentication method.|
|<|http\_user|`string`|<|Authentication user name.|
|<|http\_password|`string`|<|Authentication password for specified user name.|
|<|verify\_peer|`integer`|0 - no<br>1 - yes|Verify the SSL certificate of the web server.|
|<|verify\_host|`integer`|0 - no<br>1 - yes|Verify that the Common Name field or the Subject Alternate Name field of the web server certificate matches.|
|<|ssl\_cert\_file|`string`|<|Name of the SSL certificate file used for client authentication.|
|<|ssl\_key\_file|`string`|<|Name of the SSL private key file used for client authentication.|
|<|ssl\_key\_password|`string`|<|SSL private key file password.|
|steps|<|<|<|Root element for web scenario steps.|
|step|<|<|<|Individual web scenario step.|
|<|name|`string`|<|Web scenario step name.|
|<|url|`string`|<|URL for monitoring.|
|<|posts|`text`|<|List of 'Post' variables.|
|<|variables|`text`|<|List of step-level variables (macros) that should be applied after this step.<br><br>If the variable value has a 'regex:' prefix, then its value is extracted from the data returned by this step according to the regular expression pattern following the 'regex:' prefix|
|<|headers|`text`|<|HTTP headers that will be sent when performing a request.|
|<|follow\_redirects|`integer`|0 - no<br>1 - yes|Follow HTTP redirects.|
|<|retrieve\_mode|`integer`|0 - content<br>1 - headers only|HTTP response retrieve mode.|
|<|timeout|`string`|<|Timeout of step execution. Seconds, time unit with suffix or user macro.|
|<|required|`string`|<|Required string. Ignored if empty.|
|<|status\_codes|`string`|<|A comma delimited list of accepted status codes. Ignored if empty. For example: 200-201,210-299|
#### HP Comware template
The *Template Net HP Comware HH3C SNMPv2* now contains the correct value
mapping.
#### HP Comware template
The *Template Net HP Comware HH3C SNMPv2* now contains the correct value
mapping.
#### HP iLO template
The counter for overall server health check has been fixed in the
*Template Server HP iLO SNMPv2* template.
#### HP iLO template
The counter for overall server health check has been fixed in the
*Template Server HP iLO SNMPv2* template.
#### httptest
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861)
`httptest.create`, `httptest.update`: changed "http\_user" and
"http\_password" fields to optional when using authentication\
#### httptest
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861)
`httptest.create`, `httptest.update`: changed "http\_user" and
"http\_password" fields to optional when using authentication\
# httptest.create
# httptest.create
# httptest.delete
# httptest.delete
# httptest.get
# httptest.get
# httptest.update
# httptest.update
##### Human readable time in Plain text widget
When displaying time in the *Plain text* dashboard
[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#plain_text),
it is now displayed in a human readable form.
|<|
|<|
|-|
|<|
##### Human readable time in Plain text widget
When displaying time in the *Plain text* dashboard
[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#plain_text),
it is now displayed in a human readable form.
|<|
|<|
|-|
|<|
#### IE11 issue with map resizing in dashboard widgets
Maps, in Internet Explorer 11, are cut off on the right side if the map
content is larger than the dashboard widget area (instead of being
resized proportionately). This is intentional because of an IE11-related
issue with proper resizing of SVG images.
#### IE11 issue with map resizing in dashboard widgets
Maps, in Internet Explorer 11, are cut off on the right side if the map
content is larger than the dashboard widget area (instead of being
resized proportionately). This is intentional because of an IE11-related
issue with proper resizing of SVG images.
#### Importing
To import hosts, do the following:
- Go to: *Configuration* → *Hosts*
- Click on *Import* to the right
- Select the import file
- Mark the required options in import rules
- Click on *Import*
Note that before Zabbix 4.0.16, when a host is imported and updated, it
can only be linked to additional templates and never be unlinked from
any.
A success or failure message of the import will be displayed in the
frontend.
Import rules:
|Rule|Description|
|----|-----------|
|*Update existing*|Existing elements will be updated with data taken from the import file. Otherwise they will not be updated.|
|*Create new*|The import will add new elements using data from the import file. Otherwise it will not add them.|
|*Delete missing*|The import will remove existing elements not present in the import file. Otherwise it will not remove them.<br>If *Delete missing* is marked for template linkage (only available since 4.0.16), existing template linkage not present in the import file will be removed from the host along with all entities inherited from the potentially unlinked templates (items, triggers, etc).|
#### Importing
To import hosts, do the following:
- Go to: *Configuration* → *Hosts*
- Click on *Import* to the right
- Select the import file
- Mark the required options in import rules
- Click on *Import*
Note that before Zabbix 4.0.16, when a host is imported and updated, it
can only be linked to additional templates and never be unlinked from
any.
A success or failure message of the import will be displayed in the
frontend.
Import rules:
|Rule|Description|
|----|-----------|
|*Update existing*|Existing elements will be updated with data taken from the import file. Otherwise they will not be updated.|
|*Create new*|The import will add new elements using data from the import file. Otherwise it will not add them.|
|*Delete missing*|The import will remove existing elements not present in the import file. Otherwise it will not remove them.<br>If *Delete missing* is marked for template linkage (only available since 4.0.16), existing template linkage not present in the import file will be removed from the host along with all entities inherited from the potentially unlinked templates (items, triggers, etc).|
#### Import option to remove existing template linkage
During host or template import it is now possible to update template
linkage using the *Delete missing* option. If using this option any
template linkage that does not also exist in the import file will be
deleted from the existing host/template along with **all** entities
inherited from these unlinked templates (items, triggers, etc).
By default this option is unchecked and before it is possible to mark
this checkbox a warning message is displayed that all inherited entities
may be lost as a result.
#### Import option to remove existing template linkage
During host or template import it is now possible to update template
linkage using the *Delete missing* option. If using this option any
template linkage that does not also exist in the import file will be
deleted from the existing host/template along with **all** entities
inherited from these unlinked templates (items, triggers, etc).
By default this option is unchecked and before it is possible to mark
this checkbox a warning message is displayed that all inherited entities
may be lost as a result.
#### Improved naming style
Naming style of groups and applications has been improved for some
out-of-the-box templates.
#### Improved naming style
Naming style of groups and applications has been improved for some
out-of-the-box templates.
##### In accepting-side log:
...failed to accept an incoming connection: from 127.0.0.1: support for TLS was not compiled in
##### In accepting-side log:
...failed to accept an incoming connection: from 127.0.0.1: support for TLS was not compiled in
##### In connecting-side log:
Linux:
...In zbx_tls_init_child()
...OpenSSL library (version OpenSSL 1.1.1 11 Sep 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK test sender"
...End of zbx_tls_connect():FAIL error:'connection closed by peer'
...send value error: TCP successful, cannot establish TLS to [[localhost]:10051]: connection closed by peer
Windows:
...OpenSSL library (version OpenSSL 1.1.1a 20 Nov 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK test sender"
...zbx_psk_client_cb() requested PSK identity "PSK test sender"
...End of zbx_tls_connect():FAIL error:'SSL_connect() I/O error: [0x00000000] The operation completed successfully.'
...send value error: TCP successful, cannot establish TLS to [[192.168.1.2]:10051]: SSL_connect() I/O error: [0x00000000] The operation completed successfully.
##### In connecting-side log:
Linux:
...In zbx_tls_init_child()
...OpenSSL library (version OpenSSL 1.1.1 11 Sep 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK test sender"
...End of zbx_tls_connect():FAIL error:'connection closed by peer'
...send value error: TCP successful, cannot establish TLS to [[localhost]:10051]: connection closed by peer
Windows:
...OpenSSL library (version OpenSSL 1.1.1a 20 Nov 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK test sender"
...zbx_psk_client_cb() requested PSK identity "PSK test sender"
...End of zbx_tls_connect():FAIL error:'SSL_connect() I/O error: [0x00000000] The operation completed successfully.'
...send value error: TCP successful, cannot establish TLS to [[192.168.1.2]:10051]: SSL_connect() I/O error: [0x00000000] The operation completed successfully.
#### Increased proxy-server limit per connection
Limit per connection has been increased from 128MB to 1GB packet size
(ZBX\_MAX\_RECV\_DATA\_SIZE constant).
#### Increased proxy-server limit per connection
Limit per connection has been increased from 128MB to 1GB packet size
(ZBX\_MAX\_RECV\_DATA\_SIZE constant).
#### Installation steps
To install, double-click the downloaded MSI file.
Accept the license to proceed to the next step.
Specify the following parameters.
|Parameter|Description|
|---------|-----------|
|*Host name*|Specify host name.|
|*Zabbix server IP/DNS*|Specify IP/DNS of Zabbix server.|
|*Agent listen port*|Specify agent listen port (10050 by default).|
|*Server or Proxy for active checks*|Specify IP/DNS of Zabbix server/proxy for active agent checks.|
|*Remote commands*|Mark the checkbox to enable remote commands.|
|*Enable PSK*|Mark the checkbox to enable TLS support via pre-shared keys.|
|*Add agent location to the PATH*|Add agent location to the PATH variable.|
Enter pre-shared key identity and value. This step is only available if
you checked *Enable PSK* in the previous step.
Select Zabbix components to install - [Zabbix agent
daemon](/manual/concepts/agent), [Zabbix
sender](/manual/concepts/sender), [Zabbix get](/manual/concepts/get).
Zabbix components along with the configuration file will be installed in
a *Zabbix Agent* folder in Program Files. zabbix\_agentd.exe will be set
up as Windows service with automatic startup.
#### Installation steps
To install, double-click the downloaded MSI file.
Accept the license to proceed to the next step.
Specify the following parameters.
|Parameter|Description|
|---------|-----------|
|*Host name*|Specify host name.|
|*Zabbix server IP/DNS*|Specify IP/DNS of Zabbix server.|
|*Agent listen port*|Specify agent listen port (10050 by default).|
|*Server or Proxy for active checks*|Specify IP/DNS of Zabbix server/proxy for active agent checks.|
|*Remote commands*|Mark the checkbox to enable remote commands.|
|*Enable PSK*|Mark the checkbox to enable TLS support via pre-shared keys.|
|*Add agent location to the PATH*|Add agent location to the PATH variable.|
Enter pre-shared key identity and value. This step is only available if
you checked *Enable PSK* in the previous step.
Select Zabbix components to install - [Zabbix agent
daemon](/manual/concepts/agent), [Zabbix
sender](/manual/concepts/sender), [Zabbix get](/manual/concepts/get).
Zabbix components along with the configuration file will be installed in
a *Zabbix Agent* folder in Program Files. zabbix\_agentd.exe will be set
up as Windows service with automatic startup.
### Installing debuginfo packages
::: noteclassic
Debuginfo packages are currently available for RHEL/CentOS
versions 7, 6 and 5.
::: To enable debuginfo repository edit
*/etc/yum.repos.d/zabbix.repo* file. Change `enabled=0` to `enabled=1`
for zabbix-debuginfo repository.
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/4.0/rhel/7/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
This will allow you to install the zabbix-debuginfo package.
# yum install zabbix-debuginfo
This single package contains debug information for all binary Zabbix
components.
### Installing debuginfo packages
::: noteclassic
Debuginfo packages are currently available for RHEL/CentOS
versions 7, 6 and 5.
::: To enable debuginfo repository edit
*/etc/yum.repos.d/zabbix.repo* file. Change `enabled=0` to `enabled=1`
for zabbix-debuginfo repository.
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/4.0/rhel/7/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
This will allow you to install the zabbix-debuginfo package.
# yum install zabbix-debuginfo
This single package contains debug information for all binary Zabbix
components.
#### Installing locales
To list all installed languages, run:
locale -a
If some languages that are needed are not listed, open the
*/etc/locale.gen* file and uncomment the required locales. Since Zabbix
uses UTF-8 encoding, you need to select locales with UTF-8 charset.
Now, run:
locale-gen
Restart the web server.
The locales should now be installed. It may be required to reload Zabbix
frontend page in browser using Ctrl + F5 for new languages to appear.
#### Installing locales
To list all installed languages, run:
locale -a
If some languages that are needed are not listed, open the
*/etc/locale.gen* file and uncomment the required locales. Since Zabbix
uses UTF-8 encoding, you need to select locales with UTF-8 charset.
Now, run:
locale-gen
Restart the web server.
The locales should now be installed. It may be required to reload Zabbix
frontend page in browser using Ctrl + F5 for new languages to appear.
#### Installing MIB files
On Debian-based systems:
# apt install snmp-mibs-downloader
# download-mibs
On RedHat-based systems:
# yum install net-snmp-libs
#### Installing MIB files
On Debian-based systems:
# apt install snmp-mibs-downloader
# download-mibs
On RedHat-based systems:
# yum install net-snmp-libs
#### Installing Zabbix
If installing Zabbix directly from [Zabbix git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse),
translation files should be generated manually. To generate translation
files, run:
make gettext
locale/make_mo.sh
This step is not needed when installing Zabbix from packages or source
tar.gz files.
#### Installing Zabbix
If installing Zabbix directly from [Zabbix git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse),
translation files should be generated manually. To generate translation
files, run:
make gettext
locale/make_mo.sh
This step is not needed when installing Zabbix from packages or source
tar.gz files.
#### Internal events can be disabled
Internal events will not be created, if all internal actions for them
are disabled --- this can be useful for reducing the amount of event
records and controlling the size of the event tables. See [more
information](/manual/config/events/sources#internal_events).
#### Internal events can be disabled
Internal events will not be created, if all internal actions for them
are disabled --- this can be useful for reducing the amount of event
records and controlling the size of the event tables. See [more
information](/manual/config/events/sources#internal_events).
#### Internal queue items
There are also another two items specifically allowing to remote query
internal queue stats on another Zabbix instance:
- `zabbix[stats,<ip>,<port>,queue,<from>,<to>]` internal item - for
direct internal queue queries to remote Zabbix server/proxy
- `zabbix.stats[<ip>,<port>,queue,<from>,<to>]` agent item - for
agent-based internal queue queries to remote Zabbix server/proxy
See also: [Internal items](/manual/config/items/itemtypes/internal),
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
#### Internal queue items
There are also another two items specifically allowing to remote query
internal queue stats on another Zabbix instance:
- `zabbix[stats,<ip>,<port>,queue,<from>,<to>]` internal item - for
direct internal queue queries to remote Zabbix server/proxy
- `zabbix.stats[<ip>,<port>,queue,<from>,<to>]` agent item - for
agent-based internal queue queries to remote Zabbix server/proxy
See also: [Internal items](/manual/config/items/itemtypes/internal),
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
#### Introduction
MIB stands for a Management Information Base. MIB files allow you to use
textual representation of the OID (Object Identifier).
For example,
ifHCOutOctets
is textual representation of OID
1.3.6.1.2.1.31.1.1.1.10
You can use either, when monitoring SNMP devices with Zabbix, but if you
feel more comfortable when using textual representation you have to
install MIB files.
#### Introduction
MIB stands for a Management Information Base. MIB files allow you to use
textual representation of the OID (Object Identifier).
For example,
ifHCOutOctets
is textual representation of OID
1.3.6.1.2.1.31.1.1.1.10
You can use either, when monitoring SNMP devices with Zabbix, but if you
feel more comfortable when using textual representation you have to
install MIB files.
#### IPv6 address issue in SNMPv3 traps
Due to a net-snmp bug, IPv6 address may not be correctly displayed when
using SNMPv3 in SNMP traps. For more details and a possible workaround,
see [ZBX-14541](https://support.zabbix.com/browse/ZBX-14541).
#### IPv6 address issue in SNMPv3 traps
Due to a net-snmp bug, IPv6 address may not be correctly displayed when
using SNMPv3 in SNMP traps. For more details and a possible workaround,
see [ZBX-14541](https://support.zabbix.com/browse/ZBX-14541).
#### item
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861) `item.create`,
`item.update`: changed "username" and "password" fields to optional for
HTTP agent type items and using authentication\
#### item
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861) `item.create`,
`item.update`: changed "username" and "password" fields to optional for
HTTP agent type items and using authentication\
#### Item changes
- A 'mode' parameter has been added to the `vmware.eventlog[]` item
[key](/manual/config/items/itemtypes/simple_checks/vmware_keys),
used in monitoring VMware envirnoments, allowing to optionally
specify skipping of older log data. See also: [Template
changes](/manual/installation/template_changes#vmware_template).
```{=html}
<!-- -->
```
- Support of IPv6 addresses has been added to the first parameter of
the `net.dns[]` Zabbix agent
[item](/manual/config/items/itemtypes/zabbix_agent).
#### Item changes
- A 'mode' parameter has been added to the `vmware.eventlog[]` item
[key](/manual/config/items/itemtypes/simple_checks/vmware_keys),
used in monitoring VMware envirnoments, allowing to optionally
specify skipping of older log data. See also: [Template
changes](/manual/installation/template_changes#vmware_template).
```{=html}
<!-- -->
```
- Support of IPv6 addresses has been added to the first parameter of
the `net.dns[]` Zabbix agent
[item](/manual/config/items/itemtypes/zabbix_agent).
#### Item changes
The Timeout [configuration
parameter](/manual/appendix/config/zabbix_server) is now used for
web.page.get, web.page.regexp and web.page.perf items.
#### Item changes
The Timeout [configuration
parameter](/manual/appendix/config/zabbix_server) is now used for
web.page.get, web.page.regexp and web.page.perf items.
#### Item changes
* ''vmware.hv.discovery'' item for VMware hypervisor discovery now returns two [[:manual/vm_monitoring/discovery_fields|additional fields]]: {#PARENT.NAME} and {#PARENT.TYPE}, returning name and type of the container that stores the hypervisor respectively
#### Item changes
* ''vmware.hv.discovery'' item for VMware hypervisor discovery now returns two [[:manual/vm_monitoring/discovery_fields|additional fields]]: {#PARENT.NAME} and {#PARENT.TYPE}, returning name and type of the container that stores the hypervisor respectively
#### Item changes
**web.page.get**, **web.page.perf**, **web.page.regexp** agent
[items](/manual/config/items/itemtypes/zabbix_agent) now along with
hostname also support URL as the first parameter, allowing to specify
both HTTP and HTTPS protocols. As a prerequisite of SSL (HTTPS)
functionality, the agent should be compiled with cURL support.
Previously, only domain name or IP address was allowed in the first
parameter and there was no support for HTTPS protocol.
Additionally, Unicode is now supported in the hostnames of these items
(Punycode support was added).
#### Item changes
**web.page.get**, **web.page.perf**, **web.page.regexp** agent
[items](/manual/config/items/itemtypes/zabbix_agent) now along with
hostname also support URL as the first parameter, allowing to specify
both HTTP and HTTPS protocols. As a prerequisite of SSL (HTTPS)
functionality, the agent should be compiled with cURL support.
Previously, only domain name or IP address was allowed in the first
parameter and there was no support for HTTPS protocol.
Additionally, Unicode is now supported in the hostnames of these items
(Punycode support was added).
# item.create
# item.create
# item.delete
# item.delete
# item.get
# item.get
#### Item history
Global housekeeper settings no longer override item-level history/trends
settings in the case when keeping history/trends is entirely disabled on
the item level.
In addition, if previously disabling item history/trends had to be
specified by entering '0' as the storage period value, now the same can
be done using a dedicated radio button.
#### Item history
Global housekeeper settings no longer override item-level history/trends
settings in the case when keeping history/trends is entirely disabled on
the item level.
In addition, if previously disabling item history/trends had to be
specified by entering '0' as the storage period value, now the same can
be done using a dedicated radio button.
#### Item improvements
The following items that were previously supported only on AIX LPAR of
type "Shared", now are also supported on "Dedicated":
- **system.stat\[cpu,ec\]** (with "Dedicated" always returns 100
(percent))
- **system.stat\[cpu,pc\]**
- **system.stat\[ent\]**
See **system.stat\[\]** in [agent
items](/manual/config/items/itemtypes/zabbix_agent) for more details.
#### Item improvements
The following items that were previously supported only on AIX LPAR of
type "Shared", now are also supported on "Dedicated":
- **system.stat\[cpu,ec\]** (with "Dedicated" always returns 100
(percent))
- **system.stat\[cpu,pc\]**
- **system.stat\[ent\]**
See **system.stat\[\]** in [agent
items](/manual/config/items/itemtypes/zabbix_agent) for more details.
#### itemprototype
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861)
`itemprototype.create`, `itemprototype.update`: changed "username" and
"password" fields to optional for HTTP agent type item prototypes and
using authentication\
#### itemprototype
Bug fixes:\
[ZBX-10861](https://support.zabbix.com/browse/ZBX-10861)
`itemprototype.create`, `itemprototype.update`: changed "username" and
"password" fields to optional for HTTP agent type item prototypes and
using authentication\
# itemprototype.create
# itemprototype.create
# itemprototype.delete
# itemprototype.delete
# itemprototype.get
# itemprototype.get
# itemprototype.update
# itemprototype.update
#### Items
A new `regex_excl_dir` parameter has been added to vfs.dir.count\[\] and
vfs.dir.size\[\] agent
[items](/manual/config/items/itemtypes/zabbix_agent) allowing to exclude
the whole content of a subdirectory from the results.
#### Items
A new `regex_excl_dir` parameter has been added to vfs.dir.count\[\] and
vfs.dir.size\[\] agent
[items](/manual/config/items/itemtypes/zabbix_agent) allowing to exclude
the whole content of a subdirectory from the results.
#### Items / item prototypes
In an [item](/manual/config/items/item) or an [item
prototype](/manual/discovery/low_level_discovery#item_prototypes)
configuration, user macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Name (deprecated)|<|yes|
|Item key parameters|<|yes|
|Update interval|<|no|
|Custom intervals|<|no|
|History storage period|<|no|
|Trend storage period|<|no|
|//Calculated item //|<|<|
|<|Formula|yes|
|*Database monitor*|<|<|
|<|Username|yes|
|^|Password|yes|
|^|SQL query|yes|
|//HTTP agent //|<|<|
|<|URL|yes|
|^|Query fields|yes|
|^|Timeout|no|
|^|Request body|yes|
|^|Headers (names and values)|yes|
|^|Required status codes|yes|
|^|HTTP proxy|yes|
|^|HTTP authentication username|yes|
|^|HTTP authentication password|yes|
|^|SSl certificate file|yes|
|^|SSl key file|yes|
|^|SSl key password|yes|
|^|Allowed hosts|yes|
|*JMX agent*|<|<|
|<|JMX endpoint|yes|
|//SNMP agent //|<|<|
|<|SNMP OID|yes|
|//SSH agent //|<|<|
|<|Username|yes|
|^|Public key file|yes|
|^|Private key file|yes|
|^|Password|yes|
|^|Script|yes|
|//TELNET agent //|<|<|
|<|Username|yes|
|^|Password|yes|
|^|Script|yes|
|//Zabbix trapper //|<|<|
|<|Allowed hosts|yes|
|*Preprocessing*|<|<|
|<|Step parameters|yes|
#### Items / item prototypes
In an [item](/manual/config/items/item) or an [item
prototype](/manual/discovery/low_level_discovery#item_prototypes)
configuration, user macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Name (deprecated)|<|yes|
|Item key parameters|<|yes|
|Update interval|<|no|
|Custom intervals|<|no|
|History storage period|<|no|
|Trend storage period|<|no|
|//Calculated item //|<|<|
|<|Formula|yes|
|*Database monitor*|<|<|
|<|Username|yes|
|^|Password|yes|
|^|SQL query|yes|
|//HTTP agent //|<|<|
|<|URL|yes|
|^|Query fields|yes|
|^|Timeout|no|
|^|Request body|yes|
|^|Headers (names and values)|yes|
|^|Required status codes|yes|
|^|HTTP proxy|yes|
|^|HTTP authentication username|yes|
|^|HTTP authentication password|yes|
|^|SSl certificate file|yes|
|^|SSl key file|yes|
|^|SSl key password|yes|
|^|Allowed hosts|yes|
|*JMX agent*|<|<|
|<|JMX endpoint|yes|
|//SNMP agent //|<|<|
|<|SNMP OID|yes|
|//SSH agent //|<|<|
|<|Username|yes|
|^|Public key file|yes|
|^|Private key file|yes|
|^|Password|yes|
|^|Script|yes|
|//TELNET agent //|<|<|
|<|Username|yes|
|^|Password|yes|
|^|Script|yes|
|//Zabbix trapper //|<|<|
|<|Allowed hosts|yes|
|*Preprocessing*|<|<|
|<|Step parameters|yes|
#### Items
The **vmware.eventlog\[\]** item for [VMware
monitoring](/manual/config/items/itemtypes/simple_checks/vmware_keys),
when used with the 'skip' option, e. g.
**vmware.eventlog\[<url>,skip\]** now behaves differently after
being recreated (i.e. previous item removed, new one created with a
different internal ID) - now the internal events cache is reset and only
new events are read. Previously, the skip option would not be enforced
in this scenario.
#### Items
The **vmware.eventlog\[\]** item for [VMware
monitoring](/manual/config/items/itemtypes/simple_checks/vmware_keys),
when used with the 'skip' option, e. g.
**vmware.eventlog\[<url>,skip\]** now behaves differently after
being recreated (i.e. previous item removed, new one created with a
different internal ID) - now the internal events cache is reset and only
new events are read. Previously, the skip option would not be enforced
in this scenario.
#### Items
To configure querying of internal stats on another Zabbix instance, you
may use two items:
- `zabbix[stats,<ip>,<port>]` internal item - for direct remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
- `zabbix.stats[<ip>,<port>]` agent item - for agent-based remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
See also: [Internal items](/manual/config/items/itemtypes/internal),
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
The following diagram illustrates the use of either item depending on
the context.
-  - Server
→ external Zabbix instance (`zabbix[stats,<ip>,<port>]`)
-  - Server →
proxy → external Zabbix instance (`zabbix[stats,<ip>,<port>]`)
-  - Server →
agent → external Zabbix instance (`zabbix.stats[<ip>,<port>]`)
-  - Server →
proxy → agent → external Zabbix instance
(`zabbix.stats[<ip>,<port>]`)
To make sure that the target instance allows querying it by the external
instance, list the address of the external instance in the
'StatsAllowedIP' parameter on the target instance.
#### Items
To configure querying of internal stats on another Zabbix instance, you
may use two items:
- `zabbix[stats,<ip>,<port>]` internal item - for direct remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
- `zabbix.stats[<ip>,<port>]` agent item - for agent-based remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
See also: [Internal items](/manual/config/items/itemtypes/internal),
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
The following diagram illustrates the use of either item depending on
the context.
-  - Server
→ external Zabbix instance (`zabbix[stats,<ip>,<port>]`)
-  - Server →
proxy → external Zabbix instance (`zabbix[stats,<ip>,<port>]`)
-  - Server →
agent → external Zabbix instance (`zabbix.stats[<ip>,<port>]`)
-  - Server →
proxy → agent → external Zabbix instance
(`zabbix.stats[<ip>,<port>]`)
To make sure that the target instance allows querying it by the external
instance, list the address of the external instance in the
'StatsAllowedIP' parameter on the target instance.
#### Items
- Trailing whitespace is no longer allowed after the `maxdelay`
parameter in log\[\], log.count\[\], logrt\[\], logrt.count\[\]
[items](/manual/config/items/itemtypes/zabbix_agent).
#### Items
- Trailing whitespace is no longer allowed after the `maxdelay`
parameter in log\[\], log.count\[\], logrt\[\], logrt.count\[\]
[items](/manual/config/items/itemtypes/zabbix_agent).
# item.update
# item.update
#### Item update interval for unreachable hosts
A bug related to item check time on unreachable hosts has been fixed.
This bug was introduced in Zabbix version 3.4.9 or 4.0.0. Now the item
check period is recalculated based on the UnavailableDelay value, not on
the item update period. This can potentially change unreachable poller
performance. For example, if item previously had a delay of 1h then now
it will be checked based on the UnavailableDelay value, not every 1h as
it was (due to bug). Therefore it is recommended to increase
UnavailableDelay value to avoid possible unreachable poller overload.
#### Item update interval for unreachable hosts
A bug related to item check time on unreachable hosts has been fixed.
This bug was introduced in Zabbix version 3.4.9 or 4.0.0. Now the item
check period is recalculated based on the UnavailableDelay value, not on
the item update period. This can potentially change unreachable poller
performance. For example, if item previously had a delay of 1h then now
it will be checked based on the UnavailableDelay value, not every 1h as
it was (due to bug). Therefore it is recommended to increase
UnavailableDelay value to avoid possible unreachable poller overload.
### Java gateway installation
It is required to install [Java gateway](/manual/concepts/java) only if
you want to monitor JMX applications. Java gateway is lightweight and
does not require a database.
Once the required [repository](#adding_zabbix_repository) is added, you
can install Zabbix Java gateway by running:
# apt install zabbix-java-gateway
Proceed to [setup](/manual/concepts/java/from_debian_ubuntu) for more
details on configuring and running Java gateway.
### Java gateway installation
It is required to install [Java gateway](/manual/concepts/java) only if
you want to monitor JMX applications. Java gateway is lightweight and
does not require a database.
Once the required [repository](#adding_zabbix_repository) is added, you
can install Zabbix Java gateway by running:
# apt install zabbix-java-gateway
Proceed to [setup](/manual/concepts/java/from_debian_ubuntu) for more
details on configuring and running Java gateway.
### Java gateway installation
It is required to install [Java gateway](/manual/concepts/java) only if
you want to monitor JMX applications. Java gateway is lightweight and
does not require a database.
Once the required [repository](#adding_zabbix_repository) is added, you
can install Zabbix Java gateway by running:
# yum install zabbix-java-gateway
Proceed to [setup](/manual/concepts/java/from_rhel_centos) for more
details on configuring and running Java gateway.
### Java gateway installation
It is required to install [Java gateway](/manual/concepts/java) only if
you want to monitor JMX applications. Java gateway is lightweight and
does not require a database.
Once the required [repository](#adding_zabbix_repository) is added, you
can install Zabbix Java gateway by running:
# yum install zabbix-java-gateway
Proceed to [setup](/manual/concepts/java/from_rhel_centos) for more
details on configuring and running Java gateway.
#### Java gateway property file
A new `zabbix.propertiesFile` configuration
[parameter](/manual/appendix/config/zabbix_java) allows to specify a
property file, which can be used to set additional properties in such a
way that they are not visible on a command line or to overwrite existing
ones.
#### Java gateway property file
A new `zabbix.propertiesFile` configuration
[parameter](/manual/appendix/config/zabbix_java) allows to specify a
property file, which can be used to set additional properties in such a
way that they are not visible on a command line or to overwrite existing
ones.
#### JMX monitoring error message
As Zabbix Java gateway now supports working with custom MBeans returning
non-primitive data types, which override the **toString()** method, the
possible error message has been changed the following way:
| | |
|---|---|
|*Previously:*|`data object type is not primitive: xxx`|
|*In Zabbix 4.0:*|`Data object type cannot be converted to string.`|
#### JMX monitoring error message
As Zabbix Java gateway now supports working with custom MBeans returning
non-primitive data types, which override the **toString()** method, the
possible error message has been changed the following way:
| | |
|---|---|
|*Previously:*|`data object type is not primitive: xxx`|
|*In Zabbix 4.0:*|`Data object type cannot be converted to string.`|
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JSONPath preprocessing
Quoted numeric values are now accepted by the JSONPath [aggregate
functions](/manual/appendix/items/jsonpath#functions) (sum, min, max,
etc.) in item value preprocessing. It means that the values are
converted from string type to numeric if aggregation is required.
#### JSONPath preprocessing
Quoted numeric values are now accepted by the JSONPath [aggregate
functions](/manual/appendix/items/jsonpath#functions) (sum, min, max,
etc.) in item value preprocessing. It means that the values are
converted from string type to numeric if aggregation is required.
#### JSONPath
Zabbix implementation of [JSONPath](/manual/appendix/items/jsonpath) now
supports the extraction of matching element names with a `~` suffix. It
returns the name of the matched object or an index in string format of
the matched array item.
#### JSONPath
Zabbix implementation of [JSONPath](/manual/appendix/items/jsonpath) now
supports the extraction of matching element names with a `~` suffix. It
returns the name of the matched object or an index in string format of
the matched array item.
#### Juniper template
The more correct OID of 'jnxOperatingCPU' (1.3.6.1.4.1.2636.3.1.13.1.8)
is now used instead of 'jnxOperating5MinLoadAvg'
(1.3.6.1.4.1.2636.3.1.13.1.21) in these LLD item and trigger prototypes:
- `{#SNMPVALUE}: CPU utilization`
- `{#SNMPVALUE}: High CPU utilization`
in:
- *Template Net Juniper SNMPv2*
#### Juniper template
The more correct OID of 'jnxOperatingCPU' (1.3.6.1.4.1.2636.3.1.13.1.8)
is now used instead of 'jnxOperating5MinLoadAvg'
(1.3.6.1.4.1.2636.3.1.13.1.21) in these LLD item and trigger prototypes:
- `{#SNMPVALUE}: CPU utilization`
- `{#SNMPVALUE}: High CPU utilization`
in:
- *Template Net Juniper SNMPv2*
#### Known issues in 4.0.0 - 4.0.15
- High memory usage has been observed during process startup with
SQLite 3.7.17 on Centos/RHEL 7. The startup process has been
improved in 4.0.16 to avoid similar issues with other databases as
well. See [ZBX-9084](https://support.zabbix.com/browse/ZBX-9084) for
more details.
#### Known issues in 4.0.0 - 4.0.15
- High memory usage has been observed during process startup with
SQLite 3.7.17 on Centos/RHEL 7. The startup process has been
improved in 4.0.16 to avoid similar issues with other databases as
well. See [ZBX-9084](https://support.zabbix.com/browse/ZBX-9084) for
more details.
#### Known issues in 4.0.0, 4.0.1
- Upgrade to 4.0.0 and 4.0.1 from Zabbix 3.0 does not replace
{TRIGGER.NAME} macros to {EVENT.NAME} macros like it should. Fixed
for 4.0.2.
#### Known issues in 4.0.0, 4.0.1
- Upgrade to 4.0.0 and 4.0.1 from Zabbix 3.0 does not replace
{TRIGGER.NAME} macros to {EVENT.NAME} macros like it should. Fixed
for 4.0.2.
#### Known issues in 4.0.0 - 4.0.2
- If the *[Check now](/manual/config/items/check_now)* request is
performed from the item list for items that do not support it
(template items, active agent items, etc.), a 'Request sent
successfully' message is displayed even though the functionality
does not work for these items. Fixed in 4.0.3, by displaying a
corresponding error message.
#### Known issues in 4.0.0 - 4.0.2
- If the *[Check now](/manual/config/items/check_now)* request is
performed from the item list for items that do not support it
(template items, active agent items, etc.), a 'Request sent
successfully' message is displayed even though the functionality
does not work for these items. Fixed in 4.0.3, by displaying a
corresponding error message.
#### Known issues in 4.0.0 - 4.0.3
- Time suffixes do not work in constants of calculated item formulas.
Fixed in 4.0.4.
- [Negative problem
duration](/manual/web_interface/frontend_sections/monitoring/problems#negative_problem_duration)
affects the total result in [SLA calculation](/manual/it_services)
or [Availability
report](/manual/web_interface/frontend_sections/reports/availability),
making it incorrect. Fixed in 4.0.4.
#### Known issues in 4.0.0 - 4.0.3
- Time suffixes do not work in constants of calculated item formulas.
Fixed in 4.0.4.
- [Negative problem
duration](/manual/web_interface/frontend_sections/monitoring/problems#negative_problem_duration)
affects the total result in [SLA calculation](/manual/it_services)
or [Availability
report](/manual/web_interface/frontend_sections/reports/availability),
making it incorrect. Fixed in 4.0.4.
#### Known issues in 4.0.0 - 4.0.5
- `net.dns[]` Zabbix agent
[item](/manual/config/items/itemtypes/zabbix_agent) does not support
IPv6 addresses in its first parameter. Fixed in 4.0.6.
#### Known issues in 4.0.0 - 4.0.5
- `net.dns[]` Zabbix agent
[item](/manual/config/items/itemtypes/zabbix_agent) does not support
IPv6 addresses in its first parameter. Fixed in 4.0.6.
#### Known issues in 4.0.0
- Fullscreen mode for the dashboards cannot be accessed with the
respective URL parameter:
`/zabbix.php?action=dashboard.view&fullscreen=1`. Fixed in 4.0.1.
- When filtering triggers in *Monitoring* → *Overview* (Triggers),
trigger severity instead of problem severity is taken into account.
#### Known issues in 4.0.0
- Fullscreen mode for the dashboards cannot be accessed with the
respective URL parameter:
`/zabbix.php?action=dashboard.view&fullscreen=1`. Fixed in 4.0.1.
- When filtering triggers in *Monitoring* → *Overview* (Triggers),
trigger severity instead of problem severity is taken into account.
#### Known issues in 4.0.2
- Parent host group selection does not work in the following
locations:
- *Monitoring* → *Problems* filter
- *Monitoring* → *Dashboard* widgets with host group selection:
- *Reports* → *Triggers top 100* filter
#### Known issues in 4.0.2
- Parent host group selection does not work in the following
locations:
- *Monitoring* → *Problems* filter
- *Monitoring* → *Dashboard* widgets with host group selection:
- *Reports* → *Triggers top 100* filter
#### Known issues in 4.0.3
- If an item is deleted that has a low-level discovery created
trigger, the trigger is not deleted. This leads to "orphaned"
problems (with no item/host) being displayed in the problem view.
Similarly, if an item is deleted that has low-level discovery
created dependent item, the dependent item is not deleted. Fixed in
4.0.4.
#### Known issues in 4.0.3
- If an item is deleted that has a low-level discovery created
trigger, the trigger is not deleted. This leads to "orphaned"
problems (with no item/host) being displayed in the problem view.
Similarly, if an item is deleted that has low-level discovery
created dependent item, the dependent item is not deleted. Fixed in
4.0.4.
#### Known issues in 4.0.6, 4.0.7
- IPMI pollers are unable to process more than 60 items per minute.
Fixed in 4.0.8.
- You may encounter the issue of 100% CPU usage by IPMI pollers if
using OpenIPMI version 2.0.26 and above. Fixed in 4.0.8.
#### Known issues in 4.0.6, 4.0.7
- IPMI pollers are unable to process more than 60 items per minute.
Fixed in 4.0.8.
- You may encounter the issue of 100% CPU usage by IPMI pollers if
using OpenIPMI version 2.0.26 and above. Fixed in 4.0.8.
#### Known issues in 4.0.8
- This version requires *write* permissions to the `assets` directory
for the web server user. This requirement, however, would break
those installations of the frontend where the web server has no
write permissions to the document root (see
[ZBX-16180](https://support.zabbix.com/browse/ZBX-16180) for
details). As a result, this requirement is rolled back in 4.0.9.
#### Known issues in 4.0.8
- This version requires *write* permissions to the `assets` directory
for the web server user. This requirement, however, would break
those installations of the frontend where the web server has no
write permissions to the document root (see
[ZBX-16180](https://support.zabbix.com/browse/ZBX-16180) for
details). As a result, this requirement is rolled back in 4.0.9.
#### Known issues
See [known issues](/manual/installation/known_issues#graphs) for graphs.
#### Known issues
See [known issues](/manual/installation/known_issues#graphs) for graphs.
#### Known issues starting with 4.0.3
- Failed login attempt message has been changed to display only the
first 39 characters of a stored IP address as that's the character
limit in the database field. That means that IPv6 IP addresses
longer than 39 characters will be shown incompletely.
#### Known issues starting with 4.0.3
- Failed login attempt message has been changed to display only the
first 39 characters of a stored IP address as that's the character
limit in the database field. That means that IPv6 IP addresses
longer than 39 characters will be shown incompletely.
#### LDAP authentication with anonymous bind
Anonymous bind is now supported in LDAP authentication.
#### LDAP authentication with anonymous bind
Anonymous bind is now supported in LDAP authentication.
#### Leading and trailing spaces disallowed in host names
Leading and trailing spaces are no longer allowed in host and template
names.
#### Leading and trailing spaces disallowed in host names
Leading and trailing spaces are no longer allowed in host and template
names.
#### libssh support
Support of the libssh library (starting from version 0.6.0) has been
added. Previously only libssh2 was supported for SSH checks.
#### libssh support
Support of the libssh library (starting from version 0.6.0) has been
added. Previously only libssh2 was supported for SSH checks.
#### License update for linking with OpenSSL
Exception has been added to the license giving permission that the code
of Zabbix is linked with the OpenSSL project OpenSSL library (see README
file in Zabbix source code).
#### License update for linking with OpenSSL
Exception has been added to the license giving permission that the code
of Zabbix is linked with the OpenSSL project OpenSSL library (see README
file in Zabbix source code).
#### Linking elements
Once you have put some elements on the map, it is time to start linking
them. To link two elements you must first select them. With the elements
selected, click on *Add* next to Link.
With a link created, the single element form now contains an additional
*Links* section. Click on *Edit* to edit link attributes.
{width="600"}
Link attributes:
|Parameter|Description|
|---------|-----------|
|*Label*|Label that will be rendered on top of the link.<br>The [{host:key.func(param)}](/manual/appendix/macros/supported_by_location) macro is supported in this field, but only with `avg`, `last`, `min` and `max` trigger functions, with seconds as parameter.|
|*Connect to*|The element that the link connects to.|
|*Type (OK)*|Default link style:<br>**Line** - single line<br>**Bold line** - bold line<br>**Dot** - dots<br>**Dashed line** - dashed line|
|*Color (OK)*|Default link color.|
|*[Link indicators](links)*|List of triggers linked to the link. In case a trigger has status PROBLEM, its style is applied to the link.|
#### Linking elements
Once you have put some elements on the map, it is time to start linking
them. To link two elements you must first select them. With the elements
selected, click on *Add* next to Link.
With a link created, the single element form now contains an additional
*Links* section. Click on *Edit* to edit link attributes.
{width="600"}
Link attributes:
|Parameter|Description|
|---------|-----------|
|*Label*|Label that will be rendered on top of the link.<br>The [{host:key.func(param)}](/manual/appendix/macros/supported_by_location) macro is supported in this field, but only with `avg`, `last`, `min` and `max` trigger functions, with seconds as parameter.|
|*Connect to*|The element that the link connects to.|
|*Type (OK)*|Default link style:<br>**Line** - single line<br>**Bold line** - bold line<br>**Dot** - dots<br>**Dashed line** - dashed line|
|*Color (OK)*|Default link color.|
|*[Link indicators](links)*|List of triggers linked to the link. In case a trigger has status PROBLEM, its style is applied to the link.|
#### Locale
Note that the proxy requires a UTF-8 locale so that some textual items
can be interpreted correctly. Most modern Unix-like systems have a UTF-8
locale as default, however, there are some systems where that may need
to be set specifically.
#### Locale
Note that the proxy requires a UTF-8 locale so that some textual items
can be interpreted correctly. Most modern Unix-like systems have a UTF-8
locale as default, however, there are some systems where that may need
to be set specifically.
#### Locale
Note that the server requires a UTF-8 locale so that some textual items
can be interpreted correctly. Most modern Unix-like systems have a UTF-8
locale as default, however, there are some systems where that may need
to be set specifically.
#### Locale
Note that the server requires a UTF-8 locale so that some textual items
can be interpreted correctly. Most modern Unix-like systems have a UTF-8
locale as default, however, there are some systems where that may need
to be set specifically.
#### Log file monitoring
`log[]` and `logrt[]` items repeatedly reread log file from the
beginning if file system is 100% full and the log file is being appended
(see [ZBX-10884](https://support.zabbix.com/browse/ZBX-10884) for more
information).
#### Log file monitoring
`log[]` and `logrt[]` items repeatedly reread log file from the
beginning if file system is 100% full and the log file is being appended
(see [ZBX-10884](https://support.zabbix.com/browse/ZBX-10884) for more
information).
#### Logging changes
The message printed to the log files about a full history cache has been
changed the following way:
| | |
|---|---|
|*Previously:*|`History buffer is full. Sleeping for 1 second.`|
|*In Zabbix 4.0:*|`History cache is full. Sleeping for 1 second.`|
#### Logging changes
The message printed to the log files about a full history cache has been
changed the following way:
| | |
|---|---|
|*Previously:*|`History buffer is full. Sleeping for 1 second.`|
|*In Zabbix 4.0:*|`History cache is full. Sleeping for 1 second.`|
### Logging
- Zabbix Java gateway logs are now easier to read, as exception stack
trace is no longer available in error and warning level messages.
### Logging
- Zabbix Java gateway logs are now easier to read, as exception stack
trace is no longer available in error and warning level messages.
#### Log items
Two new options have been added to the `log`, `log.count`, `logrt` and
`logrt.count` [items](/manual/config/items/itemtypes/zabbix_agent):
- *mtime-reread* - non-unique records, reread file if its modification
time changes but size does not
- *mtime-noreread* - non-unique records, do not reread file if its
modification time changes but size does not
For `log` and `log.count` items these options have been added as a new
<options> parameter, e.g.
log[file,<regexp>,<encoding>,<maxlines>,<mode>,<output>,<maxdelay>,<options>]
For `logrt` and `logrt.count` these options have been added to the
already existing <options> parameter.
#### Log items
Two new options have been added to the `log`, `log.count`, `logrt` and
`logrt.count` [items](/manual/config/items/itemtypes/zabbix_agent):
- *mtime-reread* - non-unique records, reread file if its modification
time changes but size does not
- *mtime-noreread* - non-unique records, do not reread file if its
modification time changes but size does not
For `log` and `log.count` items these options have been added as a new
<options> parameter, e.g.
log[file,<regexp>,<encoding>,<maxlines>,<mode>,<output>,<maxdelay>,<options>]
For `logrt` and `logrt.count` these options have been added to the
already existing <options> parameter.
##### Low-level discovery rule
Create a low-level discovery rule using the in-built discovery key:
vfs.fs.discovery
This discovery rule will return discovery macros such as {\#FSNAME},
{\#FSTYPE} that can be used in creating item prototypes.
##### Low-level discovery rule
Create a low-level discovery rule using the in-built discovery key:
vfs.fs.discovery
This discovery rule will return discovery macros such as {\#FSNAME},
{\#FSTYPE} that can be used in creating item prototypes.
#### Macros
A new {EVENT.RECOVERY.NAME} macro is supported, returning the recovery
event name.
{TRIGGER.ID} macro is now supported in trigger tag values. It may be
useful for identifying triggers created from trigger prototypes and, for
example, suppressing problems from these triggers during maintenance.
#### Macros
A new {EVENT.RECOVERY.NAME} macro is supported, returning the recovery
event name.
{TRIGGER.ID} macro is now supported in trigger tag values. It may be
useful for identifying triggers created from trigger prototypes and, for
example, suppressing problems from these triggers during maintenance.
#### Macros
- Host macros: {HOST.HOST}, {HOST.NAME}, {HOST.IP}, {HOST.DNS},
{HOST.CONN} are now supported in trapper/HTTP agent item "Allowed
hosts" field in the frontend (also "trapper\_hosts" property in
API).
#### Macros
- Host macros: {HOST.HOST}, {HOST.NAME}, {HOST.IP}, {HOST.DNS},
{HOST.CONN} are now supported in trapper/HTTP agent item "Allowed
hosts" field in the frontend (also "trapper\_hosts" property in
API).
### Macros
- {ITEM.VALUE}, {ITEM.LASTVALUE} are now supported in the URL field of
trigger [configuration](/manual/config/triggers/trigger).
### Macros
- {ITEM.VALUE}, {ITEM.LASTVALUE} are now supported in the URL field of
trigger [configuration](/manual/config/triggers/trigger).
#### Macro support
The following macros may be used in event tags:
- {ITEM.VALUE}, {ITEM.LASTVALUE}, {HOST.HOST}, {HOST.NAME},
{HOST.CONN}, {HOST.DNS}, {HOST.IP}, {HOST.PORT} and {HOST.ID} macros
can be used to populate the tag name or tag value.
- {INVENTORY.\*}
[macros](/manual/appendix/macros/supported_by_location) can be used
to reference host inventory values from one or several hosts in a
trigger expression (supported since 4.0.0).
- [User macros](/manual/config/macros/usermacros) and user macro
context is supported for the tag name/value. User macro context may
include low-level discovery macros.
- Low-level discovery macros can be used for the tag name/value in
trigger prototypes.
{EVENT.TAGS} and {EVENT.RECOVERY.TAGS} macros can be used in
trigger-based notifications and they will resolve to a comma separated
list of event tags or recovery event tags.
#### Macro support
The following macros may be used in event tags:
- {ITEM.VALUE}, {ITEM.LASTVALUE}, {HOST.HOST}, {HOST.NAME},
{HOST.CONN}, {HOST.DNS}, {HOST.IP}, {HOST.PORT} and {HOST.ID} macros
can be used to populate the tag name or tag value.
- {INVENTORY.\*}
[macros](/manual/appendix/macros/supported_by_location) can be used
to reference host inventory values from one or several hosts in a
trigger expression (supported since 4.0.0).
- [User macros](/manual/config/macros/usermacros) and user macro
context is supported for the tag name/value. User macro context may
include low-level discovery macros.
- Low-level discovery macros can be used for the tag name/value in
trigger prototypes.
{EVENT.TAGS} and {EVENT.RECOVERY.TAGS} macros can be used in
trigger-based notifications and they will resolve to a comma separated
list of event tags or recovery event tags.
#### Maintenance and Daylight Saving Time
In previous Zabbix versions, maintenance period calculation was unaware
of the possible effects caused by Daylight Saving Time change resulting
in unpredictable behaviours. In the new version Daylight Saving Time
(DST) change is cared for and should not unpredictably affect how long
the maintenance will be. Let's say we have a two-hour maintenance that
usually starts at 1am and finishes at 3am. If after one hour of
maintenance (at 2am) a DST change happens and current time changes from
2:00 to 3:00, the maintenance will continue for one more hour till 4:00.
#### Maintenance and Daylight Saving Time
In previous Zabbix versions, maintenance period calculation was unaware
of the possible effects caused by Daylight Saving Time change resulting
in unpredictable behaviours. In the new version Daylight Saving Time
(DST) change is cared for and should not unpredictably affect how long
the maintenance will be. Let's say we have a two-hour maintenance that
usually starts at 1am and finishes at 3am. If after one hour of
maintenance (at 2am) a DST change happens and current time changes from
2:00 to 3:00, the maintenance will continue for one more hour till 4:00.
# maintenance.create
# maintenance.create
# maintenance.delete
# maintenance.delete
# maintenance.get
# maintenance.get
#### Maintenance icon in host list
An orange wrench icon
next to the host status now indicates that this host is in maintenance
in *Configuration → Hosts*. Maintenance details are displayed when the
mouse pointer is positioned over the icon:
Previously, an orange *In maintenance* string was displayed as status
instead of the icon.
#### Maintenance icon in host list
An orange wrench icon
next to the host status now indicates that this host is in maintenance
in *Configuration → Hosts*. Maintenance details are displayed when the
mouse pointer is positioned over the icon:
Previously, an orange *In maintenance* string was displayed as status
instead of the icon.
# maintenance.update
# maintenance.update
#### Manual closing of problems
When [updating a problem](/manual/acknowledges#updating_problems), the
checkbox for closing a problem is now available if the *Allow manual
close* option is checked in [trigger
configuration](/manual/config/triggers/trigger) for at least one of the
selected problems. Only those problems will be closed that are allowed
to be closed when clicking on *Update*. Already closed problems will not
be closed repeatedly. If no problem is manually closeable, the checkbox
is disabled.
Previously, closing a problem in this way was only possible if the
*Allow manual close* option was checked in [trigger
configuration](/manual/config/triggers/trigger) for each selected
problem. If at least one problem was not manually closeable, the
checkbox was disabled.
Similarly, when changing problem severity the relevant checkbox is now
available if at least one selected problem is read-writable. Previously
each selected problem had to be read-writable, otherwise the checkbox
was disabled.
#### Manual closing of problems
When [updating a problem](/manual/acknowledges#updating_problems), the
checkbox for closing a problem is now available if the *Allow manual
close* option is checked in [trigger
configuration](/manual/config/triggers/trigger) for at least one of the
selected problems. Only those problems will be closed that are allowed
to be closed when clicking on *Update*. Already closed problems will not
be closed repeatedly. If no problem is manually closeable, the checkbox
is disabled.
Previously, closing a problem in this way was only possible if the
*Allow manual close* option was checked in [trigger
configuration](/manual/config/triggers/trigger) for each selected
problem. If at least one problem was not manually closeable, the
checkbox was disabled.
Similarly, when changing problem severity the relevant checkbox is now
available if at least one selected problem is read-writable. Previously
each selected problem had to be read-writable, otherwise the checkbox
was disabled.
#### Map lines
Create a map line.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map API lines",
"width": 500,
"height": 500,
"lines": [
{
"x1": 30,
"y1": 10,
"x2": 100,
"y2": 50,
"line_type": 1,
"line_width": 10,
"line_color": "009900"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"11"
]
},
"id": 1
}
```
#### Map lines
Create a map line.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map API lines",
"width": 500,
"height": 500,
"lines": [
{
"x1": 30,
"y1": 10,
"x2": 100,
"y2": 50,
"line_type": 1,
"line_width": 10,
"line_color": "009900"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"11"
]
},
"id": 1
}
```
#### MariaDB row size error
Prior to MariaDB 10.2.26, 10.3.17, and 10.4.7, MariaDB didn't properly
calculate the row sizes while executing DDL, so "unsafe" tables could be
created, even with `innodb_strict_mode=ON` set. This was fixed by
[MDEV-19292](https://jira.mariadb.org/browse/MDEV-19292). As a side
effect, tables that could be created in previous versions may get
rejected after the latest releases.
Suggested database changes for existing 4.0 installations:
shell> mysql -uroot -p<password>
mysql> alter table `host_inventory` modify `name` varchar(128) default '' not null, modify `alias` varchar(128) default '' not null, modify `os` varchar(128) default '' not null, modify `os_short` varchar(128) default '' not null;
Suggested database changes for new 4.0 installations:
shell> mysql -uroot -p<password>
mysql> set global innodb_strict_mode='OFF';
Perform database creation as usual and fix schema after:
shell> mysql -uroot -p<password>
mysql> alter table `host_inventory` modify `name` varchar(128) default '' not null, modify `alias` varchar(128) default '' not null, modify `os` varchar(128) default '' not null, modify `os_short` varchar(128) default '' not null;
mysql> set global innodb_strict_mode='ON';
#### MariaDB row size error
Prior to MariaDB 10.2.26, 10.3.17, and 10.4.7, MariaDB didn't properly
calculate the row sizes while executing DDL, so "unsafe" tables could be
created, even with `innodb_strict_mode=ON` set. This was fixed by
[MDEV-19292](https://jira.mariadb.org/browse/MDEV-19292). As a side
effect, tables that could be created in previous versions may get
rejected after the latest releases.
Suggested database changes for existing 4.0 installations:
shell> mysql -uroot -p<password>
mysql> alter table `host_inventory` modify `name` varchar(128) default '' not null, modify `alias` varchar(128) default '' not null, modify `os` varchar(128) default '' not null, modify `os_short` varchar(128) default '' not null;
Suggested database changes for new 4.0 installations:
shell> mysql -uroot -p<password>
mysql> set global innodb_strict_mode='OFF';
Perform database creation as usual and fix schema after:
shell> mysql -uroot -p<password>
mysql> alter table `host_inventory` modify `name` varchar(128) default '' not null, modify `alias` varchar(128) default '' not null, modify `os` varchar(128) default '' not null, modify `os_short` varchar(128) default '' not null;
mysql> set global innodb_strict_mode='ON';
##### Master item
Create a Zabbix agent item using the following key:
vfs.fs.get
Set the type of information to "Text" for possibly big JSON data.
The data returned by this item will contain something like the following
for a mounted filesystem:
``` {.java}
{
"fsname": "/",
"fstype": "rootfs",
"bytes": {
"total": 1000,
"free": 500,
"used": 500,
"pfree": 50.00,
"pused": 50.00
},
"inodes": {
"total": 1000,
"free": 500,
"used": 500,
"pfree": 50.00,
"pused": 50.00
}
}
```
##### Master item
Create a Zabbix agent item using the following key:
vfs.fs.get
Set the type of information to "Text" for possibly big JSON data.
The data returned by this item will contain something like the following
for a mounted filesystem:
``` {.java}
{
"fsname": "/",
"fstype": "rootfs",
"bytes": {
"total": 1000,
"free": 500,
"used": 500,
"pfree": 50.00,
"pused": 50.00
},
"inodes": {
"total": 1000,
"free": 500,
"used": 500,
"pfree": 50.00,
"pused": 50.00
}
}
```
#### Miscellaneous
- Command line arguments that exceed 2KB are now supported in proc.num
and proc.mem checks on AIX platform.
#### Miscellaneous
- Command line arguments that exceed 2KB are now supported in proc.num
and proc.mem checks on AIX platform.
#### Miscellaneous
- The allowed character limit has been raised from 63 to 255 ASCII
characters for fields containing DNS names. The affected forms are
host configuration and passive proxy configuration.
- When importing maps (*Monitoring* → *Maps* → *Import* button) the
*Create new* option for importing images is now checked by default:
#### Miscellaneous
- The allowed character limit has been raised from 63 to 255 ASCII
characters for fields containing DNS names. The affected forms are
host configuration and passive proxy configuration.
- When importing maps (*Monitoring* → *Maps* → *Import* button) the
*Create new* option for importing images is now checked by default:
#### Modification time ignored in log, log.count items
File modification time is now ignored in log and log.count
[items](/manual/config/items/itemtypes/zabbix_agent).
#### Modification time ignored in log, log.count items
File modification time is now ignored in log and log.count
[items](/manual/config/items/itemtypes/zabbix_agent).
#### Monitoring → Problems
The following parameters are supported:
- `sort` - sort column: clock, host, severity, name
- `sortorder` - sort order or results: DESC - descending, ASC -
ascending
- `filter_set` - should be 'filter\_set=1' to use "filter\_\*"
parameters
- `filter_rst` - should be 'filter\_rst=1' to reset filter elements
- `filter_show` - filter option "Show": 1 - recent problems, 2 - all,
3 - in problem state
- `filter_groupids` - filter option "Host groups": array of host
groups IDs
- `filter_hostids` - filter option "Hosts": array of host IDs
- `filter_application` - filter option "Application": freeform string
- `filter_triggerids` - filter option "Triggers": array of trigger IDs
- `filter_name` - filter option "Problem": freeform string
- `filter_severity` - filter option "Minimum severity": 0 - not
classified, 1 - information, 2 - warning, 3 - average, 4 - high, 5 -
disaster
- `filter_age_state` - filter option "Age less than": should be
'filter\_age\_state=1' to enable 'filter\_age'. Is used only when
'filter\_show' equals 3.
- `filter_age` - filter option "Age less than": days
- `filter_inventory` - filter option "Host inventory": array of
inventory fields: \[field\], \[value\]
- `filter_evaltype` - filter option "Tags", tag filtering strategy:
0 - And/Or, 2 - Or
- `filter_tags` - filter option "Tags": array of defined tags:
\[tag\], \[operator\], \[value\]
- `filter_show_tags` - filter option "Show tags": 0 - none, 1 - one,
2 - two, 3 - three
- `filter_tag_name_format` - filter option "Tag name": 0 - full name,
1 - shortened, 2 - none
- `filter_tag_priority` - filter option "Tag display priority":
comma-separated string of tag display priority
- `filter_show_suppressed` - filter option "Show suppressed problems":
should be 'filter\_show\_suppressed=1' to show
- `filter_unacknowledged` - filter option "Show unacknowledged only":
should be 'filter\_unacknowledged=1' to show
- `filter_compact_view` - filter option "Compact view": should be
'filter\_compact\_view=1' to show
- `filter_show_timeline` - filter option "Show timeline": should be
'filter\_show\_timeline=1' to show
- `filter_details` - filter option "Show details": should be
'filter\_details=1' to show
- `filter_highlight_row` - filter option "Highlight whole row" (use
problem color as background color for every problem row): should be
'1' to highlight; can be set only when 'filter\_compact\_view' is
set
- `from` - date range start, can be 'relative' (e.g.: now-1m)
- `to` - date range end, can be 'relative' (e.g.: now-1m)
#### Monitoring → Problems
The following parameters are supported:
- `sort` - sort column: clock, host, severity, name
- `sortorder` - sort order or results: DESC - descending, ASC -
ascending
- `filter_set` - should be 'filter\_set=1' to use "filter\_\*"
parameters
- `filter_rst` - should be 'filter\_rst=1' to reset filter elements
- `filter_show` - filter option "Show": 1 - recent problems, 2 - all,
3 - in problem state
- `filter_groupids` - filter option "Host groups": array of host
groups IDs
- `filter_hostids` - filter option "Hosts": array of host IDs
- `filter_application` - filter option "Application": freeform string
- `filter_triggerids` - filter option "Triggers": array of trigger IDs
- `filter_name` - filter option "Problem": freeform string
- `filter_severity` - filter option "Minimum severity": 0 - not
classified, 1 - information, 2 - warning, 3 - average, 4 - high, 5 -
disaster
- `filter_age_state` - filter option "Age less than": should be
'filter\_age\_state=1' to enable 'filter\_age'. Is used only when
'filter\_show' equals 3.
- `filter_age` - filter option "Age less than": days
- `filter_inventory` - filter option "Host inventory": array of
inventory fields: \[field\], \[value\]
- `filter_evaltype` - filter option "Tags", tag filtering strategy:
0 - And/Or, 2 - Or
- `filter_tags` - filter option "Tags": array of defined tags:
\[tag\], \[operator\], \[value\]
- `filter_show_tags` - filter option "Show tags": 0 - none, 1 - one,
2 - two, 3 - three
- `filter_tag_name_format` - filter option "Tag name": 0 - full name,
1 - shortened, 2 - none
- `filter_tag_priority` - filter option "Tag display priority":
comma-separated string of tag display priority
- `filter_show_suppressed` - filter option "Show suppressed problems":
should be 'filter\_show\_suppressed=1' to show
- `filter_unacknowledged` - filter option "Show unacknowledged only":
should be 'filter\_unacknowledged=1' to show
- `filter_compact_view` - filter option "Compact view": should be
'filter\_compact\_view=1' to show
- `filter_show_timeline` - filter option "Show timeline": should be
'filter\_show\_timeline=1' to show
- `filter_details` - filter option "Show details": should be
'filter\_details=1' to show
- `filter_highlight_row` - filter option "Highlight whole row" (use
problem color as background color for every problem row): should be
'1' to highlight; can be set only when 'filter\_compact\_view' is
set
- `from` - date range start, can be 'relative' (e.g.: now-1m)
- `to` - date range end, can be 'relative' (e.g.: now-1m)
#### Moving and copy-pasting elements
Several selected elements can be **moved** to another place in the map
by clicking on one of the selected elements, holding down the mouse
button and moving the cursor to the desired location.
One or more elements can be **copied** by selecting the elements, then
clicking on a selected element with the right mouse button and selecting
*Copy* from the menu.
{width="600"}
To paste the elements, click on a map area with the right mouse button
and select *Paste* from the menu. The *Paste without external links*
option will paste the elements retaining only the links that are between
the selected elements.
Copy-pasting works within the same browser window. Keyboard shortcuts
are not supported.
#### Moving and copy-pasting elements
Several selected elements can be **moved** to another place in the map
by clicking on one of the selected elements, holding down the mouse
button and moving the cursor to the desired location.
One or more elements can be **copied** by selecting the elements, then
clicking on a selected element with the right mouse button and selecting
*Copy* from the menu.
{width="600"}
To paste the elements, click on a map area with the right mouse button
and select *Paste* from the menu. The *Paste without external links*
option will paste the elements retaining only the links that are between
the selected elements.
Copy-pasting works within the same browser window. Keyboard shortcuts
are not supported.
#### MySQL
- CR\_CONN\_HOST\_ERROR
- CR\_SERVER\_GONE\_ERROR
- CR\_CONNECTION\_ERROR
- CR\_SERVER\_LOST
- CR\_UNKNOWN\_HOST
- ER\_SERVER\_SHUTDOWN
- ER\_ACCESS\_DENIED\_ERROR
- ER\_ILLEGAL\_GRANT\_FOR\_TABLE
- ER\_TABLEACCESS\_DENIED\_ERROR
- ER\_UNKNOWN\_ERROR
#### MySQL
- CR\_CONN\_HOST\_ERROR
- CR\_SERVER\_GONE\_ERROR
- CR\_CONNECTION\_ERROR
- CR\_SERVER\_LOST
- CR\_UNKNOWN\_HOST
- ER\_SERVER\_SHUTDOWN
- ER\_ACCESS\_DENIED\_ERROR
- ER\_ILLEGAL\_GRANT\_FOR\_TABLE
- ER\_TABLEACCESS\_DENIED\_ERROR
- ER\_UNKNOWN\_ERROR
#### MySQL custom error codes
If Zabbix is used with MySQL installation on Azure, an unclear error
message *\[9002\] Some errors occurred* may appear in Zabbix logs. This
generic error text is sent to Zabbix server or proxy by the database. To
get more information about the cause of the error, check Azure logs.
#### MySQL custom error codes
If Zabbix is used with MySQL installation on Azure, an unclear error
message *\[9002\] Some errors occurred* may appear in Zabbix logs. This
generic error text is sent to Zabbix server or proxy by the database. To
get more information about the cause of the error, check Azure logs.
#### MySQL/MariaDB
**1.** Check the database character set and collation.
For example:
mysql> SELECT @@character_set_database, @@collation_database;
+--------------------------+----------------------+
| @@character_set_database | @@collation_database |
+--------------------------+----------------------+
| utf8mb4 | utf8mb4_general_ci |
+--------------------------+----------------------+
As we see, the character set here is not 'utf8' and collation is not
'utf8\_bin', so we need to fix them.
**2.** Stop Zabbix.
**3.** Create a backup copy of the database!
**4.** Fix the character set and collation on database level:
alter database <your DB name> character set utf8 collate utf8_bin;
Fixed values:
mysql> SELECT @@character_set_database, @@collation_database;
+--------------------------+----------------------+
| @@character_set_database | @@collation_database |
+--------------------------+----------------------+
| utf8 | utf8_bin |
+--------------------------+----------------------+
**5.** Load the
[script](https://support.zabbix.com/secure/attachment/113858/113858_utf8_convert.sql)
to fix character set and collation on table and column level:
mysql <your DB name> < utf8_convert.sql
**6.** Execute the script:
SET @ZABBIX_DATABASE = '<your DB name>';
If MariaDB → set innodb_strict_mode = OFF;
CALL zbx_convert_utf8();
If MariaDB → set innodb_strict_mode = ON;
drop procedure zbx_convert_utf8;
Note that data encoding will be changed on disk. For example, when
converting characters like Æ, Ñ, Ö from 'latin1' to 'utf8' they will go
from 1 byte to 2 bytes. Thus the repaired database may require more
space than before.
**7.** If no errors - you may want to create a database backup copy with
the fixed database.
**8.** Start Zabbix.
#### MySQL/MariaDB
**1.** Check the database character set and collation.
For example:
mysql> SELECT @@character_set_database, @@collation_database;
+--------------------------+----------------------+
| @@character_set_database | @@collation_database |
+--------------------------+----------------------+
| utf8mb4 | utf8mb4_general_ci |
+--------------------------+----------------------+
As we see, the character set here is not 'utf8' and collation is not
'utf8\_bin', so we need to fix them.
**2.** Stop Zabbix.
**3.** Create a backup copy of the database!
**4.** Fix the character set and collation on database level:
alter database <your DB name> character set utf8 collate utf8_bin;
Fixed values:
mysql> SELECT @@character_set_database, @@collation_database;
+--------------------------+----------------------+
| @@character_set_database | @@collation_database |
+--------------------------+----------------------+
| utf8 | utf8_bin |
+--------------------------+----------------------+
**5.** Load the
[script](https://support.zabbix.com/secure/attachment/113858/113858_utf8_convert.sql)
to fix character set and collation on table and column level:
mysql <your DB name> < utf8_convert.sql
**6.** Execute the script:
SET @ZABBIX_DATABASE = '<your DB name>';
If MariaDB → set innodb_strict_mode = OFF;
CALL zbx_convert_utf8();
If MariaDB → set innodb_strict_mode = ON;
drop procedure zbx_convert_utf8;
Note that data encoding will be changed on disk. For example, when
converting characters like Æ, Ñ, Ö from 'latin1' to 'utf8' they will go
from 1 byte to 2 bytes. Thus the repaired database may require more
space than before.
**7.** If no errors - you may want to create a database backup copy with
the fixed database.
**8.** Start Zabbix.
## NAME
zabbix\_agentd - Zabbix agent daemon [ ]{#lbAC}
## NAME
zabbix\_agentd - Zabbix agent daemon [ ]{#lbAC}
## NAME
zabbix\_get - Zabbix get utility [ ]{#lbAC}
## NAME
zabbix\_get - Zabbix get utility [ ]{#lbAC}
## NAME
zabbix\_proxy - Zabbix proxy daemon [ ]{#lbAC}
## NAME
zabbix\_proxy - Zabbix proxy daemon [ ]{#lbAC}
## NAME
zabbix\_sender - Zabbix sender utility [ ]{#lbAC}
## NAME
zabbix\_sender - Zabbix sender utility [ ]{#lbAC}
## NAME
zabbix\_server - Zabbix server daemon [ ]{#lbAC}
## NAME
zabbix\_server - Zabbix server daemon [ ]{#lbAC}
#### Network discovery
In a [network discovery rule](/manual/discovery/network_discovery/rule),
user macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Update interval|<|no|
|*SNMP v1, v2*|<|<|
|<|SNMP community|yes|
|^|SNMP OID|yes|
|*SNMP v3*|<|<|
|<|Context name|yes|
|^|Security name|yes|
|^|Authentication passphrase|yes|
|^|Privacy passphrase|yes|
|^|SNMP OID|yes|
#### Network discovery
In a [network discovery rule](/manual/discovery/network_discovery/rule),
user macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Update interval|<|no|
|*SNMP v1, v2*|<|<|
|<|SNMP community|yes|
|^|SNMP OID|yes|
|*SNMP v3*|<|<|
|<|Context name|yes|
|^|Security name|yes|
|^|Authentication passphrase|yes|
|^|Privacy passphrase|yes|
|^|SNMP OID|yes|
#### New Cisco UCS server template
A Cisco UCS server monitoring template - *Template Server Cisco UCS
SNMPv2* has been added.
It will be available in *Configuration* → *Templates* in new
installations. If you are upgrading from previous versions, you can find
this template in the `templates` directory of the downloaded latest
Zabbix version. Then, while in *Configuration* → *Templates* you can
import it manually into Zabbix.
#### New Cisco UCS server template
A Cisco UCS server monitoring template - *Template Server Cisco UCS
SNMPv2* has been added.
It will be available in *Configuration* → *Templates* in new
installations. If you are upgrading from previous versions, you can find
this template in the `templates` directory of the downloaded latest
Zabbix version. Then, while in *Configuration* → *Templates* you can
import it manually into Zabbix.
#### New items
A new `vfs.fs.get` agent item has been added that returns a JSON with
filesystem data including such details as the mountpoint name,
mountpoint type, filesystem size and inode metrics.
See a [working
example](/manual/discovery/low_level_discovery/mounted_filesystems) of
how this item can be used in discovery.
#### New items
A new `vfs.fs.get` agent item has been added that returns a JSON with
filesystem data including such details as the mountpoint name,
mountpoint type, filesystem size and inode metrics.
See a [working
example](/manual/discovery/low_level_discovery/mounted_filesystems) of
how this item can be used in discovery.
##### New templates
New templates are also available for remote Zabbix server or proxy
internal metric monitoring:
- Template App Remote Zabbix server
- Template App Remote Zabbix proxy
Note that in order to use a template for remote monitoring of multiple
external instances, a separate host is required for each external
instance monitoring.
##### New templates
New templates are also available for remote Zabbix server or proxy
internal metric monitoring:
- Template App Remote Zabbix server
- Template App Remote Zabbix proxy
Note that in order to use a template for remote monitoring of multiple
external instances, a separate host is required for each external
instance monitoring.
#### New templates
New templates are available for monitoring some IBM, Dell, HP, Cisco UCS
and Supermicro Aten hardware:
- Template Server IBM IMM SNMPv1/2
- Template Server Dell iDRAC SNMPv2
- Template Server HP iLO SNMPv2
- Template Server Supermicro Aten SNMPv2
- Template Server Cisco UCS SNMPv2
These templates are part of the default Zabbix dataset for new
installations. If you are upgrading from previous versions, you can
import these templates manually.
#### New templates
New templates are available for monitoring some IBM, Dell, HP, Cisco UCS
and Supermicro Aten hardware:
- Template Server IBM IMM SNMPv1/2
- Template Server Dell iDRAC SNMPv2
- Template Server HP iLO SNMPv2
- Template Server Supermicro Aten SNMPv2
- Template Server Cisco UCS SNMPv2
These templates are part of the default Zabbix dataset for new
installations. If you are upgrading from previous versions, you can
import these templates manually.
#### New templates
New templates are available for [remote
monitoring](/manual/appendix/items/remote_stats) of Zabbix server or
proxy internal metrics from an external instance:
- Template App Remote Zabbix server
- Template App Remote Zabbix proxy
Note that in order to use a template for remote monitoring of multiple
external instances, a separate host is required for each external
instance monitoring.
#### New templates
New templates are available for [remote
monitoring](/manual/appendix/items/remote_stats) of Zabbix server or
proxy internal metrics from an external instance:
- Template App Remote Zabbix server
- Template App Remote Zabbix proxy
Note that in order to use a template for remote monitoring of multiple
external instances, a separate host is required for each external
instance monitoring.
#### Non-root permissions implemented for Docker images
Zabbix Docker images have been updated to implement non-root container
best practices. Due to the change:
- All directories have been restricted for the container user, except
directories which are required for the container. For example,
/etc/zabbix/ with Zabbix component configuration files.
- Ports 80 and 443 have been changed to 8080 and 8443, because usage
of all ports <1024 is restricted for non-privileged users. Zabbix
web interface images have been updated to use non-privileged ports
8080, 8443; Zabbix snmptrap images port 1162.
- All Zabbix images are updated to use a non-privileged user. By
default, 'zabbix' with UID 1997.
A known issue: Nginx based images do not run under root. Will be fixed
soon.
#### Non-root permissions implemented for Docker images
Zabbix Docker images have been updated to implement non-root container
best practices. Due to the change:
- All directories have been restricted for the container user, except
directories which are required for the container. For example,
/etc/zabbix/ with Zabbix component configuration files.
- Ports 80 and 443 have been changed to 8080 and 8443, because usage
of all ports <1024 is restricted for non-privileged users. Zabbix
web interface images have been updated to use non-privileged ports
8080, 8443; Zabbix snmptrap images port 1162.
- All Zabbix images are updated to use a non-privileged user. By
default, 'zabbix' with UID 1997.
A known issue: Nginx based images do not run under root. Will be fixed
soon.
::: noteclassic
This blank page is needed for the parent page to be
displayed as folder.
:::
::: noteclassic
This blank page is needed for the parent page to be
displayed as folder.
:::
::: noteclassic
This blank page is needed for the parent page to be
displayed as folder.
:::
::: noteclassic
This blank page is needed for the parent page to be
displayed as folder.
:::
::: noteclassic
This blank page is needed for the parent page to be
displayed as folder.
:::
::: noteclassic
This blank page is needed for the parent page to be
displayed as folder.
:::
#### One side connects with PSK but other side uses LibreSSL or has been compiled without encryption support
LibreSSL does not support PSK.
In connecting-side log:
...TCP successful, cannot establish TLS to [[192.168.1.2]:10050]: SSL_connect() I/O error: [0] Success
In accepting-side log:
...failed to accept an incoming connection: from 192.168.1.2: support for PSK was not compiled in
In Zabbix frontend:
Get value from agent failed: TCP successful, cannot establish TLS to [[192.168.1.2]:10050]: SSL_connect() I/O error: [0] Success
#### One side connects with PSK but other side uses LibreSSL or has been compiled without encryption support
LibreSSL does not support PSK.
In connecting-side log:
...TCP successful, cannot establish TLS to [[192.168.1.2]:10050]: SSL_connect() I/O error: [0] Success
In accepting-side log:
...failed to accept an incoming connection: from 192.168.1.2: support for PSK was not compiled in
In Zabbix frontend:
Get value from agent failed: TCP successful, cannot establish TLS to [[192.168.1.2]:10050]: SSL_connect() I/O error: [0] Success
#### One side connects with PSK but other side uses OpenSSL with PSK support disabled
In connecting-side log:
...TCP successful, cannot establish TLS to [[192.168.1.2]:10050]: SSL_connect() set result code to SSL_ERROR_SSL: file ../ssl/record/rec_layer_s3.c line 1536: error:14094410:SSL routines:ssl3_read_bytes:sslv3 alert handshake failure: SSL alert number 40: TLS read fatal alert "handshake failure"
In accepting-side log:
...failed to accept an incoming connection: from 192.168.1.2: TLS handshake set result code to 1: file ssl/statem/statem_srvr.c line 1422: error:1417A0C1:SSL routines:tls_post_process_client_hello:no shared cipher: TLS write fatal alert "handshake failure"
#### One side connects with PSK but other side uses OpenSSL with PSK support disabled
In connecting-side log:
...TCP successful, cannot establish TLS to [[192.168.1.2]:10050]: SSL_connect() set result code to SSL_ERROR_SSL: file ../ssl/record/rec_layer_s3.c line 1536: error:14094410:SSL routines:ssl3_read_bytes:sslv3 alert handshake failure: SSL alert number 40: TLS read fatal alert "handshake failure"
In accepting-side log:
...failed to accept an incoming connection: from 192.168.1.2: TLS handshake set result code to 1: file ssl/statem/statem_srvr.c line 1422: error:1417A0C1:SSL routines:tls_post_process_client_hello:no shared cipher: TLS write fatal alert "handshake failure"
## OPTIONS
**-s**, **--host** *host-name-or-IP*
Specify host name or IP address of a host.
**-p**, **--port** *port-number*
Specify port number of agent running on the host. Default is 10050.
**-I**, **--source-address** *IP-address*
Specify source IP address.
**-k**, **--key** *item-key*
Specify key of item to retrieve value for.
**--tls-connect** *value*
How to connect to agent. Values:
[ ]{#lbAF}
## OPTIONS
**-s**, **--host** *host-name-or-IP*
Specify host name or IP address of a host.
**-p**, **--port** *port-number*
Specify port number of agent running on the host. Default is 10050.
**-I**, **--source-address** *IP-address*
Specify source IP address.
**-k**, **--key** *item-key*
Specify key of item to retrieve value for.
**--tls-connect** *value*
How to connect to agent. Values:
[ ]{#lbAF}
#### Ordering shapes and lines
To bring one shape in front of the other (or vice versa) click on the
shape with the right mouse button bringing up the map shape menu.
#### Ordering shapes and lines
To bring one shape in front of the other (or vice versa) click on the
shape with the right mouse button bringing up the map shape menu.
#### OS Linux template
Two new items have been added to *Template\_OS\_Linux*:
- `CPU guest time` - the time spent running a virtual CPU for guest
operating systems
- `CPU guest nice time` - the time spent running a niced guest
(virtual CPU for guest operating systems)
The CPU utilization graph has been updated to include these two items.
#### OS Linux template
Two new items have been added to *Template\_OS\_Linux*:
- `CPU guest time` - the time spent running a virtual CPU for guest
operating systems
- `CPU guest nice time` - the time spent running a niced guest
(virtual CPU for guest operating systems)
The CPU utilization graph has been updated to include these two items.
#### Other locations
In addition to the locations listed here, user macros can be used in the
following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Global scripts (including confirmation text)|<|yes|
|*Monitoring → Screens*|<|<|
|<|URL field of *dynamic URL* screen element|yes|
|*Administration → Users → Media*|<|<|
|<|When active|no|
|*Administration → General → Working time*|<|<|
|<|Working time|no|
For a complete list of all macros supported in Zabbix, see [supported
macros](/manual/appendix/macros/supported_by_location).
#### Other locations
In addition to the locations listed here, user macros can be used in the
following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Global scripts (including confirmation text)|<|yes|
|*Monitoring → Screens*|<|<|
|<|URL field of *dynamic URL* screen element|yes|
|*Administration → Users → Media*|<|<|
|<|When active|no|
|*Administration → General → Working time*|<|<|
|<|Working time|no|
For a complete list of all macros supported in Zabbix, see [supported
macros](/manual/appendix/macros/supported_by_location).
##### Outgoing connections
The simplest case is outgoing connections:
- For outgoing connections with certificate - use TLSCipherCert13 or
TLSCipherCert
- For outgoing connections with PSK - use TLSCipherPSK13 and
TLSCipherPSK
- In case of zabbix\_get and zabbix\_sender utilities the command-line
parameters `--tls-cipher13` and `--tls-cipher` can be used
(encryption is unambiguously specified with a `--tls-connect`
parameter)
##### Outgoing connections
The simplest case is outgoing connections:
- For outgoing connections with certificate - use TLSCipherCert13 or
TLSCipherCert
- For outgoing connections with PSK - use TLSCipherPSK13 and
TLSCipherPSK
- In case of zabbix\_get and zabbix\_sender utilities the command-line
parameters `--tls-cipher13` and `--tls-cipher` can be used
(encryption is unambiguously specified with a `--tls-connect`
parameter)
#### Output value
JSONPaths can be divided in definite and indefinite paths. A definite
path can return only null or a single match. An indefinite path can
return multiple matches, basically JSONPaths with detached, multiple
name/index list, array slice or expression segments. However, when a
function is used the JSONPath becomes definite, as functions always
output single value.
A definite path returns the object/array/value it's referencing, while
indefinite path returns an array of the matched objects/arrays/values.
#### Output value
JSONPaths can be divided in definite and indefinite paths. A definite
path can return only null or a single match. An indefinite path can
return multiple matches, basically JSONPaths with detached, multiple
name/index list, array slice or expression segments. However, when a
function is used the JSONPath becomes definite, as functions always
output single value.
A definite path returns the object/array/value it's referencing, while
indefinite path returns an array of the matched objects/arrays/values.
#### Overview
Configuring a map in Zabbix requires that you first create a map by
defining its general parameters and then you start filling the actual
map with elements and their links.
You can populate the map with elements that are a host, a host group, a
trigger, an image or another map.
Icons are used to represent map elements. You can define the information
that will be displayed with the icons and set that recent problems are
displayed in a special way. You can link the icons and define
information to be displayed on the links.
You can add custom URLs to be accessible by clicking on the icons. Thus
you may link a host icon to host properties or a map icon to another
map.
Maps are managed in *Monitoring* →
*[Maps](/manual/web_interface/frontend_sections/monitoring/maps)*, where
they can be configured, managed and viewed. In the monitoring view you
can click on the icons and take advantage of the links to some scripts
and URLs.
Network maps are based on vector graphics (SVG) since Zabbix 3.4.
#### Overview
Configuring a map in Zabbix requires that you first create a map by
defining its general parameters and then you start filling the actual
map with elements and their links.
You can populate the map with elements that are a host, a host group, a
trigger, an image or another map.
Icons are used to represent map elements. You can define the information
that will be displayed with the icons and set that recent problems are
displayed in a special way. You can link the icons and define
information to be displayed on the links.
You can add custom URLs to be accessible by clicking on the icons. Thus
you may link a host icon to host properties or a map icon to another
map.
Maps are managed in *Monitoring* →
*[Maps](/manual/web_interface/frontend_sections/monitoring/maps)*, where
they can be configured, managed and viewed. In the monitoring view you
can click on the icons and take advantage of the links to some scripts
and URLs.
Network maps are based on vector graphics (SVG) since Zabbix 3.4.
#### Overview
Custom graphs, as the name suggests, offer customisation capabilities.
While simple graphs are good for viewing data of a single item, they do
not offer configuration capabilities.
Thus, if you want to change graph style or the way lines are displayed
or compare several items, for example incoming and outgoing traffic in a
single graph, you need a custom graph.
Custom graphs are configured manually.
They can be created for a host or several hosts or for a single
template.
#### Overview
Custom graphs, as the name suggests, offer customisation capabilities.
While simple graphs are good for viewing data of a single item, they do
not offer configuration capabilities.
Thus, if you want to change graph style or the way lines are displayed
or compare several items, for example incoming and outgoing traffic in a
single graph, you need a custom graph.
Custom graphs are configured manually.
They can be created for a host or several hosts or for a single
template.
#### Overview
Hosts are [exported](/manual/xml_export_import) with many related
objects and object relations.
Host export contains:
- linked host groups
- host data
- template linkage
- host group linkage
- host interfaces
- directly linked applications
- directly linked items
- directly linked triggers
- directly linked graphs
- directly linked discovery rules with all prototypes
- directly linked web scenarios
- host macros
- host inventory data
- value maps
#### Overview
Hosts are [exported](/manual/xml_export_import) with many related
objects and object relations.
Host export contains:
- linked host groups
- host data
- template linkage
- host group linkage
- host interfaces
- directly linked applications
- directly linked items
- directly linked triggers
- directly linked graphs
- directly linked discovery rules with all prototypes
- directly linked web scenarios
- host macros
- host inventory data
- value maps
#### Overview
Host screens look similar to [global
screens](/manual/config/visualization/screens), however, host screens
display data about the host only. Host screens are configured on the
[template](/manual/config/templates/template#adding_screens) level and
then are generated for a host, once the template is linked to the host.
Host screens *cannot* be configured or directly accessed in the
*Monitoring* →
*[Screens](/manual/web_interface/frontend_sections/monitoring/screens)*
section, which is reserved for global screens. The ways to access host
screens are listed below in this section.
{width="600"}
#### Overview
Host screens look similar to [global
screens](/manual/config/visualization/screens), however, host screens
display data about the host only. Host screens are configured on the
[template](/manual/config/templates/template#adding_screens) level and
then are generated for a host, once the template is linked to the host.
Host screens *cannot* be configured or directly accessed in the
*Monitoring* →
*[Screens](/manual/web_interface/frontend_sections/monitoring/screens)*
section, which is reserved for global screens. The ways to access host
screens are listed below in this section.
{width="600"}
#### Overview
If
[installed](/manual/installation/install_from_packages/debian_ubuntu#java_gateway_installation)
from Debian/Ubuntu packages, the following information will help you in
setting up Zabbix [Java gateway](/manual/concepts/java).
#### Overview
If
[installed](/manual/installation/install_from_packages/debian_ubuntu#java_gateway_installation)
from Debian/Ubuntu packages, the following information will help you in
setting up Zabbix [Java gateway](/manual/concepts/java).
#### Overview
If
[installed](/manual/installation/install_from_packages/rhel_centos#java_gateway_installation)
from RHEL/CentOS packages, the following information will help you in
setting up Zabbix [Java gateway](/manual/concepts/java).
#### Overview
If
[installed](/manual/installation/install_from_packages/rhel_centos#java_gateway_installation)
from RHEL/CentOS packages, the following information will help you in
setting up Zabbix [Java gateway](/manual/concepts/java).
#### Overview
If [installed](/manual/installation/install#installing_java_gateway)
from sources, the following information will help you in setting up
Zabbix [Java gateway](/manual/concepts/java).
#### Overview
If [installed](/manual/installation/install#installing_java_gateway)
from sources, the following information will help you in setting up
Zabbix [Java gateway](/manual/concepts/java).
#### Overview
If you have a network to look after, you may want to have an overview of
your infrastructure somewhere. For that purpose you can create maps in
Zabbix - of networks and of anything you like.
All users can create network maps. The maps can be public (available to
all users) or private (available to selected users).
Proceed to [configuring a network
map](/manual/config/visualization/maps/map).
#### Overview
If you have a network to look after, you may want to have an overview of
your infrastructure somewhere. For that purpose you can create maps in
Zabbix - of networks and of anything you like.
All users can create network maps. The maps can be public (available to
all users) or private (available to selected users).
Proceed to [configuring a network
map](/manual/config/visualization/maps/map).
#### Overview
In a slide show you can configure that a number of [screens](screens)
are displayed one after another at set intervals.
Sometimes you might want to switch between some configured screens.
While that can be done manually, doing that more than once or twice may
become very tedious. This is where the slide show function comes to
rescue.
All users in Zabbix (including non-admin users) can create slide shows.
Slide shows have an owner - the user who created them.
Slide shows can be made public or private. Public slide shows are
visible to all users, however, they must have at least read permissions
to all slide show elements (screens) to see it. To add a screen to the
slide show the user must also have at least read permission to it.
Private slide shows are visible only to their owner. Private slide shows
can be shared by the owner to other users and user groups. Regular
(non-Super admin) users can only share with the groups and users they
are member of. Private slide shows will be visible to their owner and
the users the slide show is shared with as long as they have read
permissions to all included screens. Admin level users, as long as they
have read permissions to all included screens, can see and edit private
slide shows regardless of being the owner or belonging to the shared
user list.
#### Overview
In a slide show you can configure that a number of [screens](screens)
are displayed one after another at set intervals.
Sometimes you might want to switch between some configured screens.
While that can be done manually, doing that more than once or twice may
become very tedious. This is where the slide show function comes to
rescue.
All users in Zabbix (including non-admin users) can create slide shows.
Slide shows have an owner - the user who created them.
Slide shows can be made public or private. Public slide shows are
visible to all users, however, they must have at least read permissions
to all slide show elements (screens) to see it. To add a screen to the
slide show the user must also have at least read permission to it.
Private slide shows are visible only to their owner. Private slide shows
can be shared by the owner to other users and user groups. Regular
(non-Super admin) users can only share with the groups and users they
are member of. Private slide shows will be visible to their owner and
the users the slide show is shared with as long as they have read
permissions to all included screens. Admin level users, as long as they
have read permissions to all included screens, can see and edit private
slide shows regardless of being the owner or belonging to the shared
user list.
#### Overview
In order to use any other language than English in Zabbix web interface,
its locale should be installed on the web server. Additionally, the PHP
gettext extension is required for the translations to work.
If a locale is installed, a language becomes available in the [language
selector](/manual/web_interface/user_profile#user_profile) in Zabbix web
interface. Languages for which locales are not installed are greyed out
and cannot be selected.
#### Overview
In order to use any other language than English in Zabbix web interface,
its locale should be installed on the web server. Additionally, the PHP
gettext extension is required for the translations to work.
If a locale is installed, a language becomes available in the [language
selector](/manual/web_interface/user_profile#user_profile) in Zabbix web
interface. Languages for which locales are not installed are greyed out
and cannot be selected.
#### Overview
It is possible to discover mounted filesystems and their properties
(mountpoint name, mountpoint type, filesystem size and inode
statistics).
To do that, you may use a combination of:
- the `vfs.fs.get` agent item (supported since Zabbix **4.0.17**) as
the master item
- a low-level discovery rule and dependent item prototypes
#### Overview
It is possible to discover mounted filesystems and their properties
(mountpoint name, mountpoint type, filesystem size and inode
statistics).
To do that, you may use a combination of:
- the `vfs.fs.get` agent item (supported since Zabbix **4.0.17**) as
the master item
- a low-level discovery rule and dependent item prototypes
#### Overview
JSONPath consists of segments separated with dots. A segment can be
either a simple word like a JSON value name, `*` or a more complex
construct enclosed within square brackets `[` `]`. The separating dot
before bracket segment is optional and can be omitted. For example:
|Path|Description|
|----|-----------|
|`$.object.name`|Return the object.name contents.|
|`$.object['name']`|Return the object.name contents.|
|`$.object.['name']`|Return the object.name contents.|
|`$["object"]['name']`|Return the object.name contents.|
|`$.['object'].["name"]`|Return the object.name contents.|
|`$.object.history.length()`|Return the number of object.history array elements.|
|`$[?(@.name == 'Object')].price.first()`|Return the price field of the first object with name 'Object'.|
|`$[?(@.name == 'Object')].history.first().length()`|Return the number of history array elements of the first object with name 'Object'.|
|`$[?(@.price > 10)].length()`|Return the number of objects with price being greater than 10.|
#### Overview
JSONPath consists of segments separated with dots. A segment can be
either a simple word like a JSON value name, `*` or a more complex
construct enclosed within square brackets `[` `]`. The separating dot
before bracket segment is optional and can be omitted. For example:
|Path|Description|
|----|-----------|
|`$.object.name`|Return the object.name contents.|
|`$.object['name']`|Return the object.name contents.|
|`$.object.['name']`|Return the object.name contents.|
|`$["object"]['name']`|Return the object.name contents.|
|`$.['object'].["name"]`|Return the object.name contents.|
|`$.object.history.length()`|Return the number of object.history array elements.|
|`$[?(@.name == 'Object')].price.first()`|Return the price field of the first object with name 'Object'.|
|`$[?(@.name == 'Object')].history.first().length()`|Return the number of history array elements of the first object with name 'Object'.|
|`$[?(@.price > 10)].length()`|Return the number of objects with price being greater than 10.|
#### Overview of files
If you obtained Java gateway from sources, you should have ended up with
a collection of shell scripts, JAR and configuration files under
$PREFIX/sbin/zabbix\_java. The role of these files is summarized below.
bin/zabbix-java-gateway-$VERSION.jar
Java gateway JAR file itself.
lib/logback-core-0.9.27.jar
lib/logback-classic-0.9.27.jar
lib/slf4j-api-1.6.1.jar
lib/android-json-4.3_r3.1.jar
Dependencies of Java gateway: [Logback](http://logback.qos.ch/),
[SLF4J](http://www.slf4j.org/), and [Android
JSON](https://android.googlesource.com/platform/libcore/+/master/json)
library.
lib/logback.xml
lib/logback-console.xml
Configuration files for Logback.
shutdown.sh
startup.sh
Convenience scripts for starting and stopping Java gateway.
settings.sh
Configuration file that is sourced by startup and shutdown scripts
above.
#### Overview of files
If you obtained Java gateway from sources, you should have ended up with
a collection of shell scripts, JAR and configuration files under
$PREFIX/sbin/zabbix\_java. The role of these files is summarized below.
bin/zabbix-java-gateway-$VERSION.jar
Java gateway JAR file itself.
lib/logback-core-0.9.27.jar
lib/logback-classic-0.9.27.jar
lib/slf4j-api-1.6.1.jar
lib/android-json-4.3_r3.1.jar
Dependencies of Java gateway: [Logback](http://logback.qos.ch/),
[SLF4J](http://www.slf4j.org/), and [Android
JSON](https://android.googlesource.com/platform/libcore/+/master/json)
library.
lib/logback.xml
lib/logback-console.xml
Configuration files for Logback.
shutdown.sh
startup.sh
Convenience scripts for starting and stopping Java gateway.
settings.sh
Configuration file that is sourced by startup and shutdown scripts
above.
#### Overview
On Zabbix screens you can group information from various sources for a
quick overview on a single screen. Building the screens is quite easy
and intuitive.
Essentially a screen is a table. You choose how many cells per table and
what elements to display in the cells. The following elements can be
displayed:
- simple graphs
- simple graph prototypes
- user-defined custom graphs
- custom graph prototypes
- maps
- other screens
- plain text information
- server information (overview)
- host information (overview)
- trigger information (overview)
- host/host group issues (status of problems)
- problems by severity
- data overview
- clock
- history of events
- history of recent actions
- URL (data taken from another location)
Global screens are managed in *Monitoring* →
*[Screens](/manual/web_interface/frontend_sections/monitoring/screens)*,
where they can be configured, managed and viewed. They can also be added
to the favorites section of *Monitoring* →
*[Dashboard](/manual/web_interface/frontend_sections/monitoring/dashboard)*.
[Host-level screens](/manual/config/visualization/host_screens) are
configured on template level and then generated for hosts once the
template is linked to the hosts.
To configure a screen you must first create it by defining its general
properties and then add individual elements in the cells.
All users in Zabbix (including non-admin users) can create screens.
Screens have an owner - the user who created them.
Screens can be made public or private. Public screens are visible to all
users.
Private screens are visible only to their owner. Private screens can be
shared by the owner to other users and user groups. Regular (non-Super
admin) users can only share with the groups and users they are member
of. Private screens will be visible to their owner and the users the
screen is shared with as long as they have read permissions to all
screen elements. Admin level users, as long as they have read
permissions to all screen elements, can see and edit private screens
regardless of being the owner or belonging to the shared user list.
::: notewarning
For both public and private screens a user must have
at least read permissions to all screen elements in order to see the
screen. To add an element to a screen a user must also have at least
read permission to it.
:::
#### Overview
On Zabbix screens you can group information from various sources for a
quick overview on a single screen. Building the screens is quite easy
and intuitive.
Essentially a screen is a table. You choose how many cells per table and
what elements to display in the cells. The following elements can be
displayed:
- simple graphs
- simple graph prototypes
- user-defined custom graphs
- custom graph prototypes
- maps
- other screens
- plain text information
- server information (overview)
- host information (overview)
- trigger information (overview)
- host/host group issues (status of problems)
- problems by severity
- data overview
- clock
- history of events
- history of recent actions
- URL (data taken from another location)
Global screens are managed in *Monitoring* →
*[Screens](/manual/web_interface/frontend_sections/monitoring/screens)*,
where they can be configured, managed and viewed. They can also be added
to the favorites section of *Monitoring* →
*[Dashboard](/manual/web_interface/frontend_sections/monitoring/dashboard)*.
[Host-level screens](/manual/config/visualization/host_screens) are
configured on template level and then generated for hosts once the
template is linked to the hosts.
To configure a screen you must first create it by defining its general
properties and then add individual elements in the cells.
All users in Zabbix (including non-admin users) can create screens.
Screens have an owner - the user who created them.
Screens can be made public or private. Public screens are visible to all
users.
Private screens are visible only to their owner. Private screens can be
shared by the owner to other users and user groups. Regular (non-Super
admin) users can only share with the groups and users they are member
of. Private screens will be visible to their owner and the users the
screen is shared with as long as they have read permissions to all
screen elements. Admin level users, as long as they have read
permissions to all screen elements, can see and edit private screens
regardless of being the owner or belonging to the shared user list.
::: notewarning
For both public and private screens a user must have
at least read permissions to all screen elements in order to see the
screen. To add an element to a screen a user must also have at least
read permission to it.
:::
#### Overview
Simple graphs are provided for the visualization of data gathered by
items.
No configuration effort is required on the user part to view simple
graphs. They are freely made available by Zabbix.
Just go to *Monitoring → Latest data* and click on the Graph link for
the respective item and a graph will be displayed.
{width="600"}
::: noteclassic
Simple graphs are provided for all numeric items. For
textual items, a link to History is available in *Monitoring → Latest
data*.
:::
#### Overview
Simple graphs are provided for the visualization of data gathered by
items.
No configuration effort is required on the user part to view simple
graphs. They are freely made available by Zabbix.
Just go to *Monitoring → Latest data* and click on the Graph link for
the respective item and a graph will be displayed.
{width="600"}
::: noteclassic
Simple graphs are provided for all numeric items. For
textual items, a link to History is available in *Monitoring → Latest
data*.
:::
#### Overview
Starting with Zabbix 4.0.5, it is possible to make some internal metrics
of Zabbix server and proxy accessible remotely by another Zabbix
instance or a third party tool. This can be useful so that
supporters/service providers can monitor their client Zabbix
servers/proxies remotely or, in organizations where Zabbix is not the
main monitoring tool, that Zabbix internal metrics can be monitored by a
third party system in an umbrella-monitoring setup.
Zabbix internal stats are exposed to a configurable set of addresses
listed in the new 'StatsAllowedIP'
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
parameter. Requests will be accepted only from these addresses.
#### Overview
Starting with Zabbix 4.0.5, it is possible to make some internal metrics
of Zabbix server and proxy accessible remotely by another Zabbix
instance or a third party tool. This can be useful so that
supporters/service providers can monitor their client Zabbix
servers/proxies remotely or, in organizations where Zabbix is not the
main monitoring tool, that Zabbix internal metrics can be monitored by a
third party system in an umbrella-monitoring setup.
Zabbix internal stats are exposed to a configurable set of addresses
listed in the new 'StatsAllowedIP'
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
parameter. Requests will be accepted only from these addresses.
#### Overview
This page provides a list of cookies used by Zabbix.
|Name|Description|Values|Expires/Max-Age|HttpOnly[^1]|Secure[^2]|
|----|-----------|------|---------------|------------|----------|
|PHPSESSID|Unique PHP session ID.<br><br>The length can be set in *php.ini - session.sid\_length*.|Example: kvlp5pu2ru1a2ccvff0g52m87a|Session (expires when the browsing session ends)|\+|\+ (only if HTTPS is enabled on a web server)|
|ZBX\_SESSION\_NAME<br>(available since 4.0.0).<br>String used as the name of the Zabbix frontend session cookie.<br><br>Default: zbx\_sessionid|Unique session cookie ID - a 32 character string.|Example: 004bc0213e7e8bca87fcc3919eca5270|Current date and time +1 month (31 days)|\+|\+ (only if HTTPS is enabled on a web server)|
|tab|Active tab number; this cookie is only used on pages with multiple tabs (e.g. *Host*, *Trigger* or *Action* configuration page) and is created, when a user navigates from a primary tab to another tab (such as *Tags* or *Dependencies* tab).<br><br>0 is used for the primary tab.|Example: 1|Session (expires when the browsing session ends)|\-|\-|
|browserwarning\_ignore|Whether a warning about using an outdated browser should be ignored.|yes|Session (expires when the browsing session ends)|\-|\-|
::: noteclassic
Forcing 'HttpOnly' flag on Zabbix cookies by a webserver
directive is not supported.
:::
[^1]: When `HttpOnly` is 'true' the cookie will be made accessible only
through the HTTP protocol. This means that the cookie won't be
accessible by scripting languages, such as JavaScript. This setting
can effectively help to reduce identity theft through XSS attacks
(although it is not supported by all browsers).
[^2]: `Secure` indicates that the cookie should only be transmitted over
a secure HTTPS connection from the client. When set to 'true', the
cookie will only be set if a secure connection exists.
#### Overview
This page provides a list of cookies used by Zabbix.
|Name|Description|Values|Expires/Max-Age|HttpOnly[^1]|Secure[^2]|
|----|-----------|------|---------------|------------|----------|
|PHPSESSID|Unique PHP session ID.<br><br>The length can be set in *php.ini - session.sid\_length*.|Example: kvlp5pu2ru1a2ccvff0g52m87a|Session (expires when the browsing session ends)|\+|\+ (only if HTTPS is enabled on a web server)|
|ZBX\_SESSION\_NAME<br>(available since 4.0.0).<br>String used as the name of the Zabbix frontend session cookie.<br><br>Default: zbx\_sessionid|Unique session cookie ID - a 32 character string.|Example: 004bc0213e7e8bca87fcc3919eca5270|Current date and time +1 month (31 days)|\+|\+ (only if HTTPS is enabled on a web server)|
|tab|Active tab number; this cookie is only used on pages with multiple tabs (e.g. *Host*, *Trigger* or *Action* configuration page) and is created, when a user navigates from a primary tab to another tab (such as *Tags* or *Dependencies* tab).<br><br>0 is used for the primary tab.|Example: 1|Session (expires when the browsing session ends)|\-|\-|
|browserwarning\_ignore|Whether a warning about using an outdated browser should be ignored.|yes|Session (expires when the browsing session ends)|\-|\-|
::: noteclassic
Forcing 'HttpOnly' flag on Zabbix cookies by a webserver
directive is not supported.
:::
[^1]: When `HttpOnly` is 'true' the cookie will be made accessible only
through the HTTP protocol. This means that the cookie won't be
accessible by scripting languages, such as JavaScript. This setting
can effectively help to reduce identity theft through XSS attacks
(although it is not supported by all browsers).
[^2]: `Secure` indicates that the cookie should only be transmitted over
a secure HTTPS connection from the client. When set to 'true', the
cookie will only be set if a secure connection exists.
#### Overview
This section demonstrates how to build Windows agent binaries from
sources with or without TLS.
#### Overview
This section demonstrates how to build Windows agent binaries from
sources with or without TLS.
#### Overview
This section explains how to add a “Host group” type element when
configuring a [network map](/manual/config/visualization/maps/map).
#### Overview
This section explains how to add a “Host group” type element when
configuring a [network map](/manual/config/visualization/maps/map).
#### Overview
This section lists available
[screen](/manual/config/visualization/screens) elements and provides
details for screen element configuration.
#### Overview
This section lists available
[screen](/manual/config/visualization/screens) elements and provides
details for screen element configuration.
#### Overview
Update operations allow you to be notified when problems are
[updated](/manual/acknowledges#updating_problems) by other users, i.e.:
- commented upon
- acknowledged
- severity changed
- closed (manually)
Update operations are available in actions with the event source as
*Triggers*.
Both messages and remote commands are supported in update operations.
Update operations do not support escalating - all operations are
assigned to a single step.
#### Overview
Update operations allow you to be notified when problems are
[updated](/manual/acknowledges#updating_problems) by other users, i.e.:
- commented upon
- acknowledged
- severity changed
- closed (manually)
Update operations are available in actions with the event source as
*Triggers*.
Both messages and remote commands are supported in update operations.
Update operations do not support escalating - all operations are
assigned to a single step.
#### Overview
When monitoring systems using an agent, a good practice is to obtain
metrics from the host on which the agent is installed. To use the
principle of least privilege, it is necessary to determine what metrics
are obtained from the agent.
The table in this document allows you to select the minimum rights for
guaranteed correct operation of Zabbix agent.
If a different user is selected for the agent to work, rather than
'LocalSystem', then for the operation of agent as a Windows service, the
new user must have the rights "Log on as a service" from "Local
Policy→User Rights Assignment" and the right to create, write and delete
the Zabbix agent log file.
::: noteclassic
When working with the rights of an agent based on the
"minimum technically acceptable" group, prior provision of rights to
objects for monitoring is required.
:::
#### Overview
When monitoring systems using an agent, a good practice is to obtain
metrics from the host on which the agent is installed. To use the
principle of least privilege, it is necessary to determine what metrics
are obtained from the agent.
The table in this document allows you to select the minimum rights for
guaranteed correct operation of Zabbix agent.
If a different user is selected for the agent to work, rather than
'LocalSystem', then for the operation of agent as a Windows service, the
new user must have the rights "Log on as a service" from "Local
Policy→User Rights Assignment" and the right to create, write and delete
the Zabbix agent log file.
::: noteclassic
When working with the rights of an agent based on the
"minimum technically acceptable" group, prior provision of rights to
objects for monitoring is required.
:::
#### Overview
While a [simple graph](simple) is great for accessing data of one item
and [custom graphs](custom) offer customisation options, none of the two
allow to quickly create a comparison graph for multiple items with
little effort and no maintenance.
To address this issue, since Zabbix 2.4 it is possible to create ad-hoc
graphs for several items in a very quick way.
#### Overview
While a [simple graph](simple) is great for accessing data of one item
and [custom graphs](custom) offer customisation options, none of the two
allow to quickly create a comparison graph for multiple items with
little effort and no maintenance.
To address this issue, since Zabbix 2.4 it is possible to create ad-hoc
graphs for several items in a very quick way.
#### Overview
With lots of data flowing into Zabbix, it becomes much easier for the
users if they can look at a visual representation of what is going on
rather than only numbers.
This is where graphs come in. Graphs allow to grasp the data flow at a
glance, correlate problems, discover when something started or make a
presentation of when something might turn into a problem.
Zabbix provides users with:
- built-in [simple graphs](/manual/config/visualization/graphs/simple)
of one item data
- the possibility to create more complex [customized
graphs](/manual/config/visualization/graphs/custom)
- access to a comparison of several items quickly in [ad-hoc
graphs](/manual/config/visualization/graphs/adhoc)
- modern customisable [vector
graphs](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#graph)
#### Overview
With lots of data flowing into Zabbix, it becomes much easier for the
users if they can look at a visual representation of what is going on
rather than only numbers.
This is where graphs come in. Graphs allow to grasp the data flow at a
glance, correlate problems, discover when something started or make a
presentation of when something might turn into a problem.
Zabbix provides users with:
- built-in [simple graphs](/manual/config/visualization/graphs/simple)
of one item data
- the possibility to create more complex [customized
graphs](/manual/config/visualization/graphs/custom)
- access to a comparison of several items quickly in [ad-hoc
graphs](/manual/config/visualization/graphs/adhoc)
- modern customisable [vector
graphs](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#graph)
#### Overview
You can assign some triggers to a
[link](/manual/config/visualization/maps/map#linking_elements) between
elements in a network map. When these triggers go into a problem state,
the link can reflect that.
When you configure a link, you set the default link type and color. When
you assign triggers to a link, you can assign different link types and
colors with these triggers.
Should any of these triggers go into a problem state, their link style
and color will be displayed on the link. So maybe your default link was
a green line. Now, with the trigger in problem state, your link may
become bold red (if you have defined it so).
#### Overview
You can assign some triggers to a
[link](/manual/config/visualization/maps/map#linking_elements) between
elements in a network map. When these triggers go into a problem state,
the link can reflect that.
When you configure a link, you set the default link type and color. When
you assign triggers to a link, you can assign different link types and
colors with these triggers.
Should any of these triggers go into a problem state, their link style
and color will be displayed on the link. So maybe your default link was
a green line. Now, with the trigger in problem state, your link may
become bold red (if you have defined it so).
#### Overview
Zabbix Mac OS agent can be installed from PKG installer packages
available for
[download](https://www.zabbix.com/download_agents#tab:40LTS). Versions
with or without encryption are available.
#### Overview
Zabbix Mac OS agent can be installed from PKG installer packages
available for
[download](https://www.zabbix.com/download_agents#tab:40LTS). Versions
with or without encryption are available.
#### Parameters
|Parameter|Mandatory|Range|Default|Description|
|---------|---------|-----|-------|-----------|
|AllowRoot|no|<|0|Allow the proxy to run as 'root'. If disabled and the proxy is started by 'root', the proxy will try to switch to the 'zabbix' user instead. Has no effect if started under a regular user.<br>0 - do not allow<br>1 - allow<br>This parameter is supported since Zabbix 2.2.0.|
|CacheSize|no|128K-64G|8M|Size of configuration cache, in bytes.<br>Shared memory size, for storing host and item data.<br>The maximum value of this parameter was increased from 8GB to 64GB in Zabbix 4.0.21.|
|ConfigFrequency|no|1-604800|3600|How often proxy retrieves configuration data from Zabbix server in seconds.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|DBHost|no|<|localhost|Database host name.<br>In case of MySQL localhost or empty string results in using a socket. In case of PostgreSQL<br>only empty string results in attempt to use socket.|
|DBName|yes|<|<|Database name or path to database file for SQLite3 (multi-process architecture of Zabbix does not allow to use [in-memory database](https://www.sqlite.org/inmemorydb.html), e.g. `:memory:`, `file::memory:?cache=shared` or `file:memdb1?mode=memory&cache=shared`).<br><br>Warning: Do not attempt to use the same database Zabbix server is using.|
|DBPassword|no|<|<|Database password. Ignored for SQLite.<br>Comment this line if no password is used.|
|DBSchema|no|<|<|Schema name. Used for IBM DB2 and PostgreSQL.|
|DBSocket|no|<|3306|Path to MySQL socket.<br>Database port when not using local socket. Ignored for SQLite.|
|DBUser|<|<|<|Database user. Ignored for SQLite.|
|DataSenderFrequency|no|1-3600|1|Proxy will send collected data to the server every N seconds. Note that active proxy will still poll Zabbix server every second for remote command tasks.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|DebugLevel|no|0-5|3|Specifies debug level:<br>0 - basic information about starting and stopping of Zabbix processes<br>1 - critical information<br>2 - error information<br>3 - warnings<br>4 - for debugging (produces lots of information)<br>5 - extended debugging (produces even more information)|
|EnableRemoteCommands|no|<|0|Whether remote commands from Zabbix server are allowed.<br>0 - not allowed<br>1 - allowed<br>This parameter is supported since Zabbix 3.4.0.|
|ExternalScripts|no|<|/usr/local/share/zabbix/externalscripts|Location of external scripts (depends on compile-time installation variable *datadir*).|
|Fping6Location|no|<|/usr/sbin/fping6|Location of fping6.<br>Make sure that fping6 binary has root ownership and SUID flag set.<br>Make empty ("Fping6Location=") if your fping utility is capable to process IPv6 addresses.|
|FpingLocation|no|<|/usr/sbin/fping|Location of fping.<br>Make sure that fping binary has root ownership and SUID flag set!|
|HeartbeatFrequency|no|0-3600|60|Frequency of heartbeat messages in seconds.<br>Used for monitoring availability of proxy on server side.<br>0 - heartbeat messages disabled.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|HistoryCacheSize|no|128K-2G|16M|Size of history cache, in bytes.<br>Shared memory size for storing history data.|
|HistoryIndexCacheSize|no|128K-2G|4M|Size of history index cache, in bytes.<br>Shared memory size for indexing history data stored in history cache.<br>The index cache size needs roughly 100 bytes to cache one item.<br>This parameter is supported since Zabbix 3.0.0.|
|Hostname|no|<|Set by HostnameItem|Unique, case sensitive Proxy name. Make sure the proxy name is known to the server!<br>Allowed characters: alphanumeric, '.', ' ', '\_' and '-'.<br>Maximum length: 64|
|HostnameItem|no|<|system.hostname|Item used for setting Hostname if it is undefined (this will be run on the proxy similarly as on an agent).<br>Does not support UserParameters, performance counters or aliases, but does support system.run\[\].<br><br>Ignored if Hostname is set.<br><br>This parameter is supported since Zabbix 1.8.6.|
|HousekeepingFrequency|no|0-24|1|How often Zabbix will perform housekeeping procedure (in hours).<br>Housekeeping is removing outdated information from the database.<br>*Note*: To prevent housekeeper from being overloaded (for example, when configuration parameters ProxyLocalBuffer or ProxyOfflineBuffer are greatly reduced), no more than 4 times HousekeepingFrequency hours of outdated information are deleted in one housekeeping cycle. Thus, if HousekeepingFrequency is 1, no more than 4 hours of outdated information (starting from the oldest entry) will be deleted per cycle.<br>*Note*: To lower load on proxy startup housekeeping is postponed for 30 minutes after proxy start. Thus, if HousekeepingFrequency is 1, the very first housekeeping procedure after proxy start will run after 30 minutes, and will repeat every hour thereafter. This postponing behavior is in place since Zabbix 2.4.0.<br>Since Zabbix 3.0.0 it is possible to disable automatic housekeeping by setting HousekeepingFrequency to 0. In this case the housekeeping procedure can only be started by *housekeeper\_execute* runtime control option and the period of outdated information deleted in one housekeeping cycle is 4 times the period since the last housekeeping cycle, but not less than 4 hours and not greater than 4 days.|
|Include|no|<|<|You may include individual files or all files in a directory in the configuration file.<br>To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: `/absolute/path/to/config/files/*.conf`. Pattern matching is supported since Zabbix 2.4.0.<br>See [special notes](special_notes_include) about limitations.|
|JavaGateway|no|<|<|IP address (or hostname) of Zabbix Java gateway.<br>Only required if Java pollers are started.<br>This parameter is supported since Zabbix 2.0.0.|
|JavaGatewayPort|no|1024-32767|10052|Port that Zabbix Java gateway listens on.<br>This parameter is supported since Zabbix 2.0.0.|
|ListenIP|no|<|0.0.0.0|List of comma delimited IP addresses that the trapper should listen on.<br>Trapper will listen on all network interfaces if this parameter is missing.<br>Multiple IP addresses are supported since Zabbix 1.8.3.|
|ListenPort|no|1024-32767|10051|Listen port for trapper.|
|LoadModule|no|<|<|Module to load at proxy startup. Modules are used to extend functionality of the proxy.<br>Formats:<br>LoadModule=<module.so><br>LoadModule=<path/module.so><br>(since 4.0.9) LoadModule=</abs\_path/module.so><br>Either the module must be located in directory specified by LoadModulePath or (since 4.0.9) the path must precede the module name. If the preceding path is absolute (starts with '/') then LoadModulePath is ignored.<br>It is allowed to include multiple LoadModule parameters.|
|LoadModulePath|no|<|<|Full path to location of proxy modules.<br>Default depends on compilation options.|
|LogFile|yes, if LogType is set to *file*, otherwise<br>no|<|<|Name of log file.|
|LogFileSize|no|0-1024|1|Maximum size of log file in MB.<br>0 - disable automatic log rotation.<br>*Note*: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew.|
|LogRemoteCommands|no|<|0|Enable logging of executed shell commands as warnings.<br>0 - disabled<br>1 - enabled<br>This parameter is supported since Zabbix 3.4.0.|
|LogType|no|<|file|Log output type:<br>*file* - write log to file specified by LogFile parameter,<br>*system* - write log to syslog,<br>*console* - write log to standard output.<br>This parameter is supported since Zabbix 3.0.0.|
|LogSlowQueries|no|0-3600000|0|How long a database query may take before being logged (in milliseconds).<br>0 - don't log slow queries.<br>This option becomes enabled starting with DebugLevel=3.<br>This parameter is supported since Zabbix 1.8.2.|
|PidFile|no|<|/tmp/zabbix\_proxy.pid|Name of PID file.|
|ProxyLocalBuffer|no|0-720|0|Proxy will keep data locally for N hours, even if the data have already been synced with the server.<br>This parameter may be used if local data will be used by third party applications.|
|ProxyMode|no|0-1|0|Proxy operating mode.<br>0 - proxy in the active mode<br>1 - proxy in the passive mode<br>This parameter is supported since Zabbix 1.8.3.<br>*Note* that (sensitive) proxy configuration data may become available to parties having access to the Zabbix server trapper port when using an active proxy. This is possible because anyone may pretend to be an active proxy and request configuration data; authentication does not take place.|
|ProxyOfflineBuffer|no|1-720|1|Proxy will keep data for N hours in case of no connectivity with Zabbix server.<br>Older data will be lost.|
|ServerPort|no|1024-32767|10051|Port of Zabbix trapper on Zabbix server.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|Server|yes|<|<|If ProxyMode is set to *active mode*:<br>IP address or DNS name of Zabbix server to get configuration data from and send data to.<br><br>If ProxyMode is set to *passive mode*:<br>List of comma delimited IP addresses, optionally in CIDR notation, or DNS names of Zabbix server. Incoming connections will be accepted only from the addresses listed here. If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address. '0.0.0.0/0' can be used to allow any IPv4 address.<br>*Example*: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com|
|SNMPTrapperFile|no|<|/tmp/zabbix\_traps.tmp|Temporary file used for passing data from SNMP trap daemon to the proxy.<br>Must be the same as in zabbix\_trap\_receiver.pl or SNMPTT configuration file.<br>This parameter is supported since Zabbix 2.0.0.|
|SocketDir|no|<|/tmp|Directory to store IPC sockets used by internal Zabbix services.<br>This parameter is supported since Zabbix 3.4.0.|
|SourceIP|no|<|<|Source IP address for:<br>- outgoing connections to Zabbix server;<br>- agentless connections (VMware, SSH, JMX, SNMP, Telnet and simple checks);<br>- HTTP agent connections|
|SSHKeyLocation|no|<|<|Location of public and private keys for SSH checks and actions|
|SSLCertLocation|no|<|<|Location of SSL client certificate files for client authentication.<br>This parameter is used in web monitoring only and is supported since Zabbix 2.4.0.|
|SSLKeyLocation|no|<|<|Location of SSL private key files for client authentication.<br>This parameter is used in web monitoring only and is supported since Zabbix 2.4.0.|
|SSLCALocation|no|<|<|Location of certificate authority (CA) files for SSL server certificate verification.<br>Note that the value of this parameter will be set as libcurl option CURLOPT\_CAPATH. For libcurl versions before 7.42.0, this only has effect if libcurl was compiled to use OpenSSL. For more information see [cURL web page](http://curl.haxx.se/libcurl/c/CURLOPT_CAPATH.html).<br>This parameter is used in web monitoring since Zabbix 2.4.0 and in SMTP authentication since Zabbix 3.0.0.|
|StartDBSyncers|no|1-100|4|Number of pre-forked instances of DB Syncers.<br>The upper limit used to be 64 before version 1.8.5.<br>This parameter is supported since Zabbix 1.8.3.|
|StartDiscoverers|no|0-250|1|Number of pre-forked instances of discoverers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartHTTPPollers|no|0-1000|1|Number of pre-forked instances of HTTP pollers.|
|StartIPMIPollers|no|0-1000|0|Number of pre-forked instances of IPMI pollers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartJavaPollers|no|0-1000|0|Number of pre-forked instances of Java pollers.<br>This parameter is supported since Zabbix 2.0.0.|
|StartPingers|no|0-1000|1|Number of pre-forked instances of ICMP pingers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartPollersUnreachable|no|0-1000|1|Number of pre-forked instances of pollers for unreachable hosts (including IPMI and Java).<br>Since Zabbix 2.4.0, at least one poller for unreachable hosts must be running if regular, IPMI or Java pollers are started.<br>The upper limit used to be 255 before version 1.8.5.<br>This option is missing in version 1.8.3.|
|StartPollers|no|0-1000|5|Number of pre-forked instances of pollers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartSNMPTrapper|no|0-1|0|If set to 1, SNMP trapper process will be started.<br>This parameter is supported since Zabbix 2.0.0.|
|StartTrappers|no|0-1000|5|Number of pre-forked instances of trappers.<br>Trappers accept incoming connections from Zabbix sender and active agents.<br>The upper limit used to be 255 before version 1.8.5.|
|StartVMwareCollectors|no|0-250|0|Number of pre-forked vmware collector instances.<br>This parameter is supported since Zabbix 2.2.0.|
|StatsAllowedIP|no|<|<|List of comma delimited IP addresses, optionally in CIDR notation, or DNS names of external Zabbix instances. Stats request will be accepted only from the addresses listed here. If this parameter is not set no stats requests will be accepted.<br>If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address. '0.0.0.0/0' can be used to allow any IPv4 address.<br>Example: StatsAllowedIP=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com<br>This parameter is supported since Zabbix 4.0.5.|
|Timeout|no|1-30|3|Specifies how long we wait for agent, SNMP device or external check (in seconds).|
|TLSAccept|yes for passive proxy, if TLS certificate or PSK parameters are defined (even for *unencrypted* connection), otherwise no|<|<|What incoming connections to accept from Zabbix server. Used for a passive proxy, ignored on an active proxy. Multiple values can be specified, separated by comma:<br>*unencrypted* - accept connections without encryption (default)<br>*psk* - accept connections with TLS and a pre-shared key (PSK)<br>*cert* - accept connections with TLS and a certificate<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCAFile|no|<|<|Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCertFile|no|<|<|Full pathname of a file containing the proxy certificate or certificate chain, used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCipherAll|no|<|<|GnuTLS priority string or OpenSSL (TLS 1.2) cipher string. Override the default ciphersuite selection criteria for certificate- and PSK-based encryption.<br>Example: TLS\_AES\_256\_GCM\_SHA384:TLS\_CHACHA20\_POLY1305\_SHA256:TLS\_AES\_128\_GCM\_SHA256<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherAll13|no|<|<|Cipher string for OpenSSL 1.1.1 or newer in TLS 1.3. Override the default ciphersuite selection criteria for certificate- and PSK-based encryption.<br>Example for GnuTLS: NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL::+SIGN-ALL:+CTYPE-X.509<br>Example for OpenSSL: EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherCert|no|<|<|GnuTLS priority string or OpenSSL (TLS 1.2) cipher string. Override the default ciphersuite selection criteria for certificate-based encryption.<br>Example for GnuTLS: NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509<br>Example for OpenSSL: EECDH+aRSA+AES128:RSA+aRSA+AES128<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherCert13|no|<|<|Cipher string for OpenSSL 1.1.1 or newer in TLS 1.3. Override the default ciphersuite selection criteria for certificate-based encryption.<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherPSK|no|<|<|GnuTLS priority string or OpenSSL (TLS 1.2) cipher string. Override the default ciphersuite selection criteria for PSK-based encryption.<br>Example for GnuTLS: NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL<br>Example for OpenSSL: kECDHEPSK+AES128:kPSK+AES128<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherPSK13|no|<|<|Cipher string for OpenSSL 1.1.1 or newer in TLS 1.3. Override the default ciphersuite selection criteria for PSK-based encryption.<br>Example: TLS\_CHACHA20\_POLY1305\_SHA256:TLS\_AES\_128\_GCM\_SHA256<br>This parameter is supported since Zabbix 4.0.19.|
|TLSConnect|yes for active proxy, if TLS certificate or PSK parameters are defined (even for *unencrypted* connection), otherwise no|<|<|How the proxy should connect to Zabbix server. Used for an active proxy, ignored on a passive proxy. Only one value can be specified:<br>*unencrypted* - connect without encryption (default)<br>*psk* - connect using TLS and a pre-shared key (PSK)<br>*cert* - connect using TLS and a certificate<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCRLFile|no|<|<|Full pathname of a file containing revoked certificates.This parameter is used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSKeyFile|no|<|<|Full pathname of a file containing the proxy private key, used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSPSKFile|no|<|<|Full pathname of a file containing the proxy pre-shared key. used for encrypted communications with Zabbix server.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSPSKIdentity|no|<|<|Pre-shared key identity string, used for encrypted communications with Zabbix server.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSServerCertIssuer|no|<|<|Allowed server certificate issuer.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSServerCertSubject|no|<|<|Allowed server certificate subject.<br>This parameter is supported since Zabbix 3.0.0.|
|TmpDir|no|<|/tmp|Temporary directory.|
|TrapperTimeout|no|1-300|300|Specifies how many seconds trapper may spend processing new data.|
|User|no|<|zabbix|Drop privileges to a specific, existing user on the system.<br>Only has effect if run as 'root' and AllowRoot is disabled.<br>This parameter is supported since Zabbix 2.4.0.|
|UnavailableDelay|no|1-3600|60|How often host is checked for availability during the [unavailability](/manual/appendix/items/unreachability#unavailable_host) period, in seconds.|
|UnreachableDelay|no|1-3600|15|How often host is checked for availability during the [unreachability](/manual/appendix/items/unreachability#unreachable_host) period, in seconds.|
|UnreachablePeriod|no|1-3600|45|After how many seconds of [unreachability](/manual/appendix/items/unreachability#unreachable_host) treat a host as unavailable.|
|VMwareCacheSize|no|256K-2G|8M|Shared memory size for storing VMware data.<br>A VMware internal check zabbix\[vmware,buffer,...\] can be used to monitor the VMware cache usage (see [Internal checks](/manual/config/items/itemtypes/internal)).<br>Note that shared memory is not allocated if there are no vmware collector instances configured to start.<br>This parameter is supported since Zabbix 2.2.0.|
|VMwareFrequency|no|10-86400|60|Delay in seconds between data gathering from a single VMware service.<br>This delay should be set to the least update interval of any VMware monitoring item.<br>This parameter is supported since Zabbix 2.2.0.|
|VMwarePerfFrequency|no|10-86400|60|Delay in seconds between performance counter statistics retrieval from a single VMware service.<br>This delay should be set to the least update interval of any VMware monitoring [item](/manual/config/items/itemtypes/simple_checks/vmware_keys#footnotes) that uses VMware performance counters.<br>This parameter is supported since Zabbix 2.2.9, 2.4.4|
|VMwareTimeout|no|1-300|10|The maximum number of seconds vmware collector will wait for a response from VMware service (vCenter or ESX hypervisor).<br>This parameter is supported since Zabbix 2.2.9, 2.4.4|
#### Parameters
|Parameter|Mandatory|Range|Default|Description|
|---------|---------|-----|-------|-----------|
|AllowRoot|no|<|0|Allow the proxy to run as 'root'. If disabled and the proxy is started by 'root', the proxy will try to switch to the 'zabbix' user instead. Has no effect if started under a regular user.<br>0 - do not allow<br>1 - allow<br>This parameter is supported since Zabbix 2.2.0.|
|CacheSize|no|128K-64G|8M|Size of configuration cache, in bytes.<br>Shared memory size, for storing host and item data.<br>The maximum value of this parameter was increased from 8GB to 64GB in Zabbix 4.0.21.|
|ConfigFrequency|no|1-604800|3600|How often proxy retrieves configuration data from Zabbix server in seconds.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|DBHost|no|<|localhost|Database host name.<br>In case of MySQL localhost or empty string results in using a socket. In case of PostgreSQL<br>only empty string results in attempt to use socket.|
|DBName|yes|<|<|Database name or path to database file for SQLite3 (multi-process architecture of Zabbix does not allow to use [in-memory database](https://www.sqlite.org/inmemorydb.html), e.g. `:memory:`, `file::memory:?cache=shared` or `file:memdb1?mode=memory&cache=shared`).<br><br>Warning: Do not attempt to use the same database Zabbix server is using.|
|DBPassword|no|<|<|Database password. Ignored for SQLite.<br>Comment this line if no password is used.|
|DBSchema|no|<|<|Schema name. Used for IBM DB2 and PostgreSQL.|
|DBSocket|no|<|3306|Path to MySQL socket.<br>Database port when not using local socket. Ignored for SQLite.|
|DBUser|<|<|<|Database user. Ignored for SQLite.|
|DataSenderFrequency|no|1-3600|1|Proxy will send collected data to the server every N seconds. Note that active proxy will still poll Zabbix server every second for remote command tasks.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|DebugLevel|no|0-5|3|Specifies debug level:<br>0 - basic information about starting and stopping of Zabbix processes<br>1 - critical information<br>2 - error information<br>3 - warnings<br>4 - for debugging (produces lots of information)<br>5 - extended debugging (produces even more information)|
|EnableRemoteCommands|no|<|0|Whether remote commands from Zabbix server are allowed.<br>0 - not allowed<br>1 - allowed<br>This parameter is supported since Zabbix 3.4.0.|
|ExternalScripts|no|<|/usr/local/share/zabbix/externalscripts|Location of external scripts (depends on compile-time installation variable *datadir*).|
|Fping6Location|no|<|/usr/sbin/fping6|Location of fping6.<br>Make sure that fping6 binary has root ownership and SUID flag set.<br>Make empty ("Fping6Location=") if your fping utility is capable to process IPv6 addresses.|
|FpingLocation|no|<|/usr/sbin/fping|Location of fping.<br>Make sure that fping binary has root ownership and SUID flag set!|
|HeartbeatFrequency|no|0-3600|60|Frequency of heartbeat messages in seconds.<br>Used for monitoring availability of proxy on server side.<br>0 - heartbeat messages disabled.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|HistoryCacheSize|no|128K-2G|16M|Size of history cache, in bytes.<br>Shared memory size for storing history data.|
|HistoryIndexCacheSize|no|128K-2G|4M|Size of history index cache, in bytes.<br>Shared memory size for indexing history data stored in history cache.<br>The index cache size needs roughly 100 bytes to cache one item.<br>This parameter is supported since Zabbix 3.0.0.|
|Hostname|no|<|Set by HostnameItem|Unique, case sensitive Proxy name. Make sure the proxy name is known to the server!<br>Allowed characters: alphanumeric, '.', ' ', '\_' and '-'.<br>Maximum length: 64|
|HostnameItem|no|<|system.hostname|Item used for setting Hostname if it is undefined (this will be run on the proxy similarly as on an agent).<br>Does not support UserParameters, performance counters or aliases, but does support system.run\[\].<br><br>Ignored if Hostname is set.<br><br>This parameter is supported since Zabbix 1.8.6.|
|HousekeepingFrequency|no|0-24|1|How often Zabbix will perform housekeeping procedure (in hours).<br>Housekeeping is removing outdated information from the database.<br>*Note*: To prevent housekeeper from being overloaded (for example, when configuration parameters ProxyLocalBuffer or ProxyOfflineBuffer are greatly reduced), no more than 4 times HousekeepingFrequency hours of outdated information are deleted in one housekeeping cycle. Thus, if HousekeepingFrequency is 1, no more than 4 hours of outdated information (starting from the oldest entry) will be deleted per cycle.<br>*Note*: To lower load on proxy startup housekeeping is postponed for 30 minutes after proxy start. Thus, if HousekeepingFrequency is 1, the very first housekeeping procedure after proxy start will run after 30 minutes, and will repeat every hour thereafter. This postponing behavior is in place since Zabbix 2.4.0.<br>Since Zabbix 3.0.0 it is possible to disable automatic housekeeping by setting HousekeepingFrequency to 0. In this case the housekeeping procedure can only be started by *housekeeper\_execute* runtime control option and the period of outdated information deleted in one housekeeping cycle is 4 times the period since the last housekeeping cycle, but not less than 4 hours and not greater than 4 days.|
|Include|no|<|<|You may include individual files or all files in a directory in the configuration file.<br>To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: `/absolute/path/to/config/files/*.conf`. Pattern matching is supported since Zabbix 2.4.0.<br>See [special notes](special_notes_include) about limitations.|
|JavaGateway|no|<|<|IP address (or hostname) of Zabbix Java gateway.<br>Only required if Java pollers are started.<br>This parameter is supported since Zabbix 2.0.0.|
|JavaGatewayPort|no|1024-32767|10052|Port that Zabbix Java gateway listens on.<br>This parameter is supported since Zabbix 2.0.0.|
|ListenIP|no|<|0.0.0.0|List of comma delimited IP addresses that the trapper should listen on.<br>Trapper will listen on all network interfaces if this parameter is missing.<br>Multiple IP addresses are supported since Zabbix 1.8.3.|
|ListenPort|no|1024-32767|10051|Listen port for trapper.|
|LoadModule|no|<|<|Module to load at proxy startup. Modules are used to extend functionality of the proxy.<br>Formats:<br>LoadModule=<module.so><br>LoadModule=<path/module.so><br>(since 4.0.9) LoadModule=</abs\_path/module.so><br>Either the module must be located in directory specified by LoadModulePath or (since 4.0.9) the path must precede the module name. If the preceding path is absolute (starts with '/') then LoadModulePath is ignored.<br>It is allowed to include multiple LoadModule parameters.|
|LoadModulePath|no|<|<|Full path to location of proxy modules.<br>Default depends on compilation options.|
|LogFile|yes, if LogType is set to *file*, otherwise<br>no|<|<|Name of log file.|
|LogFileSize|no|0-1024|1|Maximum size of log file in MB.<br>0 - disable automatic log rotation.<br>*Note*: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew.|
|LogRemoteCommands|no|<|0|Enable logging of executed shell commands as warnings.<br>0 - disabled<br>1 - enabled<br>This parameter is supported since Zabbix 3.4.0.|
|LogType|no|<|file|Log output type:<br>*file* - write log to file specified by LogFile parameter,<br>*system* - write log to syslog,<br>*console* - write log to standard output.<br>This parameter is supported since Zabbix 3.0.0.|
|LogSlowQueries|no|0-3600000|0|How long a database query may take before being logged (in milliseconds).<br>0 - don't log slow queries.<br>This option becomes enabled starting with DebugLevel=3.<br>This parameter is supported since Zabbix 1.8.2.|
|PidFile|no|<|/tmp/zabbix\_proxy.pid|Name of PID file.|
|ProxyLocalBuffer|no|0-720|0|Proxy will keep data locally for N hours, even if the data have already been synced with the server.<br>This parameter may be used if local data will be used by third party applications.|
|ProxyMode|no|0-1|0|Proxy operating mode.<br>0 - proxy in the active mode<br>1 - proxy in the passive mode<br>This parameter is supported since Zabbix 1.8.3.<br>*Note* that (sensitive) proxy configuration data may become available to parties having access to the Zabbix server trapper port when using an active proxy. This is possible because anyone may pretend to be an active proxy and request configuration data; authentication does not take place.|
|ProxyOfflineBuffer|no|1-720|1|Proxy will keep data for N hours in case of no connectivity with Zabbix server.<br>Older data will be lost.|
|ServerPort|no|1024-32767|10051|Port of Zabbix trapper on Zabbix server.<br>Active proxy parameter. Ignored for passive proxies (see ProxyMode parameter).|
|Server|yes|<|<|If ProxyMode is set to *active mode*:<br>IP address or DNS name of Zabbix server to get configuration data from and send data to.<br><br>If ProxyMode is set to *passive mode*:<br>List of comma delimited IP addresses, optionally in CIDR notation, or DNS names of Zabbix server. Incoming connections will be accepted only from the addresses listed here. If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address. '0.0.0.0/0' can be used to allow any IPv4 address.<br>*Example*: Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com|
|SNMPTrapperFile|no|<|/tmp/zabbix\_traps.tmp|Temporary file used for passing data from SNMP trap daemon to the proxy.<br>Must be the same as in zabbix\_trap\_receiver.pl or SNMPTT configuration file.<br>This parameter is supported since Zabbix 2.0.0.|
|SocketDir|no|<|/tmp|Directory to store IPC sockets used by internal Zabbix services.<br>This parameter is supported since Zabbix 3.4.0.|
|SourceIP|no|<|<|Source IP address for:<br>- outgoing connections to Zabbix server;<br>- agentless connections (VMware, SSH, JMX, SNMP, Telnet and simple checks);<br>- HTTP agent connections|
|SSHKeyLocation|no|<|<|Location of public and private keys for SSH checks and actions|
|SSLCertLocation|no|<|<|Location of SSL client certificate files for client authentication.<br>This parameter is used in web monitoring only and is supported since Zabbix 2.4.0.|
|SSLKeyLocation|no|<|<|Location of SSL private key files for client authentication.<br>This parameter is used in web monitoring only and is supported since Zabbix 2.4.0.|
|SSLCALocation|no|<|<|Location of certificate authority (CA) files for SSL server certificate verification.<br>Note that the value of this parameter will be set as libcurl option CURLOPT\_CAPATH. For libcurl versions before 7.42.0, this only has effect if libcurl was compiled to use OpenSSL. For more information see [cURL web page](http://curl.haxx.se/libcurl/c/CURLOPT_CAPATH.html).<br>This parameter is used in web monitoring since Zabbix 2.4.0 and in SMTP authentication since Zabbix 3.0.0.|
|StartDBSyncers|no|1-100|4|Number of pre-forked instances of DB Syncers.<br>The upper limit used to be 64 before version 1.8.5.<br>This parameter is supported since Zabbix 1.8.3.|
|StartDiscoverers|no|0-250|1|Number of pre-forked instances of discoverers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartHTTPPollers|no|0-1000|1|Number of pre-forked instances of HTTP pollers.|
|StartIPMIPollers|no|0-1000|0|Number of pre-forked instances of IPMI pollers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartJavaPollers|no|0-1000|0|Number of pre-forked instances of Java pollers.<br>This parameter is supported since Zabbix 2.0.0.|
|StartPingers|no|0-1000|1|Number of pre-forked instances of ICMP pingers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartPollersUnreachable|no|0-1000|1|Number of pre-forked instances of pollers for unreachable hosts (including IPMI and Java).<br>Since Zabbix 2.4.0, at least one poller for unreachable hosts must be running if regular, IPMI or Java pollers are started.<br>The upper limit used to be 255 before version 1.8.5.<br>This option is missing in version 1.8.3.|
|StartPollers|no|0-1000|5|Number of pre-forked instances of pollers.<br>The upper limit used to be 255 before version 1.8.5.|
|StartSNMPTrapper|no|0-1|0|If set to 1, SNMP trapper process will be started.<br>This parameter is supported since Zabbix 2.0.0.|
|StartTrappers|no|0-1000|5|Number of pre-forked instances of trappers.<br>Trappers accept incoming connections from Zabbix sender and active agents.<br>The upper limit used to be 255 before version 1.8.5.|
|StartVMwareCollectors|no|0-250|0|Number of pre-forked vmware collector instances.<br>This parameter is supported since Zabbix 2.2.0.|
|StatsAllowedIP|no|<|<|List of comma delimited IP addresses, optionally in CIDR notation, or DNS names of external Zabbix instances. Stats request will be accepted only from the addresses listed here. If this parameter is not set no stats requests will be accepted.<br>If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address. '0.0.0.0/0' can be used to allow any IPv4 address.<br>Example: StatsAllowedIP=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com<br>This parameter is supported since Zabbix 4.0.5.|
|Timeout|no|1-30|3|Specifies how long we wait for agent, SNMP device or external check (in seconds).|
|TLSAccept|yes for passive proxy, if TLS certificate or PSK parameters are defined (even for *unencrypted* connection), otherwise no|<|<|What incoming connections to accept from Zabbix server. Used for a passive proxy, ignored on an active proxy. Multiple values can be specified, separated by comma:<br>*unencrypted* - accept connections without encryption (default)<br>*psk* - accept connections with TLS and a pre-shared key (PSK)<br>*cert* - accept connections with TLS and a certificate<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCAFile|no|<|<|Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCertFile|no|<|<|Full pathname of a file containing the proxy certificate or certificate chain, used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCipherAll|no|<|<|GnuTLS priority string or OpenSSL (TLS 1.2) cipher string. Override the default ciphersuite selection criteria for certificate- and PSK-based encryption.<br>Example: TLS\_AES\_256\_GCM\_SHA384:TLS\_CHACHA20\_POLY1305\_SHA256:TLS\_AES\_128\_GCM\_SHA256<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherAll13|no|<|<|Cipher string for OpenSSL 1.1.1 or newer in TLS 1.3. Override the default ciphersuite selection criteria for certificate- and PSK-based encryption.<br>Example for GnuTLS: NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL::+SIGN-ALL:+CTYPE-X.509<br>Example for OpenSSL: EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherCert|no|<|<|GnuTLS priority string or OpenSSL (TLS 1.2) cipher string. Override the default ciphersuite selection criteria for certificate-based encryption.<br>Example for GnuTLS: NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509<br>Example for OpenSSL: EECDH+aRSA+AES128:RSA+aRSA+AES128<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherCert13|no|<|<|Cipher string for OpenSSL 1.1.1 or newer in TLS 1.3. Override the default ciphersuite selection criteria for certificate-based encryption.<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherPSK|no|<|<|GnuTLS priority string or OpenSSL (TLS 1.2) cipher string. Override the default ciphersuite selection criteria for PSK-based encryption.<br>Example for GnuTLS: NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL<br>Example for OpenSSL: kECDHEPSK+AES128:kPSK+AES128<br>This parameter is supported since Zabbix 4.0.19.|
|TLSCipherPSK13|no|<|<|Cipher string for OpenSSL 1.1.1 or newer in TLS 1.3. Override the default ciphersuite selection criteria for PSK-based encryption.<br>Example: TLS\_CHACHA20\_POLY1305\_SHA256:TLS\_AES\_128\_GCM\_SHA256<br>This parameter is supported since Zabbix 4.0.19.|
|TLSConnect|yes for active proxy, if TLS certificate or PSK parameters are defined (even for *unencrypted* connection), otherwise no|<|<|How the proxy should connect to Zabbix server. Used for an active proxy, ignored on a passive proxy. Only one value can be specified:<br>*unencrypted* - connect without encryption (default)<br>*psk* - connect using TLS and a pre-shared key (PSK)<br>*cert* - connect using TLS and a certificate<br>This parameter is supported since Zabbix 3.0.0.|
|TLSCRLFile|no|<|<|Full pathname of a file containing revoked certificates.This parameter is used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSKeyFile|no|<|<|Full pathname of a file containing the proxy private key, used for encrypted communications between Zabbix components.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSPSKFile|no|<|<|Full pathname of a file containing the proxy pre-shared key. used for encrypted communications with Zabbix server.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSPSKIdentity|no|<|<|Pre-shared key identity string, used for encrypted communications with Zabbix server.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSServerCertIssuer|no|<|<|Allowed server certificate issuer.<br>This parameter is supported since Zabbix 3.0.0.|
|TLSServerCertSubject|no|<|<|Allowed server certificate subject.<br>This parameter is supported since Zabbix 3.0.0.|
|TmpDir|no|<|/tmp|Temporary directory.|
|TrapperTimeout|no|1-300|300|Specifies how many seconds trapper may spend processing new data.|
|User|no|<|zabbix|Drop privileges to a specific, existing user on the system.<br>Only has effect if run as 'root' and AllowRoot is disabled.<br>This parameter is supported since Zabbix 2.4.0.|
|UnavailableDelay|no|1-3600|60|How often host is checked for availability during the [unavailability](/manual/appendix/items/unreachability#unavailable_host) period, in seconds.|
|UnreachableDelay|no|1-3600|15|How often host is checked for availability during the [unreachability](/manual/appendix/items/unreachability#unreachable_host) period, in seconds.|
|UnreachablePeriod|no|1-3600|45|After how many seconds of [unreachability](/manual/appendix/items/unreachability#unreachable_host) treat a host as unavailable.|
|VMwareCacheSize|no|256K-2G|8M|Shared memory size for storing VMware data.<br>A VMware internal check zabbix\[vmware,buffer,...\] can be used to monitor the VMware cache usage (see [Internal checks](/manual/config/items/itemtypes/internal)).<br>Note that shared memory is not allocated if there are no vmware collector instances configured to start.<br>This parameter is supported since Zabbix 2.2.0.|
|VMwareFrequency|no|10-86400|60|Delay in seconds between data gathering from a single VMware service.<br>This delay should be set to the least update interval of any VMware monitoring item.<br>This parameter is supported since Zabbix 2.2.0.|
|VMwarePerfFrequency|no|10-86400|60|Delay in seconds between performance counter statistics retrieval from a single VMware service.<br>This delay should be set to the least update interval of any VMware monitoring [item](/manual/config/items/itemtypes/simple_checks/vmware_keys#footnotes) that uses VMware performance counters.<br>This parameter is supported since Zabbix 2.2.9, 2.4.4|
|VMwareTimeout|no|1-300|10|The maximum number of seconds vmware collector will wait for a response from VMware service (vCenter or ESX hypervisor).<br>This parameter is supported since Zabbix 2.2.9, 2.4.4|
### Parameters
The method accepts the following parameters.
|Parameter|[Type](/manual/api/reference_commentary#data_types)|Description|
|---------|---------------------------------------------------|-----------|
|extend|boolean|Default value: "true". Setting it's value to "false" allows to check session without extending it's lifetime. Supported since Zabbix 4.0.|
|sessionid|string|User session id.|
::: noteimportant
Calling **user.checkAuthentication** method
prolongs user session by default.
:::
### Parameters
The method accepts the following parameters.
|Parameter|[Type](/manual/api/reference_commentary#data_types)|Description|
|---------|---------------------------------------------------|-----------|
|extend|boolean|Default value: "true". Setting it's value to "false" allows to check session without extending it's lifetime. Supported since Zabbix 4.0.|
|sessionid|string|User session id.|
::: noteimportant
Calling **user.checkAuthentication** method
prolongs user session by default.
:::
### Performance
### Performance
#### PHP 7.3 opcache configuration
If "opcache" is enabled in the PHP 7.3 configuration, Zabbix frontend
may show a blank screen when loaded for the first time. This is a
registered [PHP bug](https://bugs.php.net/bug.php?id=78015). To work
around this, please set the "opcache.optimization\_level" parameter to
`0x7FFFBFDF` in the PHP configuration (php.ini file).
#### PHP 7.3 opcache configuration
If "opcache" is enabled in the PHP 7.3 configuration, Zabbix frontend
may show a blank screen when loaded for the first time. This is a
registered [PHP bug](https://bugs.php.net/bug.php?id=78015). To work
around this, please set the "opcache.optimization\_level" parameter to
`0x7FFFBFDF` in the PHP configuration (php.ini file).
#### Positional macros in web monitoring items
[Deprecated positional
macros](/manual/installation/upgrade_notes_400#deprecated_macros_in_item_names)
($1, $2, ...) are no longer used in the item names when creating web
monitoring [items](/manual/web_monitoring/items).
In those cases where positional macros are used in existing web
monitoring items, the item names will be updated in the database not to
use positional macros as soon as the web scenario is updated.
#### Positional macros in web monitoring items
[Deprecated positional
macros](/manual/installation/upgrade_notes_400#deprecated_macros_in_item_names)
($1, $2, ...) are no longer used in the item names when creating web
monitoring [items](/manual/web_monitoring/items).
In those cases where positional macros are used in existing web
monitoring items, the item names will be updated in the database not to
use positional macros as soon as the web scenario is updated.
#### Positional macros removed
[Deprecated](/manual/installation/upgrade_notes_400#deprecated_macros_in_item_names)
positional macros have been removed from item names in standard
templates.
#### Positional macros removed
[Deprecated](/manual/installation/upgrade_notes_400#deprecated_macros_in_item_names)
positional macros have been removed from item names in standard
templates.
#### Problem export to CSV
Export to CSV in *Monitoring* → *Problems* now exports problems from all
pages, not just the selected page. Filter settings are still obeyed.
#### Problem export to CSV
Export to CSV in *Monitoring* → *Problems* now exports problems from all
pages, not just the selected page. Filter settings are still obeyed.
#### Problem name generation
Problem and event names previously were generated on the fly in the
frontend and on server side based on the respective trigger name with
all the macros expanded. That lead to severe performance issues and also
made it impossible to see historical information about problems if the
trigger name had changed.
Now problem and event names are stored directly in the 'events' and
'problem' tables at the moment when an event is generated for a problem
or recovery. Zabbix frontend can search and query the respective tables
directly. This change leads to a better separation of triggers and
problems, improves performance, especially that of the frontend and
maintains historical problem names. However, the size of problem/events
tables is now larger.
Note that for internal events the name contains an error message why an
object changed its state; upon recovery no name is used. For discovery
and auto-registration events no name is used.
A new {EVENT.NAME} macro is supported, returning the event/problem name
with macros resolved.
See also the upgrade notes for:
- [Related macro
changes](/manual/installation/upgrade_notes_400#problem_name_generation)
- [Related API method
changes](/manual/installation/upgrade_notes_400#problem_name_generation)
#### Problem name generation
Problem and event names previously were generated on the fly in the
frontend and on server side based on the respective trigger name with
all the macros expanded. That lead to severe performance issues and also
made it impossible to see historical information about problems if the
trigger name had changed.
Now problem and event names are stored directly in the 'events' and
'problem' tables at the moment when an event is generated for a problem
or recovery. Zabbix frontend can search and query the respective tables
directly. This change leads to a better separation of triggers and
problems, improves performance, especially that of the frontend and
maintains historical problem names. However, the size of problem/events
tables is now larger.
Note that for internal events the name contains an error message why an
object changed its state; upon recovery no name is used. For discovery
and auto-registration events no name is used.
A new {EVENT.NAME} macro is supported, returning the event/problem name
with macros resolved.
See also the upgrade notes for:
- [Related macro
changes](/manual/installation/upgrade_notes_400#problem_name_generation)
- [Related API method
changes](/manual/installation/upgrade_notes_400#problem_name_generation)
### Problem tag
The problem tag object has the following properties.
|Property|Type|Description|
|--------|----|-----------|
|tag|string|Problem tag name.|
|value|string|Problem tag value.|
### Problem tag
The problem tag object has the following properties.
|Property|Type|Description|
|--------|----|-----------|
|tag|string|Problem tag name.|
|value|string|Problem tag value.|
### Problem tag
The problem tag object is used to define which problems must be
suppressed when the maintenance comes into effect. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**tag**<br>(required)|string|Problem tag name.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - Equals;<br>2 - *(default)* Contains.|
|value|string|Problem tag value.|
### Problem tag
The problem tag object is used to define which problems must be
suppressed when the maintenance comes into effect. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**tag**<br>(required)|string|Problem tag name.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - Equals;<br>2 - *(default)* Contains.|
|value|string|Problem tag value.|
#### Protection against user enumeration attacks
To make sure an attacker may not guess valid user names because
temporary account blocking after consecutive failed login attempts is
only applied to existing user names, the account blocking is now also
enforced if non-existing user names are used.
To further obscure the possibility of such attacks, a unified generic
message is now displayed for all problems related to incorrect login:
Incorrect user name or password or account is temporarily blocked.
#### Protection against user enumeration attacks
To make sure an attacker may not guess valid user names because
temporary account blocking after consecutive failed login attempts is
only applied to existing user names, the account blocking is now also
enforced if non-existing user names are used.
To further obscure the possibility of such attacks, a unified generic
message is now displayed for all problems related to incorrect login:
Incorrect user name or password or account is temporarily blocked.
#### Proxies
In a [proxy](/manual/distributed_monitoring/proxies#configuration)
configuration, user macros can be used in the following field:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Interface port (for passive proxy)|<|no|
#### Proxies
In a [proxy](/manual/distributed_monitoring/proxies#configuration)
configuration, user macros can be used in the following field:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Interface port (for passive proxy)|<|no|
##### Readable summary in maps
A hidden "aria-label" property is available allowing map information to
be read with a screen reader. Both general map description and
individual element description is available, in the following format:
- for map description:
`<Map name>, <* of * items in problem state>, <* problems in total>.`
- for describing one element with one problem:
`<Element type>, Status <Element status>, <Element name>, <Problem description>.`
- for describing one element with multiple problems:
`<Element type>, Status <Element status>, <Element name>, <* problems>.`
- for describing one element without problems:
`<Element type>, Status <Element status>, <Element name>.`
For example, this description is available:
'Local network, 1 of 6 elements in problem state, 1 problem in total. Host, Status problem, My host, Free disk space is less than 20% on volume \/. Host group, Status ok, Virtual servers. Host, Status ok, Server 1. Host, Status ok, Server 2. Host, Status ok, Server 3. Host, Status ok, Server 4. '
for the following map:
{width="600"}
##### Readable summary in maps
A hidden "aria-label" property is available allowing map information to
be read with a screen reader. Both general map description and
individual element description is available, in the following format:
- for map description:
`<Map name>, <* of * items in problem state>, <* problems in total>.`
- for describing one element with one problem:
`<Element type>, Status <Element status>, <Element name>, <Problem description>.`
- for describing one element with multiple problems:
`<Element type>, Status <Element status>, <Element name>, <* problems>.`
- for describing one element without problems:
`<Element type>, Status <Element status>, <Element name>.`
For example, this description is available:
'Local network, 1 of 6 elements in problem state, 1 problem in total. Host, Status problem, My host, Free disk space is less than 20% on volume \/. Host group, Status ok, Virtual servers. Host, Status ok, Server 1. Host, Status ok, Server 2. Host, Status ok, Server 3. Host, Status ok, Server 4. '
for the following map:
{width="600"}
#### Real-time export of events, items, trends
In case of a write error during the export (data cannot be written to
the export file or the export file cannot be renamed or a new one cannot
be created after renaming it), the data item is now dropped and never
written to the export file. It is written only in the Zabbix database.
Writing data to the export file is resumed when the writing problem is
resolved.
Previously, in case of a write error, Zabbix would retry with a 10
second interval until success. The previous behavior, while ensuring
history data equivalence between database and the export files resulted
in actually stopping monitoring until the problem with the export file
was fixed. Now the priority is given to continued monitoring rather than
keeping the export file in sync with database at all cost.
See also: [Real-time export of events, items,
trends](/manual/appendix/install/real_time_export)
#### Real-time export of events, items, trends
In case of a write error during the export (data cannot be written to
the export file or the export file cannot be renamed or a new one cannot
be created after renaming it), the data item is now dropped and never
written to the export file. It is written only in the Zabbix database.
Writing data to the export file is resumed when the writing problem is
resolved.
Previously, in case of a write error, Zabbix would retry with a 10
second interval until success. The previous behavior, while ensuring
history data equivalence between database and the export files resulted
in actually stopping monitoring until the problem with the export file
was fixed. Now the priority is given to continued monitoring rather than
keeping the export file in sync with database at all cost.
See also: [Real-time export of events, items,
trends](/manual/appendix/install/real_time_export)
#### Recent data vs longer periods
For very recent data a **single** line is drawn connecting each received
value. The single line is drawn as long as there is at least one
horizontal pixel available for one value.
For data that show a longer period **three lines** are drawn - a dark
green one shows the average, while a light pink and a light green line
shows the maximum and minimum values at that point in time. The space
between the highs and the lows is filled with yellow background.
Working time (working days) is displayed in graphs as a white
background, while non-working time is displayed in gray (with the
*Original blue* default frontend theme).
{width="550"}
Working time is always displayed in simple graphs, whereas displaying it
in [custom graphs](custom#configuring_custom_graphs) is a user
preference.
Working time is not displayed if the graph shows more than 3 months.
#### Recent data vs longer periods
For very recent data a **single** line is drawn connecting each received
value. The single line is drawn as long as there is at least one
horizontal pixel available for one value.
For data that show a longer period **three lines** are drawn - a dark
green one shows the average, while a light pink and a light green line
shows the maximum and minimum values at that point in time. The space
between the highs and the lows is filled with yellow background.
Working time (working days) is displayed in graphs as a white
background, while non-working time is displayed in gray (with the
*Original blue* default frontend theme).
{width="550"}
Working time is always displayed in simple graphs, whereas displaying it
in [custom graphs](custom#configuring_custom_graphs) is a user
preference.
Working time is not displayed if the graph shows more than 3 months.
#### Referencing a screen
Screens can be referenced by both `elementid` and `screenname` GET
parameters. For example,
http://zabbix/zabbix/screens.php?screenname=Zabbix%20server
will open the screen with that name (Zabbix server).
If both `elementid` (screen ID) and `screenname` (screen name) are
specified, `screenname` has higher priority.
#### Referencing a screen
Screens can be referenced by both `elementid` and `screenname` GET
parameters. For example,
http://zabbix/zabbix/screens.php?screenname=Zabbix%20server
will open the screen with that name (Zabbix server).
If both `elementid` (screen ID) and `screenname` (screen name) are
specified, `screenname` has higher priority.
#### Regular expressions
The *File systems for discovery* global [regular
expression](/manual/regular_expressions#explanation_of_global_regular_expressions)
has been updated to include "apfs".
#### Regular expressions
The *File systems for discovery* global [regular
expression](/manual/regular_expressions#explanation_of_global_regular_expressions)
has been updated to include "apfs".
##### Related API changes
`problem.get` and `event.get` methods have been changed in such a
way that input parameter search/filter with object {'name': '...'}
as value is used to find matching results (by field "name") in the
corresponding table ("problem" or "events").
`problem.get` and `event.get` methods have been extended by adding a
response parameter called "name". For both methods, the new parameter
contains a value from the newly added "name" field in the database
table "problem" or "events".
##### Related API changes
`problem.get` and `event.get` methods have been changed in such a
way that input parameter search/filter with object {'name': '...'}
as value is used to find matching results (by field "name") in the
corresponding table ("problem" or "events").
`problem.get` and `event.get` methods have been extended by adding a
response parameter called "name". For both methods, the new parameter
contains a value from the newly added "name" field in the database
table "problem" or "events".
##### Related macro changes
Since problem names are no longer generated in runtime based on the
current trigger name, and instead are being generated at the time of
event, there are corresponding macro changes:
- In all default messages - {TRIGGER.NAME} has been replaced by
{EVENT.NAME};
- In all trigger-based actions - {TRIGGER.NAME} will be replaced by
{EVENT.NAME} when upgrading.
See also: [known
issues](/manual/installation/known_issues#known_issues_for_400_-_401)
##### Related macro changes
Since problem names are no longer generated in runtime based on the
current trigger name, and instead are being generated at the time of
event, there are corresponding macro changes:
- In all default messages - {TRIGGER.NAME} has been replaced by
{EVENT.NAME};
- In all trigger-based actions - {TRIGGER.NAME} will be replaced by
{EVENT.NAME} when upgrading.
See also: [known
issues](/manual/installation/known_issues#known_issues_for_400_-_401)
#### Remote monitoring of Zabbix stats
It is now possible to make some internal metrics of Zabbix server and
proxy accessible remotely by another Zabbix instance or a third party
tool. This can be useful so that supporters/service providers can
monitor their client Zabbix servers/proxies remotely or, in
organizations where Zabbix is not the main monitoring tool, that Zabbix
internal metrics can be monitored by a third party system in an
umbrella-monitoring setup.
Zabbix internal stats are exposed to a configurable set of addresses
listed in the new 'StatsAllowedIP'
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
parameter. Requests will be accepted only from these addresses.
To configure querying of internal stats on another Zabbix instance, you
may use two new items:
- `zabbix[stats,<ip>,<port>]` internal item - for direct remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
- `zabbix.stats[<ip>,<port>]` agent item - for agent-based remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
To make sure that the target instance allows querying it by the external
instance, list the address of the external instance in the
'StatsAllowedIP' parameter on the target instance.
These items gather statistics in bulk and return a JSON which can be
used as the master item for dependent items that get their data from. A
selected set of internal metrics (i.e. not all) is returned by either of
these two items.
There are also another two new items allowing to specifically remotely
query internal queue stats:
- `zabbix[stats,<ip>,<port>,queue,<from>,<to>]` internal item - for
direct internal queue queries to remote Zabbix server/proxy
- `zabbix.stats[<ip>,<port>,queue,<from>,<to>]` agent item - for
agent-based internal queue queries to remote Zabbix server/proxy
For more details, see:
- [Remote monitoring of Zabbix
stats](/manual/appendix/items/remote_stats)
- [Internal items](/manual/config/items/itemtypes/internal)
- [Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
#### Remote monitoring of Zabbix stats
It is now possible to make some internal metrics of Zabbix server and
proxy accessible remotely by another Zabbix instance or a third party
tool. This can be useful so that supporters/service providers can
monitor their client Zabbix servers/proxies remotely or, in
organizations where Zabbix is not the main monitoring tool, that Zabbix
internal metrics can be monitored by a third party system in an
umbrella-monitoring setup.
Zabbix internal stats are exposed to a configurable set of addresses
listed in the new 'StatsAllowedIP'
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
parameter. Requests will be accepted only from these addresses.
To configure querying of internal stats on another Zabbix instance, you
may use two new items:
- `zabbix[stats,<ip>,<port>]` internal item - for direct remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
- `zabbix.stats[<ip>,<port>]` agent item - for agent-based remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
To make sure that the target instance allows querying it by the external
instance, list the address of the external instance in the
'StatsAllowedIP' parameter on the target instance.
These items gather statistics in bulk and return a JSON which can be
used as the master item for dependent items that get their data from. A
selected set of internal metrics (i.e. not all) is returned by either of
these two items.
There are also another two new items allowing to specifically remotely
query internal queue stats:
- `zabbix[stats,<ip>,<port>,queue,<from>,<to>]` internal item - for
direct internal queue queries to remote Zabbix server/proxy
- `zabbix.stats[<ip>,<port>,queue,<from>,<to>]` agent item - for
agent-based internal queue queries to remote Zabbix server/proxy
For more details, see:
- [Remote monitoring of Zabbix
stats](/manual/appendix/items/remote_stats)
- [Internal items](/manual/config/items/itemtypes/internal)
- [Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
#### Removing web server test page
It is recommended to remove the web server test page to avoid
information exposure. By default, web server webroot contains a test
page called index.html (Apache2 on Ubuntu is used as an example):
The test page should be removed or should be made unavailable as part of
the web server hardening process.
#### Removing web server test page
It is recommended to remove the web server test page to avoid
information exposure. By default, web server webroot contains a test
page called index.html (Apache2 on Ubuntu is used as an example):
The test page should be removed or should be made unavailable as part of
the web server hardening process.
#### Renamed widgets, screen elements and reports
The following elements have been renamed:
| | |
|---|---|
|**Previously**|**In Zabbix 4.0**|
|System status|Problems by severity|
|Host status|Problem hosts|
|Status of Zabbix|System information|
Dashboard API is also affected: some of [Dashboard widget property
types](/manual/api/reference/dashboard/object) are now renamed.
#### Renamed widgets, screen elements and reports
The following elements have been renamed:
| | |
|---|---|
|**Previously**|**In Zabbix 4.0**|
|System status|Problems by severity|
|Host status|Problem hosts|
|Status of Zabbix|System information|
Dashboard API is also affected: some of [Dashboard widget property
types](/manual/api/reference/dashboard/object) are now renamed.
#### Retrieving filter conditions
Retrieve the name of the LLD rule "24681" and its filter conditions. The
filter uses the "and" evaluation type, so the `formula` property is
empty and `eval_formula` is generated automatically.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": [
"name"
],
"selectFilter": "extend",
"itemids": ["24681"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "24681",
"name": "Filtered LLD rule",
"filter": {
"evaltype": "1",
"formula": "",
"conditions": [
{
"macro": "{#MACRO1}",
"value": "@regex1",
"operator": "8",
"formulaid": "A"
},
{
"macro": "{#MACRO2}",
"value": "@regex2",
"operator": "8",
"formulaid": "B"
},
{
"macro": "{#MACRO3}",
"value": "@regex3",
"operator": "8",
"formulaid": "C"
}
],
"eval_formula": "A and B and C"
}
}
],
"id": 1
}
```
#### Retrieving filter conditions
Retrieve the name of the LLD rule "24681" and its filter conditions. The
filter uses the "and" evaluation type, so the `formula` property is
empty and `eval_formula` is generated automatically.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": [
"name"
],
"selectFilter": "extend",
"itemids": ["24681"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "24681",
"name": "Filtered LLD rule",
"filter": {
"evaltype": "1",
"formula": "",
"conditions": [
{
"macro": "{#MACRO1}",
"value": "@regex1",
"operator": "8",
"formulaid": "A"
},
{
"macro": "{#MACRO2}",
"value": "@regex2",
"operator": "8",
"formulaid": "B"
},
{
"macro": "{#MACRO3}",
"value": "@regex3",
"operator": "8",
"formulaid": "C"
}
],
"eval_formula": "A and B and C"
}
}
],
"id": 1
}
```
### Return values
`(integer/array)` Returns either:
- an array of objects;
- the count of retrieved objects, if the `countOutput` parameter has
been used.
### Return values
`(integer/array)` Returns either:
- an array of objects;
- the count of retrieved objects, if the `countOutput` parameter has
been used.
### Return values
`(object)` Returns an object containing information about user.
### Return values
`(object)` Returns an object containing information about user.
#### Running agent
The agent will start automatically after installation or restart.
You may edit the configuration file at
`/usr/local/etc/zabbix/zabbix_agentd.conf` if necessary.
To start the agent manually, you may run:
sudo launchctl start com.zabbix.zabbix_agentd
To stop the agent manually:
sudo launchctl stop com.zabbix.zabbix_agentd
During upgrade, the existing configuration file is not overwritten.
Instead a new `zabbix_agentd.conf.NEW` file is created to be used for
reviewing and updating the existing configuration file, if necessary.
Remember to restart the agent after manual changes to the configuration
file.
#### Running agent
The agent will start automatically after installation or restart.
You may edit the configuration file at
`/usr/local/etc/zabbix/zabbix_agentd.conf` if necessary.
To start the agent manually, you may run:
sudo launchctl start com.zabbix.zabbix_agentd
To stop the agent manually:
sudo launchctl stop com.zabbix.zabbix_agentd
During upgrade, the existing configuration file is not overwritten.
Instead a new `zabbix_agentd.conf.NEW` file is created to be used for
reviewing and updating the existing configuration file, if necessary.
Remember to restart the agent after manual changes to the configuration
file.
###
Runtime control options
**config\_cache\_reload**
Reload configuration cache. Ignored if cache is being currently loaded.
Active Zabbix proxy will connect to the Zabbix server and request
configuration data. Default configuration file (unless **-c** option is
specified) will be used to find PID file and signal will be sent to
process, listed in PID file.
**housekeeper\_execute**
Execute the housekeeper. Ignored if housekeeper is being currently
executed.
**log\_level\_increase**\[=*target*\]
Increase log level, affects all processes if target is not specified
**log\_level\_decrease**\[=*target*\]
Decrease log level, affects all processes if target is not specified
[ ]{#lbAG}
###
Runtime control options
**config\_cache\_reload**
Reload configuration cache. Ignored if cache is being currently loaded.
Active Zabbix proxy will connect to the Zabbix server and request
configuration data. Default configuration file (unless **-c** option is
specified) will be used to find PID file and signal will be sent to
process, listed in PID file.
**housekeeper\_execute**
Execute the housekeeper. Ignored if housekeeper is being currently
executed.
**log\_level\_increase**\[=*target*\]
Increase log level, affects all processes if target is not specified
**log\_level\_decrease**\[=*target*\]
Decrease log level, affects all processes if target is not specified
[ ]{#lbAG}
###
Runtime control options
**config\_cache\_reload**
Reload configuration cache. Ignored if cache is being currently loaded.
Default configuration file (unless **-c** option is specified) will be
used to find PID file and signal will be sent to process, listed in PID
file.
**housekeeper\_execute**
Execute the housekeeper. Ignored if housekeeper is being currently
executed.
**log\_level\_increase**\[=*target*\]
Increase log level, affects all processes if target is not specified
**log\_level\_decrease**\[=*target*\]
Decrease log level, affects all processes if target is not specified
[ ]{#lbAG}
###
Runtime control options
**config\_cache\_reload**
Reload configuration cache. Ignored if cache is being currently loaded.
Default configuration file (unless **-c** option is specified) will be
used to find PID file and signal will be sent to process, listed in PID
file.
**housekeeper\_execute**
Execute the housekeeper. Ignored if housekeeper is being currently
executed.
**log\_level\_increase**\[=*target*\]
Increase log level, affects all processes if target is not specified
**log\_level\_decrease**\[=*target*\]
Decrease log level, affects all processes if target is not specified
[ ]{#lbAG}
###
Runtime control options
**log\_level\_increase**\[=*target*\]
Increase log level, affects all processes if target is not specified
**log\_level\_decrease**\[=*target*\]
Decrease log level, affects all processes if target is not specified
[ ]{#lbAG}
###
Runtime control options
**log\_level\_increase**\[=*target*\]
Increase log level, affects all processes if target is not specified
**log\_level\_decrease**\[=*target*\]
Decrease log level, affects all processes if target is not specified
[ ]{#lbAG}
#### script
Changes:\
[ZBX-3783](https://support.zabbix.com/browse/ZBX-3783) `script.get`:
added strict validation of input parameters\
#### script
Changes:\
[ZBX-3783](https://support.zabbix.com/browse/ZBX-3783) `script.get`:
added strict validation of input parameters\
#### Second precision for age/duration macros
Several built-in [macros](/manual/appendix/macros/supported_by_location)
returning age/duration now return the value with down-to-a-second
precision:
- {DISCOVERY.DEVICE.UPTIME}
- {DISCOVERY.SERVICE.UPTIME}
- {EVENT.AGE}
Previously these macros returned values with down-to-a-minute precision.
#### Second precision for age/duration macros
Several built-in [macros](/manual/appendix/macros/supported_by_location)
returning age/duration now return the value with down-to-a-second
precision:
- {DISCOVERY.DEVICE.UPTIME}
- {DISCOVERY.SERVICE.UPTIME}
- {EVENT.AGE}
Previously these macros returned values with down-to-a-minute precision.
### See also
1. [Differences in the Zabbix agent configuration for active and
passive checks starting from version
2.0.0](http://blog.zabbix.com/multiple-servers-for-active-agent-sure/858).
### See also
1. [Differences in the Zabbix agent configuration for active and
passive checks starting from version
2.0.0](http://blog.zabbix.com/multiple-servers-for-active-agent-sure/858).
#### See also
1. [Differences in the Zabbix agent configuration for active and
passive checks starting from version
2.0.0](http://blog.zabbix.com/multiple-servers-for-active-agent-sure/858)
#### See also
1. [Differences in the Zabbix agent configuration for active and
passive checks starting from version
2.0.0](http://blog.zabbix.com/multiple-servers-for-active-agent-sure/858)
### See also
- [Alert](/manual/api/reference/alert/object)
- [Item](/manual/api/reference/item/object)
- [Host](/manual/api/reference/host/object)
- [LLD rule](/manual/api/reference/discoveryrule/object#lld_rule)
- [Trigger](/manual/api/reference/trigger/object)
### See also
- [Alert](/manual/api/reference/alert/object)
- [Item](/manual/api/reference/item/object)
- [Host](/manual/api/reference/host/object)
- [LLD rule](/manual/api/reference/discoveryrule/object#lld_rule)
- [Trigger](/manual/api/reference/trigger/object)
### See also
- [Application](/manual/api/reference/application/object#application)
- [Discovery
rule](/manual/api/reference/discoveryrule/object#discovery_rule)
- [Graph](/manual/api/reference/graph/object#graph)
- [Host](/manual/api/reference/host/object#host)
- [Host
interface](/manual/api/reference/hostinterface/object#host_interface)
- [Trigger](/manual/api/reference/trigger/object#trigger)
### See also
- [Application](/manual/api/reference/application/object#application)
- [Discovery
rule](/manual/api/reference/discoveryrule/object#discovery_rule)
- [Graph](/manual/api/reference/graph/object#graph)
- [Host](/manual/api/reference/host/object#host)
- [Host
interface](/manual/api/reference/hostinterface/object#host_interface)
- [Trigger](/manual/api/reference/trigger/object#trigger)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Item](/manual/api/reference/item/object#item)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Item](/manual/api/reference/item/object#item)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Proxy interface](object#proxy_interface)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Proxy interface](object#proxy_interface)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Proxy interface](object#proxy_interface)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Proxy interface](object#proxy_interface)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Proxy interface](object#proxy_interface)
### See also
- [Host](/manual/api/reference/host/object#host)
- [Proxy interface](object#proxy_interface)
### See also
- [Host](/manual/api/reference/host/object#object_details)
- [Host group](/manual/api/reference/hostgroup/object#object_details)
### See also
- [Host](/manual/api/reference/host/object#object_details)
- [Host group](/manual/api/reference/hostgroup/object#object_details)
### See also
- [Icon map](/manual/api/reference/iconmap/object#icon_map)
- [Map element](object#map_element)
- [Map link](object#map_link)
- [Map URL](object#map_url)
- [Map user](object#map_user)
- [Map user group](object#map_user_group)
- [Map shapes](object#map_shapes)
- [Map lines](object#map_lines)
### See also
- [Icon map](/manual/api/reference/iconmap/object#icon_map)
- [Map element](object#map_element)
- [Map link](object#map_link)
- [Map URL](object#map_url)
- [Map user](object#map_user)
- [Map user group](object#map_user_group)
- [Map shapes](object#map_shapes)
- [Map lines](object#map_lines)
### See also
- [LLD rule filter](object#lld_rule_filter)
### See also
- [LLD rule filter](object#lld_rule_filter)
### See also
- [Map element](object#map_element)
- [Map link](object#map_link)
- [Map URL](object#map_url)
- [Map user](object#map_user)
- [Map user group](object#map_user_group)
- [Map shape](object#map_shapes)
- [Map line](object#map_lines)
### See also
- [Map element](object#map_element)
- [Map link](object#map_link)
- [Map URL](object#map_url)
- [Map user](object#map_user)
- [Map user group](object#map_user_group)
- [Map shape](object#map_shapes)
- [Map line](object#map_lines)
### See also
- [Map element](object#map_element)
- [Map link](object#map_link)
- [Map URL](object#map_url)
- [Map user](object#map_user)
- [Map user group](object#map_user_group)
- [Map shapes](object#map_shapes)
- [Map lines](object#map_lines)
### See also
- [Map element](object#map_element)
- [Map link](object#map_link)
- [Map URL](object#map_url)
- [Map user](object#map_user)
- [Map user group](object#map_user_group)
- [Map shapes](object#map_shapes)
- [Map lines](object#map_lines)
### See also
- [Screen item](/manual/api/reference/screenitem/object#screen_item)
- [screenitem.create](/manual/api/reference/screenitem/create)
- [screenitem.update](/manual/api/reference/screenitem/update)
- [screenitem.updatebyposition](/manual/api/reference/screenitem/updatebyposition)
- [Screen user](object#screen_user)
- [Screen user group](object#screen_user_group)
### See also
- [Screen item](/manual/api/reference/screenitem/object#screen_item)
- [screenitem.create](/manual/api/reference/screenitem/create)
- [screenitem.update](/manual/api/reference/screenitem/update)
- [screenitem.updatebyposition](/manual/api/reference/screenitem/updatebyposition)
- [Screen user](object#screen_user)
- [Screen user group](object#screen_user_group)
### See also
- [Screen item](/manual/api/reference/screenitem/object#screen_item)
- [Screen user](object#screen_user)
- [Screen user group](object#screen_user_group)
### See also
- [Screen item](/manual/api/reference/screenitem/object#screen_item)
- [Screen user](object#screen_user)
- [Screen user group](object#screen_user_group)
### See also
- [Screen item](/manual/api/reference/screenitem/object#screen_item)
- [Screen user](object#screen_user)
- [Screen user group](object#screen_user_group)
### See also
- [Screen item](/manual/api/reference/screenitem/object#screen_item)
- [Screen user](object#screen_user)
- [Screen user group](object#screen_user_group)
### See also
- [screenitem.updatebyposition](updatebyposition)
### See also
- [screenitem.updatebyposition](updatebyposition)
### See also
- [screenitem.update](update)
### See also
- [screenitem.update](update)
### See also
- [screen.update](/manual/api/reference/screen/update)
### See also
- [screen.update](/manual/api/reference/screen/update)
### See also
- [screen.update](/manual/api/reference/screen/update)
### See also
- [screen.update](/manual/api/reference/screen/update)
### See also
- [Template changes](/manual/installation/template_changes)
### See also
- [Template changes](/manual/installation/template_changes)
### See also
- [Template changes](/manual/installation/template_changes)
### See also
- [Template changes](/manual/installation/template_changes)
#### See also
- [Template
changes](/manual/installation/template_changes#os_linux_template)
#### See also
- [Template
changes](/manual/installation/template_changes#os_linux_template)
#### See also
- [Template
changes](/manual/installation/template_changes#os_linux_template)
#### See also
- [Template
changes](/manual/installation/template_changes#os_linux_template)
#### See also
- [Template
changes](/manual/installation/template_changes#os_linux_template)
#### See also
- [Template
changes](/manual/installation/template_changes#os_linux_template)
#### See also
- [Template
changes](/manual/installation/template_changes#tomcat_template)
#### See also
- [Template
changes](/manual/installation/template_changes#tomcat_template)
### See also
- [Time period](object#time_period)
### See also
- [Time period](object#time_period)
### See also
- [Time period](object#time_period)
### See also
- [Time period](object#time_period)
### See also
- [User](/manual/api/reference/user/object#user)
### See also
- [User](/manual/api/reference/user/object#user)
#### Selecting elements
To select elements, select one and then hold down *Ctrl* to select the
others.
You can also select multiple elements by dragging a rectangle in the
editable area and selecting all elements in it (option available since
Zabbix 2.0).
Once you select more than one element, the element property form shifts
to the mass-update mode so you can change attributes of selected
elements in one go. To do so, mark the attribute using the checkbox and
enter a new value for it. You may use macros here (such as, say,
{HOST.NAME} for the element label).
{width="600"}
#### Selecting elements
To select elements, select one and then hold down *Ctrl* to select the
others.
You can also select multiple elements by dragging a rectangle in the
editable area and selecting all elements in it (option available since
Zabbix 2.0).
Once you select more than one element, the element property form shifts
to the mass-update mode so you can change attributes of selected
elements in one go. To do so, mark the attribute using the checkbox and
enter a new value for it. You may use macros here (such as, say,
{HOST.NAME} for the element label).
{width="600"}
#### Self-signed certificate, unknown CA
[*OpenSSL*]{.underline}, in log:
error:'self signed certificate: SSL_connect() set result code to SSL_ERROR_SSL: file ../ssl/statem/statem_clnt.c\
line 1924: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:\
TLS write fatal alert "unknown CA"'
This was observed when server certificate by mistake had the same Issuer
and Subject string, although it was signed by CA. Issuer and Subject are
equal in top-level CA certificate, but they cannot be equal in server
certificate. (The same applies to proxy and agent certificates.)
#### Self-signed certificate, unknown CA
[*OpenSSL*]{.underline}, in log:
error:'self signed certificate: SSL_connect() set result code to SSL_ERROR_SSL: file ../ssl/statem/statem_clnt.c\
line 1924: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:\
TLS write fatal alert "unknown CA"'
This was observed when server certificate by mistake had the same Issuer
and Subject string, although it was signed by CA. Issuer and Subject are
equal in top-level CA certificate, but they cannot be equal in server
certificate. (The same applies to proxy and agent certificates.)
#### Server configuration cache usage
The server configuration cache has been modified to keep all host
inventory information in it. If you are using the inventory
functionality with hosts, increase the dedicated configuration cache
memory for the server accordingly.
#### Server configuration cache usage
The server configuration cache has been modified to keep all host
inventory information in it. If you are using the inventory
functionality with hosts, increase the dedicated configuration cache
memory for the server accordingly.
#### Server performance
Zabbix server performance has been improved by replacing semaphores with
pthread mutexes and read-write locks.
#### Server performance
Zabbix server performance has been improved by replacing semaphores with
pthread mutexes and read-write locks.
#### Server/proxy template
The default Zabbix server/proxy templates (*Template App Zabbix Server*,
*Template App Zabbix Proxy*) have been changed.
While some items have been renamed, there are also some completely new
items:
- Number of processed character values per second
- Number of processed log values per second
- Number of processed not supported values per second
- Number of processed numeric (float) values per second
- Number of processed numeric (unsigned) values per second
- Number of processed text values per second
The following items are new and replace some old ones:
- Zabbix configuration cache, % used - replaces *Zabbix configuration
cache, % free*
- Zabbix history index cache, % used - replaces *Zabbix history index
cache, % free*
- Zabbix history write cache, % used - replaces *Zabbix history write
cache, % free*
- (in server template only) Zabbix trend write cache, % used -
replaces *Zabbix trend write cache, % free*
- (in server template only) Zabbix value cache, % used - replaces
*Zabbix value cache, % free*
The trigger expressions using the replaced items have been updated
accordingly.
#### Server/proxy template
The default Zabbix server/proxy templates (*Template App Zabbix Server*,
*Template App Zabbix Proxy*) have been changed.
While some items have been renamed, there are also some completely new
items:
- Number of processed character values per second
- Number of processed log values per second
- Number of processed not supported values per second
- Number of processed numeric (float) values per second
- Number of processed numeric (unsigned) values per second
- Number of processed text values per second
The following items are new and replace some old ones:
- Zabbix configuration cache, % used - replaces *Zabbix configuration
cache, % free*
- Zabbix history index cache, % used - replaces *Zabbix history index
cache, % free*
- Zabbix history write cache, % used - replaces *Zabbix history write
cache, % free*
- (in server template only) Zabbix trend write cache, % used -
replaces *Zabbix trend write cache, % free*
- (in server template only) Zabbix value cache, % used - replaces
*Zabbix value cache, % free*
The trigger expressions using the replaced items have been updated
accordingly.
# - Setup from sources
# - Setup from sources
#### Sharing
The **Sharing** tab contains the map type as well as sharing options
(user groups, users) for private maps:
{width="600"}
|Parameter|Description|
|---------|-----------|
|*Type*|Select map type:<br>**Private** - map is visible only to selected user groups and users<br>**Public** - map is visible to all|
|*List of user group shares*|Select user groups that the map is accessible to.<br>You may allow read-only or read-write access.|
|*List of user shares*|Select users that the map is accessible to.<br>You may allow read-only or read-write access.|
When you click on *Add* to save this map, you have created an empty map
with a name, dimensions and certain preferences. Now you need to add
some elements. For that, click on *Constructor* in the map list to open
the editable area.
#### Sharing
The **Sharing** tab contains the map type as well as sharing options
(user groups, users) for private maps:
{width="600"}
|Parameter|Description|
|---------|-----------|
|*Type*|Select map type:<br>**Private** - map is visible only to selected user groups and users<br>**Public** - map is visible to all|
|*List of user group shares*|Select user groups that the map is accessible to.<br>You may allow read-only or read-write access.|
|*List of user shares*|Select users that the map is accessible to.<br>You may allow read-only or read-write access.|
When you click on *Add* to save this map, you have created an empty map
with a name, dimensions and certain preferences. Now you need to add
some elements. For that, click on *Constructor* in the map list to open
the editable area.
#### SNMP interface templates
Update intervals have been changed from 5m to 3m for these LLD item
prototypes:
- `Interface {#IFNAME}({#IFALIAS}): Inbound packets with errors`
- `Interface {#IFNAME}({#IFALIAS}): Outbound packets with errors`
in:
- *Template Module Interfaces Simple SNMPv1*
- *Template Module Interfaces Simple SNMPv2*
- *Template Module Interfaces SNMPv1*
- *Template Module Interfaces SNMPv2*
- *Template Module Interfaces Windows SNMPv2*
These update intervals have been changed to avoid creation of excess
internal events caused by trigger state flapping.
#### SNMP interface templates
Update intervals have been changed from 5m to 3m for these LLD item
prototypes:
- `Interface {#IFNAME}({#IFALIAS}): Inbound packets with errors`
- `Interface {#IFNAME}({#IFALIAS}): Outbound packets with errors`
in:
- *Template Module Interfaces Simple SNMPv1*
- *Template Module Interfaces Simple SNMPv2*
- *Template Module Interfaces SNMPv1*
- *Template Module Interfaces SNMPv2*
- *Template Module Interfaces Windows SNMPv2*
These update intervals have been changed to avoid creation of excess
internal events caused by trigger state flapping.
#### Sound in browsers
Sounds are now supported in MP3 format only.
#### Sound in browsers
Sounds are now supported in MP3 format only.
### Source
CDiscoveryRule::create() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CDiscoveryRule::create() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CDiscoveryRule::delete() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CDiscoveryRule::delete() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CDiscoveryRule::get() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CDiscoveryRule::get() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CDiscoveryRule::update() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CDiscoveryRule::update() in
*frontends/php/include/classes/api/services/CDiscoveryRule.php*.
### Source
CEvent::get() in
*frontends/php/include/classes/api/services/CProblem.php*.
### Source
CEvent::get() in
*frontends/php/include/classes/api/services/CProblem.php*.
### Source
CItem::create() in
*frontends/php/include/classes/api/services/CItem.php*.
### Source
CItem::create() in
*frontends/php/include/classes/api/services/CItem.php*.
### Source
CItem::delete() in
*frontends/php/include/classes/api/services/CItem.php*.
### Source
CItem::delete() in
*frontends/php/include/classes/api/services/CItem.php*.
### Source
CItem::get() in *frontends/php/include/classes/api/services/CItem.php*.
### Source
CItem::get() in *frontends/php/include/classes/api/services/CItem.php*.
### Source
CItem::update() in
*frontends/php/include/classes/api/services/CItem.php*.
### Source
CItem::update() in
*frontends/php/include/classes/api/services/CItem.php*.
### Source
CMaintenance::create() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMaintenance::create() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMaintenance::delete() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMaintenance::delete() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMaintenance::get() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMaintenance::get() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMaintenance::update() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMaintenance::update() in
*frontends/php/include/classes/api/services/CMaintenance.php*.
### Source
CMap::create() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMap::create() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMap::delete() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMap::delete() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMap::get() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMap::get() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMap::update() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMap::update() in *frontends/php/include/classes/api/services/CMap.php*.
### Source
CMediaType::create() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CMediaType::create() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CMediaType::delete() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CMediaType::delete() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CMediaType::get() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CMediaType::get() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CMediaType::update() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CMediaType::update() in
*frontends/php/include/classes/api/services/CMediaType.php*.
### Source
CProxy::create() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CProxy::create() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CProxy::delete() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CProxy::delete() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CProxy::get() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CProxy::get() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CProxy::update() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CProxy::update() in
*frontends/php/include/classes/api/services/CProxy.php*.
### Source
CScreen::create() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScreen::create() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScreen::delete() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScreen::delete() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScreen::get() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScreen::get() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScreenItem::create() in
*frontends/php/include/classes/api/services/CScreenItem.php*.
### Source
CScreenItem::create() in
*frontends/php/include/classes/api/services/CScreenItem.php*.
### Source
CScreenItem::delete() in
*frontends/php/include/classes/api/services/CScreenItem.php*.
### Source
CScreenItem::delete() in
*frontends/php/include/classes/api/services/CScreenItem.php*.
### Source
CScreen::update() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScreen::update() in
*frontends/php/include/classes/api/services/CScreen.php*.
### Source
CScript::create() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::create() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::delete() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::delete() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::execute() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::execute() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::get() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::get() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::getScriptsByHosts() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::getScriptsByHosts() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::update() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CScript::update() in
*frontends/php/include/classes/api/services/CScript.php*.
### Source
CUser::checkAuthentication() in
*frontends/php/include/classes/api/services/CUser.php*.
### Source
CUser::checkAuthentication() in
*frontends/php/include/classes/api/services/CUser.php*.
#### Strings
Strings should be enclosed with single ' or double " quotes. Inside the
strings, single or double quotes (depending on which are used to enclose
it) and backslashes `\` are escaped with the backslash `\` character.
#### Strings
Strings should be enclosed with single ' or double " quotes. Inside the
strings, single or double quotes (depending on which are used to enclose
it) and backslashes `\` are escaped with the backslash `\` character.
##### Substring extraction
Substring extraction is supported for populating the tag name or tag
value, using a macro [function](/manual/config/macros/macro_functions) -
applying a regular expression to the value obtained by the {ITEM.VALUE},
{ITEM.LASTVALUE} macro or a low-level discovery macro. For example:
{{ITEM.VALUE}.regsub(pattern, output)}
{{ITEM.VALUE}.iregsub(pattern, output)}
{{#LLDMACRO}.regsub(pattern, output)}
{{#LLDMACRO}.iregsub(pattern, output)}
Tag name and value will be cut to 255 characters if their length exceeds
255 characters after macro resolution.
See also: Using macro functions in [low-level discovery
macros](/manual/config/macros/lld_macros#using_macro_functions) for
event tagging.
##### Substring extraction
Substring extraction is supported for populating the tag name or tag
value, using a macro [function](/manual/config/macros/macro_functions) -
applying a regular expression to the value obtained by the {ITEM.VALUE},
{ITEM.LASTVALUE} macro or a low-level discovery macro. For example:
{{ITEM.VALUE}.regsub(pattern, output)}
{{ITEM.VALUE}.iregsub(pattern, output)}
{{#LLDMACRO}.regsub(pattern, output)}
{{#LLDMACRO}.iregsub(pattern, output)}
Tag name and value will be cut to 255 characters if their length exceeds
255 characters after macro resolution.
See also: Using macro functions in [low-level discovery
macros](/manual/config/macros/lld_macros#using_macro_functions) for
event tagging.
#### Supported platforms
Zabbix proxy runs on the same list of
[server\#supported platforms](/manual/concepts/server#supported platforms)
as Zabbix server.
#### Supported platforms
Zabbix proxy runs on the same list of
[server\#supported platforms](/manual/concepts/server#supported platforms)
as Zabbix server.
#### Supported segments
|Segment|Description|
|-------|-----------|
|`<name>`|Match object property by name.|
|`*`|Match all object properties.|
|`['<name>']`|Match object property by name.|
|`['<name>', '<name>', ...]`|Match object property by any of the listed names.|
|`[<index>]`|Match array element by the index.|
|`[<number>, <number>, ...]`|Match array element by any of the listed indexes.|
|`[*]`|Match all object properties or array elements.|
|`[<start>:<end>]`|Match array elements by the defined range:<br>**<start>** - the first index to match (including). If not specified matches all array elements from the beginning. If negative specifies starting offset from the end of array.<br>**<end>** - the last index to match (excluding). If not specified matches all array elements to the end. If negative specifies starting offset from the end of array.|
|`[?(<expression>)]`|Match objects/array elements by applying filter expression.|
To find a matching segment ignoring its ancestry (detached segment) it
must be prefixed with '..' , for example `$..name` or `$..['name']`
return values of all 'name' properties.
Since Zabbix 4.0.19 matched element names can be extracted by adding a
`~` suffix to the JSONPath. It returns the name of the matched object or
an index in string format of the matched array item. The output format
follows the same rules as other JSONPath queries - definite path results
are returned 'as is' and indefinite path results are returned in array.
However there is not much point of extracting the name of an element
matching a definite path - it's already known.
#### Supported segments
|Segment|Description|
|-------|-----------|
|`<name>`|Match object property by name.|
|`*`|Match all object properties.|
|`['<name>']`|Match object property by name.|
|`['<name>', '<name>', ...]`|Match object property by any of the listed names.|
|`[<index>]`|Match array element by the index.|
|`[<number>, <number>, ...]`|Match array element by any of the listed indexes.|
|`[*]`|Match all object properties or array elements.|
|`[<start>:<end>]`|Match array elements by the defined range:<br>**<start>** - the first index to match (including). If not specified matches all array elements from the beginning. If negative specifies starting offset from the end of array.<br>**<end>** - the last index to match (excluding). If not specified matches all array elements to the end. If negative specifies starting offset from the end of array.|
|`[?(<expression>)]`|Match objects/array elements by applying filter expression.|
To find a matching segment ignoring its ancestry (detached segment) it
must be prefixed with '..' , for example `$..name` or `$..['name']`
return values of all 'name' properties.
Since Zabbix 4.0.19 matched element names can be extracted by adding a
`~` suffix to the JSONPath. It returns the name of the matched object or
an index in string format of the matched array item. The output format
follows the same rules as other JSONPath queries - definite path results
are returned 'as is' and indefinite path results are returned in array.
However there is not much point of extracting the name of an element
matching a definite path - it's already known.
##### Switching from AES128 to AES256
Zabbix uses AES128 as the built-in default for data. Let's assume you
are using certificates and want to switch to AES256, on OpenSSL 1.1.1.
This can be achieved by adding the respective parameters in
`zabbix_server.conf`:
TLSCAFile=/home/zabbix/ca.crt
TLSCertFile=/home/zabbix/server.crt
TLSKeyFile=/home/zabbix/server.key
TLSCipherCert13=TLS_AES_256_GCM_SHA384
TLSCipherCert=EECDH+aRSA+AES256:-SHA1:-SHA384
TLSCipherPSK13=TLS_CHACHA20_POLY1305_SHA256
TLSCipherPSK=kECDHEPSK+AES256:-SHA1
TLSCipherAll13=TLS_AES_256_GCM_SHA384
TLSCipherAll=EECDH+aRSA+AES256:-SHA1:-SHA384
::: noteimportant
Although only certificate-related ciphersuites
will be used, `TLSCipherPSK*` parameters are defined as well to avoid
their default values which include less secure ciphers for wider
interoperability. PSK ciphersuites cannot be completely disabled on
server/proxy.
:::
And in `zabbix_agentd.conf`:
TLSConnect=cert
TLSAccept=cert
TLSCAFile=/home/zabbix/ca.crt
TLSCertFile=/home/zabbix/agent.crt
TLSKeyFile=/home/zabbix/agent.key
TLSCipherCert13=TLS_AES_256_GCM_SHA384
TLSCipherCert=EECDH+aRSA+AES256:-SHA1:-SHA384
##### Switching from AES128 to AES256
Zabbix uses AES128 as the built-in default for data. Let's assume you
are using certificates and want to switch to AES256, on OpenSSL 1.1.1.
This can be achieved by adding the respective parameters in
`zabbix_server.conf`:
TLSCAFile=/home/zabbix/ca.crt
TLSCertFile=/home/zabbix/server.crt
TLSKeyFile=/home/zabbix/server.key
TLSCipherCert13=TLS_AES_256_GCM_SHA384
TLSCipherCert=EECDH+aRSA+AES256:-SHA1:-SHA384
TLSCipherPSK13=TLS_CHACHA20_POLY1305_SHA256
TLSCipherPSK=kECDHEPSK+AES256:-SHA1
TLSCipherAll13=TLS_AES_256_GCM_SHA384
TLSCipherAll=EECDH+aRSA+AES256:-SHA1:-SHA384
::: noteimportant
Although only certificate-related ciphersuites
will be used, `TLSCipherPSK*` parameters are defined as well to avoid
their default values which include less secure ciphers for wider
interoperability. PSK ciphersuites cannot be completely disabled on
server/proxy.
:::
And in `zabbix_agentd.conf`:
TLSConnect=cert
TLSAccept=cert
TLSCAFile=/home/zabbix/ca.crt
TLSCertFile=/home/zabbix/agent.crt
TLSKeyFile=/home/zabbix/agent.key
TLSCipherCert13=TLS_AES_256_GCM_SHA384
TLSCipherCert=EECDH+aRSA+AES256:-SHA1:-SHA384
#### Switching to raw values
A dropdown on the upper right allows to switch from the simple graph to
the *Values/500 latest values* listings. This can be useful for viewing
the numeric values making up the graph.
The values represented here are raw, i.e. no units or postprocessing of
values is used. Value mapping, however, is applied.
#### Switching to raw values
A dropdown on the upper right allows to switch from the simple graph to
the *Values/500 latest values* listings. This can be useful for viewing
the numeric values making up the graph.
The values represented here are raw, i.e. no units or postprocessing of
values is used. Value mapping, however, is applied.
## SYNOPSIS
**zabbix\_agentd** \[**-c** *config-file*\]\
**zabbix\_agentd** \[**-c** *config-file*\] **-p**\
**zabbix\_agentd** \[**-c** *config-file*\] **-t** *item-key*\
**zabbix\_agentd** \[**-c** *config-file*\] **-R** *runtime-option*\
**zabbix\_agentd -h**\
**zabbix\_agentd -V** [ ]{#lbAD}
## SYNOPSIS
**zabbix\_agentd** \[**-c** *config-file*\]\
**zabbix\_agentd** \[**-c** *config-file*\] **-p**\
**zabbix\_agentd** \[**-c** *config-file*\] **-t** *item-key*\
**zabbix\_agentd** \[**-c** *config-file*\] **-R** *runtime-option*\
**zabbix\_agentd -h**\
**zabbix\_agentd -V** [ ]{#lbAD}
## SYNOPSIS
**zabbix\_proxy** \[**-c** *config-file*\]\
**zabbix\_proxy** \[**-c** *config-file*\] **-R** *runtime-option*\
**zabbix\_proxy -h**\
**zabbix\_proxy -V** [ ]{#lbAD}
## SYNOPSIS
**zabbix\_proxy** \[**-c** *config-file*\]\
**zabbix\_proxy** \[**-c** *config-file*\] **-R** *runtime-option*\
**zabbix\_proxy -h**\
**zabbix\_proxy -V** [ ]{#lbAD}
## SYNOPSIS
**zabbix\_server** \[**-c** *config-file*\]\
**zabbix\_server** \[**-c** *config-file*\] **-R** *runtime-option*\
**zabbix\_server -h**\
**zabbix\_server -V** [ ]{#lbAD}
## SYNOPSIS
**zabbix\_server** \[**-c** *config-file*\]\
**zabbix\_server** \[**-c** *config-file*\] **-R** *runtime-option*\
**zabbix\_server -h**\
**zabbix\_server -V** [ ]{#lbAD}
##### Template filtering based on linked templates
Templates can now be filtered based on the templates that are directly
linked to it. Multiple directly linked templates can be specified.
{width="550"}
##### Template filtering based on linked templates
Templates can now be filtered based on the templates that are directly
linked to it. Multiple directly linked templates can be specified.
{width="550"}
#### Templates
In a [template](/manual/config/templates/template) configuration, user
macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|//Tags //|<|<|
|<|Tag names|yes|
|^|Tag values|yes|
#### Templates
In a [template](/manual/config/templates/template) configuration, user
macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|//Tags //|<|<|
|<|Tag names|yes|
|^|Tag values|yes|
#### Templates
Templates are available for remote monitoring of Zabbix server or proxy
internal metrics from an external instance:
- Template App Remote Zabbix server
- Template App Remote Zabbix proxy
Note that in order to use a template for remote monitoring of multiple
external instances, a separate host is required for each external
instance monitoring.
#### Templates
Templates are available for remote monitoring of Zabbix server or proxy
internal metrics from an external instance:
- Template App Remote Zabbix server
- Template App Remote Zabbix proxy
Note that in order to use a template for remote monitoring of multiple
external instances, a separate host is required for each external
instance monitoring.
##### Testing cipher strings and allowing only PFS ciphersuites
To see which ciphersuites have been selected you need to set
'DebugLevel=4' in the configuration file, or use the `-vv` option for
zabbix\_sender.
Some experimenting with `TLSCipher*` parameters might be necessary
before you get the desired ciphersuites. It is inconvenient to restart
Zabbix server, proxy or agent multiple times just to tweak `TLSCipher*`
parameters. More convenient options are using zabbix\_sender or the
`openssl` command. Let's show both.
**1.** Using zabbix\_sender.
Let's make a test configuration file, for example
/home/zabbix/test.conf, with the syntax of a zabbix\_agentd.conf file:
Hostname=nonexisting
ServerActive=nonexisting
TLSConnect=cert
TLSCAFile=/home/zabbix/ca.crt
TLSCertFile=/home/zabbix/agent.crt
TLSKeyFile=/home/zabbix/agent.key
TLSPSKIdentity=nonexisting
TLSPSKFile=/home/zabbix/agent.psk
You need valid CA and agent certificates and PSK for this example.
Adjust certificate and PSK file paths and names for your environment.
If you are not using certificates, but only PSK, you can make a simpler
test file:
Hostname=nonexisting
ServerActive=nonexisting
TLSConnect=psk
TLSPSKIdentity=nonexisting
TLSPSKFile=/home/zabbix/agentd.psk
The selected ciphersuites can be seen by running zabbix\_sender (example
compiled with OpenSSL 1.1.d):
$ zabbix_sender -vv -c /home/zabbix/test.conf -k nonexisting_item -o 1 2>&1 | grep ciphersuites
zabbix_sender [41271]: DEBUG: zbx_tls_init_child() certificate ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA AES128-GCM-SHA256 AES128-CCM8 AES128-CCM AES128-SHA256 AES128-SHA
zabbix_sender [41271]: DEBUG: zbx_tls_init_child() PSK ciphersuites: TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA PSK-AES128-GCM-SHA256 PSK-AES128-CCM8 PSK-AES128-CCM PSK-AES128-CBC-SHA256 PSK-AES128-CBC-SHA
zabbix_sender [41271]: DEBUG: zbx_tls_init_child() certificate and PSK ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA AES128-GCM-SHA256 AES128-CCM8 AES128-CCM AES128-SHA256 AES128-SHA ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA PSK-AES128-GCM-SHA256 PSK-AES128-CCM8 PSK-AES128-CCM PSK-AES128-CBC-SHA256 PSK-AES128-CBC-SHA
Here you see the ciphersuites selected by default. These default values
are chosen to ensure interoperability with Zabbix agents running on
systems with older OpenSSL versions (from 1.0.1).
With newer systems you can choose to tighten security by allowing only a
few ciphersuites, e.g. only ciphersuites with PFS (Perfect Forward
Secrecy). Let's try to allow only ciphersuites with PFS using
`TLSCipher*` parameters.
::: noteimportant
The result will not be interoperable with systems
using OpenSSL 1.0.1 and 1.0.2, if PSK is used. Certificate-based
encryption should work.
:::
Add two lines to the `test.conf` configuration file:
TLSCipherCert=EECDH+aRSA+AES128
TLSCipherPSK=kECDHEPSK+AES128
and test again:
$ zabbix_sender -vv -c /home/zabbix/test.conf -k nonexisting_item -o 1 2>&1 | grep ciphersuites
zabbix_sender [42892]: DEBUG: zbx_tls_init_child() certificate ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA
zabbix_sender [42892]: DEBUG: zbx_tls_init_child() PSK ciphersuites: TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA
zabbix_sender [42892]: DEBUG: zbx_tls_init_child() certificate and PSK ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA AES128-GCM-SHA256 AES128-CCM8 AES128-CCM AES128-SHA256 AES128-SHA ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA PSK-AES128-GCM-SHA256 PSK-AES128-CCM8 PSK-AES128-CCM PSK-AES128-CBC-SHA256 PSK-AES128-CBC-SHA
The "certificate ciphersuites" and "PSK ciphersuites" lists have changed
- they are shorter than before, only containing TLS 1.3 ciphersuites and
TLS 1.2 ECDHE-\* ciphersuites as expected.
**2.** TLSCipherAll and TLSCipherAll13 cannot be tested with
zabbix\_sender; they do not affect "certificate and PSK ciphersuites"
value shown in the example above. To tweak TLSCipherAll and
TLSCipherAll13 you need to experiment with the agent, proxy or server.
So, to allow only PFS ciphersuites you may need to add up to three
parameters
TLSCipherCert=EECDH+aRSA+AES128
TLSCipherPSK=kECDHEPSK+AES128
TLSCipherAll=EECDH+aRSA+AES128:kECDHEPSK+AES128
to zabbix\_agentd.conf, zabbix\_proxy.conf and zabbix\_server\_conf if
each of them has a configured certificate and agent has also PSK.
If your Zabbix environment uses only PSK-based encryption and no
certificates, then only one:
TLSCipherPSK=kECDHEPSK+AES128
Now that you understand how it works you can test the ciphersuite
selection even outside of Zabbix, with the `openssl` command. Let's test
all three `TLSCipher*` parameter values:
$ openssl ciphers EECDH+aRSA+AES128 | sed 's/:/ /g'
TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA
$ openssl ciphers kECDHEPSK+AES128 | sed 's/:/ /g'
TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA
$ openssl ciphers EECDH+aRSA+AES128:kECDHEPSK+AES128 | sed 's/:/ /g'
TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA
You may prefer `openssl ciphers` with option `-V` for a more verbose
output:
$ openssl ciphers -V EECDH+aRSA+AES128:kECDHEPSK+AES128
0x13,0x02 - TLS_AES_256_GCM_SHA384 TLSv1.3 Kx=any Au=any Enc=AESGCM(256) Mac=AEAD
0x13,0x03 - TLS_CHACHA20_POLY1305_SHA256 TLSv1.3 Kx=any Au=any Enc=CHACHA20/POLY1305(256) Mac=AEAD
0x13,0x01 - TLS_AES_128_GCM_SHA256 TLSv1.3 Kx=any Au=any Enc=AESGCM(128) Mac=AEAD
0xC0,0x2F - ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH Au=RSA Enc=AESGCM(128) Mac=AEAD
0xC0,0x27 - ECDHE-RSA-AES128-SHA256 TLSv1.2 Kx=ECDH Au=RSA Enc=AES(128) Mac=SHA256
0xC0,0x13 - ECDHE-RSA-AES128-SHA TLSv1 Kx=ECDH Au=RSA Enc=AES(128) Mac=SHA1
0xC0,0x37 - ECDHE-PSK-AES128-CBC-SHA256 TLSv1 Kx=ECDHEPSK Au=PSK Enc=AES(128) Mac=SHA256
0xC0,0x35 - ECDHE-PSK-AES128-CBC-SHA TLSv1 Kx=ECDHEPSK Au=PSK Enc=AES(128) Mac=SHA1
Similarly, you can test the priority strings for GnuTLS:
$ gnutls-cli -l --priority=NONE:+VERS-TLS1.2:+ECDHE-RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509
Cipher suites for NONE:+VERS-TLS1.2:+ECDHE-RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509
TLS_ECDHE_RSA_AES_128_GCM_SHA256 0xc0, 0x2f TLS1.2
TLS_ECDHE_RSA_AES_128_CBC_SHA256 0xc0, 0x27 TLS1.2
Protocols: VERS-TLS1.2
Ciphers: AES-128-GCM, AES-128-CBC
MACs: AEAD, SHA256
Key Exchange Algorithms: ECDHE-RSA
Groups: GROUP-SECP256R1, GROUP-SECP384R1, GROUP-SECP521R1, GROUP-X25519, GROUP-X448, GROUP-FFDHE2048, GROUP-FFDHE3072, GROUP-FFDHE4096, GROUP-FFDHE6144, GROUP-FFDHE8192
PK-signatures: SIGN-RSA-SHA256, SIGN-RSA-PSS-SHA256, SIGN-RSA-PSS-RSAE-SHA256, SIGN-ECDSA-SHA256, SIGN-ECDSA-SECP256R1-SHA256, SIGN-EdDSA-Ed25519, SIGN-RSA-SHA384, SIGN-RSA-PSS-SHA384, SIGN-RSA-PSS-RSAE-SHA384, SIGN-ECDSA-SHA384, SIGN-ECDSA-SECP384R1-SHA384, SIGN-EdDSA-Ed448, SIGN-RSA-SHA512, SIGN-RSA-PSS-SHA512, SIGN-RSA-PSS-RSAE-SHA512, SIGN-ECDSA-SHA512, SIGN-ECDSA-SECP521R1-SHA512, SIGN-RSA-SHA1, SIGN-ECDSA-SHA1
##### Testing cipher strings and allowing only PFS ciphersuites
To see which ciphersuites have been selected you need to set
'DebugLevel=4' in the configuration file, or use the `-vv` option for
zabbix\_sender.
Some experimenting with `TLSCipher*` parameters might be necessary
before you get the desired ciphersuites. It is inconvenient to restart
Zabbix server, proxy or agent multiple times just to tweak `TLSCipher*`
parameters. More convenient options are using zabbix\_sender or the
`openssl` command. Let's show both.
**1.** Using zabbix\_sender.
Let's make a test configuration file, for example
/home/zabbix/test.conf, with the syntax of a zabbix\_agentd.conf file:
Hostname=nonexisting
ServerActive=nonexisting
TLSConnect=cert
TLSCAFile=/home/zabbix/ca.crt
TLSCertFile=/home/zabbix/agent.crt
TLSKeyFile=/home/zabbix/agent.key
TLSPSKIdentity=nonexisting
TLSPSKFile=/home/zabbix/agent.psk
You need valid CA and agent certificates and PSK for this example.
Adjust certificate and PSK file paths and names for your environment.
If you are not using certificates, but only PSK, you can make a simpler
test file:
Hostname=nonexisting
ServerActive=nonexisting
TLSConnect=psk
TLSPSKIdentity=nonexisting
TLSPSKFile=/home/zabbix/agentd.psk
The selected ciphersuites can be seen by running zabbix\_sender (example
compiled with OpenSSL 1.1.d):
$ zabbix_sender -vv -c /home/zabbix/test.conf -k nonexisting_item -o 1 2>&1 | grep ciphersuites
zabbix_sender [41271]: DEBUG: zbx_tls_init_child() certificate ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA AES128-GCM-SHA256 AES128-CCM8 AES128-CCM AES128-SHA256 AES128-SHA
zabbix_sender [41271]: DEBUG: zbx_tls_init_child() PSK ciphersuites: TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA PSK-AES128-GCM-SHA256 PSK-AES128-CCM8 PSK-AES128-CCM PSK-AES128-CBC-SHA256 PSK-AES128-CBC-SHA
zabbix_sender [41271]: DEBUG: zbx_tls_init_child() certificate and PSK ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA AES128-GCM-SHA256 AES128-CCM8 AES128-CCM AES128-SHA256 AES128-SHA ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA PSK-AES128-GCM-SHA256 PSK-AES128-CCM8 PSK-AES128-CCM PSK-AES128-CBC-SHA256 PSK-AES128-CBC-SHA
Here you see the ciphersuites selected by default. These default values
are chosen to ensure interoperability with Zabbix agents running on
systems with older OpenSSL versions (from 1.0.1).
With newer systems you can choose to tighten security by allowing only a
few ciphersuites, e.g. only ciphersuites with PFS (Perfect Forward
Secrecy). Let's try to allow only ciphersuites with PFS using
`TLSCipher*` parameters.
::: noteimportant
The result will not be interoperable with systems
using OpenSSL 1.0.1 and 1.0.2, if PSK is used. Certificate-based
encryption should work.
:::
Add two lines to the `test.conf` configuration file:
TLSCipherCert=EECDH+aRSA+AES128
TLSCipherPSK=kECDHEPSK+AES128
and test again:
$ zabbix_sender -vv -c /home/zabbix/test.conf -k nonexisting_item -o 1 2>&1 | grep ciphersuites
zabbix_sender [42892]: DEBUG: zbx_tls_init_child() certificate ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA
zabbix_sender [42892]: DEBUG: zbx_tls_init_child() PSK ciphersuites: TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA
zabbix_sender [42892]: DEBUG: zbx_tls_init_child() certificate and PSK ciphersuites: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA AES128-GCM-SHA256 AES128-CCM8 AES128-CCM AES128-SHA256 AES128-SHA ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA PSK-AES128-GCM-SHA256 PSK-AES128-CCM8 PSK-AES128-CCM PSK-AES128-CBC-SHA256 PSK-AES128-CBC-SHA
The "certificate ciphersuites" and "PSK ciphersuites" lists have changed
- they are shorter than before, only containing TLS 1.3 ciphersuites and
TLS 1.2 ECDHE-\* ciphersuites as expected.
**2.** TLSCipherAll and TLSCipherAll13 cannot be tested with
zabbix\_sender; they do not affect "certificate and PSK ciphersuites"
value shown in the example above. To tweak TLSCipherAll and
TLSCipherAll13 you need to experiment with the agent, proxy or server.
So, to allow only PFS ciphersuites you may need to add up to three
parameters
TLSCipherCert=EECDH+aRSA+AES128
TLSCipherPSK=kECDHEPSK+AES128
TLSCipherAll=EECDH+aRSA+AES128:kECDHEPSK+AES128
to zabbix\_agentd.conf, zabbix\_proxy.conf and zabbix\_server\_conf if
each of them has a configured certificate and agent has also PSK.
If your Zabbix environment uses only PSK-based encryption and no
certificates, then only one:
TLSCipherPSK=kECDHEPSK+AES128
Now that you understand how it works you can test the ciphersuite
selection even outside of Zabbix, with the `openssl` command. Let's test
all three `TLSCipher*` parameter values:
$ openssl ciphers EECDH+aRSA+AES128 | sed 's/:/ /g'
TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA
$ openssl ciphers kECDHEPSK+AES128 | sed 's/:/ /g'
TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA
$ openssl ciphers EECDH+aRSA+AES128:kECDHEPSK+AES128 | sed 's/:/ /g'
TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES128-SHA256 ECDHE-RSA-AES128-SHA ECDHE-PSK-AES128-CBC-SHA256 ECDHE-PSK-AES128-CBC-SHA
You may prefer `openssl ciphers` with option `-V` for a more verbose
output:
$ openssl ciphers -V EECDH+aRSA+AES128:kECDHEPSK+AES128
0x13,0x02 - TLS_AES_256_GCM_SHA384 TLSv1.3 Kx=any Au=any Enc=AESGCM(256) Mac=AEAD
0x13,0x03 - TLS_CHACHA20_POLY1305_SHA256 TLSv1.3 Kx=any Au=any Enc=CHACHA20/POLY1305(256) Mac=AEAD
0x13,0x01 - TLS_AES_128_GCM_SHA256 TLSv1.3 Kx=any Au=any Enc=AESGCM(128) Mac=AEAD
0xC0,0x2F - ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH Au=RSA Enc=AESGCM(128) Mac=AEAD
0xC0,0x27 - ECDHE-RSA-AES128-SHA256 TLSv1.2 Kx=ECDH Au=RSA Enc=AES(128) Mac=SHA256
0xC0,0x13 - ECDHE-RSA-AES128-SHA TLSv1 Kx=ECDH Au=RSA Enc=AES(128) Mac=SHA1
0xC0,0x37 - ECDHE-PSK-AES128-CBC-SHA256 TLSv1 Kx=ECDHEPSK Au=PSK Enc=AES(128) Mac=SHA256
0xC0,0x35 - ECDHE-PSK-AES128-CBC-SHA TLSv1 Kx=ECDHEPSK Au=PSK Enc=AES(128) Mac=SHA1
Similarly, you can test the priority strings for GnuTLS:
$ gnutls-cli -l --priority=NONE:+VERS-TLS1.2:+ECDHE-RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509
Cipher suites for NONE:+VERS-TLS1.2:+ECDHE-RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509
TLS_ECDHE_RSA_AES_128_GCM_SHA256 0xc0, 0x2f TLS1.2
TLS_ECDHE_RSA_AES_128_CBC_SHA256 0xc0, 0x27 TLS1.2
Protocols: VERS-TLS1.2
Ciphers: AES-128-GCM, AES-128-CBC
MACs: AEAD, SHA256
Key Exchange Algorithms: ECDHE-RSA
Groups: GROUP-SECP256R1, GROUP-SECP384R1, GROUP-SECP521R1, GROUP-X25519, GROUP-X448, GROUP-FFDHE2048, GROUP-FFDHE3072, GROUP-FFDHE4096, GROUP-FFDHE6144, GROUP-FFDHE8192
PK-signatures: SIGN-RSA-SHA256, SIGN-RSA-PSS-SHA256, SIGN-RSA-PSS-RSAE-SHA256, SIGN-ECDSA-SHA256, SIGN-ECDSA-SECP256R1-SHA256, SIGN-EdDSA-Ed25519, SIGN-RSA-SHA384, SIGN-RSA-PSS-SHA384, SIGN-RSA-PSS-RSAE-SHA384, SIGN-ECDSA-SHA384, SIGN-ECDSA-SECP384R1-SHA384, SIGN-EdDSA-Ed448, SIGN-RSA-SHA512, SIGN-RSA-PSS-SHA512, SIGN-RSA-PSS-RSAE-SHA512, SIGN-ECDSA-SHA512, SIGN-ECDSA-SECP521R1-SHA512, SIGN-RSA-SHA1, SIGN-ECDSA-SHA1
#### Testing MIB files
Testing snmp MIBs can be done using `snmpwalk` utility. If you don't
have it installed, use the following instructions.
On Debian-based systems:
# apt install snmp
On RedHat-based systems:
# yum install net-snmp-utils
After that, the following command must not give error when you query a
network device:
$ snmpwalk -v 2c -c public <NETWORK DEVICE IP> ifInOctets
IF-MIB::ifInOctets.1 = Counter32: 176137634
IF-MIB::ifInOctets.2 = Counter32: 0
IF-MIB::ifInOctets.3 = Counter32: 240375057
IF-MIB::ifInOctets.4 = Counter32: 220893420
[...]
Used options:
| | |
|---|---|
|-v 2c|use SNMP protocol version 2c|
| | |
|---|---|
#### Testing MIB files
Testing snmp MIBs can be done using `snmpwalk` utility. If you don't
have it installed, use the following instructions.
On Debian-based systems:
# apt install snmp
On RedHat-based systems:
# yum install net-snmp-utils
After that, the following command must not give error when you query a
network device:
$ snmpwalk -v 2c -c public <NETWORK DEVICE IP> ifInOctets
IF-MIB::ifInOctets.1 = Counter32: 176137634
IF-MIB::ifInOctets.2 = Counter32: 0
IF-MIB::ifInOctets.3 = Counter32: 240375057
IF-MIB::ifInOctets.4 = Counter32: 220893420
[...]
Used options:
| | |
|---|---|
|-v 2c|use SNMP protocol version 2c|
| | |
|---|---|
This is a blank page to display the parent page as a folder.
This is a blank page to display the parent page as a folder.
#### Timeout value in web scenario steps
The timeout value in a web scenario step can no longer be '0'.
Similarly, any user macros used in this field must not resolve to '0'.
#### Timeout value in web scenario steps
The timeout value in a web scenario step can no longer be '0'.
Similarly, any user macros used in this field must not resolve to '0'.
##### Time period selector
Take note of the time period selector above the graph. It allows to
select often required periods with one mouse click.
See also: [Time period
selector](/manual/config/visualization/graphs/simple#time_period_selector)
##### Time period selector
Take note of the time period selector above the graph. It allows to
select often required periods with one mouse click.
See also: [Time period
selector](/manual/config/visualization/graphs/simple#time_period_selector)
#### Time period selector
The [time period
selector](/manual/config/visualization/graphs/simple#time_period_selector)
allows to select often required periods with one mouse click. The time
period selector can be opened by clicking on the time period tab next to
the filter.
Clicking on *Show* in the Graph column displays a bar graph where
availability information is displayed in bar format each bar
representing a past week of the current year.
{width="600"}
The green part of a bar stands for OK time and red for problem time.
#### Time period selector
The [time period
selector](/manual/config/visualization/graphs/simple#time_period_selector)
allows to select often required periods with one mouse click. The time
period selector can be opened by clicking on the time period tab next to
the filter.
Clicking on *Show* in the Graph column displays a bar graph where
availability information is displayed in bar format each bar
representing a past week of the current year.
{width="600"}
The green part of a bar stands for OK time and red for problem time.
#### Time synchronization
It is very important to have precise system time on server with Zabbix
running. [ntpd](http://www.ntp.org/) is the most popular daemon that
synchronizes the host's time with the time of other machines. It's
strongly recommended to maintain synchronized system time on all systems
Zabbix components are running on.
#### Time synchronization
It is very important to have precise system time on server with Zabbix
running. [ntpd](http://www.ntp.org/) is the most popular daemon that
synchronizes the host's time with the time of other machines. It's
strongly recommended to maintain synchronized system time on all systems
Zabbix components are running on.
#### Tomcat template
*Template App Apache Tomcat JMX* has been updated:
- support for recent Tomcat versions has been added
- the following macros have been defined: {$PROTOCOL\_HANDLER\_HTTP},
{$PROTOCOL\_HANDLER\_HTTPS}, {$PROTOCOL\_HANDLER\_AJP}
#### Tomcat template
*Template App Apache Tomcat JMX* has been updated:
- support for recent Tomcat versions has been added
- the following macros have been defined: {$PROTOCOL\_HANDLER\_HTTP},
{$PROTOCOL\_HANDLER\_HTTPS}, {$PROTOCOL\_HANDLER\_AJP}
#### Too long PSK value used with OpenSSL 1.1.1
In connecting-side log:
...OpenSSL library (version OpenSSL 1.1.1 11 Sep 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK 1"
...zbx_psk_client_cb() requested PSK identity "PSK 1"
...End of zbx_tls_connect():FAIL error:'SSL_connect() set result code to SSL_ERROR_SSL: file ssl\statem\extensions_clnt.c line 801: error:14212044:SSL routines:tls_construct_ctos_early_data:internal error: TLS write fatal alert "internal error"'
In accepting-side log:
...Message from 123.123.123.123 is missing header. Message ignored.
This problem typically arises when upgrading OpenSSL from 1.0.x or 1.1.0
to 1.1.1 and if the PSK value is longer than 512-bit (64-byte PSK,
entered as 128 hexadecimal digits).
See also: [Value size
limits](/manual/encryption/using_pre_shared_keys#size_limits)
#### Too long PSK value used with OpenSSL 1.1.1
In connecting-side log:
...OpenSSL library (version OpenSSL 1.1.1 11 Sep 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK 1"
...zbx_psk_client_cb() requested PSK identity "PSK 1"
...End of zbx_tls_connect():FAIL error:'SSL_connect() set result code to SSL_ERROR_SSL: file ssl\statem\extensions_clnt.c line 801: error:14212044:SSL routines:tls_construct_ctos_early_data:internal error: TLS write fatal alert "internal error"'
In accepting-side log:
...Message from 123.123.123.123 is missing header. Message ignored.
This problem typically arises when upgrading OpenSSL from 1.0.x or 1.1.0
to 1.1.1 and if the PSK value is longer than 512-bit (64-byte PSK,
entered as 128 hexadecimal digits).
See also: [Value size
limits](/manual/encryption/using_pre_shared_keys#size_limits)
#### Trapper process
Receiving internal metric requests from an external Zabbix instance is
handled by the trapper process that validates the request, gathers the
metrics, creates the JSON data buffer and sends the prepared JSON back,
for example, from server:
``` {.java}
{
"response": "success",
"data": {
"boottime": N,
"hosts": N,
"items": N,
"items_unsupported": N,
"preprocessing_queue": N,
"process": {
"alert manager": {
"busy": {
"avg": N,
"max": N,
"min": N
},
"idle": {
"avg": N,
"max": N,
"min": N
},
"count": N
},
...
},
"queue": N,
"rcache": {
"total": N,
"free": N,
"pfree": N,
"used": N,
"pused": N
},
"requiredperformance": N,
"triggers": N,
"uptime": N,
"vcache": {
"buffer": {
"total": N,
"free": N,
"pfree": N,
"used": N,
"pused": N
},
"cache": {
"requests": N,
"hits": N,
"misses": N,
"mode": N
}
},
"vmware": {
"total": N,
"free": N,
"pfree": N,
"used": N,
"pused": N
},
"wcache": {
"values": {
"all": N,
"float": N,
"uint": N,
"str": N,
"log": N,
"text": N,
"not supported": N
},
"history": {
"pfree": N,
"free": N,
"total": N,
"used": N,
"pused": N
},
"index": {
"pfree": N,
"free": N,
"total": N,
"used": N,
"pused": N
},
"trend": {
"pfree": N,
"free": N,
"total": N,
"used": N,
"pused": N
}
}
}
}
```
#### Trapper process
Receiving internal metric requests from an external Zabbix instance is
handled by the trapper process that validates the request, gathers the
metrics, creates the JSON data buffer and sends the prepared JSON back,
for example, from server:
``` {.java}
{
"response": "success",
"data": {
"boottime": N,
"hosts": N,
"items": N,
"items_unsupported": N,
"preprocessing_queue": N,
"process": {
"alert manager": {
"busy": {
"avg": N,
"max": N,
"min": N
},
"idle": {
"avg": N,
"max": N,
"min": N
},
"count": N
},
...
},
"queue": N,
"rcache": {
"total": N,
"free": N,
"pfree": N,
"used": N,
"pused": N
},
"requiredperformance": N,
"triggers": N,
"uptime": N,
"vcache": {
"buffer": {
"total": N,
"free": N,
"pfree": N,
"used": N,
"pused": N
},
"cache": {
"requests": N,
"hits": N,
"misses": N,
"mode": N
}
},
"vmware": {
"total": N,
"free": N,
"pfree": N,
"used": N,
"pused": N
},
"wcache": {
"values": {
"all": N,
"float": N,
"uint": N,
"str": N,
"log": N,
"text": N,
"not supported": N
},
"history": {
"pfree": N,
"free": N,
"total": N,
"used": N,
"pused": N
},
"index": {
"pfree": N,
"free": N,
"total": N,
"used": N,
"pused": N
},
"trend": {
"pfree": N,
"free": N,
"total": N,
"used": N,
"pused": N
}
}
}
}
```
#### trigger
Bug fixes:\
[ZBX-19424](https://support.zabbix.com/browse/ZBX-19424)
`trigger.create`: fixed trigger creation on PostgreSQL with host name
consisting of only numbers\
#### trigger
Bug fixes:\
[ZBX-19424](https://support.zabbix.com/browse/ZBX-19424)
`trigger.create`: fixed trigger creation on PostgreSQL with host name
consisting of only numbers\
##### Trigger lines
Simple triggers are displayed as lines with black dashes over trigger
severity color -- take note of the blue line on the graph and the
trigger information displayed in the legend. Up to 3 trigger lines can
be displayed on the graph; if there are more triggers then the triggers
with lower severity are prioritized. Triggers are always displayed in
simple graphs, whereas displaying them in [custom
graphs](custom#configuring_custom_graphs) is a user preference.
##### Trigger lines
Simple triggers are displayed as lines with black dashes over trigger
severity color -- take note of the blue line on the graph and the
trigger information displayed in the legend. Up to 3 trigger lines can
be displayed on the graph; if there are more triggers then the triggers
with lower severity are prioritized. Triggers are always displayed in
simple graphs, whereas displaying them in [custom
graphs](custom#configuring_custom_graphs) is a user preference.
### Trigger prototype tag
The trigger prototype tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**tag**<br>(required)|string|Trigger prototype tag name.|
|value|string|Trigger prototype tag value.|
### Trigger prototype tag
The trigger prototype tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**tag**<br>(required)|string|Trigger prototype tag name.|
|value|string|Trigger prototype tag value.|
#### Triggers
In a [trigger](/manual/config/triggers/trigger) configuration, user
macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Name|<|yes|
|Operational data|<|yes|
|Expression (only in constants and function parameters; secret macros are not supported)|<|yes|
|Description|<|yes|
|URL|<|yes|
|Tag for matching|<|yes|
|//Tags //|<|<|
|<|Tag names|yes|
|^|Tag values|yes|
#### Triggers
In a [trigger](/manual/config/triggers/trigger) configuration, user
macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Name|<|yes|
|Operational data|<|yes|
|Expression (only in constants and function parameters; secret macros are not supported).|<|yes|
|Description|<|yes|
|URL|<|yes|
|Tag for matching|<|yes|
|//Tags //|<|<|
|<|Tag names|yes|
|^|Tag values|yes|
### Trigger tag
The trigger tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**tag**<br>(required)|string|Trigger tag name.|
|value|string|Trigger tag value.|
### Trigger tag
The trigger tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**tag**<br>(required)|string|Trigger tag name.|
|value|string|Trigger tag value.|
#### Troubleshooting agent items
- If used with the passive agent, *Timeout* value in server
configuration may need to be higher than *Timeout* in the agent
configuration file. Otherwise the item may not get any value because
the server request to agent timed out first.
#### Troubleshooting agent items
- If used with the passive agent, *Timeout* value in server
configuration may need to be higher than *Timeout* in the agent
configuration file. Otherwise the item may not get any value because
the server request to agent timed out first.
#### Troubleshooting and removing agent
This section lists some useful commands that can be used for
troubleshooting and removing Zabbix agent installation.
See if Zabbix agent is running:
ps aux | grep zabbix_agentd
See if Zabbix agent has been installed from packages:
$ pkgutil --pkgs | grep zabbix
com.zabbix.pkg.ZabbixAgent
See the files that were installed from the installer package (note that
the initial `/` is not displayed in this view):
$ pkgutil --only-files --files com.zabbix.pkg.ZabbixAgent
Library/LaunchDaemons/com.zabbix.zabbix_agentd.plist
usr/local/bin/zabbix_get
usr/local/bin/zabbix_sender
usr/local/etc/zabbix/zabbix_agentd/userparameter_examples.conf.NEW
usr/local/etc/zabbix/zabbix_agentd/userparameter_mysql.conf.NEW
usr/local/etc/zabbix/zabbix_agentd.conf.NEW
usr/local/sbin/zabbix_agentd
Stop Zabbix agent if it was launched with `launchctl`:
sudo launchctl unload /Library/LaunchDaemons/com.zabbix.zabbix_agentd.plist
Remove files (including configuration and logs) that were installed with
installer package:
sudo rm -f /Library/LaunchDaemons/com.zabbix.zabbix_agentd.plist
sudo rm -f /usr/local/sbin/zabbix_agentd
sudo rm -f /usr/local/bin/zabbix_get
sudo rm -f /usr/local/bin/zabbix_sender
sudo rm -rf /usr/local/etc/zabbix
sudo rm -rf /var/logs/zabbix
Forget that Zabbix agent has been installed:
sudo pkgutil --forget com.zabbix.pkg.ZabbixAgent
#### Troubleshooting and removing agent
This section lists some useful commands that can be used for
troubleshooting and removing Zabbix agent installation.
See if Zabbix agent is running:
ps aux | grep zabbix_agentd
See if Zabbix agent has been installed from packages:
$ pkgutil --pkgs | grep zabbix
com.zabbix.pkg.ZabbixAgent
See the files that were installed from the installer package (note that
the initial `/` is not displayed in this view):
$ pkgutil --only-files --files com.zabbix.pkg.ZabbixAgent
Library/LaunchDaemons/com.zabbix.zabbix_agentd.plist
usr/local/bin/zabbix_get
usr/local/bin/zabbix_sender
usr/local/etc/zabbix/zabbix_agentd/userparameter_examples.conf.NEW
usr/local/etc/zabbix/zabbix_agentd/userparameter_mysql.conf.NEW
usr/local/etc/zabbix/zabbix_agentd.conf.NEW
usr/local/sbin/zabbix_agentd
Stop Zabbix agent if it was launched with `launchctl`:
sudo launchctl unload /Library/LaunchDaemons/com.zabbix.zabbix_agentd.plist
Remove files (including configuration and logs) that were installed with
installer package:
sudo rm -f /Library/LaunchDaemons/com.zabbix.zabbix_agentd.plist
sudo rm -f /usr/local/sbin/zabbix_agentd
sudo rm -f /usr/local/bin/zabbix_get
sudo rm -f /usr/local/bin/zabbix_sender
sudo rm -rf /usr/local/etc/zabbix
sudo rm -rf /var/logs/zabbix
Forget that Zabbix agent has been installed:
sudo pkgutil --forget com.zabbix.pkg.ZabbixAgent
#### URL parameters for fullscreen/kiosk modes
Fullscreen and kiosk modes in supported frontend pages can now be
activated using URL parameters. For example, in dashboards:
- `/zabbix.php?action=dashboard.view&fullscreen=1` - activate
fullscreen mode
- `/zabbix.php?action=dashboard.view&kiosk=1` - activate kiosk mode
- `/zabbix.php?action=dashboard.view&fullscreen=0` - activate normal
mode
#### URL parameters for fullscreen/kiosk modes
Fullscreen and kiosk modes in supported frontend pages can now be
activated using URL parameters. For example, in dashboards:
- `/zabbix.php?action=dashboard.view&fullscreen=1` - activate
fullscreen mode
- `/zabbix.php?action=dashboard.view&kiosk=1` - activate kiosk mode
- `/zabbix.php?action=dashboard.view&fullscreen=0` - activate normal
mode
#### Use of relative URLs
Relative paths are now allowed in a URL field.
#### Use of relative URLs
Relative paths are now allowed in a URL field.
# user.checkAuthentication
# user.checkAuthentication
#### User-configured ciphersuites
The built-in ciphersuite selection criteria can be overridden with
user-configured ciphersuites (since Zabbix 4.0.19).
::: noteimportant
User-configured ciphersuites is a feature intended
for advanced users who understand TLS ciphersuites, their security and
consequences of mistakes, and who are comfortable with TLS
troubleshooting.
:::
The built-in ciphersuite selection criteria can be overridden using the
following parameters:
|Override scope|Parameter|Value|Description|
|--------------|---------|-----|-----------|
|Ciphersuite selection for certificates|TLSCipherCert13|Valid OpenSSL 1.1.1 [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.3 protocol (their values are passed to the OpenSSL function SSL\_CTX\_set\_ciphersuites()).|Certificate-based ciphersuite selection criteria for TLS 1.3<br><br>Only OpenSSL 1.1.1 or newer.|
|^|TLSCipherCert|Valid OpenSSL [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.2 or valid GnuTLS [priority strings](https://gnutls.org/manual/html_node/Priority-Strings.html). Their values are passed to the SSL\_CTX\_set\_cipher\_list() or gnutls\_priority\_init() functions, respectively.|Certificate-based ciphersuite selection criteria for TLS 1.2/1.3 (GnuTLS), TLS 1.2 (OpenSSL)|
|Ciphersuite selection for PSK|TLSCipherPSK13|Valid OpenSSL 1.1.1 [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.3 protocol (their values are passed to the OpenSSL function SSL\_CTX\_set\_ciphersuites()).|PSK-based ciphersuite selection criteria for TLS 1.3<br><br>Only OpenSSL 1.1.1 or newer.|
|^|TLSCipherPSK|Valid OpenSSL [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.2 or valid GnuTLS [priority strings](https://gnutls.org/manual/html_node/Priority-Strings.html). Their values are passed to the SSL\_CTX\_set\_cipher\_list() or gnutls\_priority\_init() functions, respectively.|PSK-based ciphersuite selection criteria for TLS 1.2/1.3 (GnuTLS), TLS 1.2 (OpenSSL)|
|Combined ciphersuite list for certificate and PSK|TLSCipherAll13|Valid OpenSSL 1.1.1 [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.3 protocol (their values are passed to the OpenSSL function SSL\_CTX\_set\_ciphersuites()).|Ciphersuite selection criteria for TLS 1.3<br><br>Only OpenSSL 1.1.1 or newer.|
|^|TLSCipherAll|Valid OpenSSL [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.2 or valid GnuTLS [priority strings](https://gnutls.org/manual/html_node/Priority-Strings.html). Their values are passed to the SSL\_CTX\_set\_cipher\_list() or gnutls\_priority\_init() functions, respectively.|Ciphersuite selection criteria for TLS 1.2/1.3 (GnuTLS), TLS 1.2 (OpenSSL)|
To override the ciphersuite selection in
[zabbix\_get](/manpages/zabbix_get) and
[zabbix\_sender](/manpages/zabbix_sender) utilities - use the
command-line parameters:
- `--tls-cipher13`
- `--tls-cipher`
The new parameters are optional. If a parameter is not specified, the
internal default value is used. If a parameter is defined it cannot be
empty.
If the setting of a TLSCipher\* value in the crypto library fails then
the server, proxy or agent will not start and an error is logged.
It is important to understand when each parameter is applicable.
#### User-configured ciphersuites
The built-in ciphersuite selection criteria can be overridden with
user-configured ciphersuites (since Zabbix 4.0.19).
::: noteimportant
User-configured ciphersuites is a feature intended
for advanced users who understand TLS ciphersuites, their security and
consequences of mistakes, and who are comfortable with TLS
troubleshooting.
:::
The built-in ciphersuite selection criteria can be overridden using the
following parameters:
|Override scope|Parameter|Value|Description|
|--------------|---------|-----|-----------|
|Ciphersuite selection for certificates|TLSCipherCert13|Valid OpenSSL 1.1.1 [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.3 protocol (their values are passed to the OpenSSL function SSL\_CTX\_set\_ciphersuites()).|Certificate-based ciphersuite selection criteria for TLS 1.3<br><br>Only OpenSSL 1.1.1 or newer.|
|^|TLSCipherCert|Valid OpenSSL [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.2 or valid GnuTLS [priority strings](https://gnutls.org/manual/html_node/Priority-Strings.html). Their values are passed to the SSL\_CTX\_set\_cipher\_list() or gnutls\_priority\_init() functions, respectively.|Certificate-based ciphersuite selection criteria for TLS 1.2/1.3 (GnuTLS), TLS 1.2 (OpenSSL)|
|Ciphersuite selection for PSK|TLSCipherPSK13|Valid OpenSSL 1.1.1 [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.3 protocol (their values are passed to the OpenSSL function SSL\_CTX\_set\_ciphersuites()).|PSK-based ciphersuite selection criteria for TLS 1.3<br><br>Only OpenSSL 1.1.1 or newer.|
|^|TLSCipherPSK|Valid OpenSSL [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.2 or valid GnuTLS [priority strings](https://gnutls.org/manual/html_node/Priority-Strings.html). Their values are passed to the SSL\_CTX\_set\_cipher\_list() or gnutls\_priority\_init() functions, respectively.|PSK-based ciphersuite selection criteria for TLS 1.2/1.3 (GnuTLS), TLS 1.2 (OpenSSL)|
|Combined ciphersuite list for certificate and PSK|TLSCipherAll13|Valid OpenSSL 1.1.1 [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.3 protocol (their values are passed to the OpenSSL function SSL\_CTX\_set\_ciphersuites()).|Ciphersuite selection criteria for TLS 1.3<br><br>Only OpenSSL 1.1.1 or newer.|
|^|TLSCipherAll|Valid OpenSSL [cipher strings](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for TLS 1.2 or valid GnuTLS [priority strings](https://gnutls.org/manual/html_node/Priority-Strings.html). Their values are passed to the SSL\_CTX\_set\_cipher\_list() or gnutls\_priority\_init() functions, respectively.|Ciphersuite selection criteria for TLS 1.2/1.3 (GnuTLS), TLS 1.2 (OpenSSL)|
To override the ciphersuite selection in
[zabbix\_get](/manpages/zabbix_get) and
[zabbix\_sender](/manpages/zabbix_sender) utilities - use the
command-line parameters:
- `--tls-cipher13`
- `--tls-cipher`
The new parameters are optional. If a parameter is not specified, the
internal default value is used. If a parameter is defined it cannot be
empty.
If the setting of a TLSCipher\* value in the crypto library fails then
the server, proxy or agent will not start and an error is logged.
It is important to understand when each parameter is applicable.
# user.create
# user.create
# user.delete
# user.delete
# user.get
# user.get
#### usergroup
Bug fixes:\
[ZBX-19857](https://support.zabbix.com/browse/ZBX-19857)
`usergroup.get`: dropped support for the non-working option
`web_gui_access`\
#### usergroup
Bug fixes:\
[ZBX-19857](https://support.zabbix.com/browse/ZBX-19857)
`usergroup.get`: dropped support for the non-working option
`web_gui_access`\
# usergroup.create
# usergroup.create
# usergroup.delete
# usergroup.delete
# usergroup.get
# usergroup.get
# usergroup.update
# usergroup.update
# user.login
# user.login
# user.logout
# user.logout
# usermacro.create
# usermacro.create
# usermacro.createglobal
# usermacro.createglobal
# usermacro.delete
# usermacro.delete
# usermacro.deleteglobal
# usermacro.deleteglobal
# usermacro.get
# usermacro.get
# usermacro.update
# usermacro.update
# usermacro.updateglobal
# usermacro.updateglobal
# user.update
# user.update
#### Using custom MIB files
There are standard MIB files coming with every GNU/Linux distribution.
But some device vendors provide their own.
Let's say, you would like to use
[CISCO-SMI](ftp://ftp.cisco.com/pub/mibs/v2/CISCO-SMI.my) MIB file. The
following instructions will download and install it:
# wget ftp://ftp.cisco.com/pub/mibs/v2/CISCO-SMI.my -P /tmp
# mkdir -p /usr/local/share/snmp/mibs
# grep -q '^mibdirs +/usr/local/share/snmp/mibs' /etc/snmp/snmp.conf 2>/dev/null || echo "mibdirs +/usr/local/share/snmp/mibs" >> /etc/snmp/snmp.conf
# cp /tmp/CISCO-SMI.my /usr/local/share/snmp/mibs
Now you should be able to use it. Try to translate the name of the
object *ciscoProducts* from the MIB file to OID:
# snmptranslate -IR -On CISCO-SMI::ciscoProducts
.1.3.6.1.4.1.9.1
::: noteimportant
If you receive errors instead of the OID, ensure
all the previous commands did not return any errors.
:::
The object name translation worked, you are ready to use custom MIB
file. Note the MIB name prefix (*CISCO-SMI::*) used in the query. You
will need this when using command-line tools as well as Zabbix.
Don't forget to restart Zabbix server/proxy before using this MIB file
in Zabbix.
::: noteimportant
Keep in mind that MIB files can have dependencies.
That is, one MIB may require another. In order to satisfy these
dependencies you have to install all the affected MIB
files.
:::
#### Using custom MIB files
There are standard MIB files coming with every GNU/Linux distribution.
But some device vendors provide their own.
Let's say, you would like to use
[CISCO-SMI](ftp://ftp.cisco.com/pub/mibs/v2/CISCO-SMI.my) MIB file. The
following instructions will download and install it:
# wget ftp://ftp.cisco.com/pub/mibs/v2/CISCO-SMI.my -P /tmp
# mkdir -p /usr/local/share/snmp/mibs
# grep -q '^mibdirs +/usr/local/share/snmp/mibs' /etc/snmp/snmp.conf 2>/dev/null || echo "mibdirs +/usr/local/share/snmp/mibs" >> /etc/snmp/snmp.conf
# cp /tmp/CISCO-SMI.my /usr/local/share/snmp/mibs
Now you should be able to use it. Try to translate the name of the
object *ciscoProducts* from the MIB file to OID:
# snmptranslate -IR -On CISCO-SMI::ciscoProducts
.1.3.6.1.4.1.9.1
::: noteimportant
If you receive errors instead of the OID, ensure
all the previous commands did not return any errors.
:::
The object name translation worked, you are ready to use custom MIB
file. Note the MIB name prefix (*CISCO-SMI::*) used in the query. You
will need this when using command-line tools as well as Zabbix.
Don't forget to restart Zabbix server/proxy before using this MIB file
in Zabbix.
::: noteimportant
Keep in mind that MIB files can have dependencies.
That is, one MIB may require another. In order to satisfy these
dependencies you have to install all the affected MIB
files.
:::
#### Using filter
Filter can help narrow down the number of hosts and/or triggers
displayed. The filter is located below the *Availability report* bar. It
can be opened and collapsed by clicking on the *Filter* tab on the left.
#### Using filter
Filter can help narrow down the number of hosts and/or triggers
displayed. The filter is located below the *Availability report* bar. It
can be opened and collapsed by clicking on the *Filter* tab on the left.
##### Using filter
You can use the filter to display only the items you are interested in.
The *Filter* link is located above the table to the right. You can use
it to filter items by host group, host, application, a string in the
item name; you can also select to display items that have no data
gathered.
Specifying a parent host group implicitly selects all nested host
groups.
*Show details* allows to extend displayable information on the items.
Such details as refresh interval, history and trends settings, item type
and item errors (fine/unsupported) are displayed. A link to item
configuration is also available.
{width="600"}
By default, items without data are shown but details are not displayed.
**Ad-hoc graphs for comparing items**
You may use the checkbox in the second column to select several items
and then compare their data in a simple or stacked [ad-hoc
graph](/manual/config/visualization/graphs/adhoc). To do that, select
items of interest, then click on the required graph button below the
table.
**Links to value history/simple graph**
The last column in the latest value list offers:
- a **History** link (for all textual items) - leading to listings
(*Values/500 latest values*) displaying the history of previous item
values.
```{=html}
<!-- -->
```
- a **Graph** link (for all numeric items) - leading to a [simple
graph](/manual/config/visualization/graphs/simple). However, once
the graph is displayed, a dropdown on the upper right offers a
possibility to switch to *Values/500 latest values* as well.
{width="600"}
The values displayed in this list are "raw", that is, no postprocessing
is applied.
::: noteclassic
The total amount of values displayed is defined by the value
of *Limit for search and filter results* parameter, set in
[Administration →
General](/manual/web_interface/frontend_sections/administration/general).
:::
##### Using filter
You can use the filter to display only the items you are interested in.
The *Filter* link is located above the table to the right. You can use
it to filter items by host group, host, application, a string in the
item name; you can also select to display items that have no data
gathered.
Specifying a parent host group implicitly selects all nested host
groups.
*Show details* allows to extend displayable information on the items.
Such details as refresh interval, history and trends settings, item type
and item errors (fine/unsupported) are displayed. A link to item
configuration is also available.
{width="600"}
By default, items without data are shown but details are not displayed.
**Ad-hoc graphs for comparing items**
You may use the checkbox in the second column to select several items
and then compare their data in a simple or stacked [ad-hoc
graph](/manual/config/visualization/graphs/adhoc). To do that, select
items of interest, then click on the required graph button below the
table.
**Links to value history/simple graph**
The last column in the latest value list offers:
- a **History** link (for all textual items) - leading to listings
(*Values/500 latest values*) displaying the history of previous item
values.
```{=html}
<!-- -->
```
- a **Graph** link (for all numeric items) - leading to a [simple
graph](/manual/config/visualization/graphs/simple). However, once
the graph is displayed, a dropdown on the upper right offers a
possibility to switch to *Values/500 latest values* as well.
{width="600"}
The values displayed in this list are "raw", that is, no postprocessing
is applied.
::: noteclassic
The total amount of values displayed is defined by the value
of *Limit for search and filter results* parameter, set in
[Administration →
General](/manual/web_interface/frontend_sections/administration/general).
:::
##### Using filter
You can use the filter to display only the problems you are interested
in. The filter is located above the table.
{width="600"}
|Parameter|Description|
|---------|-----------|
|*Show*|Filter by problem status:<br>**Recent problems** - unresolved and recently resolved problems are displayed (default)<br>**Problems** - unresolved problems are displayed<br>**Any** - history of all events is displayed|
|*Acknowledge status*|Filter by acknowledgment status:<br>**Any** - acknowledged and unacknowledged problems are displayed (default)<br>**With unacknowledged events** - problems with unacknowledged events are displayed<br>**With last event unacknowledged** - problems with last event unacknowledged are displayed|
|*Minimum severity*|Filter by minimum problem severity.|
|*Age (less than)*|Mark the checkbox to filter by problem age.|
|*Name*|Filter by problem name.|
|*Application*|Filter by application.|
|*Host inventory*|Filter by inventory type and value.|
|*Show suppressed problems*|Mark the checkbox to display problems which would otherwise be suppressed (not shown) because of host maintenance.|
**Overview of data**
In the next screenshot Data is selected in the *Type* dropdown. As a
result, performance item data of two local hosts are displayed.
{width="600"}
The color of problem items is based on the problem severity color, which
can be adjusted in the [problem
update](/manual/acknowledges#updating_problems) screen.
Only values that fall within the last 24 hours are displayed by default.
This limit has been introduced with the aim of improving initial loading
times for large pages of latest data. It is also possible to change this
limitation by changing the value of ZBX\_HISTORY\_PERIOD
[constant](/manual/web_interface/definitions) in
*include/defines.inc.php*.
Clicking on a piece of data offers links to some predefined graphs or
latest values.
##### Using filter
You can use the filter to display only the problems you are interested
in. The filter is located above the table.
{width="600"}
|Parameter|Description|
|---------|-----------|
|*Show*|Filter by problem status:<br>**Recent problems** - unresolved and recently resolved problems are displayed (default)<br>**Problems** - unresolved problems are displayed<br>**Any** - history of all events is displayed|
|*Acknowledge status*|Filter by acknowledgment status:<br>**Any** - acknowledged and unacknowledged problems are displayed (default)<br>**With unacknowledged events** - problems with unacknowledged events are displayed<br>**With last event unacknowledged** - problems with last event unacknowledged are displayed|
|*Minimum severity*|Filter by minimum problem severity.|
|*Age (less than)*|Mark the checkbox to filter by problem age.|
|*Name*|Filter by problem name.|
|*Application*|Filter by application.|
|*Host inventory*|Filter by inventory type and value.|
|*Show suppressed problems*|Mark the checkbox to display problems which would otherwise be suppressed (not shown) because of host maintenance.|
**Overview of data**
In the next screenshot Data is selected in the *Type* dropdown. As a
result, performance item data of two local hosts are displayed.
{width="600"}
The color of problem items is based on the problem severity color, which
can be adjusted in the [problem
update](/manual/acknowledges#updating_problems) screen.
Only values that fall within the last 24 hours are displayed by default.
This limit has been introduced with the aim of improving initial loading
times for large pages of latest data. It is also possible to change this
limitation by changing the value of ZBX\_HISTORY\_PERIOD
[constant](/manual/web_interface/definitions) in
*include/defines.inc.php*.
Clicking on a piece of data offers links to some predefined graphs or
latest values.
#### Using macro functions
Macro functions are supported with low-level discovery macros (except in
low-level discovery rule filter), allowing to extract a certain part of
the macro value using a regular expression.
For example, you may want to extract the customer name and interface
number from the following LLD macro for the purposes of event tagging:
{#IFALIAS}=customername_1
To do so, the `regsub` macro function can be used with the macro in the
event tag value field of a trigger prototype:
Note, that commas are not allowed in unquoted item [key
parameters](/manual/config/items/item/key#key_parameters), so the
parameter containing a macro function has to be quoted. The backslash
(`\`) character should be used to escape double quotes inside the
parameter. Example:
net.if.in["{{#IFALIAS}.regsub(\"(.*)_([0-9]+)\", \1)}",bytes]
For more information on macro function syntax, see: [Macro
functions](/manual/config/macros/macro_functions)
Macro functions are supported in low-level discovery macros since Zabbix
4.0.
#### Using macro functions
Macro functions are supported with low-level discovery macros (except in
low-level discovery rule filter), allowing to extract a certain part of
the macro value using a regular expression.
For example, you may want to extract the customer name and interface
number from the following LLD macro for the purposes of event tagging:
{#IFALIAS}=customername_1
To do so, the `regsub` macro function can be used with the macro in the
event tag value field of a trigger prototype:
Note, that commas are not allowed in unquoted item [key
parameters](/manual/config/items/item/key#key_parameters), so the
parameter containing a macro function has to be quoted. The backslash
(`\`) character should be used to escape double quotes inside the
parameter. Example:
net.if.in["{{#IFALIAS}.regsub(\"(.*)_([0-9]+)\", \1)}",bytes]
For more information on macro function syntax, see: [Macro
functions](/manual/config/macros/macro_functions)
Macro functions are supported in low-level discovery macros since Zabbix
4.0.
#### Using MIBs in Zabbix
The most important to keep in mind is that Zabbix processes do not get
informed of the changes made to MIB files. So after every change you
must restart Zabbix server or proxy, e. g.:
# service zabbix-server restart
After that, the changes made to MIB files are in effect.
#### Using MIBs in Zabbix
The most important to keep in mind is that Zabbix processes do not get
informed of the changes made to MIB files. So after every change you
must restart Zabbix server or proxy, e. g.:
# service zabbix-server restart
After that, the changes made to MIB files are in effect.
#### Validation to avoid proxy/agent data duplication
Session tokens have been added to incoming proxy/agent data along with
virtual IDs that are assigned to incoming values. The value ID is a
simple ascending counter, unique within one data session (identified by
the session token). This ID is used to discard duplicate values that
might be sent in poor connectivity environments. For more details on the
protocols, see:
- [Server-proxy data exchange
protocol](/manual/appendix/protocols/server_proxy)
- [Active agent
checks](/manual/appendix/items/activepassive#sending_in_collected_data)
Data without session token will be accepted without validation for
duplicate values, ensuring backwards compatibility.
#### Validation to avoid proxy/agent data duplication
Session tokens have been added to incoming proxy/agent data along with
virtual IDs that are assigned to incoming values. The value ID is a
simple ascending counter, unique within one data session (identified by
the session token). This ID is used to discard duplicate values that
might be sent in poor connectivity environments. For more details on the
protocols, see:
- [Server-proxy data exchange
protocol](/manual/appendix/protocols/server_proxy)
- [Active agent
checks](/manual/appendix/items/activepassive#sending_in_collected_data)
Data without session token will be accepted without validation for
duplicate values, ensuring backwards compatibility.
#### valuemap
Changes:\
[ZBX-3783](https://support.zabbix.com/browse/ZBX-3783) `valuemap.get`:
added strict validation of input parameters\
#### valuemap
Changes:\
[ZBX-3783](https://support.zabbix.com/browse/ZBX-3783) `valuemap.get`:
added strict validation of input parameters\
# valuemap.create
# valuemap.create
# valuemap.delete
# valuemap.delete
# valuemap.get
# valuemap.get
# valuemap.update
# valuemap.update
#### Viewing details
The times for problem start and recovery in *Monitoring → Problems* are
links. Clicking on them opens more details of the event.
{width="600"}
Note how the problem severity differs for the trigger and the problem
event - for the problem event it has been updated using the *Update
problem* [screen](/manual/acknowledges#updating_problems).
In the action list, the following icons are used to denote the activity
type:
-  -
problem event generated
-  -
message has been sent
-  -
problem event acknowledged
-  -
comment has been added
-  -
problem severity has been increased (e.g. Information → Warning)
-  -
problem severity has been decreased (e.g. Warning → Information)
-  -
problem severity has been changed, but returned to the original
level (e.g. Warning → Information → Warning)
-  -
remote command has been executed
-  -
problem event has recovered
-  -
problem has been closed manually
#### Viewing details
The times for problem start and recovery in *Monitoring → Problems* are
links. Clicking on them opens more details of the event.
{width="600"}
Note how the problem severity differs for the trigger and the problem
event - for the problem event it has been updated using the *Update
problem* [screen](/manual/acknowledges#updating_problems).
In the action list, the following icons are used to denote the activity
type:
-  -
problem event generated
-  -
message has been sent
-  -
problem event acknowledged
-  -
comment has been added
-  -
problem severity has been increased (e.g. Information → Warning)
-  -
problem severity has been decreased (e.g. Warning → Information)
-  -
problem severity has been changed, but returned to the original
level (e.g. Warning → Information → Warning)
-  -
remote command has been executed
-  -
problem event has recovered
-  -
problem has been closed manually
#### Viewing host group elements
This option is available if "Host group elements" show option is chosen.
When selecting "Host group elements" as the *show* option, you will at
first see only one icon for the host group. However, when you save the
map and then go to the map view, you will see that the map includes all
the elements (hosts) of the certain host group:
|Map editing view|Map view|
|----------------|--------|
|*{width="450"}*|{width="450"}|
Notice how the {HOST.NAME} macro is used. In map editing the macro name
in unresolved, while in map view all the unique names of the hosts are
displayed.
#### Viewing host group elements
This option is available if "Host group elements" show option is chosen.
When selecting "Host group elements" as the *show* option, you will at
first see only one icon for the host group. However, when you save the
map and then go to the map view, you will see that the map includes all
the elements (hosts) of the certain host group:
|Map editing view|Map view|
|----------------|--------|
|*{width="450"}*|{width="450"}|
Notice how the {HOST.NAME} macro is used. In map editing the macro name
in unresolved, while in map view all the unique names of the hosts are
displayed.
#### Viewing slide shows
To view a slide show, click on its name in the list of all slide shows.
#### Viewing slide shows
To view a slide show, click on its name in the list of all slide shows.
#### VMware datacenter discovery
A new `vmware.dc.discovery[url]`
[item](/manual/config/items/itemtypes/simple_checks/vmware_keys) returns
a JSON containing {\#DATACENTER} and {\#DATACENTERID} properties.
#### VMware datacenter discovery
A new `vmware.dc.discovery[url]`
[item](/manual/config/items/itemtypes/simple_checks/vmware_keys) returns
a JSON containing {\#DATACENTER} and {\#DATACENTERID} properties.
#### VMware datastore discovery
VMware datastore discovery has been moved from hypervisor level to
vCenter level. As a result datastores are discovered and datastore info
is collected only once for each datastore instead of one time per each
hypervisor.
Within this development the following new items have been added:
- vmware.datastore.discovery\[<url>\]
- vmware.datastore.hv.list\[<url>,<datastore>\]
- vmware.datastore.read\[<url>,<datastore>,<mode>\]
- vmware.datastore.write\[<url>,<datastore>,<mode>\]
- vmware.datastore.size\[<url>,<datastore>,<mode>\]
- vmware.hv.datastore.list\[<url>,<uuid>\]
For more information on the added items, see: [VMware monitoring item
keys](/manual/config/items/itemtypes/simple_checks/vmware_keys)
#### VMware datastore discovery
VMware datastore discovery has been moved from hypervisor level to
vCenter level. As a result datastores are discovered and datastore info
is collected only once for each datastore instead of one time per each
hypervisor.
Within this development the following new items have been added:
- vmware.datastore.discovery\[<url>\]
- vmware.datastore.hv.list\[<url>,<datastore>\]
- vmware.datastore.read\[<url>,<datastore>,<mode>\]
- vmware.datastore.write\[<url>,<datastore>,<mode>\]
- vmware.datastore.size\[<url>,<datastore>,<mode>\]
- vmware.hv.datastore.list\[<url>,<uuid>\]
For more information on the added items, see: [VMware monitoring item
keys](/manual/config/items/itemtypes/simple_checks/vmware_keys)
#### VMware template
*Template VM VMware* has been updated:
- the key of the "Event log" item has been changed to
`vmware.eventlog[{$URL},skip]` - now skipping old data
#### VMware template
*Template VM VMware* has been updated:
- the key of the "Event log" item has been changed to
`vmware.eventlog[{$URL},skip]` - now skipping old data
#### VMware template
*Template VM VMware* has been updated:
- the type of information for the "VMware: Free space on datastore
(percentage)" item has been corrected and is now set to Numeric
(float).
- The following template macros now have more specific names:
- {$URL} renamed to {$VMWARE.URL}
- {$USERNAME} renamed to {$VMWARE.USERNAME}
- {$PASSWORD} renamed to {$VMWARE.PASSWORD}
#### VMware template
*Template VM VMware* has been updated:
- the type of information for the "VMware: Free space on datastore
(percentage)" item has been corrected and is now set to Numeric
(float).
- The following template macros now have more specific names:
- {$URL} renamed to {$VMWARE.URL}
- {$USERNAME} renamed to {$VMWARE.USERNAME}
- {$PASSWORD} renamed to {$VMWARE.PASSWORD}
##### Warnings about incompatible versions
Warnings are now being logged if incompatible Zabbix daemon versions are
used.
##### Warnings about incompatible versions
Warnings are now being logged if incompatible Zabbix daemon versions are
used.
#### Web monitoring items
Removed support of `{HOST.*}` macro in name property of web scenario and
web scenario step.
#### Web monitoring items
Removed support of `{HOST.*}` macro in name property of web scenario and
web scenario step.
#### Web monitoring
This widget displays a status summary of the active web monitoring
scenarios.
::: noteclassic
In cases when a user does not have permission to access
certain widget elements, that element's name will appear as
*Inaccessible* during the widget's configuration. This results in
*Inaccessible Item, Inaccessible Host, Inaccessible Group, Inaccessible
Map and Inaccessible Graph* appearing instead of the "real" name of the
element.
:::
#### Web monitoring
This widget displays a status summary of the active web monitoring
scenarios.
::: noteclassic
In cases when a user does not have permission to access
certain widget elements, that element's name will appear as
*Inaccessible* during the widget's configuration. This results in
*Inaccessible Item, Inaccessible Host, Inaccessible Group, Inaccessible
Map and Inaccessible Graph* appearing instead of the "real" name of the
element.
:::
#### Web scenario fields
The maximum field size has been increased from 255 to 2000 characters in
the web scenario variables and web scenario step variables and post
fields.
#### Web scenario fields
The maximum field size has been increased from 255 to 2000 characters in
the web scenario variables and web scenario step variables and post
fields.
#### Web scenario
In a [web scenario](/manual/web_monitoring) configuration, user macros
can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Name|<|yes|
|Update interval|<|no|
|Agent|<|yes|
|HTTP proxy|<|yes|
|Variables (values only)|<|yes|
|Headers (names and values)|<|yes|
|//Steps //|<|<|
|<|Name|yes|
|^|URL|yes|
|^|Variables (values only)|yes|
|^|Headers (names and values)|yes|
|^|Timeout|no|
|^|Required string|yes|
|^|Required status codes|no|
|//Authentication //|<|<|
|<|User|yes|
|^|Password|yes|
|^|SSL certificate|yes|
|^|SSL key file|yes|
|^|SSL key password|yes|
#### Web scenario
In a [web scenario](/manual/web_monitoring) configuration, user macros
can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Name|<|yes|
|Update interval|<|no|
|Agent|<|yes|
|HTTP proxy|<|yes|
|Variables (values only)|<|yes|
|Headers (names and values)|<|yes|
|//Steps //|<|<|
|<|Name|yes|
|^|URL|yes|
|^|Variables (values only)|yes|
|^|Headers (names and values)|yes|
|^|Timeout|no|
|^|Required string|yes|
|^|Required status codes|no|
|//Authentication //|<|<|
|<|User|yes|
|^|Password|yes|
|^|SSL certificate|yes|
|^|SSL key file|yes|
|^|SSL key password|yes|
#### Whitespace
Whitespace (space, tab characters) can be freely used in bracket
notation segments and expressions, for example,
`$[ 'a' ][ 0 ][ ?( $.b == 'c' ) ][ : -1 ].first( )`.
#### Whitespace
Whitespace (space, tab characters) can be freely used in bracket
notation segments and expressions, for example,
`$[ 'a' ][ 0 ][ ?( $.b == 'c' ) ][ : -1 ].first( )`.
##### Windows agent compilation revision
Generating a Windows file properties revision number has been added for
agent compilation on MS Windows. It follows a `{b}{t}{nn}` format where:
- `{b}` - source (1 - feature or release, 2 - tag)
- `{t}` - type (1 - alpha, 2 - beta, 3 - release candidate, 4 -
release)
- `{nn}` - sequence number for the 'type'
For example:
|Tag|Branch|Version|Result|
|---|------|-------|------|
|4.0.8|<|Zabbix 4.0.8|4.0.8.2400|
|<|release/4.0|Zabbix 4.0.8rc3|4.0.8.1303|
|<|feature/ZBX-16074|Zabbix 4.0.8rc1|4.0.8.1301|
##### Windows agent compilation revision
Generating a Windows file properties revision number has been added for
agent compilation on MS Windows. It follows a `{b}{t}{nn}` format where:
- `{b}` - source (1 - feature or release, 2 - tag)
- `{t}` - type (1 - alpha, 2 - beta, 3 - release candidate, 4 -
release)
- `{nn}` - sequence number for the 'type'
For example:
|Tag|Branch|Version|Result|
|---|------|-------|------|
|4.0.8|<|Zabbix 4.0.8|4.0.8.2400|
|<|release/4.0|Zabbix 4.0.8rc3|4.0.8.1303|
|<|feature/ZBX-16074|Zabbix 4.0.8rc1|4.0.8.1301|
#### Windows MSI agent packages
Windows MSI installer packages for Zabbix Windows agent are available
for [download](https://www.zabbix.com/download_agents#tab:40LTS).
#### Windows MSI agent packages
Windows MSI installer packages for Zabbix Windows agent are available
for [download](https://www.zabbix.com/download_agents#tab:40LTS).
#### Working with English perfcounters on Windows
It is now possible to work with exclusively English names of Windows
performance counters, regardless of the locale, using the new
items/parameters:
- `perf_counter_en` Windows agent
[item](/manual/config/items/itemtypes/zabbix_agent/win_keys)
- `PerfCounterEn` Windows agent
[parameter](/manual/appendix/config/zabbix_agentd_win)
Note that these items will only work on **Windows Server 2008/Vista**
and above.
#### Working with English perfcounters on Windows
It is now possible to work with exclusively English names of Windows
performance counters, regardless of the locale, using the new
items/parameters:
- `perf_counter_en` Windows agent
[item](/manual/config/items/itemtypes/zabbix_agent/win_keys)
- `PerfCounterEn` Windows agent
[parameter](/manual/appendix/config/zabbix_agentd_win)
Note that these items will only work on **Windows Server 2008/Vista**
and above.
#### Working with problems
Several changes have been made for working with problems, including
changed macros. For more details, see the [what's
new](/manual/introduction/whatsnew400#working_with_problems) entry.
#### Working with problems
Several changes have been made for working with problems, including
changed macros. For more details, see the [what's
new](/manual/introduction/whatsnew400#working_with_problems) entry.
#### Zabbix agent checks on Windows
Non-existing DNS entries in a `Server` parameter of Zabbix agent
configuration file (zabbix\_agentd.conf) may increase Zabbix agent
response time on Windows. This happens because Windows DNS caching
daemon doesn't cache negative responses for IPv4 addresses. However, for
IPv6 addresses negative responses are cached, so a possible workaround
to this is disabling IPv4 on the host.
#### Zabbix agent checks on Windows
Non-existing DNS entries in a `Server` parameter of Zabbix agent
configuration file (zabbix\_agentd.conf) may increase Zabbix agent
response time on Windows. This happens because Windows DNS caching
daemon doesn't cache negative responses for IPv4 addresses. However, for
IPv6 addresses negative responses are cached, so a possible workaround
to this is disabling IPv4 on the host.
# Zabbix API changes in 4.0
# Zabbix API changes in 4.0
#### Zabbix frontend sets own cookie path
If Zabbix frontend runs behind proxy, cookie path set by Zabbix now
needs to be specified in the proxy configuration. See [using Zabbix
frontend behind
proxy](/manual/appendix/other_issues#using Zabbix frontend behind proxy)
for details.
#### Zabbix frontend sets own cookie path
If Zabbix frontend runs behind proxy, cookie path set by Zabbix now
needs to be specified in the proxy configuration. See [using Zabbix
frontend behind
proxy](/manual/appendix/other_issues#using Zabbix frontend behind proxy)
for details.
#### Zabbix Java gateway availability
From now on Zabbix Java gateway availability status will not change to
red each time any of the items become not supported. The JMX
availability badge will only become red on network errors - when Java
gateway is not available or when there are some communication problems
between Zabbix server and Zabbix Java gateway.
#### Zabbix Java gateway availability
From now on Zabbix Java gateway availability status will not change to
red each time any of the items become not supported. The JMX
availability badge will only become red on network errors - when Java
gateway is not available or when there are some communication problems
between Zabbix server and Zabbix Java gateway.
#### Zabbix Java gateway logs modified
If you monitor Java gateway logs, keep in mind that exception stack
trace is no longer available in warning and error level logging of Java
gateway.
#### Zabbix Java gateway logs modified
If you monitor Java gateway logs, keep in mind that exception stack
trace is no longer available in warning and error level logging of Java
gateway.
# Zabbix manpages
These are Zabbix manpages for Zabbix processes.
# Zabbix manpages
These are Zabbix manpages for Zabbix processes.
##### Zabbix packages from OS repositories
Often, OS distributions (in particular, Debian-based distributions)
provide their own Zabbix packages.\
Note, that these packages are not supported by Zabbix, they are
typically out of date and lack the latest features and bug fixes. Only
the packages from [repo.zabbix.com](https://repo.zabbix.com/) are
officially supported.
If you are upgrading from packages provided by OS distributions (or had
them installed at some point), follow this procedure to switch to
official Zabbix packages:
1. Always uninstall the old packages first.
2. Check for residual files that may have been left after
deinstallation.
3. Install official packages following [installation
instructions](https://www.zabbix.com/download?zabbix=4.0) provided
by Zabbix.
Never do a direct update, as this may result in a broken installation.
##### Zabbix packages from OS repositories
Often, OS distributions (in particular, Debian-based distributions)
provide their own Zabbix packages.\
Note, that these packages are not supported by Zabbix, they are
typically out of date and lack the latest features and bug fixes. Only
the packages from [repo.zabbix.com](https://repo.zabbix.com/) are
officially supported.
If you are upgrading from packages provided by OS distributions (or had
them installed at some point), follow this procedure to switch to
official Zabbix packages:
1. Always uninstall the old packages first.
2. Check for residual files that may have been left after
deinstallation.
3. Install official packages following [installation
instructions](https://www.zabbix.com/download?zabbix=4.0) provided
by Zabbix.
Never do a direct update, as this may result in a broken installation.
###
###
# 10 Cookies used by Zabbix
# 10 Zabbix 使用的 Cookies
# 10 Discovery using WMI queries
# 10 使用 WMI 进行发现 queries
# 10 Graph prototype
# 10 图形原型
# 10 Graph prototype
# 10 图形原型
# 10 Inclusion
# 10 包含
# 10 Notes on selecting processes in proc.mem and proc.num items
# 10 关于在 proc.mem 和 proc.num 监控项中选择进程的注意事项
# 10 Notifications upon events
# 10 事件通知
# 10 Oracle plugin
# 10 Oracle 插件
# 10 Queue
# 10 队列
# 10 Telnet checks
# 10 Telnet检查
# 10 Upgrade notes for 6.0.0
::: noteimportant
Zabbix 6.0.0 is not released yet.
:::
These notes are for upgrading from Zabbix 5.4.x to Zabbix 6.0.0. All
notes are grouped into:
- `Critical` - the most critical information related to the upgrade
process and the changes in Zabbix functionality
- `Informational` - all remaining information describing the changes
in Zabbix functionality
It is possible to upgrade to Zabbix 6.0.0 from versions before Zabbix
5.4.0. See the [upgrade procedure](/manual/installation/upgrade) section
for all relevant information about upgrading from previous Zabbix
versions.
# 10 Upgrade notes for 6.0.0
::: noteimportant
Zabbix 6.0.0 is not released yet.
:::
These notes are for upgrading from Zabbix 5.4.x to Zabbix 6.0.0. All
notes are grouped into:
- `Critical` - the most critical information related to the upgrade
process and the changes in Zabbix functionality
- `Informational` - all remaining information describing the changes
in Zabbix functionality
It is possible to upgrade to Zabbix 6.0.0 from versions before Zabbix
5.4.0. See the [upgrade procedure](/manual/installation/upgrade) section
for all relevant information about upgrading from previous Zabbix
versions.
# 10 Upgrade notes for 6.0.0
These notes are for upgrading from Zabbix 5.4.x to Zabbix 6.0.0. All
notes are grouped into:
- `Critical` - the most critical information related to the upgrade
process and the changes in Zabbix functionality
- `Informational` - all remaining information describing the changes
in Zabbix functionality
It is possible to upgrade to Zabbix 6.0.0 from versions before Zabbix
5.4.0. See the [upgrade procedure](/manual/installation/upgrade) section
for all relevant information about upgrading from previous Zabbix
versions.
# 10 6.0.0 版本升级注意事项
本文档适用于从Zabbix 5.4.x升级至Zabbix 6.0.0的说明。所有注意事项分为以下两类：
- `Critical` - 与升级过程及Zabbix功能变更相关的最关键信息
- `Informational` - 描述变更的所有其他补充信息
in Zabbix functionality
支持从早于Zabbix 5.4.0的版本升级至Zabbix 6.0.0。有关从历史版本升级的所有相关信息，请参阅[upgrade procedure](/manual/installation/upgrade)章节。
# 10 Version compatibility
# 10 版本兼容性
# 10 Virtual machine monitoring
# 10 虚拟机监控
# 10 What's new in Zabbix 6.0.5
# 10 Zabbix 6.0.5 新特性
# 10 Zabbix agent on Microsoft Windows
# 10 Zabbix agent 在 Microsoft Windows 上
# 11 Database error handling
If Zabbix detects that the backend database is not accessible, it will
send a notification message and continue the attempts to connect to the
database. For some database engines, specific error codes are
recognized.
# 11 数据库错误处理
如果Zabbix检测到后端数据库不可访问，它将发送通知消息并持续尝试连接数据库。对于某些数据库引擎，系统能够识别特定的错误代码。
# 11 Discovery using ODBC SQL queries
# 11 使用 ODBC SQL 进行发现 queries
# 11 External checks
# 11 外部检查
# 11 Host availability
# 11 主机可用性
# 11 Implementation details of net.tcp.service and net.udp.service checks
Implementation of net.tcp.service and net.udp.service checks is detailed
on this page for various services specified in the service parameter.
# 11 net.tcp.service 与 net.udp.service 检查的实现细节
本页详细介绍了针对service参数中指定的各种服务实现net.tcp.service和net.udp.service检查的方法。
# 11 Macros
# 11 宏
# 11 Maintenance
# 11 维护
# 11 PostgreSQL plugin
# 11 PostgreSQL 插件
# 11 Recipes for monitoring
# 11 监控方法
# 11 SAML setup with Microsoft Entra ID
# 11 使用Microsoft Entra ID配置SAML
# 11 Time zones
# 11 时区
# 11 Upgrade notes for 6.0.1
# 11 6.0.1 更新说明
# 11 Value cache
# 11 值缓存
# 11 What's new in Zabbix 6.0.6
# 11 Zabbix 6.0.6 新特性
# 12 Discovery using Prometheus data
# 12 使用 Prometheus 数据进行发现
# 12 Execute now
# 12 立即执行
# 12 Item value
# 12 监控项 值
# 12 Item value
# 12 监控项 值
# 12 Performance tuning
::: noteimportant
This is a work in progress.
:::
# 12 性能调优
::: noteimportant
这是一项持续进行的工作。
:::
# 12 Redis plugin
# 12 Redis 插件
# 12 Regular expressions
# 12 正则表达式
# 12 Resetting password
# 12 密码重置
# 12 SAML setup with Okta
This section describes how to configure Okta to enable SAML 2.0
authentication for Zabbix.
# 12 使用 Okta 的 SAML 设置
本节介绍如何配置Okta以启用Zabbix的SAML 2.0身份验证。
# 12 Trapper items
# 12 Trapper 监控项
# 12 Unreachable/unavailable host interface settings
# 12 不可达/不可用主机接口设置
# 12 Upgrade notes for 6.0.2
This minor version doesn't have any upgrade notes.
# 12 6.0.2 版本升级说明
此次要version没有任何升级说明.
# 12 Users and user groups
# 12 用户与用户组
# 12 What's new in Zabbix 6.0.7
# 12 Zabbix 6.0.7 新特性
# 12 Zabbix sender dynamic link library for Windows
#### Overview
In a Windows environment applications can send data to Zabbix
server/proxy by using the Zabbix sender dynamic link library
(zabbix\_sender.dll) instead of having to launch an external process
(zabbix\_sender.exe).
zabbix_sender.h and zabbix_sender.lib are required for compiling user applications with zabbix_sender.dll.
#### Getting it
There are two ways of getting zabbix_sender.dll.
**1.** [Download](https://www.zabbix.com/download_agents) zabbix_sender.h, zabbix_sender.lib and zabbix_sender.dll files as a ZIP archive.
When choosing download options make sure to select "No encryption" under *Encryption* and "Archive" under *Packaging*. Then download Zabbix agent (not Zabbix agent 2).
The zabbix_sender.h, zabbix_sender.lib and zabbix_sender.dll files will be inside the downloaded ZIP archive in the `bin\dev` directory. Unzip the files where you need it.
See also [known issues](/manual/installation/known_issues#missing-files-in-windows-agent-archive).
**2.** Build zabbix_sender.dll from source (see [instructions](/manual/installation/install/win_agent#overview)).
The dynamic link library with the development files will be located in
the `bin\winXX\dev` directory. To use it, include the zabbix_sender.h header
file and link with the zabbix_sender.lib library.
#### See also
- [example](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/build/win32/examples/zabbix_sender/sender.c) of a simple Zabbix sender utility implemented with Zabbix sender dynamic link library to illustrate the library usage;
- [zabbix_sender.h](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/zabbix_sender/win32/zabbix_sender.h) file for the interface functions of the Zabbix sender dynamic link library. This file contains documentation explaining the purpose of each interface function, its arguments, and return value.
# 12 Windows版Zabbix sender动态链接库
#### 概述
在Windows环境中，应用程序可以通过使用Zabbix sender动态链接库(zabbix\_sender.dll)向Zabbix
server/proxy发送数据，而无需启动外部进程(zabbix\_sender.exe)。
使用zabbix_sender.dll编译用户应用程序时需要zabbix_sender.h和zabbix_sender.lib文件。
#### 获取方法
获取zabbix_sender.dll有两种方式。
**1.** [Download](https://www.zabbix.com/download_agents) zabbix_sender.h、zabbix_sender.lib和zabbix_sender.dll文件的ZIP压缩包。
选择下载选项时，确保在*加密*下选择"无加密"，在*打包*下选择"归档"。然后下载Zabbix agent（而非Zabbix agent 2）。
下载的ZIP压缩包中的`bin\dev`目录内包含zabbix_sender.h、zabbix_sender.lib和zabbix_sender.dll文件。将文件解压到所需位置。
另请参阅[windows-agent-归档文件中缺失文件](/manual/installation/known_issues#windows-agent-归档文件中缺失文件)。
**2.** 从源代码构建zabbix_sender.dll（参见[概述](/manual/installation/install/win_agent#概述)）。
带有开发文件的动态链接库将位于`bin\winXX\dev`目录中。使用时需包含zabbix_sender.h头文件
file并链接zabbix_sender.lib库。
#### 另请参阅
- [example](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/build/win32/examples/zabbix_sender/sender.c) 使用Zabbix sender动态链接库实现的简单Zabbix sender工具示例，展示库的使用方法；
- [zabbix_sender.h](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/zabbix_sender/win32/zabbix_sender.h) file 包含Zabbix sender动态链接库接口函数的文档。此file包含说明每个接口函数用途、参数和返回值的文档。
# 13 Discovery of block devices
In a similar way as [file
systems](/manual/discovery/low_level_discovery#configuring_low-level_discovery)
are discovered, it is possible to also discover block devices and their
type.
# 13 块设备发现
与[file
systems](/manual/discovery/low_level_discovery#configuring_low-level_discovery)的发现方式类似
也可以发现块设备及其类型
# 13 JMX monitoring
# 13 JMX 监控
# 13 Map
# 13 地图
# 13 Map
# 13 地图
# 13 Oracle database setup
# 13 Oracle 数据库设置
# 13. Problem acknowledgment
# 13 问题确认
# 13 Python library for Zabbix API
# 13 Zabbix API的Python库
# 13 Remote monitoring of Zabbix stats
# 13 Zabbix 统计数据的远程监控
# 13 Restricting agent checks
# 13 限制 agent 检查
# 13 SMART plugin
# 13 SMART 插件
# 13 Storage of secrets
# 13 密钥存储
# 13 Upgrade notes for 6.0.3
This minor version doesn't have any upgrade notes.
# 13 6.0.3 版本升级说明
此次要version没有任何升级说明.
# 13 What's new in Zabbix 6.0.8
# 13 Zabbix 6.0.8 新特性
# 14 Configuration export/import
# 14 配置导出/导入
# 14 Configuring Kerberos with Zabbix
# 14 使用 Zabbix 配置 Kerberos
# 14 Discovery of host interfaces in Zabbix
# 14 Zabbix 中的主机接口发现
# 14 Map navigation tree
# 14 地图导航树
# 14 Map navigation tree
# 14 地图导航树
# 14 ODBC monitoring
# 14 ODBC 监控
# 14 Plugins
# 14 插件
# 14 Scheduled reports
# 14 计划报告
# 14 Service monitoring upgrade
# 14 服务监控升级
# 14 Setting up scheduled reports
# 14 设置定时报告
# 14 Upgrade notes for 6.0.4
This minor version doesn't have any upgrade notes.
# 14 6.0.4 版本升级说明
此次要version没有相关的升级说明.
# 14 What's new in Zabbix 6.0.9
# 14 Zabbix 6.0.9 新特性
# 15 Additional frontend languages
# 15 附加前端语言
# 15 Dependent items
# 15 依赖 监控项
# 15 Discovery
Please use the sidebar to access content in the Discovery section.
# 15 发现
请使用侧边栏访问发现部分的内容。
# 15 modbus.get parameters
# 15 modbus.get 参数
# 15 Other issues
# 15 其他问题
# 15 Plain text
# 15 纯文本
# 15 Plain text
# 15 纯文本
# 15 What's new in Zabbix 6.0.10
# 15 Zabbix 6.0.10 新特性
# 16 Agent vs agent 2 comparison
This section describes the differences between the Zabbix agent and the
Zabbix agent 2.
|Parameter|Zabbix agent|Zabbix agent 2|
|--|------|------|
|Programming language|C|Go with some parts in C|
|Daemonization|yes|by systemd only (yes on Windows)|
|Supported extensions|Custom [loadable modules](/manual/config/items/loadablemodules) in C.|Custom [plugins](/manual/config/items/plugins) in Go.|
|*Requirements*|<|<|
|Supported platforms|Linux, IBM AIX, FreeBSD, NetBSD, OpenBSD, HP-UX, Mac OS X, Solaris: 9, 10, 11, Windows: all desktop and server versions since XP|Linux, Windows: all desktop and server versions, on which a [supported Go version](/manual/installation/requirements#agent-2) can be installed.|
|Supported crypto libraries|GnuTLS 3.1.18 and newer<br>OpenSSL 1.0.1, 1.0.2, 1.1.0, 1.1.1, 3.0.x. Note that 3.0.x is supported since Zabbix 6.0.4.<br>LibreSSL - tested with versions 2.7.4, 2.8.2 (certain limitations apply, see the [Encryption](/manual/encryption#compiling_zabbix_with_encryption_support) page for details).|Linux: OpenSSL 1.0.1 and later is supported since Zabbix 4.4.8.<br>MS Windows: OpenSSL 1.1.1 or later.<br>The OpenSSL library must have PSK support enabled. LibreSSL is not supported.|
|Monitoring processes|<|<|
|Processes|A separate active check process for each server/proxy record.|Single process with automatically created threads.<br>The maximum number of threads is determined by the GOMAXPROCS environment variable.|
|Metrics|**UNIX**: see a list of supported [items](/manual/config/items/itemtypes/zabbix_agent).<br><br>**Windows**: see a list of additional Windows-specific [items](/manual/config/items/itemtypes/zabbix_agent/win_keys).|**UNIX**: All metrics supported by Zabbix agent.<br>Additionally, the agent 2 provides Zabbix-native monitoring solution for: Docker, Memcached, MySQL, PostgreSQL, Redis, systemd, and other monitoring targets - see a full list of agent 2 specific [items](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2).<br><br>**Windows**: All metrics supported by Zabbix agent, and also net.tcp.service\* checks of HTTPS, LDAP.<br>Additionally, the agent 2 provides Zabbix-native monitoring solution for: PostgreSQL, Redis.|
|Concurrency|Active checks for single server are executed sequentially.|Checks from different plugins or multiple checks within one plugin can be executed concurrently.|
|Scheduled/flexible intervals|Supported for passive checks only.|Supported for passive and active checks.|
|Third-party traps|no|yes|
|*Additional features*|<|<|
|Persistent storage|no|yes|
|Persistent files for log\*\[\] metrics|yes (only on Unix)|no|
|Log data upload|Can be performed during log gathering to free the buffer.|Log gathering is stopped when the buffer is full, therefore the [BufferSize](/manual/appendix/config/zabbix_agent2) parameter must be at least MaxLinesPerSecond x 2.|
|Timeout settings|Defined on an agent level only.|Plugin timeout can override the timeout defined on an agent level.|
|Changes user at runtime|yes (Unix-like systems only)|no (controlled by systemd)|
|User-configurable ciphersuites|yes|no|
**See also:**
- *Zabbix processes description*: [Zabbix
agent](/manual/concepts/agent), [Zabbix agent
2](/manual/concepts/agent2)
- *Configuration parameters*: Zabbix agent
[UNIX](/manual/appendix/config/zabbix_agentd) /
[Windows](/manual/appendix/config/zabbix_agentd_win), Zabbix agent 2
[UNIX](/manual/appendix/config/zabbix_agent2) /
[Windows](/manual/appendix/config/zabbix_agent2_win)
# 16 Agent与agent 2对比
本节描述Zabbix agent与Zabbix agent 2之间的差异。
| 参数 | Zabbix agent | Zabbix agent 2 |
|--|------|------|
| Programming language | C语言 | 主要使用Go语言（部分采用C语言） |
| Daemonization | 支持 | 仅通过systemd管理（Windows系统支持） |
| Supported extensions | 使用C语言编写自定义[loadable modules](/manual/config/items/loadablemodules)。 | 使用Go语言编写自定义[plugins](/manual/config/items/plugins)。 |
| *Requirements* | < | < |
| Supported platforms | Linux、IBM AIX、FreeBSD、NetBSD、OpenBSD、HP-UX、Mac OS X、Solaris: 9/10/11、Windows: XP及之后所有桌面和服务器版本 | Linux、Windows: 可安装[supported Go version](/manual/installation/requirements#agent-2)的所有桌面和服务器版本 |
| Supported crypto libraries | GnuTLS 3.1.18及以上<br>OpenSSL 1.0.1/1.0.2/1.1.0/1.1.1/3.0.x（注：3.0.x自Zabbix 6.0.4起支持）<br>LibreSSL - 测试版本2.7.4/2.8.2（存在限制，详见[编译带加密支持的zabbix](/manual/encryption#编译带加密支持的zabbix)页面） | Linux: OpenSSL 1.0.1及以上（自Zabbix 4.4.8起支持）<br>Windows: OpenSSL 1.1.1及以上<br>OpenSSL库需启用PSK支持。不支持LibreSSL。 |
| Monitoring processes | < | < |
| Processes | 每个server/proxy记录对应独立的活动检查进程。 | 单进程自动创建多线程<br>最大线程数由GOMAXPROCS环境变量决定。 |
| Metrics | **UNIX系统**: 查看支持的[items](/manual/config/items/itemtypes/zabbix_agent)列表<br><br>**Windows系统**: 查看额外的Windows专用[items](/manual/config/items/itemtypes/zabbix_agent/win_keys)列表 | **UNIX系统**: 支持Zabbix agent所有指标<br>此外，agent 2提供原生监控方案：Docker、Memcached、MySQL、PostgreSQL、Redis、systemd等 - 完整列表见agent 2专用[items](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2)<br><br>**Windows系统**: 支持Zabbix agent所有指标，及HTTPS/LDAP的net.tcp.service*检查<br>此外，agent 2提供PostgreSQL、Redis原生监控方案 |
| Concurrency | 单服务器活动检查按顺序执行。 | 不同插件或同一插件内的多个检查可并发执行。 |
| Scheduled/flexible intervals | 仅支持被动检查。 | 支持被动和主动检查。 |
| Third-party traps | 不支持 | 支持 |
| *Additional features* | < | < |
| Persistent storage | 不支持 | 支持 |
| Persistent files for log\*\[\] metrics | 支持（仅Unix系统） | 不支持 |
| Log data upload | 日志收集时可执行缓冲区释放操作。 | 缓冲区满时停止日志收集，因此[BufferSize](/manual/appendix/config/zabbix_agent2)参数值至少需为MaxLinesPerSecond x 2。 |
| Timeout settings | 仅在agent级别定义。 | 插件超时可覆盖agent级别定义的超时。 |
| Changes user at runtime | 支持（仅类Unix系统） | 不支持（由systemd控制） |
| User-configurable ciphersuites | 支持 | 不支持 |
**另请参阅:**
- *Zabbix进程说明*: [Zabbix
agent](/manual/concepts/agent), [Zabbix agent
2](/manual/concepts/agent2)
- *配置参数*: Zabbix agent
[UNIX](/manual/appendix/config/zabbix_agentd) /
[Windows](/manual/appendix/config/zabbix_agentd_win), Zabbix agent 2
[UNIX](/manual/appendix/config/zabbix_agent2) /
[Windows](/manual/appendix/config/zabbix_agent2_win)
# 16 Creating custom performance counter names for VMware
# 16 为 VMware 创建自定义性能计数器名称
# 16 Distributed monitoring
# 16 分布式监控
# 16 HTTP agent
# 16 HTTP agent
# 16 Issues with SELinux
Socket-based inter-process communication has been added since Zabbix
3.4. On systems where SELinux is enabled it may be required to add
SELinux rules to allow Zabbix create/use UNIX domain sockets in the
`SocketDir` directory. Currently socket files are used by server
(alerter, preprocessing, IPMI) and proxy (IPMI). Socket files are
persistent, meaning are present while the process is running.
# 16 SELinux的问题
从 Zabbix 3.4 开始添加了基于套接字的进程间通信。 在启用 SELinux 的系统上，可能需要添加 SELinux 规则以允许 Zabbix `SocketDir`目录中创建/使用 UNIX 域套接字。当前，服务器（警报器、预处理器、IPMI）和代理（IPMI）使用套接字文件。套接字文件是持久的，意思是一直伴随进程运行而存在。
# 16 Problem hosts
# 16 问题主机
# 16 Problem hosts
# 16 问题主机
# 16 Upgrade notes for 6.0.6
# 16 6.0.6 版本升级说明
# 16 What's new in Zabbix 6.0.11
# 16 Zabbix 6.0.11 新特性
# 17 Encryption
# 17 加密
# 17 Escaping examples
# 17 转义示例
# 17 Notes on system.cpu.util items on Windows
# 17 关于 Windows 系统下 system.cpu.util 监控项 的注意事项
# 17 Problems
# 17 问题
# 17 Problems
# 17 问题
# 17 Prometheus checks
# 17 个 Prometheus 检查
# 17 Upgrade notes for 6.0.7
# 17 6.0.7 版本升级说明
# 17 What's new in Zabbix 6.0.12
# 17 Zabbix 6.0.12 的新特性
# 18 Problems by severity
# 18 按严重程度分类的问题
# 18 Problems by severity
# 18 按严重程度分类的问题
# 18 Script items
# 18 脚本监控项
# 18 Upgrade notes for 6.0.8
This minor version doesn't have any upgrade notes.
# 18 6.0.8 版本升级说明
此次要version没有任何升级说明.
# 18 Web interface
# 18 Web 界面
# 18 What's new in Zabbix 6.0.13
# 18 Zabbix 6.0.13 新特性
# 19 API
# 19 API
# 19 SLA report
# 19 SLA 报告
# 19 SLA report
# 19 SLA 报告
# 19 Upgrade notes for 6.0.9
This minor version doesn't have any upgrade notes.
# 19 6.0.9 版本升级说明
此次要version没有任何升级说明。
# 19 What's new in Zabbix 6.0.14
# 19 Zabbix 6.0.14 版本新特性
# 1 Action log
# 1 操作日志
# 1 Additional JavaScript objects
# 1 附加 JavaScript objects
# 1 Aggregate calculations
# 1 聚合计算
# 1 Aggregate functions
Except where stated otherwise, all functions listed here are supported
in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Aggregate functions can work with either:
- history of items, for example, `min(/host/key,1h)`
- [foreach functions](/manual/appendix/functions/aggregate/foreach) as
the only parameter, for example, `min(last_foreach(/*/key))` (only in calculated items; cannot be used in triggers)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
- Function-specific parameters are described with each function
- `/host/key` and `(sec|#num)<:time shift>` parameters must never be
quoted
# 1 聚合函数
除特别说明外，此处列出的所有函数均支持以下场景：
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
聚合函数可处理以下数据类型：
- 监控项历史数据，例如`min(/host/key,1h)`
- [foreach functions](/manual/appendix/functions/aggregate/foreach)作为
the only parameter, for example, `min(last_foreach(/*/key))` (only in calculated items; cannot be used in triggers)
`min(last_foreach(/*/key))`（仅适用于计算型监控项；不可用于触发器）
关于函数参数的通用说明：
- 函数参数间用逗号分隔
- 可选参数（或参数部分）以`<` `>`标识
- 函数特定参数将在各函数中单独说明
- `/host/key`和`(sec|#num)<:time shift>`参数禁止使用引号包裹
# 1 Best practices for secure Zabbix setup
# 1 Zabbix 安全配置最佳实践
# 1 Building loadable plugins
# 1 构建可加载插件
# 1 Building Zabbix agent on Windows
# 1 在Windows上构建Zabbix agent
# 1 Ceph plugin
# 1 Ceph 插件
# 1 Compilation issues
These are the known issues regarding Zabbix compilation from sources. For all other cases, see the [Known issues](/manual/installation/known_issues) page.
# 1 编译 问题
以下是关于从源代码编译Zabbix的已知问题. 其他所有情况请参阅[Known issues](/manual/installation/known_issues)页面.
# 1 Conditions
# 1 条件
# 1 Configuring a host
# 1 配置主机
# 1 Configuring a network discovery rule
# 1 配置网络发现规则
# 1 Configuring a network map
# 1 配置网络拓扑图
# 1 Configuring a template
# 1 配置模板
# 1 Configuring a trigger
# 1 配置触发器
# 1 Configuring a user
# 1 配置用户
# 1 Connection type or permission problems
# 1 连接类型或权限问题
# 1 Creating an item
# 1 创建 监控项
# 1 Dashboard
# 1 仪表板
# 1 Dashboard widgets
# 1 仪表盘部件
# 1 Database creation
# 1 数据库创建
# 1 Debian/Ubuntu frontend installation
# 1 Debian/Ubuntu 前端安装
# 1 Discovery of mounted filesystems
# 1 已挂载文件系统的发现
# 1 Dynamic indexes
# 1 动态索引
# 1 E-mail
# 1 电子邮件
# 1 Escaping special characters from LLD macro values in JSONPath
When low-level discovery macros are used in JSONPath preprocessing and
their values are resolved, the following rules of escaping special
characters are applied:
- only backslash (\\) and double quote (") characters are considered
for escaping;
- if the resolved macro value contains these characters, each of them
is escaped with a backslash;
- if they are already escaped with a backslash, it is not considered
as escaping and both the backslash and the following special
characters are escaped once again.
For example:
|JSONPath|LLD macro value|After substitution|
|--------|---------------|------------------|
|$.\[?(@.value == "{\#MACRO}")\]|special "value"|$.\[?(@.value == "special \\"value\\"")\]|
|^|c:\\temp|$.\[?(@.value == "c:\\\\temp")\]|
|^|a\\\\b|$.\[?(@.value == "a\\\\\\\\b")\]|
When used in the expression the macro that may have special characters
should be enclosed in double quotes:
|JSONPath|LLD macro value|After substitution|Result|
|--------|--------|--------|--------|
|$.\[?(@.value == "{\#MACRO}")\]|special "value"|$.\[?(@.value == "special \\"value\\"")\]|OK|
|$.\[?(@.value == {\#MACRO})\]|^|$.\[?(@.value == special \\"value\\")\]|**Bad JSONPath expression**|
When used in the path the macro that may have special characters should
be enclosed in square brackets **and** double quotes:
|JSONPath|LLD macro value|After substitution|Result|
|--------|--------|--------|--------|
|$.\["{\#MACRO}"\].value|c:\\temp|$.\["c:\\\\temp"\].value|OK|
|$.{\#MACRO}.value|^|$.c:\\\\temp.value|**Bad JSONPath expression**|
# 1 从JSONPath中的LLD宏值转义特殊字符
当JSONPath预处理中使用低级发现宏时
它们的值在解析时遵循以下特殊字符转义规则
应用的字符：
- 仅反斜杠 (\\) 和双引号 (") 字符被视为特殊字符
用于转义;
- 如果解析后的宏值包含这些字符，则每个字符
使用反斜杠进行转义；
- 如果它们已经被反斜杠转义，则不予考虑
as escaping and both the backslash and the following special
characters are escaped once again.
例如:
| JSONPath | LLD宏值 | 替换后结果 |
|--------|---------------|------------------|
| $.\[?(@.value == "{\#MACRO}")\] | special "value" | $.\[?(@.value == "special \\"value\\"")\] |
| ^ | c:\\temp | $.\[?(@.value == "c:\\\\temp")\] |
| ^ | a\\\\b | $.\[?(@.value == "a\\\\\\\\b")\] |
当在表达式中使用可能包含特殊字符的宏时
应使用双引号括起来：
| JSONPath | LLD宏值 | 替换后 | 结果 |
|--------|--------|--------|--------|
| $.\[?(@.value == "{\#MACRO}")\] | special "value" | $.\[?(@.value == "special \\"value\\"")\] | OK |
| $.\[?(@.value == {\#MACRO})\] | ^ | $.\[?(@.value == special \\"value\\")\] | **错误的JSONPath表达式** |
当在路径中使用可能包含特殊字符的宏时
需用方括号**和**双引号括起：
| JSON路径 | LLD宏值 | 替换后 | 结果 |
|--------|--------|--------|--------|
| $.\["{\#MACRO}"\].value | c:\\temp | $.\["c:\\\\temp"\].value | OK |
| $.{\#MACRO}.value | ^ | $.c:\\\\temp.value | **错误的JSONPath表达式** |
# 1 Extending Zabbix agents
This tutorial provides step-by-step instructions on how to extend the
functionality of Zabbix agent with the use of a [user
parameter](/manual/config/items/userparameters).
# 1 扩展 Zabbix agents
本教程提供逐步指导，说明如何通过使用[user
parameter](/manual/config/items/userparameters)来扩展Zabbix agent的功能。
# 1 Foreach functions
# 1 循环处理函数
# 1 General
# 1 概述
# 1 Getting Zabbix
# 1 获取 Zabbix
# 1 Global notifications
# 1 全局通知
# 1 Graphs
# 1 图表
# 1 Graphs
# 1 图表
# 1 High availability
# 1 高可用性
# 1 Host groups
# 1 主机组
# 1 Host groups
In the frontend host groups can be [exported](/manual/xml_export_import)
only with host or template export. When a host or template is exported
all groups it belongs to are exported with it automatically.
API allows to export host groups independently from hosts or templates.
# 1 主机组
在前端界面中，主机组只能与主机或模板export进行[exported](/manual/xml_export_import)。当导出一个主机或模板时，
其所归属的所有组都会自动随之导出。
API允许独立于主机或模板对主机组进行export操作。
# 1 Hosts and host groups
# 1 主机与主机组
# 1 Installation and setup
Please use the sidebar to access content in this section.
# 1 安装与配置
请使用侧边栏访问本节内容。
# 1 Introduction
Please use the sidebar to access content in the Introduction section.
# 1 简介
请使用侧边栏访问"简介"部分的内容。
# 1 Item key format
Item key format, including key parameters, must follow syntax rules. The
following illustrations depict the supported syntax. Allowed elements
and characters at each point can be determined by following the arrows -
if some block can be reached through the line, it is allowed, if not -
it is not allowed.
{width="600"}
To construct a valid item key, one starts with specifying the key name,
then there's a choice to either have parameters or not - as depicted by
the two lines that could be followed.
# 1 监控项 键格式
监控项键格式（包括键参数）必须遵循语法规则。
以下图示展示了支持的语法结构。通过箭头路径可以确定每个位置允许的元素和字符——如果某个区块可以通过连线到达，则表示允许使用；反之则不允许。
{width="600"}
要构建有效的监控项键，首先需指定键名称，然后可选择是否包含参数——如图中两条可选路径所示。
# 1 Item keys specific to agent 2
# 1 监控项 键值特定于 agent 2
# 1 Item prototypes
# 1 监控项原型
# 1 Item prototypes
# 1 监控项原型
# 1 Item prototypes
Once a rule is created, go to the items for that rule and press "Create
item prototype" to create an item prototype. Note how macro {\#FSNAME}
is used where a file system name is required. When the discovery rule is
processed, this macro will be substituted with the discovered file
system.
Low-level discovery [macros](/manual/config/macros/lld_macros) and user
[macros](/manual/appendix/macros/supported_by_location_user) may be used
in item prototype configuration and item value preprocessing
[parameters](/manual/config/items/item#item_value_preprocessing). Note
that when used in update intervals, a single macro has to fill the whole
field. Multiple macros in one field or macros mixed with text are not
supported.
::: noteclassic
Context-specific escaping of low-level discovery macros is
performed for safe use in regular expression and XPath preprocessing
parameters.
:::
Attributes that are specific for item prototypes:
|Parameter|Description|
|---------|-----------|
|*Create enabled*|If checked the item will be added in an enabled state.<br>If unchecked, the item will be added to a discovered entity, but in a disabled state.|
|*Discover*|If checked (default) the item will be added to a discovered entity.<br>If unchecked, the item will not be added to a discovered entity, unless this setting is [overridden](/manual/discovery/low_level_discovery#override) in the discovery rule.|
We can create several item prototypes for each file system metric we are
interested in:
*[Mass update](/manual/config/items/itemupdate#using_mass_update)*
option is available if you want to update properties of several item
prototypes at once.
# 1 Item prototypes
Once a rule is created, go to the items for that rule and press "Create
item prototype" to create an item prototype. Note how macro {\#FSNAME}
is used where a file system name is required. When the discovery rule is
processed, this macro will be substituted with the discovered file
system.
Low-level discovery [macros](/manual/config/macros/lld_macros) and user
[macros](/manual/appendix/macros/supported_by_location_user) may be used
in item prototype configuration and item value preprocessing
[parameters](/manual/config/items/item#item_value_preprocessing). Note
that when used in update intervals, a single macro has to fill the whole
field. Multiple macros in one field or macros mixed with text are not
supported.
::: noteclassic
Context-specific escaping of low-level discovery macros is
performed for safe use in regular expression and XPath preprocessing
parameters.
:::
Attributes that are specific for item prototypes:
|Parameter|Description|
|---------|-----------|
|*Create enabled*|If checked the item will be added in an enabled state.<br>If unchecked, the item will be added to a discovered entity, but in a disabled state.|
|*Discover*|If checked (default) the item will be added to a discovered entity.<br>If unchecked, the item will not be added to a discovered entity, unless this setting is [overridden](/manual/discovery/low_level_discovery#override) in the discovery rule.|
We can create several item prototypes for each file system metric we are
interested in:
*[Mass update](/manual/config/items/itemupdate#using_mass_update)*
option is available if you want to update properties of several item
prototypes at once.
# 1 Item prototypes
Once a rule is created, go to the items for that rule and press "Create
item prototype" to create an item prototype.
Note how the {\#FSNAME} macro is used where a file system name is required.
The use of a low-level discovery macro is mandatory in the item key to make sure
that the discovery is processed correctly. When the discovery rule is processed,
this macro will be substituted with the discovered file system.
Low-level discovery [macros](/manual/config/macros/lld_macros) and user
[macros](/manual/appendix/macros/supported_by_location_user) are supported
in item prototype configuration and item value preprocessing
[parameters](/manual/config/items/item#item_value_preprocessing). Note
that when used in update intervals, a single macro has to fill the whole
field. Multiple macros in one field or macros mixed with text are not
supported.
::: noteclassic
Context-specific escaping of low-level discovery macros is
performed for safe use in regular expression and XPath preprocessing
parameters.
:::
Attributes that are specific for item prototypes:
|Parameter|Description|
|--|--------|
|*Create enabled*|If checked the item will be added in an enabled state.<br>If unchecked, the item will be added to a discovered entity, but in a disabled state.|
|*Discover*|If checked (default) the item will be added to a discovered entity.<br>If unchecked, the item will not be added to a discovered entity, unless this setting is [overridden](/manual/discovery/low_level_discovery#override) in the discovery rule.|
We can create several item prototypes for each file system metric we are
interested in:
Click on the three-dot icon to open the menu for the specific item prototype with these options:
- *Create trigger prototype* - create a trigger prototype based on this item prototype
- *Trigger prototypes* - click to see a list with links to already-configured trigger prototypes of this item prototype
- *Create dependent item* - create a dependent item for this item prototype
*[Mass update](/manual/config/items/itemupdate#using_mass_update)*
option is available if you want to update properties of several item
prototypes at once.
# 1 监控项原型
创建规则后，转到该规则的监控项并点击"创建
监控项原型"以create一个监控项原型。
注意在需要file系统名称的地方如何使用{\#FSNAME}宏。
在监控项键中使用低级发现宏是强制性的，以确保
发现过程正确执行。当处理发现规则时，
此宏将被替换为发现的file系统。
在监控项原型配置和监控项值预处理[监控项-值预处理](/manual/config/items/item#监控项-值预处理)中支持
低级发现[macros](/manual/config/macros/lld_macros)和用户
[macros](/manual/appendix/macros/supported_by_location_user)。注意
当在update间隔中使用时，单个宏必须填充整个
字段。不支持在一个字段中使用多个宏或宏与文本混合。
::: noteclassic
针对低级发现宏执行特定上下文的转义，
以便安全地用于正则表达式和XPath预处理参数。
:::
监控项原型特有的属性：
| 参数 | 描述 |
|--|--------|
| *Create enabled* | 如果勾选，监控项将以启用状态添加。<br>如果未勾选，监控项将添加到发现的实体中，但处于禁用状态。 |
| *Discover* | 如果勾选（默认），监控项将添加到发现的实体中。<br>如果未勾选，监控项将不会添加到发现的实体中，除非此设置在发现规则中被[覆盖](/manual/discovery/low_level_discovery#覆盖)。 |
我们可以为每个感兴趣的file系统指标create多个监控项原型：
点击三点图标打开特定监控项原型的菜单，包含以下选项：
- *创建触发器原型* - 基于此监控项原型create一个触发器原型
- *触发器原型* - 点击查看已配置的此监控项原型的触发器原型列表
- *创建依赖监控项* - 为此监控项原型create一个依赖监控项
*[Mass update](/manual/config/items/itemupdate#using_mass_update)*
选项可用于一次性update多个监控项原型的属性。
# 1 Items
# 1 监控项
# 1 Items
# 1 监控项
# 1 Items supported by platform
The table displays support for Zabbix [agent
items](/manual/config/items/itemtypes/zabbix_agent) on various
platforms:
- Items marked with "**X**" are supported, the ones marked with
"**-**" are not supported.
- If an item is marked with "**?**", it is not known whether it is
supported or not.
- If an item is marked with "**r**", it means that it requires root
privileges.
- Parameters that are included in angle brackets
**<**like\_this**>** are optional.
::: noteclassic
[Windows-only](/manual/config/items/itemtypes/zabbix_agent/win_keys)
Zabbix agent items are not included in this table.
:::
| | | | | | | | | | | | | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|NetBSD|<|<|<|<|<|<|<|<|<|<|<|▼▼|
|OpenBSD|<|<|<|<|<|<|<|<|<|<|▼▼|^|
|Mac OS X|<|<|<|<|<|<|<|<|<|▼▼|^|^|
|Tru64|<|<|<|<|<|<|<|<|▼▼|^|^|^|
|AIX|<|<|<|<|<|<|<|▼▼|^|^|^|^|
|HP-UX|<|<|<|<|<|<|▼▼|^|^|^|^|^|
|Solaris|<|<|<|<|<|▼▼|^|^|^|^|^|^|
|FreeBSD|<|<|<|<|▼▼|^|^|^|^|^|^|^|
|Linux 2.6 (and later)|<|<|<|▼▼|^|^|^|^|^|^|^|^|
|Linux 2.4|<|<|▼▼|^|^|^|^|^|^|^|^|^|
|Windows|<|▼▼|^|^|^|^|^|^|^|^|^|^|
|▼ Item ▼|<|1|2|3|4|5|6|7|8|9|10|11|
|**agent.hostmetadata**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.hostname**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.ping**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.variant**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.version**|<|X|X|X|X|X|X|X|X|X|X|X|
|**kernel.maxfiles**|<|\-|X|X|X|\-|\-|\-|?|X|X|X|
|**kernel.maxproc**|<|\-|\-|X|X|X|\-|\-|?|X|X|X|
|**kernel.openfiles**|<|\-|X|X|?|?|?|?|?|?|?|?|
|**log\[file,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**log.count\[file,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**logrt\[file\_regexp,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**logrt.count\[file\_regexp,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**modbus.get\[endpoint,<slave id>,<function>,<address>,<count>,<type>,<endianness>,<offset>\]**|<|X|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.dns\[<ip>,zone,<type>,<timeout>,<count>,<protocol>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.dns.record\[<ip>,zone,<type>,<timeout>,<count>,<protocol>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.if.collisions\[if\]**|<|\-|X|X|X|X|\-|X|\-|X|X|r|
|**net.if.discovery**|<|X|X|X|X|X|X|X|\-|\-|X|X|
|**net.if.in\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|X|\-|X|\-|\-|X|X|r|
|^|overruns|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|frame|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|compressed|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|multicast|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.if.out\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|\-|\-|X|\-|\-|\-|\-|\-|
|^|overruns|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|collision|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|carrier|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|compressed|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.if.total\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|\-|\-|X|\-|\-|\-|\-|\-|
|^|overruns|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|compressed|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.tcp.listen\[port\]**|<|X|X|X|X|X|\-|\-|\-|X|\-|\-|
|**net.tcp.port\[<ip>,port\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.service\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.service.perf\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]**|<|X^**[7](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.udp.listen\[port\]**|<|\-|X|X|X|X|\-|\-|\-|X|\-|\-|
|**net.udp.service\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.udp.service.perf\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.udp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]**|<|X^**[7](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**proc.cpu.util\[<name>,<user>,<type>,<cmdline>,<mode>,<zone>\]**|<|\-|X|X|\-|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|\-|\-|\-|\-|\-|\-|
|*type* ▲|total *(default)*|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|user|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|system|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|*mode* ▲|avg1 *(default)*|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|*zone* ▲|current *(default)*|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|^|all|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|**proc.mem\[<name>,<user>,<mode>,<cmdline><memtype>\]**|<|\-|X|X|X|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|\-|X|X|\-|X|X|
|*mode* ▲|sum *(default)*|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|avg|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|max|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|min|\-|X|X|X|X|\-|X|X|\-|X|X|
|*memtype* ▲|<|\-|X|X|X|X|\-|X|\-|\-|\-|\-|
|**proc.num\[<name>,<user>,<state>,<cmdline>,<zone>\]**|<|X|X|X|X|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|\-|X|X|
|*state* ▲|all *(default)*|\-|X|X|X|X|X|X|X|\-|X|X|
|^|disk|\-|X|X|X|\-|\-|\-|\-|\-|X|X|
|^|sleep|\-|X|X|X|X|X|X|X|\-|X|X|
|^|zomb|\-|X|X|X|X|X|X|X|\-|X|X|
|^|run|\-|X|X|X|X|X|X|X|\-|X|X|
|^|trace|\-|X|X|X|\-|\-|\-|\-|\-|X|X|
|*cmdline* ▲|<|\-|X|X|X|X|X|X|X|\-|X|X|
|*zone* ▲|current *(default)*|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|^|all|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|**sensor\[device,sensor,<mode>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|X|\-|
|**system.boottime**|<|\-|X|X|X|X|\-|\-|\-|X|X|X|
|**system.cpu.discovery**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.cpu.intr**|<|\-|X|X|X|X|\-|X|\-|\-|X|X|
|**system.cpu.load\[<cpu>,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*cpu* ▲|all *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|percpu|X|X|X|X|X|X|X|\-|X|X|X|
|*mode* ▲|avg1 *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|avg5|X|X|X|X|X|X|X|X|X|X|X|
|^|avg15|X|X|X|X|X|X|X|X|X|X|X|
|**system.cpu.num\[<type>\]**|<|X|X|X|X|X|X|X|\-|X|X|X|
|*type* ▲|online *(default)*|X|X|X|X|X|X|X|\-|X|X|X|
|^|max|\-|X|X|X|X|\-|\-|\-|X|\-|\-|
|**system.cpu.switches**|<|\-|X|X|X|X|\-|X|\-|\-|X|X|
|**system.cpu.util\[<cpu>,<type>,<mode>,<logical\_or\_physical>\]**|<|X|X|X|X|X|X|X|X|\-|X|X|
|*type* ▲|user *(default)*|\-|X|X|X|X|X|X|X|\-|X|X|
|^|nice|\-|X|X|X|\-|X|\-|X|\-|X|X|
|^|idle|\-|X|X|X|X|X|X|X|\-|X|X|
|^|system *(default for Windows)*|X|X|X|X|X|X|X|X|\-|X|X|
|^|iowait|\-|\-|X|\-|X|\-|X|\-|\-|\-|\-|
|^|interrupt|\-|\-|X|X|\-|\-|\-|\-|\-|X|\-|
|^|softirq|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|steal|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|guest|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|guest\_nice|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲|avg1 *(default)*|X|X|X|X|X|X|X|X|\-|X|X|
|^|avg5|X|X|X|X|X|X|X|\-|\-|X|X|
|^|avg15|X|X|X|X|X|X|X|\-|\-|X|X|
|*logical\_or\_physical* ▲|logical *(default)*|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|^|physical|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**system.hostname\[<type>,<transform>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.hw.chassis\[<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.cpu\[<cpu>,<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.devices\[<type>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.macaddr\[<interface>,<format>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.localtime\[<type>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*type* ▲|utc *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|local|X|X|X|X|X|X|X|X|X|X|X|
|**system.run\[command,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|wait *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|nowait|X|X|X|X|X|X|X|X|X|X|X|
|**system.stat\[resource,<type>\]**|<|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|**system.sw.arch**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.sw.os\[<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.sw.packages\[<regexp>,<manager>,<format>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.swap.in\[<device>,<type>\]**<br>*(specifying a device is only supported under Linux)*|<|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|*type* ▲<br>*(pages will only work if<br>device was not specified)*|count *(default under all except Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|^|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|pages *(default under Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|**system.swap.out\[<device>,<type>\]**<br>*(specifying a device is only supported under Linux)*|<|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|*type* ▲<br>*(pages will only work if<br>device was not specified)*|count *(default under all except Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|^|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|pages *(default under Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|**system.swap.size\[<device>,<type>\]**<br>*(specifying a device is only supported under FreeBSD, for other platforms must be empty or "all")*|<|X|X|X|X|X|\-|X|X|\-|X|\-|
|*type* ▲|free *(default)*|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|total|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|used|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|pfree|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|pused|X ^**[6](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|\-|X|X|\-|X|\-|
|**system.uname**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.uptime**|<|X|X|X|X|X|\-|X|?|X|X|X|
|**system.users.num**|<|\-|X|X|X|X|X|X|X|X|X|X|
|**systemd.unit.discovery**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**systemd.unit.get**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**systemd.unit.info**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**vfs.dev.discovery**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**vfs.dev.read\[<device>,<type>,<mode>\]**|<|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|*type* ▲|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|operations *(default for OpenBSD, AIX)*|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|^|bytes *(default for Solaris)*|\-|\-|\-|X|X|\-|X|\-|\-|X|\-|
|^|sps *(default for Linux)*|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|ops|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|bps *(default for FreeBSD)*|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲<br>*(compatible only with<br>type in: sps, ops, bps)*|avg1 *(default)*|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|**vfs.dev.write\[<device>,<type>,<mode>\]**|<|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|*type* ▲|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|operations *(default for OpenBSD, AIX)*|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|^|bytes *(default for Solaris)*|\-|\-|\-|X|X|\-|X|\-|\-|X|\-|
|^|sps *(default for Linux)*|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|ops|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|bps *(default for FreeBSD)*|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲<br>*(compatible only with<br>type in: sps, ops, bps)*|avg1 *(default)*|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|**vfs.dir.count\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.dir.get\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.dir.size\[dir,<regex\_incl>,<regex\_excl>,<mode>,<max\_depth>,<regex\_excl\_dir>\]**|<|X|X|X|?|?|?|?|?|?|?|?|
|**vfs.file.cksum\[file,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.contents\[file,<encoding>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.exists\[file,<types\_incl>,<types\_excl>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.get\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.md5sum\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.owner\[file,<ownertype>,<resulttype>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.permissions\[file\]**|<|\-|X|X|?|?|?|?|?|?|?|?|
|**vfs.file.regexp\[file,regexp,<encoding>,<start line>,<end line>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.regmatch\[file,regexp,<encoding>,<start line>,<end line>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.size\[file,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**vfs.file.time\[file,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|modify *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|access|X|X|X|X|X|X|X|X|X|X|X|
|^|change|X^**[5](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|**vfs.fs.discovery**|<|X|X|X|X|X|X|X|\-|X|X|X|
|**vfs.fs.get**|<|X|X|X|X|X|X|X|\-|X|X|X|
|**vfs.fs.inode\[fs,<mode>\]**|<|\-|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|\-|X|X|X|X|X|X|X|X|X|X|
|^|free|\-|X|X|X|X|X|X|X|X|X|X|
|^|used|\-|X|X|X|X|X|X|X|X|X|X|
|^|pfree|\-|X|X|X|X|X|X|X|X|X|X|
|^|pused|\-|X|X|X|X|X|X|X|X|X|X|
|**vfs.fs.size\[fs,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|free|X|X|X|X|X|X|X|X|X|X|X|
|^|used|X|X|X|X|X|X|X|X|X|X|X|
|^|pfree|X|X|X|X|X|X|X|X|X|X|X|
|^|pused|X|X|X|X|X|X|X|X|X|X|X|
|**vm.memory.size\[<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|active|\-|\-|\-|X|\-|X|\-|\-|X|X|X|
|^|anon|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|buffers|\-|X|X|X|\-|\-|\-|\-|\-|X|X|
|^|cached|X|X|X|X|\-|\-|X|\-|\-|X|X|
|^|exec|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|file|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|free|X|X|X|X|X|X|X|X|X|X|X|
|^|inactive|\-|\-|\-|X|\-|\-|\-|\-|X|X|X|
|^|pinned|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|^|shared|\-|X|\-|X|\-|\-|\-|\-|\-|X|X|
|^|wired|\-|\-|\-|X|\-|\-|\-|\-|X|X|X|
|^|used|X|X|X|X|X|X|X|X|X|X|X|
|^|pused|X|X|X|X|X|X|X|X|X|X|X|
|^|available|X|X|X|X|X|X|X|X|X|X|X|
|^|pavailable|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.get\[host,<path>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.perf\[host,<path>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.regexp\[host,<path>,<port>,regexp,<length>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
::: notetip
See also a description of [vm.memory.size
parameters](vm.memory.size_params).
:::
# 1 监控项 平台支持
该表格展示了Zabbix [agent
items](/manual/config/items/itemtypes/zabbix_agent)在不同平台上的支持情况
平台:
- 标记为"**X**"的监控项表示受支持
"**-**" 不支持。
- 如果某个监控项被标记为"**?**"，则表示无法确定它是否
支持与否。
- 如果某个监控项被标记为"**r**"，则表示它需要root权限
权限。
- 包含在尖括号中的参数
**<**like\_this**>** are optional.
::: noteclassic
[Windows-only](/manual/config/items/itemtypes/zabbix_agent/win_keys)
Zabbix agent 监控项 未包含在此表中
:::
| | | | | | | | | | | | | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| NetBSD | < | < | < | < | < | < | < | < | < | < | < | ▼▼ |
OpenBSD | < | < | < | < | < | < | < | < | < | < | ▼▼ | ^ |
Mac OS X | < | < | < | < | < | < | < | < | < | ▼▼ | ^ | ^ |
| Tru64 | < | < | < | < | < | < | < | < | ▼▼ | ^ | ^ | ^ |
| AIX | < | < | < | < | < | < | < | ▼▼ | ^ | ^ | ^ | ^ |
| HP-UX | < | < | < | < | < | < | ▼▼ | ^ | ^ | ^ | ^ | ^ |
| Solaris | < | < | < | < | < | ▼▼ | ^ | ^ | ^ | ^ | ^ | ^ |
| FreeBSD | < | < | < | < | ▼▼ | ^ | ^ | ^ | ^ | ^ | ^ | ^ |
| Linux 2.6 (及更高版本) | < | < | < | ▼▼ | ^ | ^ | ^ | ^ | ^ | ^ | ^ | ^ |
| Linux 2.4 | < | < | ▼▼ | ^ | ^ | ^ | ^ | ^ | ^ | ^ | ^ | ^ |
| Windows | < | ▼▼ | ^ | ^ | ^ | ^ | ^ | ^ | ^ | ^ | ^ | ^ |
| ▼ 监控项 ▼ | < | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
| **agent.hostmetadata** | < | X | X | X | X | X | X | X | X | X | X | X |
| **agent.hostname** | < | X | X | X | X | X | X | X | X | X | X | X |
| **agent.ping** | < | X | X | X | X | X | X | X | X | X | X | X |
| **agent.variant** | < | X | X | X | X | X | X | X | X | X | X | X |
| **agent.version** | < | X | X | X | X | X | X | X | X | X | X | X |
| **kernel.maxfiles** | < | \- | X | X | X | \- | \- | \- | ? | X | X | X |
| **kernel.maxproc** | < | \- | \- | X | X | X | \- | \- | ? | X | X | X |
| **kernel.openfiles** | < | \- | X | X | ? | ? | ? | ? | ? | ? | ? | ? |
| **log\[file,\<正则表达式\>,\<编码\>,\<最大行数\>,\<模式\>,\<输出\>,\<最大延迟\>,\<选项\>,\<持久化目录\>\]** | < | X^**[4](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | X | X | X | X | X | X | X | X |
| *persistent\_dir* ▲ | < | \- | X | X | X | X | X | X | X | X | X | X |
| **log.count\[file,\<正则表达式\>,\<编码\>,\<最大处理行数\>,\<模式\>,\<最大延迟\>,\<选项\>,\<持久化目录\>\]** | < | X^**[4](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | X | X | X | X | X | X | X | X |
| *persistent\_dir* ▲ | < | \- | X | X | X | X | X | X | X | X | X | X |
| **logrt\[file\_regexp,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]** | < | X^**[4](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | X | X | X | X | X | X | X | X |
| *persistent\_dir* ▲ | < | \- | X | X | X | X | X | X | X | X | X | X |
| **logrt.count\[file\_regexp,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]** | < | X^**[4](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | X | X | X | X | X | X | X | X |
| *persistent\_dir* ▲ | < | \- | X | X | X | X | X | X | X | X | X | X |
| **modbus.get[终端节点,<从站ID>,<功能码>,<地址>,<数量>,<类型>,<字节序>,<偏移量>]** | < | X | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **net.dns\[<ip>,zone,<type>,<timeout>,<count>,<protocol>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **net.dns.record\[<ip>,zone,<type>,<timeout>,<count>,<protocol>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **net.if.collisions\[if\]** | < | \- | X | X | X | X | \- | X | \- | X | X | r |
| **net.if.discovery** | < | X | X | X | X | X | X | X | \- | \- | X | X |
| **net.if.in[if,<mode>]** | < | X | X | X | X | X | X ^**[1](/manual/appendix/items/supported_by_platform#脚注)**^ | X | \- | X | X | r |
| *模式* ▲ | 字节 *(默认)* | X | X | X | X | X ^**[2](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | X | X | r |
| ^ | 数据包 | X | X | X | X | X | X | X | \- | X | X | r |
| ^ | 错误 | X | X | X | X | X ^**[2](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | X | X | r |
| ^ | 丢弃 | X | X | X | X | \- | X | \- | \- | X | X | r |
| ^ | 溢出 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 帧 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 压缩 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 组播 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **net.if.out[if,<mode>]** | < | X | X | X | X | X | X ^**[1](/manual/appendix/items/supported_by_platform#脚注)**^ | X | \- | X | X | r |
| *模式* ▲ | 字节 *(默认)* | X | X | X | X | X ^**[2](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | X | X | r |
| ^ | 数据包 | X | X | X | X | X | X | X | \- | X | X | r |
| ^ | 错误 | X | X | X | X | X ^**[2](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | X | X | r |
| ^ | 丢弃 | X | X | X | \- | \- | X | \- | \- | \- | \- | \- |
| ^ | 溢出 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 碰撞 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 运营商 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 压缩 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **net.if.total\[if,<mode>\]** | < | X | X | X | X | X | X ^**[1](/manual/appendix/items/supported_by_platform#脚注)**^ | X | \- | X | X | r |
| *模式* ▲ | 字节 *(默认)* | X | X | X | X | X ^**[2](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | X | X | r |
| ^ | 数据包 | X | X | X | X | X | X | X | \- | X | X | r |
| ^ | 错误 | X | X | X | X | X ^**[2](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | X | X | r |
| ^ | 丢弃 | X | X | X | \- | \- | X | \- | \- | \- | \- | \- |
| ^ | 溢出 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 压缩 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **net.tcp.listen\[端口\]** | < | X | X | X | X | X | \- | \- | \- | X | \- | \- |
| **net.tcp.port\[<ip>,端口\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **net.tcp.service[service,<ip>,<port>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **net.tcp.service.perf[服务,<ip>,<端口>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **net.tcp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]** | < | X^**[7](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **net.udp.listen\[port\]** | < | \- | X | X | X | X | \- | \- | \- | X | \- | \- |
| **net.udp.service[服务,<ip>,<端口>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **net.udp.service.perf[服务,<ip>,<端口>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **net.udp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]** | < | X^**[7](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| < | < | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
| **proc.cpu.util[<name>,<user>,<type>,<cmdline>,<mode>,<zone>]** | < | \- | X | X | \- | X ^**[3](/manual/appendix/items/supported_by_platform#脚注)**^ | \- | \- | \- | \- | \- | \- |
| *类型* ▲ | 总计 *(默认)* | \- | X | X | \- | X | \- | \- | \- | \- | \- | \- |
| ^ | 用户 | \- | X | X | \- | X | \- | \- | \- | \- | \- | \- |
| ^ | 系统 | \- | X | X | \- | X | \- | \- | \- | \- | \- | \- |
| *模式* ▲ | avg1 *(默认)* | \- | X | X | \- | X | \- | \- | \- | \- | \- | \- |
| ^ | avg5 | \- | X | X | \- | X | \- | \- | \- | \- | \- | \- |
| ^ | avg15 | \- | X | X | \- | X | \- | \- | \- | \- | \- | \- |
| *区域* ▲ | 当前 *(默认)* | \- | \- | \- | \- | X | \- | \- | \- | \- | \- | \- |
| ^ | 全部 | \- | \- | \- | \- | X | \- | \- | \- | \- | \- | \- |
| **proc.mem\[<名称>,<用户>,<模式>,<命令行><内存类型>\]** | < | \- | X | X | X | X ^**[3](/manual/appendix/items/supported_by_platform#脚注)**^ | \- | X | X | \- | X | X |
| *模式* ▲ | 求和 *(默认)* | \- | X | X | X | X | \- | X | X | \- | X | X |
| ^ | 平均值 | \- | X | X | X | X | \- | X | X | \- | X | X |
| ^ | 最大值 | \- | X | X | X | X | \- | X | X | \- | X | X |
| ^ | 最小值 | \- | X | X | X | X | \- | X | X | \- | X | X |
| *内存类型* ▲ | < | \- | X | X | X | X | \- | X | \- | \- | \- | \- |
| **proc.num\[<进程名>,<用户>,<状态>,<命令行>,<区域>\]** | < | X | X | X | X | X ^**[3](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | X | \- | X | X |
| *状态* ▲ | 全部 *(默认)* | \- | X | X | X | X | X | X | X | \- | X | X |
| ^ | 磁盘 | \- | X | X | X | \- | \- | \- | \- | \- | X | X |
| ^ | sleep | \- | X | X | X | X | X | X | X | \- | X | X |
| ^ | 僵尸 | \- | X | X | X | X | X | X | X | \- | X | X |
| ^ | run | \- | X | X | X | X | X | X | X | \- | X | X |
| ^ | 追踪 | \- | X | X | X | \- | \- | \- | \- | \- | X | X |
| *命令行* ▲ | < | \- | X | X | X | X | X | X | X | \- | X | X |
| *区域* ▲ | 当前 *(默认)* | \- | \- | \- | \- | X | \- | \- | \- | \- | \- | \- |
| ^ | 全部 | \- | \- | \- | \- | X | \- | \- | \- | \- | \- | \- |
| **传感器[设备,传感器,<模式>]** | < | \- | X | X | \- | \- | \- | \- | \- | \- | X | \- |
| **system.boottime** | < | \- | X | X | X | X | \- | \- | \- | X | X | X |
| **system.cpu.discovery** | < | X | X | X | X | X | X | X | X | X | X | X |
| **system.cpu.intr** | < | \- | X | X | X | X | \- | X | \- | \- | X | X |
| **system.cpu.load\[<cpu>,<mode>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| *cpu* ▲ | 全部 *(默认)* | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 每CPU | X | X | X | X | X | X | X | \- | X | X | X |
| *模式* ▲ | avg1 *(默认)* | X | X | X | X | X | X | X | X | X | X | X |
| ^ | avg5 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | avg15 | X | X | X | X | X | X | X | X | X | X | X |
| **system.cpu.num\[<类型>\]** | < | X | X | X | X | X | X | X | \- | X | X | X |
| *类型* ▲ | 在线 *(默认)* | X | X | X | X | X | X | X | \- | X | X | X |
| ^ | 最大值 | \- | X | X | X | X | \- | \- | \- | X | \- | \- |
| **system.cpu.switches** | < | \- | X | X | X | X | \- | X | \- | \- | X | X |
| **system.cpu.util\[<cpu>,<type>,<mode>,<logical\_or\_physical>\]** | < | X | X | X | X | X | X | X | X | \- | X | X |
| *类型* ▲ | 用户 *(默认)* | \- | X | X | X | X | X | X | X | \- | X | X |
| ^ | 良好 | \- | X | X | X | \- | X | \- | X | \- | X | X |
| ^ | 空闲 | \- | X | X | X | X | X | X | X | \- | X | X |
| ^ | system *(Windows默认)* | X | X | X | X | X | X | X | X | \- | X | X |
| ^ | iowait | \- | \- | X | \- | X | \- | X | \- | \- | \- | \- |
| ^ | 中断 | \- | \- | X | X | \- | \- | \- | \- | \- | X | \- |
| ^ | softirq | \- | \- | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 窃取 | \- | \- | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 访客 | \- | \- | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | guest\_nice | \- | \- | X | \- | \- | \- | \- | \- | \- | \- | \- |
| *模式* ▲ | avg1 *(默认)* | X | X | X | X | X | X | X | X | \- | X | X |
| ^ | avg5 | X | X | X | X | X | X | X | \- | \- | X | X |
| ^ | avg15 | X | X | X | X | X | X | X | \- | \- | X | X |
| *logical\_or\_physical* ▲ | logical *(默认)* | \- | \- | \- | \- | \- | \- | X | \- | \- | \- | \- |
| ^ | 物理 | \- | \- | \- | \- | \- | \- | X | \- | \- | \- | \- |
| < | < | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
| **system.hostname\[<类型>,<转换>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **system.hw.chassis\[<info>\]** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **system.hw.cpu\[<cpu>,<info>\]** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **system.hw.devices\[<type>\]** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **system.hw.macaddr\[<接口>,<格式>\]** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **system.localtime\[<类型>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| *类型* ▲ | utc *(默认)* | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 本地 | X | X | X | X | X | X | X | X | X | X | X |
| **system.run[command,<mode>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| *模式* ▲ | 等待 *(默认)* | X | X | X | X | X | X | X | X | X | X | X |
| ^ | nowait | X | X | X | X | X | X | X | X | X | X | X |
| **system.stat\[resource,<type>\]** | < | \- | \- | \- | \- | \- | \- | X | \- | \- | \- | \- |
| **system.sw.arch** | < | X | X | X | X | X | X | X | X | X | X | X |
| **system.sw.os[<info>]** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **system.sw.packages\[<regexp>,<manager>,<format>\]** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **system.swap.in\[<设备>,<类型>\]**<br>*(仅Linux系统支持指定设备参数)* | < | \- | X | X | \- | X | \- | \- | \- | \- | X | \- |
| *类型* ▲<br>*(页面仅在未指定设备时生效)* | 计数 *(默认除Linux外均适用)* | \- | X | X | \- | X | \- | \- | \- | \- | X | \- |
| ^ | 扇区 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 页面 *(Linux下默认)* | \- | X | X | \- | X | \- | \- | \- | \- | X | \- |
| **system.swap.out\[<设备>,<类型>\]**<br>*(仅Linux系统支持指定设备参数)* | < | \- | X | X | \- | X | \- | \- | \- | \- | X | \- |
| *类型* ▲<br>*(页面仅在未指定设备时生效)* | 计数 *(默认除Linux外均适用)* | \- | X | X | \- | X | \- | \- | \- | \- | X | \- |
| ^ | 扇区 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 页面 *(Linux下默认)* | \- | X | X | \- | X | \- | \- | \- | \- | X | \- |
| **system.swap.size\[<设备>,<类型>\]**<br>*(仅在FreeBSD下支持指定设备，其他平台必须为空或"all")* | < | X | X | X | X | X | \- | X | X | \- | X | \- |
| *类型* ▲ | 免费 *(默认)* | X | X | X | X | X | \- | X | X | \- | X | \- |
| ^ | 总计 | X | X | X | X | X | \- | X | X | \- | X | \- |
| ^ | 已使用 | X | X | X | X | X | \- | X | X | \- | X | \- |
| ^ | pfree | X | X | X | X | X | \- | X | X | \- | X | \- |
| ^ | 已暂停 | X ^**[6](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | X | X | \- | X | X | \- | X | \- |
| **system.uname** | < | X | X | X | X | X | X | X | X | X | X | X |
| **system.uptime** | < | X | X | X | X | X | \- | X | ? | X | X | X |
| **system.users.num** | < | \- | X | X | X | X | X | X | X | X | X | X |
| **systemd.unit.discovery** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **systemd.unit.get** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **systemd.unit.info** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| < | < | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
| **vfs.dev.discovery** | < | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| **vfs.dev.read\[<设备>,<类型>,<模式>\]** | < | \- | X | X | X | X | \- | X | \- | \- | X | \- |
| *类型* ▲ | 扇区 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 操作 *(OpenBSD、AIX默认)* | \- | X | X | X | X | \- | X | \- | \- | X | \- |
| ^ | 字节 *(Solaris默认)* | \- | \- | \- | X | X | \- | X | \- | \- | X | \- |
| ^ | sps *(Linux默认值)* | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 运维 | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| ^ | bps *(FreeBSD默认单位)* | \- | \- | \- | X | \- | \- | \- | \- | \- | \- | \- |
| *模式* ▲<br>*(仅兼容类型：<br>sps, ops, bps)* | avg1 *(默认)* | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| ^ | avg5 | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| ^ | avg15 | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| **vfs.dev.write\[<设备>,<类型>,<模式>\]** | < | \- | X | X | X | X | \- | X | \- | \- | X | \- |
| *类型* ▲ | 扇区 | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 操作 *(OpenBSD、AIX默认)* | \- | X | X | X | X | \- | X | \- | \- | X | \- |
| ^ | 字节 *(Solaris默认)* | \- | \- | \- | X | X | \- | X | \- | \- | X | \- |
| ^ | sps *(Linux默认)* | \- | X | X | \- | \- | \- | \- | \- | \- | \- | \- |
| ^ | 运维 | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| ^ | bps *(FreeBSD默认单位)* | \- | \- | \- | X | \- | \- | \- | \- | \- | \- | \- |
| *模式* ▲<br>*(仅兼容类型为:<br>sps, ops, bps)* | avg1 *(默认)* | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| ^ | avg5 | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| ^ | avg15 | \- | X | X | X | \- | \- | \- | \- | \- | \- | \- |
| **vfs.dir.count\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.dir.get\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.dir.size[目录,<正则表达式_包含>,<正则表达式_排除>,<模式>,<最大深度>,<目录排除正则表达式>]** | < | X | X | X | ? | ? | ? | ? | ? | ? | ? | ? |
| **vfs.file.cksum[file,<mode>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.contents[file,<encoding>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.exists\[file,<types\_incl>,<types\_excl>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.get\[file\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.md5sum[file]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.owner[file,<ownertype>,<resulttype>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.permissions[file]** | < | \- | X | X | ? | ? | ? | ? | ? | ? | ? | ? |
| **vfs.file.regexp[file,regexp,<encoding>,<start line>,<end line>,<output>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.regmatch[file,regexp,<encoding>,<start line>,<end line>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **vfs.file.size[file,<mode>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| < | < | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
| **vfs.file.time[file,<mode>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| *模式* ▲ | 修改 *(默认)* | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 访问 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 变更 | X^**[5](/manual/appendix/items/supported_by_platform#脚注)**^ | X | X | X | X | X | X | X | X | X | X |
| **vfs.fs.discovery** | < | X | X | X | X | X | X | X | \- | X | X | X |
| **vfs.fs.get** | < | X | X | X | X | X | X | X | \- | X | X | X |
| **vfs.fs.inode\[fs,<模式>\]** | < | \- | X | X | X | X | X | X | X | X | X | X |
| *模式* ▲ | 总计 *(默认)* | \- | X | X | X | X | X | X | X | X | X | X |
| ^ | 空闲 | \- | X | X | X | X | X | X | X | X | X | X |
| ^ | 已使用 | \- | X | X | X | X | X | X | X | X | X | X |
| ^ | pfree | \- | X | X | X | X | X | X | X | X | X | X |
| ^ | 暂停 | \- | X | X | X | X | X | X | X | X | X | X |
| **vfs.fs.size[fs,<模式>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| *模式* ▲ | 总计 *(默认)* | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 空闲 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 已使用 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | pfree | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 暂停 | X | X | X | X | X | X | X | X | X | X | X |
| **vm.memory.size\[<模式>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| *模式* ▲ | 总计 *(默认)* | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 活动 | \- | \- | \- | X | \- | X | \- | \- | X | X | X |
| ^ | 匿名 | \- | \- | \- | \- | \- | \- | \- | \- | \- | \- | X |
| ^ | 缓冲区 | \- | X | X | X | \- | \- | \- | \- | \- | X | X |
| ^ | 缓存 | X | X | X | X | \- | \- | X | \- | \- | X | X |
| ^ | 执行 | \- | \- | \- | \- | \- | \- | \- | \- | \- | \- | X |
| ^ | file | \- | \- | \- | \- | \- | \- | \- | \- | \- | \- | X |
| ^ | 空闲 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 非活动 | \- | \- | \- | X | \- | \- | \- | \- | X | X | X |
| ^ | 置顶 | \- | \- | \- | \- | \- | \- | X | \- | \- | \- | \- |
| ^ | 共享 | \- | X | \- | X | \- | \- | \- | \- | \- | X | X |
| ^ | 有线 | \- | \- | \- | X | \- | \- | \- | \- | X | X | X |
| ^ | 已使用 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 暂停 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | 可用 | X | X | X | X | X | X | X | X | X | X | X |
| ^ | pavailable | X | X | X | X | X | X | X | X | X | X | X |
| **web.page.get\[主机,<路径>,<端口>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **web.page.perf\[主机,<路径>,<端口>\]** | < | X | X | X | X | X | X | X | X | X | X | X |
| **web.page.regexp[主机,<路径>,<端口>,正则表达式,<长度>,<输出>]** | < | X | X | X | X | X | X | X | X | X | X | X |
| < | < | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
::: notetip
另请参阅[vm.memory.size
parameters](vm.memory.size_params)的描述。
:::
# 1 Items supported by platform
The table displays support for Zabbix [agent
items](/manual/config/items/itemtypes/zabbix_agent) on various
platforms:
- Items marked with "**X**" are supported, the ones marked with
"**-**" are not supported.
- If an item is marked with "**?**", it is not known whether it is
supported or not.
- If an item is marked with "**r**", it means that it requires root
privileges.
- Parameters that are included in angle brackets
**<**like\_this**>** are optional.
::: noteclassic
[Windows-only](/manual/config/items/itemtypes/zabbix_agent/win_keys)
Zabbix agent items are not included in this table.
:::
| | | | | | | | | | | | | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|NetBSD|<|<|<|<|<|<|<|<|<|<|<|<|
|OpenBSD|<|<|<|<|<|<|<|<|<|<|<|▼▼|
|Mac OS X|<|<|<|<|<|<|<|<|<|<|▼▼|^|
|Tru64|<|<|<|<|<|<|<|<|<|▼▼|^|^|
|AIX|<|<|<|<|<|<|<|<|▼▼|^|^|^|
|HP-UX|<|<|<|<|<|<|<|▼▼|^|^|^|^|
|Solaris|<|<|<|<|<|<|▼▼|^|^|^|^|^|
|FreeBSD|<|<|<|<|<|▼▼|^|^|^|^|^|^|
|Linux 2.6 (and later)|<|<|<|<|▼▼|^|^|^|^|^|^|^|
|Linux 2.4|<|<|<|▼▼|^|^|^|^|^|^|^|^|
|Windows|<|<|▼▼|^|^|^|^|^|^|^|^|^|
|Parameter / system|<|▼▼|^|^|^|^|^|^|^|^|^|^|
|▼▼|<|1|2|3|4|5|6|7|8|9|10|11|
|**agent.hostmetadata**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.hostname**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.ping**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.variant**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.version**|<|X|X|X|X|X|X|X|X|X|X|X|
|**kernel.maxfiles**|<|\-|X|X|X|\-|\-|\-|?|X|X|X|
|**kernel.maxproc**|<|\-|\-|X|X|X|\-|\-|?|X|X|X|
|**kernel.openfiles**|<|\-|X|X|?|?|?|?|?|?|?|?|
|**log\[file,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**log.count\[file,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**logrt\[file\_regexp,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**logrt.count\[file\_regexp,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]**|<|X^**[4](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|*persistent\_dir* ▲|<|\-|X|X|X|X|X|X|X|X|X|X|
|**modbus.get\[endpoint,<slave id>,<function>,<address>,<count>,<type>,<endianness>,<offset>\]**|<|X|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.dns\[<ip>,zone,<type>,<timeout>,<count>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.dns.record\[<ip>,zone,<type>,<timeout>,<count>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.if.collisions\[if\]**|<|\-|X|X|X|X|\-|X|\-|X|X|r|
|**net.if.discovery**|<|X|X|X|X|X|X|X|\-|\-|X|X|
|**net.if.in\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|X|\-|X|\-|\-|X|X|r|
|^|overruns|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|frame|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|compressed|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|multicast|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.if.out\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|\-|\-|X|\-|\-|\-|\-|\-|
|^|overruns|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|collision|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|carrier|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|compressed|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.if.total\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|\-|\-|X|\-|\-|\-|\-|\-|
|^|overruns|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|compressed|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.tcp.listen\[port\]**|<|X|X|X|X|X|\-|\-|\-|X|\-|\-|
|**net.tcp.port\[<ip>,port\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.service\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.service.perf\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]**|<|X^**[7](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**net.udp.listen\[port\]**|<|\-|X|X|X|X|\-|\-|\-|X|\-|\-|
|**net.udp.service\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.udp.service.perf\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.udp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]**|<|X^**[7](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**proc.cpu.util\[<name>,<user>,<type>,<cmdline>,<mode>,<zone>\]**|<|\-|X|X|\-|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|\-|\-|\-|\-|\-|\-|
|*type* ▲|total *(default)*|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|user|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|system|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|*mode* ▲|avg1 *(default)*|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|*zone* ▲|current *(default)*|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|^|all|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|**proc.mem\[<name>,<user>,<mode>,<cmdline><memtype>\]**|<|\-|X|X|X|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|\-|X|X|\-|X|X|
|*mode* ▲|sum *(default)*|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|avg|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|max|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|min|\-|X|X|X|X|\-|X|X|\-|X|X|
|*memtype* ▲|<|\-|X|X|X|X|\-|X|\-|\-|\-|\-|
|**proc.num\[<name>,<user>,<state>,<cmdline>,<zone>\]**|<|X|X|X|X|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|\-|X|X|
|*state* ▲|all *(default)*|\-|X|X|X|X|X|X|X|\-|X|X|
|^|disk|\-|X|X|X|\-|\-|\-|\-|\-|X|X|
|^|sleep|\-|X|X|X|X|X|X|X|\-|X|X|
|^|zomb|\-|X|X|X|X|X|X|X|\-|X|X|
|^|run|\-|X|X|X|X|X|X|X|\-|X|X|
|^|trace|\-|X|X|X|\-|\-|\-|\-|\-|X|X|
|*cmdline* ▲|<|\-|X|X|X|X|X|X|X|\-|X|X|
|*zone* ▲|current *(default)*|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|^|all|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|**sensor\[device,sensor,<mode>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|X|\-|
|**system.boottime**|<|\-|X|X|X|X|\-|\-|\-|X|X|X|
|**system.cpu.discovery**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.cpu.intr**|<|\-|X|X|X|X|\-|X|\-|\-|X|X|
|**system.cpu.load\[<cpu>,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*cpu* ▲|all *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|percpu|X|X|X|X|X|X|X|\-|X|X|X|
|*mode* ▲|avg1 *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|avg5|X|X|X|X|X|X|X|X|X|X|X|
|^|avg15|X|X|X|X|X|X|X|X|X|X|X|
|**system.cpu.num\[<type>\]**|<|X|X|X|X|X|X|X|\-|X|X|X|
|*type* ▲|online *(default)*|X|X|X|X|X|X|X|\-|X|X|X|
|^|max|\-|X|X|X|X|\-|\-|\-|X|\-|\-|
|**system.cpu.switches**|<|\-|X|X|X|X|\-|X|\-|\-|X|X|
|**system.cpu.util\[<cpu>,<type>,<mode>,<logical\_or\_physical>\]**|<|X|X|X|X|X|X|X|X|\-|X|X|
|*type* ▲|user *(default)*|\-|X|X|X|X|X|X|X|\-|X|X|
|^|nice|\-|X|X|X|\-|X|\-|X|\-|X|X|
|^|idle|\-|X|X|X|X|X|X|X|\-|X|X|
|^|system *(default for Windows)*|X|X|X|X|X|X|X|X|\-|X|X|
|^|iowait|\-|\-|X|\-|X|\-|X|\-|\-|\-|\-|
|^|interrupt|\-|\-|X|X|\-|\-|\-|\-|\-|X|\-|
|^|softirq|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|steal|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|guest|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|guest\_nice|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲|avg1 *(default)*|X|X|X|X|X|X|X|X|\-|X|X|
|^|avg5|X|X|X|X|X|X|X|\-|\-|X|X|
|^|avg15|X|X|X|X|X|X|X|\-|\-|X|X|
|*logical\_or\_physical* ▲|logical *(default)*|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|^|physical|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**system.hostname\[<type>,<transform>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.hw.chassis\[<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.cpu\[<cpu>,<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.devices\[<type>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.macaddr\[<interface>,<format>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.localtime\[<type>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*type* ▲|utc *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|local|X|X|X|X|X|X|X|X|X|X|X|
|**system.run\[command,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|wait *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|nowait|X|X|X|X|X|X|X|X|X|X|X|
|**system.stat\[resource,<type>\]**|<|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|**system.sw.arch**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.sw.os\[<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.sw.packages\[<package>,<manager>,<format>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.swap.in\[<device>,<type>\]**<br>*(specifying a device is only supported under Linux)*|<|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|*type* ▲<br>*(pages will only work if<br>device was not specified)*|count *(default under all except Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|^|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|pages *(default under Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|**system.swap.out\[<device>,<type>\]**<br>*(specifying a device is only supported under Linux)*|<|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|*type* ▲<br>*(pages will only work if<br>device was not specified)*|count *(default under all except Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|^|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|pages *(default under Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|**system.swap.size\[<device>,<type>\]**<br>*(specifying a device is only supported under FreeBSD, for other platforms must be empty or "all")*|<|X|X|X|X|X|\-|X|X|\-|X|\-|
|*type* ▲|free *(default)*|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|total|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|used|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|pfree|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|pused|X ^**[6](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|\-|X|X|\-|X|\-|
|**system.uname**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.uptime**|<|X|X|X|X|X|\-|X|?|X|X|X|
|**system.users.num**|<|\-|X|X|X|X|X|X|X|X|X|X|
|**systemd.unit.discovery**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**systemd.unit.get**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**systemd.unit.info**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**vfs.dev.discovery**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**vfs.dev.read\[<device>,<type>,<mode>\]**|<|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|*type* ▲|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|operations *(default for OpenBSD, AIX)*|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|^|bytes *(default for Solaris)*|\-|\-|\-|X|X|\-|X|\-|\-|X|\-|
|^|sps *(default for Linux)*|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|ops|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|bps *(default for FreeBSD)*|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲<br>*(compatible only with<br>type in: sps, ops, bps)*|avg1 *(default)*|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|**vfs.dev.write\[<device>,<type>,<mode>\]**|<|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|*type* ▲|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|operations *(default for OpenBSD, AIX)*|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|^|bytes *(default for Solaris)*|\-|\-|\-|X|X|\-|X|\-|\-|X|\-|
|^|sps *(default for Linux)*|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|ops|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|bps *(default for FreeBSD)*|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲<br>*(compatible only with<br>type in: sps, ops, bps)*|avg1 *(default)*|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|**vfs.dir.count\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.dir.get\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.dir.size\[dir,<regex\_incl>,<regex\_excl>,<mode>,<max\_depth>,<regex\_excl\_dir>\]**|<|X|X|X|?|?|?|?|?|?|?|?|
|**vfs.file.cksum\[file,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.contents\[file,<encoding>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.exists\[file,<types\_incl>,<types\_excl>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.get\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.md5sum\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.owner\[file,<ownertype>,<resulttype>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.permissions\[file\]**|<|\-|X|X|?|?|?|?|?|?|?|?|
|**vfs.file.regexp\[file,regexp,<encoding>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.regmatch\[file,regexp,<encoding>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.size\[file,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**vfs.file.time\[file,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|modify *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|access|X|X|X|X|X|X|X|X|X|X|X|
|^|change|X^**[5](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|X|X|X|X|X|X|X|
|**vfs.fs.discovery**|<|X|X|X|X|X|X|X|\-|X|X|X|
|**vfs.fs.get**|<|X|X|X|X|X|X|X|\-|X|X|X|
|**vfs.fs.inode\[fs,<mode>\]**|<|\-|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|\-|X|X|X|X|X|X|X|X|X|X|
|^|free|\-|X|X|X|X|X|X|X|X|X|X|
|^|used|\-|X|X|X|X|X|X|X|X|X|X|
|^|pfree|\-|X|X|X|X|X|X|X|X|X|X|
|^|pused|\-|X|X|X|X|X|X|X|X|X|X|
|**vfs.fs.size\[fs,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|free|X|X|X|X|X|X|X|X|X|X|X|
|^|used|X|X|X|X|X|X|X|X|X|X|X|
|^|pfree|X|X|X|X|X|X|X|X|X|X|X|
|^|pused|X|X|X|X|X|X|X|X|X|X|X|
|**vm.memory.size\[<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|active|\-|\-|\-|X|\-|X|\-|\-|X|X|X|
|^|anon|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|buffers|\-|X|X|X|\-|\-|\-|\-|\-|X|X|
|^|cached|X|X|X|X|\-|\-|X|\-|\-|X|X|
|^|exec|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|file|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|free|X|X|X|X|X|X|X|X|X|X|X|
|^|inactive|\-|\-|\-|X|\-|\-|\-|\-|X|X|X|
|^|pinned|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|^|shared|\-|X|\-|X|\-|\-|\-|\-|\-|X|X|
|^|wired|\-|\-|\-|X|\-|\-|\-|\-|X|X|X|
|^|used|X|X|X|X|X|X|X|X|X|X|X|
|^|pused|X|X|X|X|X|X|X|X|X|X|X|
|^|available|X|X|X|X|X|X|X|X|X|X|X|
|^|pavailable|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.get\[host,<path>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.perf\[host,<path>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.regexp\[host,<path>,<port>,regexp,<length>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
::: notetip
See also a description of [vm.memory.size
parameters](vm.memory.size_params).
:::
# 1 不同平台支持的监控项
下表列出了不同平台支持的Zabbix agent监控项目:
- 标记为 "**X**" 的监控项代表支持, 标记为"**-**" 的监控项代表不支持.
- 如果监控项标记为 "**?**", 不确定是否被支持.
- 如果监控项标记为 "**r**", 代表该监控项需要 root 权限.
- 中括号 **<**like\_this**>**中的参数为可选项.
::: noteclassic
只支持Windows [Zabbix agent
items](/manual/config/items/itemtypes/zabbix_agent/win_keys)
不在该表中.
:::
| | | | | | | | | | | | | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|NetBSD|<|<|<|<|<|<|<|<|<|<|<|<|
|OpenBSD|<|<|<|<|<|<|<|<|<|<|<|▼▼|
|Mac OS X|<|<|<|<|<|<|<|<|<|<|▼▼|^|
|Tru64|<|<|<|<|<|<|<|<|<|▼▼|^|^|
|AIX|<|<|<|<|<|<|<|<|▼▼|^|^|^|
|HP-UX|<|<|<|<|<|<|<|▼▼|^|^|^|^|
|Solaris|<|<|<|<|<|<|▼▼|^|^|^|^|^|
|FreeBSD|<|<|<|<|<|▼▼|^|^|^|^|^|^|
|Linux 2.6 (and later)|<|<|<|<|▼▼|^|^|^|^|^|^|^|
|Linux 2.4|<|<|<|▼▼|^|^|^|^|^|^|^|^|
|Windows|<|<|▼▼|^|^|^|^|^|^|^|^|^|
|Parameter / system|<|▼▼|^|^|^|^|^|^|^|^|^|^|
|▼▼|<|1|2|3|4|5|6|7|8|9|10|11|
|**agent.hostname**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.ping**|<|X|X|X|X|X|X|X|X|X|X|X|
|**agent.version**|<|X|X|X|X|X|X|X|X|X|X|X|
|**kernel.maxfiles**|<|\-|X|X|X|\-|\-|\-|?|X|X|X|
|**kernel.maxproc**|<|\-|\-|X|X|X|\-|\-|?|X|X|X|
|**log\[file,<regexp>,<encoding>,<maxlines>,<mode>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**logrt\[file\_format,<regexp>,<encoding>,<maxlines>,<mode>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.dns\[<ip>,zone,<type>,<timeout>,<count>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.dns.record\[<ip>,zone,<type>,<timeout>,<count>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.if.collisions\[if\]**|<|\-|X|X|X|X|\-|X|\-|X|X|r|
|**net.if.discovery**|<|X|X|X|X|X|X|X|\-|\-|X|X|
|**net.if.in\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|X|\-|X|\-|\-|X|X|r|
|**net.if.out\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|\-|\-|X|\-|\-|\-|\-|\-|
|**net.if.total\[if,<mode>\]**|<|X|X|X|X|X|X ^**[1](/manual/appendix/items/supported_by_platform#footnotes)**^|X|\-|X|X|r|
|*mode* ▲|bytes *(default)*|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|packets|X|X|X|X|X|X|X|\-|X|X|r|
|^|errors|X|X|X|X|X ^**[2](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|\-|X|X|r|
|^|dropped|X|X|X|\-|\-|X|\-|\-|\-|\-|\-|
|**net.tcp.listen\[port\]**|<|X|X|X|X|X|\-|\-|\-|X|\-|\-|
|**net.tcp.port\[<ip>,port\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.service\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.tcp.service.perf\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.udp.listen\[port\]**|<|\-|X|X|X|X|\-|\-|\-|X|\-|\-|
|**net.udp.service\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**net.udp.service.perf\[service,<ip>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**proc.cpu.util\[<name>,<user>,<type>,<cmdline>,<mode>,<zone>\]**|<|\-|X|X|\-|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|\-|\-|\-|\-|\-|\-|
|*type* ▲|total *(default)*|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|user|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|system|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|*mode* ▲|avg1 *(default)*|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|\-|X|\-|\-|\-|\-|\-|\-|
|*zone* ▲|current *(default)*|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|^|all|\-|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|
|**proc.mem\[<name>,<user>,<mode>,<cmdline><memtype>\]**|<|\-|X|X|X|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|\-|X|X|\-|X|X|
|*mode* ▲|sum *(default)*|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|avg|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|max|\-|X|X|X|X|\-|X|X|\-|X|X|
|^|min|\-|X|X|X|X|\-|X|X|\-|X|X|
|*memtype* ▲|<|\-|X|X|X|X|\-|X|\-|\-|\-|\-|
|**proc.num\[<name>,<user>,<state>,<cmdline>\]**|<|X|X|X|X|X ^**[3](/manual/appendix/items/supported_by_platform#footnotes)**^|X|X|X|\-|X|X|
|*state* ▲|all *(default)*|\-|X|X|X|X|X|X|X|\-|X|X|
|^|sleep|\-|X|X|X|X|X|X|X|\-|X|X|
|^|zomb|\-|X|X|X|X|X|X|X|\-|X|X|
|^|run|\-|X|X|X|X|X|X|X|\-|X|X|
|*cmdline* ▲|<|\-|X|X|X|X|X|X|X|\-|X|X|
|**sensor\[device,sensor,<mode>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|X|\-|
|**system.boottime**|<|\-|X|X|X|X|\-|\-|\-|X|X|X|
|**system.cpu.discovery**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.cpu.intr**|<|\-|X|X|X|X|\-|X|\-|\-|X|X|
|**system.cpu.load\[<cpu>,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*cpu* ▲|all *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|percpu|X|X|X|X|X|X|X|\-|X|X|X|
|*mode* ▲|avg1 *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|avg5|X|X|X|X|X|X|X|X|X|X|X|
|^|avg15|X|X|X|X|X|X|X|X|X|X|X|
|**system.cpu.num\[<type>\]**|<|X|X|X|X|X|X|X|\-|X|X|X|
|*type* ▲|online *(default)*|X|X|X|X|X|X|X|\-|X|X|X|
|^|max|\-|X|X|X|X|\-|\-|\-|X|\-|\-|
|**system.cpu.switches**|<|\-|X|X|X|X|\-|X|\-|\-|X|X|
|**system.cpu.util\[<cpu>,<type>,<mode>\]**|<|X|X|X|X|X|X|X|X|\-|X|X|
|*type* ▲|user *(default)*|\-|X|X|X|X|X|X|X|\-|X|X|
|^|nice|\-|X|X|X|\-|X|\-|X|\-|X|X|
|^|idle|\-|X|X|X|X|X|X|X|\-|X|X|
|^|system|X|X|X|X|X|X|X|X|\-|X|X|
|^|iowait|\-|\-|X|\-|X|\-|X|\-|\-|\-|\-|
|^|interrupt|\-|\-|X|X|\-|\-|\-|\-|\-|X|\-|
|^|softirq|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|steal|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|guest|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|guest\_nice|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲|avg1 *(default)*|X|X|X|X|X|X|X|X|\-|X|X|
|^|avg5|X|X|X|X|X|X|X|\-|\-|X|X|
|^|avg15|X|X|X|X|X|X|X|\-|\-|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**system.hostname\[<type>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.hw.chassis\[<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.cpu\[<cpu>,<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.devices\[<type>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.hw.macaddr\[<interface>,<format>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.localtime\[<type>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*type* ▲|utc *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|local|X|X|X|X|X|X|X|X|X|X|X|
|**system.run\[command,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|wait *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|nowait|X|X|X|X|X|X|X|X|X|X|X|
|**system.stat\[resource,<type>\]**|<|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|**system.sw.arch**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.sw.os\[<info>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.sw.packages\[<package>,<manager>,<format>\]**|<|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|**system.swap.in\[<device>,<type>\]**<br>*(specifying a device is only supported under Linux)*|<|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|*type* ▲<br>*(pages will only work if<br>device was not specified)*|count *(default under all except Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|^|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|pages *(default under Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|**system.swap.out\[<device>,<type>\]**<br>*(specifying a device is only supported under Linux)*|<|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|*type* ▲<br>*(pages will only work if<br>device was not specified)*|count *(default under all except Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|^|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|pages *(default under Linux)*|\-|X|X|\-|X|\-|\-|\-|\-|X|\-|
|**system.swap.size\[<device>,<type>\]**<br>*(specifying a device is only supported under FreeBSD, for other platforms must be empty or "all")*|<|X|X|X|X|X|\-|X|X|\-|X|\-|
|*type* ▲|free *(default)*|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|total|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|used|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|pfree|X|X|X|X|X|\-|X|X|\-|X|\-|
|^|pused|\-|X|X|X|X|\-|X|X|\-|X|\-|
|**system.uname**|<|X|X|X|X|X|X|X|X|X|X|X|
|**system.uptime**|<|X|X|X|X|X|\-|X|?|X|X|X|
|**system.users.num**|<|\-|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**vfs.dev.read\[<device>,<type>,<mode>\]**|<|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|*type* ▲<br><br>*(defaults are different<br>under various OSes)*|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|operations|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|^|bytes|\-|\-|\-|X|X|\-|X|\-|\-|X|\-|
|^|sps|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|ops|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|bps|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲<br>*(compatible only with<br>type in: sps, ops, bps)*|avg1 *(default)*|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|**vfs.dev.write\[<device>,<type>,<mode>\]**|<|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|*type* ▲<br><br>*(defaults are different<br>under various OSes)*|sectors|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|operations|\-|X|X|X|X|\-|X|\-|\-|X|\-|
|^|bytes|\-|\-|\-|X|X|\-|X|\-|\-|X|\-|
|^|sps|\-|X|X|\-|\-|\-|\-|\-|\-|\-|\-|
|^|ops|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|bps|\-|\-|\-|X|\-|\-|\-|\-|\-|\-|\-|
|*mode* ▲<br>*(compatible only with<br>type in: sps, ops, bps)*|avg1 *(default)*|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg5|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|^|avg15|\-|X|X|X|\-|\-|\-|\-|\-|\-|\-|
|**vfs.file.cksum\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.contents\[file,<encoding>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.exists\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.md5sum\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.regexp\[file,regexp,<encoding>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.regmatch\[file,regexp,<encoding>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.file.size\[file\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
|**vfs.file.time\[file,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|modify *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|access|X|X|X|X|X|X|X|X|X|X|X|
|^|change|X|X|X|X|X|X|X|X|X|X|X|
|**vfs.fs.discovery**|<|X|X|X|X|X|X|X|\-|X|X|X|
|**vfs.fs.inode\[fs,<mode>\]**|<|\-|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|\-|X|X|X|X|X|X|X|X|X|X|
|^|free|\-|X|X|X|X|X|X|X|X|X|X|
|^|used|\-|X|X|X|X|X|X|X|X|X|X|
|^|pfree|\-|X|X|X|X|X|X|X|X|X|X|
|^|pused|\-|X|X|X|X|X|X|X|X|X|X|
|**vfs.fs.size\[fs,<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|free|X|X|X|X|X|X|X|X|X|X|X|
|^|used|X|X|X|X|X|X|X|X|X|X|X|
|^|pfree|X|X|X|X|X|X|X|X|X|X|X|
|^|pused|X|X|X|X|X|X|X|X|X|X|X|
|**vm.memory.size\[<mode>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|*mode* ▲|total *(default)*|X|X|X|X|X|X|X|X|X|X|X|
|^|active|\-|\-|\-|X|\-|X|\-|\-|X|X|X|
|^|anon|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|buffers|\-|X|X|X|\-|\-|\-|\-|\-|X|X|
|^|cached|X|X|X|X|\-|\-|X|\-|\-|X|X|
|^|exec|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|file|\-|\-|\-|\-|\-|\-|\-|\-|\-|\-|X|
|^|free|X|X|X|X|X|X|X|X|X|X|X|
|^|inactive|\-|\-|\-|X|\-|\-|\-|\-|X|X|X|
|^|pinned|\-|\-|\-|\-|\-|\-|X|\-|\-|\-|\-|
|^|shared|\-|X|\-|X|\-|\-|\-|\-|\-|X|X|
|^|wired|\-|\-|\-|X|\-|\-|\-|\-|X|X|X|
|^|used|X|X|X|X|X|X|X|X|X|X|X|
|^|pused|X|X|X|X|X|X|X|X|X|X|X|
|^|available|X|X|X|X|X|X|X|X|X|X|X|
|^|pavailable|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.get\[host,<path>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.perf\[host,<path>,<port>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|**web.page.regexp\[host,<path>,<port>,<regexp>,<length>,<output>\]**|<|X|X|X|X|X|X|X|X|X|X|X|
|<|<|1|2|3|4|5|6|7|8|9|10|11|
<note
tip>另请参见[vm.memory.size参数](vm.memory.size_params)说明.
:::
# 1 Login and configuring user
# 1 登录与用户配置
# 1 Macro functions
# 1 宏函数
# 1 Manual structure
# 1 手动结构
# 1 Media types
# 1 媒介类型
# 1 Menu
# 1 菜单
# 1 Monitoring
# 1 监控
# 1 MySQL encryption configuration
[comment]: # (tags: ssl)
# 1 MySQL 加密配置
[comment]: # (标签: ssl)
# 1 Network discovery
# 1 网络发现
# 1 Overview
# 1 概览
# 1 Proxies
# 1 Proxies
# 1 Recommended UnixODBC settings for MySQL
# 1 针对 MySQL 的推荐 UnixODBC 设置
# 1 Red Hat Enterprise Linux
# 1 Red Hat 企业版 Linux/CentOS
# 1 Red Hat Enterprise Linux
# 1 红帽企业版 Linux
# 1 Red Hat Enterprise Linux
# 1 红帽企业版 Linux
# 1 Red Hat Enterprise Linux/CentOS
# 1 Red Hat 企业版 Linux/CentOS
# 1 Sending message
# 1 发送消息
# 1 Server
# 1 Server
# 1 Server-proxy data exchange protocol
# 1 服务器-proxy 数据交换协议
# 1 Services
# 1 服务
# 1 Services
# 1 服务
# 1 Service tree
Service tree is configured in the *Services->Services* menu section. In the upper right corner, switch from [View](/manual/web_interface/frontend_sections/services/service) to the Edit mode.
{width=600}
To [configure](#service_configuration) a new service, click on the
*Create service* button in the top right-hand corner.
To quickly add a child service, you can alternatively press a plus icon next to the parent service. This will open the same service configuration form, but the Parent services parameter will be pre-filled.
# 1 服务树
服务树配置位于*服务->服务*菜单部分。在右上角，从[View](/manual/web_interface/frontend_sections/services/service)切换到编辑模式。
{width=600}
要[配置](#service_configuration)新服务，点击Top右上角的*创建服务*按钮。
要快速添加子服务，您也可以点击父服务旁的加号图标。这将打开相同的服务配置表单，但父服务参数将自动预填。
# 1 Simple graphs
# 1 简单图表
##### 1 Stop agent
Stop Zabbix agent.
##### 1 停止agent
停止 Zabbix agent.
##### 1 Stop proxy
Stop Zabbix proxy.
##### 1 停止 proxy
停止 Zabbix proxy.
##### 1 Stop server
Stop Zabbix server to make sure that no new data is inserted into
database.
##### 1 停止服务器
停止 Zabbix server 以确保没有新数据插入数据库.
##### 1 Stop Zabbix processes
Stop Zabbix server to make sure that no new data is inserted into
database.
# systemctl stop zabbix-server
If upgrading the proxy, stop proxy too.
# systemctl stop zabbix-proxy
::: noteimportant
It is no longer possible to start the upgraded
server and have older, yet unupgraded proxies report data to a newer
server. This approach, which was never recommended nor supported by
Zabbix, now is officially disabled, as the server will ignore data from
unupgraded proxies.
:::
##### 1 停止 Zabbix 进程
先停止 Zabbix server以确保没有新数据插入数据库中。
# systemctl stop zabbix-server
若升级Zabbix proxy版本，需也停止Zabbix proxy服务 。
# systemctl stop zabbix-proxy
::: 重要事项
目前，不再支持启动升级后的server，使用较旧版本且未升级的proxy向其发送数据。考虑到升级后的server会自动忽略未升级proxy发送的数据，因此Zabbix官方禁用此种应用方式。
##### 1 Stop Zabbix processes
Stop Zabbix server to make sure that no new data is inserted into
database.
# systemctl stop zabbix-server
If upgrading the proxy, stop proxy too.
# systemctl stop zabbix-proxy
::: noteimportant
It is no longer possible to start the upgraded
server and have older, yet unupgraded proxies report data to a newer
server. This approach, which was never recommended nor supported by
Zabbix, now is officially disabled, as the server will ignore data from
unupgraded proxies.
:::
##### 1 停止 Zabbix 进程
先停止 Zabbix server以确保没有新数据插入数据库中。
# systemctl stop zabbix-server
若升级Zabbix proxy版本，需也停止Zabbix proxy服务 。
# systemctl stop zabbix-proxy
::: 重要事项
目前，不再支持启动升级后的server，使用较旧版本且未升级的proxy向其发送数据。考虑到升级后的server会自动忽略未升级proxy发送的数据，因此Zabbix官方禁用此种应用方式。
##### 1 Stop Zabbix processes
Stop Zabbix server to make sure that no new data is inserted into
database.
systemctl stop zabbix-server
If upgrading Zabbix proxy, agent, or agent 2, stop these components too:
systemctl stop zabbix-proxy
systemctl stop zabbix-agent
systemctl stop zabbix-agent2
##### 1 停止Zabbix进程
停止 Zabbix server 以确保没有新数据插入数据库.
systemctl stop zabbix-server
如果升级 Zabbix proxy, agent, 或 agent 2, 也停止这些组件:
systemctl stop zabbix-proxy
systemctl stop zabbix-agent
systemctl stop zabbix-agent2
##### 1 Stop Zabbix processes
Stop Zabbix server to make sure that no new data is inserted into
database.
systemctl stop zabbix-server
If upgrading Zabbix proxy, agent, or agent 2, stop these components too:
systemctl stop zabbix-proxy
systemctl stop zabbix-agent
systemctl stop zabbix-agent2
::: noteimportant
It is no longer possible to start the upgraded
server and have older and unupgraded proxies report data to a newer
server. This approach, which was never recommended nor supported by
Zabbix, now is officially disabled, as the server will ignore data from
unupgraded proxies.
:::
##### 1 停止Zabbix进程
停止 Zabbix server 以确保没有新数据插入数据库.
systemctl stop zabbix-server
如果升级 Zabbix proxy, agent, 或 agent 2, 也请停止这些组件:
systemctl stop zabbix-proxy
systemctl stop zabbix-agent
systemctl stop zabbix-agent2
::: noteimportant
升级后的服务器将无法再接收未升级的 proxies 上报的数据. 这种从未被Zabbix推荐或支持的方式现在已被正式禁用, 因为服务器会忽略来自未升级 proxies 的数据.
:::
# 1 Supported macros
# 1 支持的宏
# 1 Supported macros
#### 概述
下表包含Zabbix原生支持宏的完整列表。
::: notetip
要查看某个功能所支持的所有宏(例如，想要知道"map URL"功能中支持的所有宏)，你可以在浏览器的搜索框中输入这个功能的名称（用快捷键CTRL+F调出搜索框），然后点击“下一个”
:::
|宏名称|支持该宏的功能|具体描述|
|-----|------------|-----------|
|{ACTION.ID}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知|*触发动作的数字ID*|
|{ACTION.NAME}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知|*触发动作的名字*|
|{ALERT.MESSAGE}|→ 告警脚本参数|*配置“动作”时用到的“默认消息”*<br>从3.0.0版本开始支持|
|{ALERT.SENDTO}|→ 告警脚本参数|*'配置“媒体”时用到的“发送至”*<br>从3.0.0版本开始支持|
|{ALERT.SUBJECT}|→ 告警脚本参数|*配置“动作”时用到的“默认主题”*<br>从3.0.0版本开始支持|
|{DATE}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*日期格式为yyyy.mm.dd*|
|{DISCOVERY.DEVICE.IPADDRESS}|→ 自动发现的通知和命令|*被发现的设备的IP地址*<br>永久有效，不依赖于是否添加了设备|
|{DISCOVERY.DEVICE.DNS}|→ 自动发现的通知和命令|*被发现的设备的DNS名称*<br>永久有效，不依赖于是否添加了设备|
|{DISCOVERY.DEVICE.STATUS}|→ 自动发现的通知和命令|*被发现设备的状态*: 可能是 UP 或者 DOWN.|
|{DISCOVERY.DEVICE.UPTIME}|→ 自动发现的通知和命令|*某设备最近一次被监控到状态改变的时间。*, 精确到秒<br>例如： 1h 29m 01s.<br>对于状态是DOWN的设备来说，这就是他们变成关机状态的时间长度|
|{DISCOVERY.RULE.NAME}|→ 自动发现的通知和命令|*用于发现设备或服务是否在线的自动发现规则的名称*|
|{DISCOVERY.SERVICE.NAME}|→ 自动发现的通知和命令|*自动发现的服务的名称*<br>例如： HTTP.|
|{DISCOVERY.SERVICE.PORT}|→ 自动发现的通知和命令|*自动发现的服务的端口*<br>例如： 80.|
|{DISCOVERY.SERVICE.STATUS}|→ 自动发现的通知和命令|*自动发现的 <服务://> 状态，可能是UP 或者 DOWN \| \|{DISCOVERY.SERVICE.UPTIME} \|→ 自动发现的通知和命令 \|*该服务自动发现状态最近改变的时间*, 精确到秒<br>例如： 1h 29m 01s.<br>对于状态是DOWN的服务，是该服务不可用的时间\| \|{ESC.HISTORY} \|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 内部通知 \|*升级history.Log 过去发送的消息。*<br>显示之前发送过的通知，通知是基于什么升级步骤发送的，以及他们的状态 (*已发送, *进行中* or *失败*).|
|{EVENT.ACK.STATUS}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*事件确认发状态(是/否)*.|
|{EVENT.AGE}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*触发动作的事件的时长*, 精确到秒<br>在升级消息时有用|
|{EVENT.DATE}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*触发动作的事件的日期*|
|{EVENT.DURATION}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*事件持续时间（发生问题和恢复事件之间的时差）*, 精确到秒<br>在问题恢复信息中有用<br><br>从 5.0.0版本开始支持|
|{EVENT.ID}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 触发器 URLs<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*触发动作的事件的数字ID*|
|{EVENT.NAME}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*触发动作的问题事件名称*<br>从4.0.0版本开始支持|
|{EVENT.NSEVERITY}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*描述事件严重性的数值* 包括: 0 - 未分级, 1 - 信息, 2 - 警告, 3 - 普通, 4 - 高, 5 - 灾难.<br>从4.0.0版本开始支持|
|{EVENT.OBJECT}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*描述事件对象的数值* 包括：0 - 触发器, 1 - 自动发现的主机, 2 - 自动发现的服务, 3 - 低级自动发现规则, 4 - Item, 5 - 低级自动发现规则.<br>从4.4.0版本开始支持|
|{EVENT.OPDATA}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*问题对应触发器的当前值*<br>从4.4.0版本开始支持 |
|{EVENT.RECOVERY.DATE}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*事件恢复日期*|
|{EVENT.RECOVERY.ID}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*恢复事件的数字ID*|
|{EVENT.RECOVERY.NAME}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*恢复时间名称*<br>从4.4.1版本开始支持|
|{EVENT.RECOVERY.STATUS}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*恢复事件的文字描述*|
|{EVENT.RECOVERY.TAGS}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*用逗号分隔的恢复事件标签* 如果没有标签的，就是一个空字符<br>从3.2.0版本开始支持|
|{EVENT.RECOVERY.TAGSJSON}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*一个包括事件标签[对象](/manual/api/reference/event/object#event_tag)的JSON数组.* 如果没有标签的，就是一个空数组<br>从5.0.0版本开始支持|
|{EVENT.RECOVERY.TIME}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*恢复时间的时间.*|
|{EVENT.RECOVERY.VALUE}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令 (如果恢复了)<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (如果恢复了)|*恢复时间的数值*|
|{EVENT.SEVERITY}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*时间严重性等级的名称*<br>从4.0.0版本开始支持|
|{EVENT.SOURCE}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*事件来源的数字描述* 包括：0 - 触发器, 1 - 自动发现, 2 - 自动注册, 3 - 内部.<br>从4.0.0版本开始支持|
|{EVENT.STATUS}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*出发动作的事件的文字描述*|
|{EVENT.TAGS}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*一组逗号分割单时间标签.* 如果没有标签的，就是一个空字符<br>从3.2.0版本开始支持|
|{EVENT.TAGSJSON}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*一个包括事件标签[对象](/manual/api/reference/event/object#event_tag)的JSON数组.* 如果没有标签的，就是一个空数组<br>从5.0.0版本开始支持|
|{EVENT.TAGS.<标签名称>}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ Wehook媒介URL名称和URL<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*用标签名称来引用的事件标签值.*<br>如果标签名称包含非字母数字的字符（包括非英语多字节UTF字符）需用双引号括起来。标签名称中引号括起来的引号和反斜杠必须用反斜杠转义。<br>从4.4.2版本开始支持|
|{EVENT.TIME}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 自动发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|* 触发动作的事件时间*|
|{EVENT.UPDATE.ACTION}|→ 问题更新的通知和命令|[问题更新](/manual/acknowledges#updating_problems)期间执行的*可读的动作名称* .<br>包括这些值: *已确认*, *已注释*, *严重级别从 (原始严重级别) 变化为 (更新严重级别)* 和 *已关闭* (取决于一次更新了多少个动作).<br>从4.0.0版本开始支持|
|{EVENT.UPDATE.DATE}|→ 问题更新的通知和命令<br>→ 服务更新的通知和命令|*事件[更新](/manual/config/notifications/action/update_operations) 的日期(例如：确认，等等).*<br>过去使用 {ACK.DATE}，当前版本已弃用|
|{EVENT.UPDATE.HISTORY}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*问题更新(例如：确认，等等)的日志*<br>过去使用 {EVENT.ACK.HISTORY}，当前版本已弃用|
|{EVENT.UPDATE.MESSAGE}|→ 问题更新的通知和命令|*问题更新的消息。*<br>过去使用 {ACK.MESSAGE}，当前版本已弃用|
|{EVENT.UPDATE.STATUS}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*问题更新状态的数值。* 包括： 0 - 因为问题/恢复事件触发了Webhook, 1 - 更新操作<br>从4.4.0版本开始支持|
|{EVENT.UPDATE.TIME}|→ 问题更新的通知和命令<br>→ 服务更新的通知和命令|*事件[更新](/manual/config/notifications/action/update_operations) (例如：确认，等等)的时间*<br>过去使用 {ACK.TIME}，当前版本已弃用|
|{EVENT.VALUE}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 基于服务的通知和命令<br>→ 服务更新的通知和命令<br>→ 服务恢复通知和命令<br>→ 内部通知<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*触发动作的事件的数值 (1 表示问题, 0 表示恢复)。*|
|{FUNCTION.VALUE<1-9>}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)<br>→ 时间名称|*在发生事件的时刻，触发器表达式中，基于监控项的第N个函数的值*<br>只包括以*/host/key* 开始的函数. 具体参见 [宏索引](supported_by_location#indexed_macros)|
|{FUNCTION.RECOVERY.VALUE<1-9>}|→ 问题[恢复通知](/manual/config/notifications/action/recovery_operations) 和命令<br>→ 问题更新的通知和命令<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*在发生事件的时刻，恢复表达式中，基于监控项的第N个函数的值*<br>只包括以*/host/key* 开始的函数. 具体参见 [宏索引](supported_by_location#indexed_macros).|
|{HOST.CONN}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 内部通知<br>→ 地图元素标签，地图URL名称和值<br>→ 监控项键值参数^[1](supported_by_location#footnotes)^<br>→ 主机界面IP/DNS<br>→ Trapper 监控项 "主机范围" 字段<br>→ 数据库监控附加参数<br>→ SSH和Telnet脚本<br>→ JMX监控项端点字段<br>→ Web监控^[4](supported_by_location#footnotes)^<br>→ 低级自动发现规则过滤正则表达式<br>→ 仪表盘小部件动态URL的URL字段<br>→ 触发器名称, 时间名称, 当前操作数据和描述<br>→ 触发器URL<br>→ [标签名称和赋值](/manual/config/tagging#macro_support)<br>→ 脚本类型监控项，监控项原型和自动发现规则参数名称和赋值<br>→ HTTP agent类型监控项，监控项原型和自动发现规则字段:<br>URL, 查询字段, 请求体, 请求头, 代理, SSL证书文件, SSL key文件, 主机白名单.<br>→ 手动主机动作 [脚本](/manual/web_interface/frontend_sections/administration/scripts) （包括确认文本）<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) （包括确认文本）|*依赖于主机设置的主机IP地址或DNS名称*^[2](supported_by_location#footnotes)^.<br><br>在触发器表达式中，可以用数字索引，来指向第一个，第二个，第三个主机，等等。例如：{HOST.CONN[<1-9>](supported_by_location#indexed_macros)} 详见 [索引宏](supported_by_location#indexed_macros).|
|{HOST.DESCRIPTION}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 内部通知<br>→ 地图元素标签<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*主机描述.*<br><br>在触发器表达式中，该宏可用配合数字索引使用，来指向第一个，第二个，第三个主机，等等。例如： {HOST.DESCRIPTION[<1-9>](supported_by_location#indexed_macros)} 详见[索引宏](supported_by_location#indexed_macros).|
|{HOST.DNS}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 内部通知<br>→ 地图元素标签，地图URL名称和值<br>→ 监控项键值参数^[1](supported_by_location#footnotes)^<br>→ 主机界面IP/DNS<br>→ Trapper 监控项 "主机范围" 字段<br>→ 数据库监控附加参数<br>→ SSH和Telnet脚本<br>→ JMX监控项端点字段<br>→ Web监控^[4](supported_by_location#footnotes)^<br>→ 低级自动发现规则过滤正则表达式<br>→ 仪表盘小部件中，动态 URL的URL字段 <br>→ 触发器名称, 时间名称, 当前操作数据和描述<br>→ 触发器 URLs<br>→ [标签名称和赋值](/manual/config/tagging#macro_support)<br>→ 脚本类型监控项，监控项原型和自动发现规则参数名称和赋值<br>→ HTTP agent类型监控项，监控项原型和自动发现规则字段:<br>URL, 查询字段, 请求体, 请求头, 代理, SSL证书文件, SSL key文件, 主机白名单.<br>→ 手动主机动作 [脚本](/manual/web_interface/frontend_sections/administration/scripts) （包括确认文本）<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) （包括确认文本）|*主机DNS名称*^[2](supported_by_location#footnotes)^.<br><br>T在触发器表达式中，该宏可用配合数字索引使用，来指向第一个，第二个，第三个主机，等等。例如：{HOST.DNS[<1-9>](supported_by_location#indexed_macros)} 详见 [索引宏](supported_by_location#indexed_macros).|
|{HOST.HOST}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 监控项键值参数<br>→ 地图元素标签，地图URL名称和值<br>→ 主机界面IP/DNS<br>→ Trapper 监控项 "主机范围" 字段<br>→ 数据库监控附加参数<br>→ SSH和Telnet脚本<br>→ JMX监控项端点字段<br>→ Web监控^[4](supported_by_location#footnotes)^<br>→ 低级自动发现规则过滤正则表达式<br>→ 仪表盘小部件动态URL的URL字段<br>→ 触发器名称, 时间名称, 当前操作数据和描述<br>→ 触发器 URLs<br>→ [标签名称和赋值](/manual/config/tagging#macro_support)<br>→ 脚本类型监控项，监控项原型和自动发现规则参数名称和赋值<br>→ HTTP agent类型监控项，监控项原型和自动发现规则字段:<br>URL, 查询字段, 请求体, 请求头, 代理, SSL证书文件, SSL key文件, 主机白名单.<br>→ 手动主机动作 [脚本](/manual/web_interface/frontend_sections/administration/scripts) （包括确认文本）<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts) （包括确认文本）|*主机名称*<br>在触发器表达式中，可以用数字索引，来指向第一个，第二个，第三个主机，等等。例如： {HOST.HOST[<1-9>](supported_by_location#indexed_macros)} 详见 [索引宏](supported_by_location#indexed_macros).<br><br> 过去使用 `{HOSTNAME<1-9>}`，当前版本已弃用|
|{HOST.ID}|→ 基于触发器的通知和命令<br>→ 问题更新的通知和命令<br>→ 内部通知<br>→ 地图元素标签，地图URL名称和值<br>→ 仪表盘小部件动态URL的URL字段<br>→ 触发器URL<br>→ [标签名称和赋值](/manual/config/tagging#macro_support)<br>→ 手动动作[脚本](/manual/web_interface/frontend_sections/administration/scripts)|*主机 ID.*<br><br>在触发器表达式中，可以用数字索引，来指向第一个，第二个，第三个主机，等等。例如：{HOST.ID[<1-9>](supported_by_location#indexed_macros)} 详见[索引宏](supported_by_location#indexed_macros).|
|{HOST.IP}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 自动注册通知和命令<br>→ 内部通知<br>→ 映射元素标签，映射URL名称和值<br>→ 监控项关键参数^[1](supported_by_location#脚注)^<br>→ 主机接口IP/DNS<br>→ 触发器监控项 "允许的主机" 字段<br>→ 数据库监控附加字段<br>→ SSH和Telnet脚本<br>→ JMX项目终结点字段<br>→ Web监控^[4](supported_by_location#脚注)^<br>→ 低级别自动发现过滤正则表达式<br>→ 动态URL仪表盘组件的URL字段<br>→ 触发器名称，事件名称，操作型数据和描述<br>→ 触发器URL<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 脚本类型监控项，监控项原型和发现规则参数名称和值<br>→ HTTP代理类型监控项，监控项原型和发现规则字段：<br>URL，查询字段，请求正文，报头，代理，SSL证书文件，SSL密钥文件，允许的主机。.<br>→ 自定义主机操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)|*主机IP地址*^[2](supported_by_location#脚注)^.<br><br>这个宏可以和一个数字索引一起使用，例如： {HOST.IP[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{IPADDRESS<1-9>}` 已弃用。|
|{HOST.METADATA}|→ 自动注册通知和命令|*主机元数据。*<br>仅适用活动代理自动注册。|
|{HOST.NAME}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ 映射元素标签，映射URL名称和值<br>→ 监控项关键参数<br>→ 主机接口IP/DNS<br>→ 触发器监控项 "允许的主机" 字段<br>→ 数据库监控附加字段<br>→ SSH和Telnet脚本<br>→ Web监控^[4](supported_by_location#脚注)^<br>→ 低级别自动发现过滤正则表达式<br>→ 动态URL仪表盘组件的URL字段<br>→ 触发器名称，事件名称，操作型数据和描述<br>→ 触发器URL<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 脚本类型监控项，监控项原型和发现规则参数名称和值<br>→ HTTP代理类型监控项，监控项原型和发现规则字段：<br>URL，查询字段，请求正文，报头，代理，SSL证书文件，SSL密钥文件，允许的主机。.<br>→ 自定义主机操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)|*可见的主机名。*<br><br>这个宏可以和一个数字索引一起使用，例如： {HOST.NAME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{HOST.PORT}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 自动注册通知和命令<br>→ 内部通知<br>→ 触发器名称，事件名称，操作型数据和描述<br>→ 触发器URL<br>→ JMX项目终结点字段<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机（代理）端口 *^[2](supported_by_location#脚注)^.<br><br>这个宏可以和一个数字索引一起使用，例如： {HOST.PORT[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{HOST.TARGET.CONN}|→ 基于触发器的命令<br>→ 问题更新命令<br>→ 发现命令<br>→ 自动注册命令|目标主机IP地址或DNS名称，取决于主机设置。<br>从5.4.0开始支持。|
|{HOST.TARGET.DNS}|→ 基于触发器的命令<br>→ 问题更新命令<br>→ 发现命令<br>→ 自动注册命令|目标主机的DNS名称。<br>从5.4.0开始支持。|
|{HOST.TARGET.HOST}|→ 基于触发器的命令<br>→ 问题更新命令<br>→ 发现命令<br>→ 自动注册命令|目标主机的技术名称。<br>从5.4.0开始支持。|
|{HOST.TARGET.IP}|→ 基于触发器的命令<br>→ 问题更新命令<br>→ 发现命令<br>→ 自动注册命令|目标主机的IP地址。<br>从5.4.0开始支持。|
|{HOST.TARGET.NAME}|→ 基于触发器的命令<br>→ 问题更新命令<br>→ 发现命令<br>→ 自动注册命令|目标主机的技术名称。<br>从5.4.0开始支持。|
|{HOSTGROUP.ID}|→ 映射元素标签，映射URL名称和值|*主机组ID。*|
|{INVENTORY.ALIAS}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的别名字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.ALIAS[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.ASSET.TAG}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的资产标签字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.ASSET.TAG[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.CHASSIS}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的机壳字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.CHASSIS[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.CONTACT}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的联系字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.CONTACT[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.CONTACT<1-9>}` 已弃用。|
|{INVENTORY.CONTRACT.NUMBER}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的合同号码字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.CONTRACT.NUMBER[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.DEPLOYMENT.STATUS}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的部署状态字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.DEPLOYMENT.STATUS[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HARDWARE}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的硬件字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HARDWARE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.HARDWARE<1-9>}` 已弃用。|
|{INVENTORY.HARDWARE.FULL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的硬件(全细节)字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HARDWARE.FULL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HOST.NETMASK}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主机子网掩码字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HOST.NETMASK[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HOST.NETWORKS}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主机网络字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HOST.NETWORKS[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HOST.ROUTER}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主机路由字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HOST.ROUTER[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HW.ARCH}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的硬件架构字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HW.ARCH[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HW.DATE.DECOMM}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的硬件退役日期字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HW.DATE.DECOMM[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HW.DATE.EXPIRY}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的硬件维修过期日期字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HW.DATE.EXPIRY[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HW.DATE.INSTALL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的硬件安装日期字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HW.DATE.INSTALL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.HW.DATE.PURCHASE}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的硬件购买日期字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.HW.DATE.PURCHASE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.INSTALLER.NAME}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的安装名称字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.INSTALLER.NAME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.LOCATION}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的位置字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.LOCATION[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.LOCATION<1-9>}` 已弃用。|
|{INVENTORY.LOCATION.LAT}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的位置纬度字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.LOCATION.LAT[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.LOCATION.LON}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的位置经度字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.LOCATION.LON[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.MACADDRESS.A}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的Mac 地址 A字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.MACADDRESS.A[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.MACADDRESS<1-9>}` 已弃用。|
|{INVENTORY.MACADDRESS.B}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的Mac 地址 B字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.MACADDRESS.B[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.MODEL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的模型字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.MODEL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.NAME}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的名称字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.NAME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.NAME<1-9>}` 已弃用。|
|{INVENTORY.NOTES}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的备注字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.NOTES[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.NOTES<1-9>}` 已弃用。|
|{INVENTORY.OOB.IP}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的带外 IP 地址字段。 field in host inventory.*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.OOB.IP[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.OOB.NETMASK}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的带外子网掩码字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.OOB.NETMASK[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.OOB.ROUTER}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的带外路由器字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.OOB.ROUTER[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.OS}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的操作系统字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.OS[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.OS<1-9>}` 已弃用。|
|{INVENTORY.OS.FULL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的操作系统(所有细节)字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.OS.FULL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.OS.SHORT}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的操作系统( 简短)字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.OS.SHORT[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.PRIMARY.CELL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主要的POC手机字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.PRIMARY.CELL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.PRIMARY.EMAIL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主要的POC email字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.PRIMARY.EMAIL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.PRIMARY.NAME}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主要的POC名称字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.PRIMARY.NAME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.PRIMARY.NOTES}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主要的POC注记字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.PRIMARY.NOTES[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.PRIMARY.PHONE.A}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主要的POC电话A字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.PRIMARY.PHONE.A[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.PRIMARY.PHONE.B}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主要的POC电话B字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.PRIMARY.PHONE.B[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.PRIMARY.SCREEN}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的主要的POC屏幕名称字段。。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.PRIMARY.SCREEN[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.SECONDARY.CELL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的第二个POC手机号码字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.SECONDARY.CELL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.SECONDARY.EMAIL}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的第二个POC email字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.SECONDARY.EMAIL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.SECONDARY.NAME}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的第二个POC名称字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.SECONDARY.NAME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.SECONDARY.NOTES}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的第二个POC注记字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.SECONDARY.NOTES[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.SECONDARY.PHONE.A}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的第二个POC电话A字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.SECONDARY.PHONE.A[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.SECONDARY.PHONE.B}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的第二个POC电话B字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.SECONDARY.PHONE.B[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.POC.SECONDARY.SCREEN}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的第二个POC聚合图形名称字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.POC.SECONDARY.SCREEN[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SERIALNO.A}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的序列号A字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SERIALNO.A[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).<br><br>`{PROFILE.SERIALNO<1-9>}` 已弃用。|
|{INVENTORY.SERIALNO.B}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的序列号B字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SERIALNO.B[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SITE.ADDRESS.A}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的场所地址A字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SITE.ADDRESS.A[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SITE.ADDRESS.B}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的场所地址B字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SITE.ADDRESS.B[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SITE.ADDRESS.C}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的场所地址C字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SITE.ADDRESS.C[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SITE.CITY}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的场所城市字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SITE.CITY[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SITE.COUNTRY}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的场所国家字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SITE.COUNTRY[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SITE.NOTES}|→ 基于触发器的通知和命令<br>→ 问题更新通知和命令<br>→ 内部通知<br>→ [标签名称和值](/manual/config/tagging#macro_support)<br>→ 映射元素标签，映射URL名称和值<br>→ 自定义事件操作 [scripts](/manual/web_interface/frontend_sections/administration/scripts)|*主机资产记录中的场所备注字段。*<br><br>这个宏可以和一个数字索引一起使用，例如： {INVENTORY.SITE.NOTES[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第1个、第2个、第3个等主机。参阅 [indexed macros](supported_by_location#indexed_macros).|
|{INVENTORY.SITE.RACK}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中站点的机架位置字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SITE.RACK[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SITE.STATE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中站点所属的省/市。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SITE.STATE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SITE.ZIP}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中站点的邮编字段*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SITE.ZIP[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SOFTWARE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的软件字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SOFTWARE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。<br><br>`{PROFILE.SOFTWARE<1-9>}` 已弃用。|
|{INVENTORY.SOFTWARE.APP.A}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的软件应用程序A的字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SOFTWARE.APP.A[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SOFTWARE.APP.B}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的软件应用程序B的字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SOFTWARE.APP.B[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SOFTWARE.APP.C}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的软件应用程序C的字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SOFTWARE.APP.C[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SOFTWARE.APP.D}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的软件应用程序D的字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SOFTWARE.APP.D[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SOFTWARE.APP.E}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的软件应用程序E的字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SOFTWARE.APP.E[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.SOFTWARE.FULL}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的软件（完整细节描述）字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.SOFTWARE.FULL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.TAG}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的标签字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.TAG[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。<br><br>`{PROFILE.TAG<1-9>}` 已弃用。|
|{INVENTORY.TYPE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的类型字段。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.TYPE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。<br><br>`{PROFILE.DEVICETYPE<1-9>}` 已弃用。|
|{INVENTORY.TYPE.FULL}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中类型（完整详细信息）字段的内容。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.TYPE.FULL[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.URL.A}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中URL A的字段内容。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.URL.A[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.URL.B}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中URL B的字段内容。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.URL.B[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.URL.C}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中URL C的字段内容。*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.URL.C[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{INVENTORY.VENDOR}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 地图元素标签,地图URL的名称和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*主机清单中的供应商字段的内容*<br><br>该宏可以与数字索引一起使用，例如 {INVENTORY.VENDOR[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.DESCRIPTION}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*引发通知的触发器表达式中的第N个监控项的描述。*<br><br>该宏可以与数字索引一起使用，例如 {ITEM.DESCRIPTION[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.DESCRIPTION.ORIG}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*引发通知的触发器表达式中的第N个监控项的描述（带有未解析的宏）。*<br><br>该宏可以与数字索引一起使用，例如 {ITEM.DESCRIPTION.ORIG[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。<br><br>支持的最低版本是 5.2.0.|
|{ITEM.ID}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 脚本类型item、item原型和发现规则参数的名称和值^[6](supported_by_location#footnotes)^<br>→ HTTP agent 类型监控项、监控项原型和发现规则字段:<br>URL,查询字段，请求正文,headers,代理proxy,SSL 证书文件,SSL密钥文件<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*引发通知的触发器表达式中的第 N 个监控项的序列ID。*<br><br>该宏可以与数字索引一起使用，例如 {ITEM.ID[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.KEY}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 脚本类型item、item原型和发现规则参数的名称和值^[6](supported_by_location#footnotes)^<br>→ HTTP agent 类型监控项、监控项原型和发现规则字段:<br>URL,查询字段，请求正文,headers,代理proxy,SSL 证书文件,SSL密钥文件<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器表达式中导致通知的第 N 监控项的键。*<br><br>该宏可以与数字索引一起使用，例如 {ITEM.KEY[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。<br><br>`{TRIGGER.KEY}` 已弃用。|
|{ITEM.KEY.ORIG}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 脚本类型item、item原型和发现规则参数的名称和值^[6](supported_by_location#footnotes)^<br>→ HTTP agent 类型监控项、监控项原型和发现规则字段:<br>URL,查询字段，请求正文,headers,代理proxy,SSL 证书文件,SSL密钥文件, 允许的主机。^[6](supported_by_location#footnotes)^<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器表达式中导致通知的第N监控项的原始键（宏未展开）。^[4](supported_by_location#footnotes)^.*<br><br>该宏可以与数字索引一起使用，例如 {ITEM.KEY.ORIG[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LASTVALUE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名字，事件名字，操作数据和描述。<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 触发器的URL地址<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器表达式中导致通知的第N项的最新值。*<br>如果收集到的最新历史值超过了 *最大历史显示周期*，在前端就会解析为\*UNKNOWN\* 。 (请查看 [管理→通用](/manual/web_interface/frontend_sections/administration/general#gui) 菜单选项)。<br>请注意，从 4.0 开始，在问题名称中使用时，在查看问题事件时不会解析为最新的监控项值，而是保留问题发生时的监控项值。 <br>它是此 `last(/{HOST.HOST}/{ITEM.KEY})`的别名。<br>从Zabbix的版本3.2.0开始，该宏支持[自定义](/manual/config/macros/macro_functions) 宏的值； <br><br>该宏可以与数字索引一起使用，例如 {ITEM.LASTVALUE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第一个、第二个、第三个等监控项。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LOG.AGE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名称、操作数据和描述<br>→ 触发器的URL地址<br>→ 事件的tags和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*监控项事件日志的持续时间*，可以精确到秒。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.LOG.AGE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LOG.DATE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名称、操作数据和描述<br>→ 触发器的URL地址<br>→ 事件的tags和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*监控项事件日志的日期*。时间格式类似于 yyyy:mm:dd 。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.LOG.DATE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LOG.EVENTID}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名称、操作数据和描述<br>→ 触发器的URL地址<br>→ 事件的tags和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*事件日志中的事件ID。*<br>仅适用于windows事件日志监控。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.LOG.EVENTID[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LOG.NSEVERITY}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名称、操作数据和描述<br>→ 触发器的URL地址<br>→ 事件的tags和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*事件日志中日志的严重级别，用数字级别描述（1--7）。*<br>仅适用于windows事件日志监控。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.LOG.NSEVERITY[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LOG.SEVERITY}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名称、操作数据和描述<br>→ 触发器的URL地址<br>→ 事件的tags和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*事件日志中日志的严重级别，使用文字描述。*<br>仅适用于windows事件日志监控。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.LOG.SEVERITY[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LOG.SOURCE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名称、操作数据和描述<br>→ 触发器的URL地址<br>→ 事件的tags和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*事件日志中事件的源*<br>仅适用于windows事件日志监控。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.LOG.SOURCE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.LOG.TIME}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名称、操作数据和描述<br>→ 触发器的URL地址<br>→ 事件的tags和值<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*item事件日志的发生时间。*<br><br>该宏可以与数字索引一起使用，例如 {ITEM.LOG.TIME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.NAME}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器表达式中导致通知的第N个监控项的名称。*<br><br>该宏可以与数字索引一起使用，例如 {ITEM.NAME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.NAME.ORIG}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|从Zabbix 6.0之后此宏已弃用。 当监控项名称中支持用户宏和位置宏时，它用于在 Zabbix 6.0 之前的版本中解析为*监控项的原始名称（即没有解析宏）*。 <br><br>该宏可以与数字索引一起使用，例如 {ITEM.NAME.ORIG[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.STATE}|→ 基于监控项的内部通知|*触发器表达式中导致通知的第 N 监控项的最新状态。* 可能的值: **不支持** 和 **正常**.<br><br>该宏可以与数字索引一起使用，例如 {ITEM.STATE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.VALUE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器名字，事件名字，操作数据和描述。<br>→ [标签的名称和值](/manual/config/tagging#macro_support)<br>→ 触发器的URL地址<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|可被解释为如下的任意一项:<br>1) 如果在触发器状态更改的上下文中使用，则解释为触发器表达式中第N个监控项的历史值（事件发生时），例如在展示事件或发送通知时。<br>2) 如果在没有触发器状态更改的上下文的情况下使用，触发器表达式中第N个监控项的最新值。例如，在弹出选择窗口中显示触发器列表时。在本例中工作方式与 {ITEM.LASTVALUE}相同。<br>在第一种情况下，如果历史记录值已被删除或从未存储过，它将解释为\*未知\*。<br>在第二种情况下并且仅在前端中，如果收集的最新历史值超过*最大历史显示周期*时间，它将解析为\*未知\*. (查看 [管理→通用](/manual/web_interface/frontend_sections/administration/general#gui) 菜单选项).<br><br>[自定义](/manual/config/macros/macro_functions) 此宏支持宏值，从 Zabbix 3.2.0 开始。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.VALUE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中的第一个、第二个、第三个等监控项。请参考[宏索引](supported_by_location#indexed_macros)。|
|{ITEM.VALUETYPE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器表达式中导致通知的第N个监控项的值类型。* 可能的值: 0 - numeric float, 1 - character, 2 - log, 3 - numeric unsigned, 4 - text。<br><br>该宏可以与数字索引一起使用，例如 {ITEM.VALUETYPE[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。<br><br>支持的最低版本是 5.4.0.|
|{LLDRULE.DESCRIPTION}|→ 基于 LLD 规则的内部通知|*引发通知的低级别自动发现规则的描述。*|
|{LLDRULE.DESCRIPTION.ORIG}|→ 基于 LLD 规则的内部通知|*引发通知的低级别自动发现规则的描述（描述中带有未解析的宏）*<br>支持的最低版本是 5.2.0.|
|{LLDRULE.ID}|→ 基于 LLD 规则的内部通知|*引发通知的低级别自动发现规则的规则序列ID*|
|{LLDRULE.KEY}|→ 基于 LLD 规则的内部通知|*引发通知的低级别自动发现规则的键值*|
|{LLDRULE.KEY.ORIG}|→ 基于 LLD 规则的内部通知|*引发通知的低级别自动发现规则的原始密钥（未扩展的宏）。*|
|{LLDRULE.NAME}|→ 基于 LLD 规则的内部通知|*导致通知的低级发现规则（已解析宏）的名称。*|
|{LLDRULE.NAME.ORIG}|→ 基于 LLD 规则的内部通知|*导致通知的低级发现规则的原始名称（即未解析宏）。*|
|{LLDRULE.STATE}|→ 基于 LLD 规则的内部通知|*低级发现规则的最新状态。* 可能的值: **不支持** 和 **正常**.|
|{MAP.ID}|→ 地图元素标签,地图URL的名称和值|*网络拓扑图ID*|
|{MAP.NAME}|→ 地图元素标签,地图URL的名称和值<br>→ Text field in map shapes|*网络拓扑图名称*<br>支持的最低版本是 3.4.0.|
|{PROXY.DESCRIPTION}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 发现的通知和命令<br>→ 自动注册的通知和命令<br>→ 内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*代理的描述*。 可以被解释为如下的可能:<br>1) 触发器表达式中第 N 个监控项的代理（在基于触发器的通知中）。 您可以在此处使用[索引](/manual/appendix/macros/supported_by_location#indexed_macros) 宏。<br>2) 代理，它执行发现(在发现通知中)，在此处使用{PROXY.DESCRIPTION} ，无需索引。<br>3) 代理指向一个已经注册的agent (在自动注册通知中)。在此处使用{PROXY.DESCRIPTION}，无需索引。<br><br>该宏可以与数字索引一起使用，例如 {PROXY.DESCRIPTION[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{PROXY.NAME}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 发现的通知和命令<br>→ 自动注册通知和命令 <br>→ 内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*代理的名称*. 可以被解释为如下的可能::<br>1)触发器表达式中第 N 个监控项的代理名称（在基于触发器的通知中）。 您可以在此处使用[索引](/manual/appendix/macros/supported_by_location#indexed_macros) 宏。<br>2)代理，它执行发现（在发现通知中）。在此处使用 {PROXY.NAME}，无需索引。<br>3) 代理指向一个已经注册的agent (在自动注册通知中)。 在此处使用{PROXY.NAME} ，无需索引。<br><br>该宏可以与数字索引一起使用，例如 {PROXY.NAME[<1-9>](supported_by_location#indexed_macros)} 指向触发器表达式中匹配的第1个，第2个，第3个等主机。 请参考[宏索引](supported_by_location#indexed_macros)。|
|{SERVICE.NAME}|→ 基于服务的通知和命令<br>→ 服务的通知和命令|*服务名称* (已解析宏)。|
|{SERVICE.ROOTCAUSE}|→ 基于服务的通知和命令<br>→ 服务的通知和命令|*导致服务失败的触发问题事件列表*, 使用安全性主机排序。 包括以下详细信息：主机名、事件名称、严重性、持续时间、服务标签和值。 |
|{SERVICE.TAGS}|→ 基于服务的通知和命令<br>→ 服务的通知和命令|*服务事件标签的逗号分隔列表。* 服务事件标签可以在服务配置选项标签中定义。如果不存在标签，则扩展为空字符串。|
|{SERVICE.TAGSJSON}|→ 基于服务的通知和命令<br>→ 服务的通知和命令|*包含服务事件标签对象的 JSON 数组。* 服务事件标签可以在服务配置选项标签中定义。 如果不存在标签，则扩展为空数组。|
|{SERVICE.TAGS.<tag name>}|→ 基于服务的通知和命令<br>→ 服务的通知和命令|*标签名称引用的服务事件标签值。* 服务事件标签可以在服务配置选项标签中定义。<br>包含非字母数字字符（包括非英语多字节 UTF 字符）的标签名称应该用双引号引起来。 带引号的标记名称中的引号和反斜杠必须使用反斜杠进行转义。|
|{TIME}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于服务的通知和命令<br>→ 服务的通知和命令<br>→ 发现的通知和命令<br>→ 自动注册通知和命令 <br>→ 内部通知<br>→ 触发器事件名称<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*现在的时间，格式为 hh:mm:ss*|
|{TRIGGER.DESCRIPTION}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器描述。*<br>如果在通知中使用了`{TRIGGER.DESCRIPTION}`，则触发器描述中支持的所有宏都将被扩展。<br>`{TRIGGER.COMMENT}` 已弃用。|
|{TRIGGER.EXPRESSION.EXPLAIN}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件<br>→ 事件名称|*部分评估的触发器表达式。*<br>基于监控项的函数在事件生成时被评估并替换为结果，而所有其他函数都显示为表达式中所写的。可用于调试触发器表达式。|
|{TRIGGER.EXPRESSION.RECOVERY.EXPLAIN}|→ Problem [recovery notifications](/manual/config/notifications/action/recovery_operations) and commands<br>→ 故障更新通知和命令<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*部分评估触发恢复表达式.*<br>基于触发器的函数在事件生成时被评估并替换为结果，而所有其他函数都显示为表达式中所写的。可用于调试触发恢复表达式。|
|{TRIGGER.EVENTS.ACK}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 地图元素标签<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*地图中地图元素或在通知中生成当前事件的触发器的已确认事件数。*|
|{TRIGGER.EVENTS.PROBLEM.ACK}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 地图元素标签<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*所有触发器的已确认 PROBLEM 事件的数量，无论其状态。*|
|{TRIGGER.EVENTS.PROBLEM.UNACK}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 地图元素标签<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*所有触发器的未确认问题事件数，无论其状态。*|
|{TRIGGER.EVENTS.UNACK}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 地图元素标签<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*地图中地图元素或在通知中生成当前事件的触发器的未确认事件数。*|
|{TRIGGER.HOSTGROUP.NAME}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*定义了触发器的已排序（按 SQL 查询）、以逗号分隔的主机组列表名称。*|
|{TRIGGER.PROBLEM.EVENTS.PROBLEM.ACK}|→ 地图元素标签|*处于PROBLEM状态的触发器已确认的PROBLEM事件数。*|
|{TRIGGER.PROBLEM.EVENTS.PROBLEM.UNACK}|→ 地图元素标签|*处于PROBLEM状态的触发器的未确认PROBLEM事件数。*|
|{TRIGGER.EXPRESSION}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器表达式。*|
|{TRIGGER.EXPRESSION.RECOVERY}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发恢复表达式* 如果*事件生成OK*在[触发器配置](/manual/config/triggers/trigger)被用于'恢复表达'; 否者返回空的string字段。<br>支持的最低版本是 3.2.0.|
|{TRIGGER.ID}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 地图元素标签,地图URL的名称和值<br>→ 触发器的URL地址<br>→ Trigger tag value<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发此操作的触发器ID。*<br>从Zabbix的4.4.1版本开始在触发标记值中受支持。|
|{TRIGGER.NAME}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器的名称* (已解析宏).<br>请注意自4.0.0开始，{EVENT.NAME} 可用于操作以显示已解析的宏触发的事件/问题名称。 |
|{TRIGGER.NAME.ORIG}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器的原始名称* (即未解析宏).|
|{TRIGGER.NSEVERITY}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*使用数字表达的触发严重性* 可能的值: |0 - 未分类，1 - 信息，2 - 警告，3 - 平均，4 - 高，5 - 灾难。
|{TRIGGER.SEVERITY}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器严重性名称* 可以在这里定义 *管理 → 通用 → 触发器展示选项*.|
|{TRIGGER.STATE}|→ 基于触发器的内部通知|*触发器的最新状态* 可能的值: **未知** 和 **正常**.|
|{TRIGGER.STATUS}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*当前触发器的值* 可以是 PROBLEM 或者 OK.<br>`{STATUS}` 已弃用。|
|{TRIGGER.TEMPLATE.NAME}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*值为已排序（按 SQL 查询）、逗号分隔的模板列表中定义了触发器，如果触发器是在主机中定义的则为 \*未知\*。*|
|{TRIGGER.URL}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 基于触发器的内部通知<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*触发器的URL地址。*|
|{TRIGGER.VALUE}|→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 触发器表达式<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件|*当前触发数值*: 0 - 触发器处于正常状态, 1 - 触发器处于问题状态。|
|{TRIGGERS.UNACK}|→ 地图元素标签|*地图元素中已取消确认问题触发器的数量，忽略触发器状态。*<br>如果至少有一个问题事件已取消确认，则触发器被视为已取消确认。 |
|{TRIGGERS.PROBLEM.UNACK}|→ 地图元素标签|*在地图标签中未确认的触发器（状态为PROBLEM）总数。*<br>如果至少有一个问题事件已取消确认，则触发器被视为已取消确认。 |
|{TRIGGERS.ACK}|→ 地图元素标签|*地图元素中已确认触发器的数量, 忽略触发器状态。*<br>如果触发器的所有问题事件都被确认，则认为触发器已被确认。 |
|{TRIGGERS.PROBLEM.ACK}|→ 地图元素标签|*地图元素中已确认触发器的数量。*<br>如果触发器的所有问题事件都被确认，则认为触发器已被确认。 |
|{USER.FULLNAME}|→ 故障更新通知和命令<br>→ 对主机手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件 (including confirmation text)|在事件确认和脚本操作中添加*用户的姓氏、名字和完整姓名*的信息。<br>从Zabbix的3.4.0版本开始在问题更新功能中支持此宏，从5.0.2开始在全局功能中支持。|
|{USER.NAME}|→ 对主机手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件 (including confirmation text)|启动脚本的*用户的名字*。<br>支持的最低版本是 5.0.2.|
|{USER.SURNAME}|→ 对主机手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件 (including confirmation text)|启动脚本的*用户的姓氏*。<br>支持的最低版本是 5.0.2.|
|{USER.USERNAME}|→ 对主机手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts) (including confirmation text)<br>→ 手动操作[脚本](/manual/web_interface/frontend_sections/administration/scripts)事件 (including confirmation text)|启动脚本的*完整用户名称*（包括姓氏和名字）。<br>支持的最低版本是 5.0.2.<br>{USER.ALIAS}仅支持Zabbix 5.4.0以前的版本,此版本已弃用。|
|{$MACRO}|→ 参阅: [User macros supported by location](/manual/appendix/macros/supported_by_location_user)|*[用户自定义](/manual/config/macros/user_macros) 宏。*|
|{\#MACRO}|→ 参阅: [低级别自动发现宏](/manual/config/macros/lld_macros)|*低级别自动发现宏。*<br><br>[定制](/manual/config/macros/macro_functions) 宏的值, 从Zabbix的4.0.0版本开始。|
|{?EXPRESSION}|→ 触发器事件名称<br>→ 基于触发器的通知和命令<br>→ 故障更新通知和命令<br>→ 地图元素标签^[3](supported_by_location#footnotes)^<br>→ 地图分享标签^[3](supported_by_location#footnotes)^<br>→ 地图中的链接标签^[3](supported_by_location#footnotes)^<br>→ 图表名称^[5](supported_by_location#footnotes)^|*表达式宏*用于公式计算。通过扩展内部的所有宏并评估结果表达式来计算。 <br>参阅 [案例](/[[/manual/config/triggers/expression#example_17) 在事件名称中使用表达式宏。<br>支持的最低版本是 5.2.0.|
# 1 System information
# 1 系统信息
# 1 Trigger-based event correlation
# 1 基于触发器的事件关联
# 1 Trigger event generation
# 1 触发器事件生成
# 1 Upgrade from sources
# 1 从源代码升级
# 1 Usage examples
# 1 使用示例
# 1 Using certificates
# 1 使用证书
# 1 Virtual machine discovery key fields
The following table lists fields returned by virtual machine related
discovery keys.
|**Item key**|<|<|
|--|--|----|
|**Description**|**Field**|**Retrieved content**|
|vmware.cluster.discovery|<|<|
|Performs cluster discovery.|{\#CLUSTER.ID}|Cluster identifier.|
|^|{\#CLUSTER.NAME}|Cluster name.|
|vmware.datastore.discovery|<|<|
|Performs datastore discovery.|{\#DATASTORE}|Datastore name.|
|^|{\#DATASTORE.EXTENT}|JSON object with an array of {instanceName:partitionId}.|
|vmware.dc.discovery|<|<|
|Performs datacenter discovery.|{\#DATACENTER}|Datacenter name.|
|^|{\#DATACENTERID}|Datacenter ID.|
|vmware.hv.discovery|<|<|
|Performs hypervisor discovery.|{\#HV.UUID}|Unique hypervisor identifier.|
|^|{\#HV.ID}|Hypervisor identifier (HostSystem managed object name).|
|^|{\#HV.NAME}|Hypervisor name.|
|^|{\#HV.NETNAME}|Hypervisor network host name.|
|^|{\#HV.IP}|Hypervisor IP address, might be empty.<br>In case of an HA configuration with multiple net interfaces, the following selection priority for interface is observed:<br>- prefer the IP which shares the IP-subnet with the vCenter IP<br>- prefer the IP from IP-subnet with default gateway<br>- prefer the IP from interface with the lowest ID<br>This field is supported since Zabbix 5.2.2.|
|^|{\#CLUSTER.NAME}|Cluster name, might be empty.|
|^|{\#DATACENTER.NAME}|Datacenter name.|
|^|{\#PARENT.NAME}|Name of container that stores the hypervisor.<br>Supported since Zabbix 4.0.3.|
|^|{\#PARENT.TYPE}|Type of container in which the hypervisor is stored. The values could be `Datacenter`, `Folder`, `ClusterComputeResource`, `VMware`, where 'VMware' stands for unknown container type.<br>Supported since Zabbix 4.0.3.|
|vmware.hv.datastore.discovery|<|<|
|Performs hypervisor datastore discovery. Note that multiple hypervisors can use the same datastore.|{\#DATASTORE}|Datastore name.|
|^|{\#MULTIPATH.COUNT}|Registered number of datastore paths.|
|^|{\#MULTIPATH.PARTITION.COUNT}|Number of available disk partitions.|
|vmware.vm.discovery|<|<|
|Performs virtual machine discovery.|{\#VM.UUID}|Unique virtual machine identifier.|
|^|{\#VM.ID}|Virtual machine identifier (VirtualMachine managed object name).|
|^|{\#VM.NAME}|Virtual machine name.|
|^|{\#HV.NAME}|Hypervisor name.|
|^|{\#DATACENTER.NAME}|Datacenter name.|
|^|{\#CLUSTER.NAME}|Cluster name, might be empty.|
|^|{\#VM.IP}|Virtual machine IP address, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.DNS}|Virtual machine DNS name, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.GUESTFAMILY}|Guest virtual machine OS family, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.GUESTFULLNAME}|Full guest virtual machine OS name, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.FOLDER}|The chain of virtual machine parent folders, can be used as value for nested groups; folder names are combined with "/". Might be empty.<br>Supported since Zabbix 5.4.2.|
|vmware.vm.net.if.discovery|<|<|
|Performs virtual machine network interface discovery.|{\#IFNAME}|Network interface name.|
|vmware.vm.vfs.dev.discovery|<|<|
|Performs virtual machine disk device discovery.|{\#DISKNAME}|Disk device name.|
|vmware.vm.vfs.fs.discovery|<|<|
|Performs virtual machine file system discovery.|{\#FSNAME}|File system name.|
# 1 虚拟机发现关键字段
下表列出了与虚拟机相关的发现键返回的字段。
| **监控项 键** | < | < |
|--|--|----|
| **Description** | **字段** | **获取内容** |
| vmware.cluster.discovery | < | < |
| Performs cluster discovery. | {\#CLUSTER.ID} | 集群标识符。 |
| ^ | {\#CLUSTER.NAME} | 集群名称。 |
| vmware.datastore.discovery | < | < |
| Performs datastore discovery. | {\#DATASTORE} | 数据存储名称。 |
| ^ | {\#DATASTORE.EXTENT} | 包含 {instanceName:partitionId} 的 array 的 JSON object。 |
| vmware.dc.discovery | < | < |
| Performs datacenter discovery. | {\#DATACENTER} | 数据中心名称。 |
| ^ | {\#DATACENTERID} | 数据中心 ID。 |
| vmware.hv.discovery | < | < |
| Performs hypervisor discovery. | {\#HV.UUID} | 唯一超虚拟化标识符。 |
| ^ | {\#HV.ID} | 超虚拟化标识符（HostSystem 管理的 object 名称）。 |
| ^ | {\#HV.NAME} | 超虚拟化名称。 |
| ^ | {\#HV.NETNAME} | 超虚拟化网络 主机名。 |
| ^ | {\#HV.IP} | 超虚拟化 IP 地址，可能为空。<br>在具有多个网络接口的 HA 配置中，接口的选择优先级如下：<br>- 优先选择与 vCenter IP 共享 IP 子网的 IP<br>- 优先选择具有默认网关的 IP 子网的 IP<br>- 优先选择接口 ID 最低的 IP<br>此字段自 Zabbix 5.2.2 起支持。 |
| ^ | {\#CLUSTER.NAME} | 集群名称，可能为空。 |
| ^ | {\#DATACENTER.NAME} | 数据中心名称。 |
| ^ | {\#PARENT.NAME} | 存储超虚拟化的容器名称。<br>自 Zabbix 4.0.3 起支持。 |
| ^ | {\#PARENT.TYPE} | 存储超虚拟化的容器类型。可能的值为 `Datacenter`、`Folder`、`ClusterComputeResource`、`VMware`，其中 'VMware' 表示未知容器类型。<br>自 Zabbix 4.0.3 起支持。 |
| vmware.hv.datastore.discovery | < | < |
| Performs hypervisor datastore discovery. Note that multiple hypervisors can use the same datastore. | {\#DATASTORE} | 数据存储名称。 |
| ^ | {\#MULTIPATH.COUNT} | 注册的数据存储路径数。 |
| ^ | {\#MULTIPATH.PARTITION.COUNT} | 可用磁盘分区数。 |
| vmware.vm.discovery | < | < |
| Performs virtual machine discovery. | {\#VM.UUID} | 唯一虚拟机标识符。 |
| ^ | {\#VM.ID} | 虚拟机标识符（VirtualMachine 管理的 object 名称）。 |
| ^ | {\#VM.NAME} | 虚拟机名称。 |
| ^ | {\#HV.NAME} | 超虚拟化名称。 |
| ^ | {\#DATACENTER.NAME} | 数据中心名称。 |
| ^ | {\#CLUSTER.NAME} | 集群名称，可能为空。 |
| ^ | {\#VM.IP} | 虚拟机 IP 地址，可能为空。<br>自 Zabbix 5.2.2 起支持。 |
| ^ | {\#VM.DNS} | 虚拟机 DNS 名称，可能为空。<br>自 Zabbix 5.2.2 起支持。 |
| ^ | {\#VM.GUESTFAMILY} | 客户虚拟机操作系统家族，可能为空。<br>自 Zabbix 5.2.2 起支持。 |
| ^ | {\#VM.GUESTFULLNAME} | 完整的客户虚拟机操作系统名称，可能为空。<br>自 Zabbix 5.2.2 起支持。 |
| ^ | {\#VM.FOLDER} | 虚拟机父文件夹链，可用作嵌套组的值；文件夹名称以 "/" 连接。可能为空。<br>自 Zabbix 5.4.2 起支持。 |
| vmware.vm.net.if.discovery | < | < |
| Performs virtual machine network interface discovery. | {\#IFNAME} | 网络接口名称。 |
| vmware.vm.vfs.dev.discovery | < | < |
| Performs virtual machine disk device discovery. | {\#DISKNAME} | 磁盘设备名称。 |
| vmware.vm.vfs.fs.discovery | < | < |
| Performs virtual machine file system discovery. | {\#FSNAME} | 文件系统名称。 |
# 1 Virtual machine discovery key fields
The following table lists fields returned by virtual machine related
discovery keys.
|**Item key**|<|<|
|------------|-|-|
|**Description**|**Field**|**Retrieved content**|
|vmware.cluster.discovery|<|<|
|Performs cluster discovery.|{\#CLUSTER.ID}|Cluster identifier.|
|^|{\#CLUSTER.NAME}|Cluster name.|
|vmware.datastore.discovery|<|<|
|Performs datastore discovery.|{\#DATASTORE}|Datastore name.|
|vmware.dc.discovery|<|<|
|Performs datacenter discovery.|{\#DATACENTER}|Datacenter name.|
|^|{\#DATACENTERID}|Datacenter ID.|
|vmware.hv.discovery|<|<|
|Performs hypervisor discovery.|{\#HV.UUID}|Unique hypervisor identifier.|
|^|{\#HV.ID}|Hypervisor identifier (HostSystem managed object name).|
|^|{\#HV.NAME}|Hypervisor name.|
|^|{\#HV.NETNAME}|Hypervisor network host name.|
|^|{\#HV.IP}|Hypervisor IP address, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#CLUSTER.NAME}|Cluster name, might be empty.|
|^|{\#DATACENTER.NAME}|Datacenter name.|
|^|{\#PARENT.NAME}|Name of container that stores the hypervisor.<br>Supported since Zabbix 4.0.3.|
|^|{\#PARENT.TYPE}|Type of container in which the hypervisor is stored. The values could be `Datacenter`, `Folder`, `ClusterComputeResource`, `VMware`, where 'VMware' stands for unknown container type.<br>Supported since Zabbix 4.0.3.|
|vmware.hv.datastore.discovery|<|<|
|Performs hypervisor datastore discovery. Note that multiple hypervisors can use the same datastore.|{\#DATASTORE}|Datastore name.|
|vmware.vm.discovery|<|<|
|Performs virtual machine discovery.|{\#VM.UUID}|Unique virtual machine identifier.|
|^|{\#VM.ID}|Virtual machine identifier (VirtualMachine managed object name).|
|^|{\#VM.NAME}|Virtual machine name.|
|^|{\#HV.NAME}|Hypervisor name.|
|^|{\#DATACENTER.NAME}|Datacenter name.|
|^|{\#CLUSTER.NAME}|Cluster name, might be empty.|
|^|{\#VM.IP}|Virtual machine IP address, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.DNS}|Virtual machine DNS name, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.GUESTFAMILY}|Guest virtual machine OS family, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.GUESTFULLNAME}|Full guest virtual machine OS name, might be empty.<br>Supported since Zabbix 5.2.2.|
|^|{\#VM.FOLDER}|The chain of virtual machine parent folders, can be used as value for nested groups; folder names are combined with "/". Might be empty.<br>Supported since Zabbix 5.4.2.|
|vmware.vm.net.if.discovery|<|<|
|Performs virtual machine network interface discovery.|{\#IFNAME}|Network interface name.|
|vmware.vm.vfs.dev.discovery|<|<|
|Performs virtual machine disk device discovery.|{\#DISKNAME}|Disk device name.|
|vmware.vm.vfs.fs.discovery|<|<|
|Performs virtual machine file system discovery.|{\#FSNAME}|File system name.|
# 1 虚拟机发现key值字段
下表列出了虚拟机发现key值返回的内容。
|**项目键**|<|<|
|-------------|-|-|
|**描述** *|字段** **检|内容**|
|vmware.cluster.discovery|<|<|
|执行 VMware 集群发现 discovery,用于发现Hypervisorv（宿主机） 。 {\#CLUSTER.ID}|集群 ID。|<|
|^|{\#CLUSTER.NAME}|集群名称。|
|vmware.hv.discovery|<|<|
|执行 hypervisor 的 discovery 。 {\#|V.UUID} 唯一的|hypervisor 的 ID|
|^|{\#HV.ID}|Hypervisorv（宿主机） 的 ID（由HostSystem管理）|
|^|{\#HV.NAME}|Hypervisor（宿主机） 的名字|
|^|{\#CLUSTER.NAME}|Vmware群集名称，可能为空。|
|^|{\#DATACENTER.NAME}|Vmware 数据中心名称。|
|vmware.hv.datastore.discovery|<|<|
|执行 hypervisor 数据存储库的 discovery 。请注意，多个hypervisor 可以使用相同的数据存储(datastore)。 {\#DATASTORE} 数据存储|称。|<|
|vmware.vm.discovery|<|<|
|执行虚拟机的 discovery 。 {\#VM.|UID} 唯一虚拟机|D。|
|^|{\#VM.ID}|虚拟机 ID（由 VirtualMachine 管理）。|
|^|{\#VM.NAME}|虚拟机名。|
|^|{\#HV.NAME}|Hypervisor （宿主机）名称。|
|^|{\#CLUSTER.NAME}|Vmware 集群名称，可能为空。|
|^|{\#DATACENTER.NAME}|Vmware 数据中心名称。|
|vmware.vm.net.if.discovery|<|<|
|执行虚拟机网络接口的 discovery 。 {\#IFNAME}|网络接口名称。|<|
|vmware.vm.vfs.dev.discovery|<|<|
|执行虚拟机磁盘设备的 discovery 。 {\#DISKNAM|} 磁盘设备名称。|<|
|vmware.vm.vfs.fs.discovery|<|<|
|执行虚拟机文件系统的 discovery 。 {\#FSNAME}|文件系统名称。|<|
# 1 VMware monitoring item keys
# 1 VMware 监控 监控项 键值
# 1 Webhook script examples
# 1 Webhook 脚本示例
# 1 Web monitoring items
# 1 Web 监控
# 1 Zabbix agent
# 1 Zabbix agent
# 1 Zabbix server
# 1 Zabbix server
# 20 Modules
# 20 模块
# 20 System information
# 20 系统信息
# 20 Trigger overview
# 20 Trigger overview
# 20 Upgrade notes for 6.0.10
# 20 6.0.10 版本升级说明
# 20 What's new in Zabbix 6.0.15
# 20 Zabbix 6.0.15 新特性
# 21 Appendixes
Please use the sidebar to access content in the Appendixes section.
# 21 附录
请使用侧边栏访问附录部分的内容。
# 21 Top hosts
# 21 Top 主机
# 21 Top hosts
# 21 Top 主机
# 21 Upgrade notes for 6.0.11
# 21 6.0.11 版本升级说明
# 21 URL
# 21 URL
# 21 What's new in Zabbix 6.0.16
# 21 Zabbix 6.0.16 新特性
# 22 Trigger overview
# 22 触发器概览
# 22 Trigger overview
# 22 触发器概览
# 22 Upgrade notes for 6.0.12
# 22 6.0.12 升级说明
# 22 Web monitoring
# 22 Web monitoring
# 22 What's new in Zabbix 6.0.17
# 22 Zabbix 6.0.17 的新特性
# 23 Upgrade notes for 6.0.13
# 23 6.0.13 版本升级说明
# 23 URL
# 23 URL
# 23 URL
# 23 URL
# 23 What's new in Zabbix 6.0.18
# Zabbix 6.0.18 的新特性
# 24 Upgrade notes for 6.0.14
# 24 6.0.14 版本升级说明
# 24 Web monitoring
# 24 Web 监控
# 24 Web monitoring
# 24 Web 监控
# 24 What's new in Zabbix 6.0.19
# 24 Zabbix 6.0.19 新特性
# 25 Upgrade notes for 6.0.15
This minor version doesn't have any upgrade notes.
# 25 6.0.15 版本升级说明
此次要version没有任何升级说明。
# 25 What's new in Zabbix 6.0.20
# 25 Zabbix 6.0.20 新特性
# 26 Upgrade notes for 6.0.16
This minor version doesn't have any upgrade notes.
# 26 6.0.16 版本升级说明
此次要version没有任何升级说明.
# 26 What's new in Zabbix 6.0.21
# 26 Zabbix 6.0.21 的新特性
# 27 Upgrade notes for 6.0.17
# 27 6.0.17 版本升级说明
# 27 What's new in Zabbix 6.0.22
# 27 Zabbix 6.0.22 的新特性
# 28 Upgrade notes for 6.0.18
# 28 6.0.18 版本升级说明
# 28 What's new in Zabbix 6.0.23
See [breaking changes](/manual/installation/upgrade_notes_6023#breaking_changes) for this version.
# 28 Zabbix 6.0.23 新特性
请参阅[重大变更](/manual/installation/upgrade_notes_6023#重大变更)了解该version。
# 29 Upgrade notes for 6.0.19
# 29 6.0.19 版本升级说明
# 29 What's new in Zabbix 6.0.24
# 29 Zabbix 6.0.24 新特性
# 2 Actions
# 2 动作
# 2 Actions
[comment]: # (tags: action)
# 2 动作
[comment]: # (tags: action)
# 2 Active agent autoregistration
# 2 个活跃的 agent 自动注册
# 2 Agent
# 2 Agent
##### 2 Back up configuration files and Zabbix agent binaries
Make a backup copy of the Zabbix agent binary and configuration file.
##### 2 备份配置文件和 Zabbix agent 二进制文件
对Zabbix agent二进制文件和配置file进行备份copy。
##### 2 Back up configuration files and Zabbix proxy binaries
Make a backup copy of the Zabbix proxy binary and configuration file.
##### 2 备份配置文件和 Zabbix proxy 二进制文件
对Zabbix proxy二进制文件和配置file进行备份copy
##### 2 Back up the existing Zabbix database
This is a very important step. Make sure that you have a backup of your
database. It will help if the upgrade procedure fails (lack of disk
space, power off, any unexpected problem).
##### 2 备份当前的数据库
备份当前的数据库是非常重要的一步。升级前请确保是否先备份数据库。若升级失败（如因磁盘空间不足、断电或其他意外导致的升级失败），备份的数据库将大派用场。
##### 2 Back up the existing Zabbix database
This is a very important step. Make sure that you have a backup of your
database. It will help if the upgrade procedure fails (lack of disk
space, power off, any unexpected problem).
##### 2 备份现有Zabbix数据库
这是一个非常重要的步骤。请确保您已备份数据库。当升级过程失败时（如磁盘空间不足、断电或任何意外问题），备份将起到关键作用。
##### 2 Back up the existing Zabbix database
This is a very important step. Make sure that you have a backup of your
database. It will help if the upgrade procedure fails (lack of disk
space, power off, any unexpected problem).
##### 2 备份现有Zabbix数据库
这是一个非常重要的步骤。请确保您已备份数据库。当升级过程失败时（如磁盘空间不足、断电或任何意外问题），备份将起到关键作用。
##### 2 Back up the existing Zabbix database
This is a very important step. Make sure that you have a backup of your
database. It will help if the upgrade procedure fails (lack of disk
space, power off, any unexpected problem).
##### 2 备份现有Zabbix数据库
这是一个非常重要的步骤。请确保您已备份数据库。当升级过程失败时（如磁盘空间不足、断电或任何意外问题），备份将起到关键作用。
# 2 Bitwise functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Expressions are accepted as parameters
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
|FUNCTION|<|<|
|--|--|--|
|**Description**|**Function-specific parameters**|**Comments**|
|**bitand** (value,mask)|<|<|
|Value of "bitwise AND" of an item value and mask.|**value** - value to check<br>**mask** (mandatory) - 64-bit unsigned integer (0 - 18446744073709551615)|Supported value types: int<br><br>Although the comparison is done in a bitwise manner, all the values must be supplied and are returned in decimal. For example, checking for the 3rd bit is done by comparing to 4, not 100.<br><br>Examples:<br>=> **bitand**(last(/host/key),**12**)=8 or **bitand**(last(/host/key),**12**)=4 → 3rd or 4th bit set, but not both at the same time<br>=> **bitand**(last(/host/key),**20**)=16 → 3rd bit not set and 5th bit set.|
|**bitlshift** (value,bits to shift)|<|<|
|Bitwise shift left of an item value.|**value** - value to check<br>**bits to shift** (mandatory) - number of bits to shift|Supported value types: int<br><br>Although the comparison is done in a bitwise manner, all the values must be supplied and are returned in decimal. For example, checking for the 3rd bit is done by comparing to 4, not 100.|
|**bitnot** (value)|<|<|
|Value of "bitwise NOT" of an item value.|**value** - value to check<br>|Supported value types: int<br><br>Although the comparison is done in a bitwise manner, all the values must be supplied and are returned in decimal. For example, checking for the 3rd bit is done by comparing to 4, not 100.|
|**bitor** (value,mask)|<|<|
|Value of "bitwise OR" of an item value and mask.|**value** - value to check<br>**mask** (mandatory) - 64-bit unsigned integer (0 - 18446744073709551615)|Supported value types: int<br><br>Although the comparison is done in a bitwise manner, all the values must be supplied and are returned in decimal. For example, checking for the 3rd bit is done by comparing to 4, not 100.|
|**bitrshift** (value,bits to shift)|<|<|
|Bitwise shift right of an item value.|**value** - value to check<br>**bits to shift** (mandatory) - number of bits to shift|Supported value types: int<br><br>Although the comparison is done in a bitwise manner, all the values must be supplied and are returned in decimal. For example, checking for the 3rd bit is done by comparing to 4, not 100.|
|**bitxor** (value,mask)|<|<|
|Value of "bitwise exclusive OR" of an item value and mask.|**value** - value to check<br>**mask** (mandatory) - 64-bit unsigned integer (0 - 18446744073709551615)|Supported value types: int<br><br>Although the comparison is done in a bitwise manner, all the values must be supplied and are returned in decimal. For example, checking for the 3rd bit is done by comparing to 4, not 100.|
# 2 位运算函数
此处列出的所有函数均支持以下场景:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
关于函数参数的一般说明:
- 函数参数通过逗号分隔
- 表达式可作为参数传入
- 可选函数参数(或参数部分)通过
`<` `>`
`<` `>`
| 函数 | < | < |
|--|--|--|
| **Description** | **函数特定参数** | **说明** |
| **bitand** (value,mask) | < | < |
| Value of "bitwise AND" of an item value and mask. | **value** - 待检测值<br>**mask** (必填) - 64位无符号integer (0 - 18446744073709551615) | 支持的值类型: int<br><br>虽然执行的是按位比较，但所有值必须以十进制形式提供和返回。例如检测第3位需与4比较而非100。<br><br>示例:<br>=> **bitand**(last(/主机/key),**12**)=8 或 **bitand**(last(/主机/key),**12**)=4 → 第3位或第4位被置位，但不同时置位<br>=> **bitand**(last(/主机/key),**20**)=16 → 第3位未置位且第5位置位 |
| **bitlshift** (value,bits to shift) | < | < |
| Bitwise shift left of an item value. | **value** - 待检测值<br>**bits to shift** (必填) - 位移位数 | 支持的值类型: int<br><br>虽然执行的是按位比较，但所有值必须以十进制形式提供和返回。例如检测第3位需与4比较而非100。 |
| **bitnot** (value) | < | < |
| Value of "bitwise NOT" of an item value. | **value** - 待检测值<br> | 支持的值类型: int<br><br>虽然执行的是按位比较，但所有值必须以十进制形式提供和返回。例如检测第3位需与4比较而非100。 |
| **bitor** (value,mask) | < | < |
| Value of "bitwise OR" of an item value and mask. | **value** - 待检测值<br>**mask** (必填) - 64位无符号integer (0 - 18446744073709551615) | 支持的值类型: int<br><br>虽然执行的是按位比较，但所有值必须以十进制形式提供和返回。例如检测第3位需与4比较而非100。 |
| **bitrshift** (value,bits to shift) | < | < |
| Bitwise shift right of an item value. | **value** - 待检测值<br>**bits to shift** (必填) - 位移位数 | 支持的值类型: int<br><br>虽然执行的是按位比较，但所有值必须以十进制形式提供和返回。例如检测第3位需与4比较而非100。 |
| **bitxor** (value,mask) | < | < |
| Value of "bitwise exclusive OR" of an item value and mask. | **value** - 待检测值<br>**mask** (必填) - 64位无符号integer (0 - 18446744073709551615) | 支持的值类型: int<br><br>虽然执行的是按位比较，但所有值必须以十进制形式提供和返回。例如检测第3位需与4比较而非100。 |
# 2 Building Zabbix agent 2 on Windows
# 2 在Windows上构建Zabbix agent 2
# 2 Certificate problems
# 2 证书问题
# 2 Clock
# 2 时钟
# 2 Clock
# 2 时钟
# 2 Configuring a host group
# 2 配置主机组
# 2 Custom graphs
# 2 自定义图表
# 2 Custom intervals
# 2 自定义间隔
# 2 Debian/Ubuntu
# 2 Debian/Ubuntu
# 2 Debian/Ubuntu/Raspbian
# 2 Debian/Ubuntu/Raspbian
# 2 Definitions
# 2 定义
# 2 Discovery of network interfaces
In a similar way as [file
systems](/manual/discovery/low_level_discovery#configuring_low-level_discovery)
are discovered, it is possible to also discover network interfaces.
# 2 网络接口发现
与[file
systems](/manual/discovery/low_level_discovery#configuring_low-level_discovery)的发现方式类似
也可以发现网络接口
# 2 Docker plugin
# 2 Docker 插件
2. Do not use "ps -ef" to browse processes - it shows only non-kernel processes. Use "ps -Af" to see all processes which will be seen by Zabbix agent.
3. Let's go through example of 'topasrec' how Zabbix agent proc.mem[] selects processes.
```
$ ps -Af | grep topasrec
root 10747984 1 0 Mar 16 - 0:00 /usr/bin/topasrec -L -s 300 -R 1 -r 6 -o /var/perf daily/ -ypersistent=1 -O type=bin -ystart_time=04:08:54,Mar16,2023
```
proc.mem[] has arguments:
```
proc.mem[<name>,<user>,<mode>,<cmdline>,<memtype>]
```
2. 不要使用"ps -ef"浏览进程 - 它仅显示非内核进程。使用"ps -Af"查看所有进程，这些进程将被Zabbix agent识别。
3. 让我们通过'topasrec'示例了解Zabbix agent proc.mem[]如何选择进程。
```
$ ps -Af | grep topasrec
root 10747984 1 0 Mar 16 - 0:00 /usr/bin/topasrec -L -s 300 -R 1 -r 6 -o /var/perf daily/ -ypersistent=1 -O type=bin -ystart_time=04:08:54,Mar16,2023
```
proc.mem[] 包含以下参数:
```
proc.mem[<name>,<user>,<mode>,<cmdline>,<memtype>]
```
# 2 Frontend sections
Please use the sidebar to access content in the Frontend sections section.
# 2 前端部分
请使用侧边栏访问前端部分的内容。
# 2 Global event correlation
# 2 全局事件关联
# 2 Host group elements
# 2 主机组元素
# 2 Hosts
# 2 主机
# 2 Inventory
# 2 库存
# 2 Items
# 2 监控项
# 2 Item value preprocessing
# 2 监控项值预处理
# 2 Linking/unlinking
# 2 关联/取消关联
# 2 Network maps
# 2 网络拓扑图
# 2 Network maps
[comment]: # (tags: map)
# 2 网络拓扑图
[comment]: # (tags: map)
# 2 New host
# 2 新主机
# 2 Operations
# 2 操作
# 2 Other event sources
# 2 其他事件源
# 2 Permissions
# 2 权限
# 2 PostgreSQL encryption configuration
[comment]: # (tags: ssl)
# 2 PostgreSQL 加密配置
[comment]: # (tags: ssl)
# 2 Preprocessing details
# 2 预处理详情
# 2 Problems
# 2 问题
# 2 Process configuration
Please use the sidebar to access content in this section.
# 2 进程配置
请使用侧边栏访问本节内容。
# 2 Proxies
# 2 Proxies
# 2 Real-life scenario
# 2 实际场景
# 2 Recommended UnixODBC settings for PostgreSQL
# 2 针对 PostgreSQL 的推荐 UnixODBC 设置
# 2 Remote commands
# 2 远程命令
# 2 Repairing Zabbix database character set and collation
# 2 修复Zabbix数据库字符集与排序规则
# 2 Requirements
# 2 要求
# 2 Scheduled reports
# 2 计划报告
# 2 Service actions
# 2 服务操作
# 2 Service actions
# 2 服务操作
# 2 Services
# 2 服务
# 2 Setup from RHEL packages
# 2 从 RHEL 包安装
# 2 Setup from RHEL packages
# 2 从 RHEL 软件包安装
# 2 SMS
# 2 条短信
# 2 SNMP agent
# 2 SNMP代理
# 2 SNMP agent
[comment]: # (tags: snmp)
# 2 SNMP agent
[comment]: # (tags: snmp)
# 2 Sound in browsers
# 2 浏览器声音
# 2 Special OIDs
Some of the most used SNMP OIDs are translated automatically to a
numeric representation by Zabbix. For example, **ifIndex** is translated
to **1.3.6.1.2.1.2.2.1.1**, **ifIndex.0** is translated to
**1.3.6.1.2.1.2.2.1.1.0**.
The table contains list of the special OIDs.
|Special OID|Identifier|Description|
|--|--|------|
|ifIndex|1.3.6.1.2.1.2.2.1.1|A unique value for each interface.|
|ifDescr|1.3.6.1.2.1.2.2.1.2|A textual string containing information about the interface.This string should include the name of the manufacturer, the product name and the version of the hardware interface.|
|ifType|1.3.6.1.2.1.2.2.1.3|The type of interface, distinguished according to the physical/link protocol(s) immediately 'below' the network layer in the protocol stack.|
|ifMtu|1.3.6.1.2.1.2.2.1.4|The size of the largest datagram which can be sent / received on the interface, specified in octets.|
|ifSpeed|1.3.6.1.2.1.2.2.1.5|An estimate of the interface's current bandwidth in bits per second.|
|ifPhysAddress|1.3.6.1.2.1.2.2.1.6|The interface's address at the protocol layer immediately \`below' the network layer in the protocol stack.|
|ifAdminStatus|1.3.6.1.2.1.2.2.1.7|The current administrative state of the interface.|
|ifOperStatus|1.3.6.1.2.1.2.2.1.8|The current operational state of the interface.|
|ifInOctets|1.3.6.1.2.1.2.2.1.10|The total number of octets received on the interface, including framing characters.|
|ifInUcastPkts|1.3.6.1.2.1.2.2.1.11|The number of subnetwork-unicast packets delivered to a higher-layer protocol.|
|ifInNUcastPkts|1.3.6.1.2.1.2.2.1.12|The number of non-unicast (i.e., subnetwork- broadcast or subnetwork-multicast) packets delivered to a higher-layer protocol.|
|ifInDiscards|1.3.6.1.2.1.2.2.1.13|The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space.|
|ifInErrors|1.3.6.1.2.1.2.2.1.14|The number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol.|
|ifInUnknownProtos|1.3.6.1.2.1.2.2.1.15|The number of packets received via the interface which were discarded because of an unknown or unsupported protocol.|
|ifOutOctets|1.3.6.1.2.1.2.2.1.16|The total number of octets transmitted out of the interface, including framing characters.|
|ifOutUcastPkts|1.3.6.1.2.1.2.2.1.17|The total number of packets that higher-level protocols requested be transmitted, and which were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent.|
|ifOutNUcastPkts|1.3.6.1.2.1.2.2.1.18|The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent.|
|ifOutDiscards|1.3.6.1.2.1.2.2.1.19|The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.|
|ifOutErrors|1.3.6.1.2.1.2.2.1.20|The number of outbound packets that could not be transmitted because of errors.|
|ifOutQLen|1.3.6.1.2.1.2.2.1.21|The length of the output packet queue (in packets).|
# 2 特殊 OID
Zabbix会自动将一些最常用的SNMP OID转换为数字表示形式。例如，**ifIndex**会被转换为**1.3.6.1.2.1.2.2.1.1**，**ifIndex.0**会被转换为**1.3.6.1.2.1.2.2.1.1.0**。
该表格包含了特殊OID的列表。
| 特殊OID | 标识符 | 描述 |
|--|--|------|
| ifIndex | 1.3.6.1.2.1.2.2.1.1 | 每个接口的唯一值。 |
| ifDescr | 1.3.6.1.2.1.2.2.1.2 | 包含接口信息的文本string。该string应包括制造商名称、产品名称和硬件接口的version。 |
| ifType | 1.3.6.1.2.1.2.2.1.3 | 接口类型，根据协议栈中网络层下方物理/链路协议进行区分。 |
| ifMtu | 1.3.6.1.2.1.2.2.1.4 | 接口上可发送/接收的最大数据报大小，以八位字节为单位。 |
| ifSpeed | 1.3.6.1.2.1.2.2.1.5 | 接口当前带宽的估计值，以比特每秒为单位。 |
| ifPhysAddress | 1.3.6.1.2.1.2.2.1.6 | 接口在协议栈中网络层下方协议层的地址。 |
| ifAdminStatus | 1.3.6.1.2.1.2.2.1.7 | 接口的当前管理状态。 |
| ifOperStatus | 1.3.6.1.2.1.2.2.1.8 | 接口的当前运行状态。 |
| ifInOctets | 1.3.6.1.2.1.2.2.1.10 | 接口上接收到的总八位字节数，包括帧字符。 |
| ifInUcastPkts | 1.3.6.1.2.1.2.2.1.11 | 传递给更高层协议的子网单播数据包数量。 |
| ifInNUcastPkts | 1.3.6.1.2.1.2.2.1.12 | 传递给更高层协议的非单播（即子网广播或子网多播）数据包数量。 |
| ifInDiscards | 1.3.6.1.2.1.2.2.1.13 | 即使未检测到错误，仍被选择丢弃的入站数据包数量，以防止其传递给更高层协议。丢弃此类数据包的一个可能原因是释放缓冲区空间。 |
| ifInErrors | 1.3.6.1.2.1.2.2.1.14 | 包含错误导致无法传递给更高层协议的入站数据包数量。 |
| ifInUnknownProtos | 1.3.6.1.2.1.2.2.1.15 | 通过接口接收但因未知或不支持的协议而被丢弃的数据包数量。 |
| ifOutOctets | 1.3.6.1.2.1.2.2.1.16 | 从接口传输出去的总八位字节数，包括帧字符。 |
| ifOutUcastPkts | 1.3.6.1.2.1.2.2.1.17 | 更高层协议请求传输且未在此子层寻址到多播或广播地址的数据包总数，包括被丢弃或未发送的数据包。 |
| ifOutNUcastPkts | 1.3.6.1.2.1.2.2.1.18 | 更高层协议请求传输且在此子层寻址到多播或广播地址的数据包总数，包括被丢弃或未发送的数据包。 |
| ifOutDiscards | 1.3.6.1.2.1.2.2.1.19 | 即使未检测到错误，仍被选择丢弃的出站数据包数量，以防止其传输。丢弃此类数据包的一个可能原因是释放缓冲区空间。 |
| ifOutErrors | 1.3.6.1.2.1.2.2.1.20 | 因错误而无法传输的出站数据包数量。 |
| ifOutQLen | 1.3.6.1.2.1.2.2.1.21 | 输出数据包队列的长度（以数据包为单位）。 |
# 2 Templates
# 2 模板
# 2 Templates
# 2 模板
# 2 Trigger expression
# 2 触发器表达式
# 2 Trigger prototypes
# 2 触发器原型
# 2 Trigger prototypes
# 2 触发器原型
# 2 Trigger prototypes
We create trigger prototypes in a similar way as item prototypes:
Attributes that are specific for trigger prototypes:
|Parameter|Description|
|--|--------|
|*Create enabled*|If checked the trigger will be added in an enabled state.<br>If unchecked, the trigger will be added to a discovered entity, but in a disabled state.|
|*Discover*|If checked (default) the trigger will be added to a discovered entity.<br>If unchecked, the trigger will not be added to a discovered entity, unless this setting is [overridden](/manual/discovery/low_level_discovery#override) in the discovery rule.|
When real triggers are created from the prototypes, there may be a need
to be flexible as to what constant ('20' in our example) is used for
comparison in the expression. See how [user macros with
context](/manual/config/macros/user_macros_context#use-cases)
can be useful to accomplish such flexibility.
You can define [dependencies](/manual/config/triggers/dependencies)
between trigger prototypes as well (supported since Zabbix 3.0). To do
that, go to the *Dependencies* tab. A trigger prototype may depend on
another trigger prototype from the same low-level discovery (LLD) rule
or on a regular trigger. A trigger prototype may not depend on a trigger
prototype from a different LLD rule or on a trigger created from trigger
prototype. Host trigger prototype cannot depend on a trigger from a
template.
# 2 触发器原型
我们create触发器原型的方式与监控项原型类似:
触发器原型特有的属性:
| 参数 | 描述 |
|--|--------|
| *Create enabled* | 如果勾选，触发器将以启用状态添加。<br>如果未勾选，触发器将被添加到发现实体中，但处于禁用状态。 |
| *Discover* | 如果勾选(默认)，触发器将被添加到发现实体中。<br>如果未勾选，触发器将不会被添加到发现实体中，除非在发现规则中[覆盖](/manual/discovery/low_level_discovery#覆盖)此设置。 |
当从原型创建实际触发器时，可能需要灵活调整表达式中的比较常量(在我们的示例中是'20')。了解如何[使用场景](/manual/config/macros/user_macros_context#使用场景)可以帮助实现这种灵活性。
您也可以定义[dependencies](/manual/config/triggers/dependencies)触发器原型之间的依赖关系(自Zabbix 3.0起支持)。要实现这一点，请转到*依赖关系*选项卡。一个触发器原型可以依赖于来自同一低级发现(LLD)规则的另一个触发器原型，或者依赖于常规触发器。一个触发器原型不能依赖于来自不同LLD规则的触发器原型，也不能依赖于从触发器原型创建的触发器。主机触发器原型不能依赖于模板中的触发器。
# 2 Triggers
# 2 触发器
# 2 Triggers
# 2 触发器
# 2 Upgrade from packages
# 2 从软件包升级
# 2 User macros
# 2 用户宏
# 2 User macros supported by location
# 2 按位置支持的用户宏
# 2 Using pre-shared keys
# 2 使用预共享密钥
# 2 vm.memory.size parameters
# 2 个 vm.memory.size 参数
# 2 Web scenarios
# 2 Web 场景
# 2 What is Zabbix
# 2 什么是 Zabbix
# 2 Windows-specific item keys
# 2 个 Windows 特定的 监控项 键
# 2 Zabbix agent protocol
Please refer to [Passive and active agent
checks](/manual/appendix/items/activepassive) page for more information.
# 2 Zabbix agent 协议
更多信息请参阅[Passive and active agent
checks](/manual/appendix/items/activepassive)页面。
# 2 Zabbix proxy
# 2 Zabbix proxy
# 30 Upgrade notes for 6.0.20
This minor version doesn't have any upgrade notes.
# 30 6.0.20 版本升级说明
此次要version没有任何升级说明。
# 30 What's new in Zabbix 6.0.25
# 30 Zabbix 6.0.25 的新特性
# 31 Upgrade notes for 6.0.21
# 31 6.0.21 版本升级说明
# 31 What's new in Zabbix 6.0.26
# 31 Zabbix 6.0.26 新特性
##### 32 bit
Open MinGW environment (Windows command prompt) and navigate to
*build/mingw* directory in the Zabbix source tree.
Run:
mingw32-make clean
mingw32-make ARCH=x86 PCRE=c:\dev\pcre32 OPENSSL=c:\dev\openssl32
##### 32位
打开MinGW环境（Windows命令提示符）并导航至
Zabbix源代码树的*build/mingw*目录。
运行：
mingw32-make clean
mingw32-make ARCH=x86 PCRE=c:\dev\pcre32 OPENSSL=c:\dev\openssl32
# 32 Upgrade notes for 6.0.22
# 32 6.0.22 版本升级说明
# 32 What's new in Zabbix 6.0.27
# 32 Zabbix 6.0.27 新特性
# 33 Upgrade notes for 6.0.23
# 33 6.0.23 版本升级说明
# 33 What's new in Zabbix 6.0.28
# 33 Zabbix 6.0.28 新特性
# 34 Upgrade notes for 6.0.24
# 34 6.0.24 版本升级说明
# 34 What's new in Zabbix 6.0.29
# 34 Zabbix 6.0.29 新特性
# 35 Upgrade notes for 6.0.25
# 35 6.0.25 版本升级说明
# 35 What's new in Zabbix 6.0.30
# 35 Zabbix 6.0.30 新特性
# 36 Upgrade notes for 6.0.26
This minor version doesn't have any upgrade notes.
# 36 6.0.26 版本升级说明
此次要version没有相关的升级说明。
# 36 What's new in Zabbix 6.0.31
# Zabbix 6.0.31 的新特性
# 37 Upgrade notes for 6.0.27
# 37 6.0.27 版本升级说明
# 37 What's new in Zabbix 6.0.32
# 37 Zabbix 6.0.32 的新特性
# 38 Upgrade notes for 6.0.28
# 38 6.0.28 版本升级说明
# 38 What's new in Zabbix 6.0.33
# 38 Zabbix 6.0.33 的新特性
# 39 Upgrade notes for 6.0.29
This minor version doesn't have any upgrade notes.
# 39 6.0.29 版本升级说明
此次要version没有任何升级说明。
# 39 What's new in Zabbix 6.0.34
# 39 Zabbix 6.0.34 新特性
# 3 Additional operations
# 3 附加操作
# 3 Ad-hoc graphs
# 3 临时图表
# 3 Agent 2
# 3 Agent 2
# 3 Authentication
# 3 身份认证
# 3 Authentication
[comment]: # (tags: ldap, saml)
# 3 认证
[comment]: # (标签: ldap, saml)
# 3 Availability report
# 3 可用性报告
##### 3 Back up configuration files, PHP files and Zabbix binaries
Make a backup copy of Zabbix binaries, configuration files and the PHP
file directory.
##### 3 备份配置文件、PHP 文件及 Zabbix 二进制文件
对Zabbix二进制文件、配置文件及PHPfile目录进行copy备份操作
##### 3 Back up configuration files, PHP files and Zabbix binaries
Make a backup copy of Zabbix binaries, configuration files and the PHP
file directory.
Configuration files:
mkdir /opt/zabbix-backup/
cp /etc/zabbix/zabbix_server.conf /opt/zabbix-backup/
cp /etc/apache2/conf-enabled/zabbix.conf /opt/zabbix-backup/
PHP files and Zabbix binaries:
cp -R /usr/share/zabbix/ /opt/zabbix-backup/
cp -R /usr/share/zabbix-* /opt/zabbix-backup/
##### 3 备份配置文件、PHP 文件及 Zabbix 二进制文件
备份 copy Zabbix二进制文件、配置文件和PHP
file 目录
配置文件:
mkdir /opt/zabbix-backup/
cp /etc/zabbix/zabbix_server.conf /opt/zabbix-backup/
cp /etc/apache2/conf-enabled/zabbix.conf /opt/zabbix-backup/
PHP文件和Zabbix二进制文件:
cp -R /usr/share/zabbix/ /opt/zabbix-backup/
cp -R /usr/share/zabbix-* /opt/zabbix-backup/
##### 3 Back up configuration files, PHP files and Zabbix binaries
Make a backup copy of Zabbix binaries, configuration files and the PHP
file directory.
Configuration files:
# mkdir /opt/zabbix-backup/
# cp /etc/zabbix/zabbix_server.conf /opt/zabbix-backup/
# cp /etc/httpd/conf.d/zabbix.conf /opt/zabbix-backup/
PHP files and Zabbix binaries:
# cp -R /usr/share/zabbix/ /opt/zabbix-backup/
# cp -R /usr/share/zabbix-* /opt/zabbix-backup/
##### 3 备份配置文件、PHP 文件及 Zabbix 二进制文件
对Zabbix二进制文件、配置文件和PHP copy目录进行备份file。
配置文件：
# mkdir /opt/zabbix-backup/
# cp /etc/zabbix/zabbix_server.conf /opt/zabbix-backup/
# cp /etc/httpd/conf.d/zabbix.conf /opt/zabbix-backup/
PHP文件和Zabbix二进制文件：
# cp -R /usr/share/zabbix/ /opt/zabbix-backup/
# cp -R /usr/share/zabbix-* /opt/zabbix-backup/
##### 3 Back up configuration files, PHP files and Zabbix binaries
Make a backup copy of Zabbix binaries, configuration files and the PHP
file directory.
Configuration files:
mkdir /opt/zabbix-backup/
cp /etc/zabbix/zabbix_server.conf /opt/zabbix-backup/
cp /etc/httpd/conf.d/zabbix.conf /opt/zabbix-backup/
PHP files and Zabbix binaries:
cp -R /usr/share/zabbix/ /opt/zabbix-backup/
cp -R /usr/share/zabbix-* /opt/zabbix-backup/
##### 3 备份配置文件、PHP 文件及 Zabbix 二进制文件
对Zabbix二进制文件、配置文件及PHP copy目录进行备份file
配置文件:
mkdir /opt/zabbix-backup/
cp /etc/zabbix/zabbix_server.conf /opt/zabbix-backup/
cp /etc/httpd/conf.d/zabbix.conf /opt/zabbix-backup/
PHP文件及Zabbix二进制文件:
cp -R /usr/share/zabbix/ /opt/zabbix-backup/
cp -R /usr/share/zabbix-* /opt/zabbix-backup/
# 3 Building Zabbix agent on macOS
# 3 在macOS上构建Zabbix agent
##### 3 Create Zabbix database
For Zabbix [server](/manual/concepts/server) and
[proxy](/manual/concepts/proxy) daemons, as well as Zabbix frontend, a
database is required. It is not needed to run Zabbix
[agent](/manual/concepts/agent).
SQL [scripts are provided](/manual/appendix/install/db_scripts) for
creating database schema and inserting the dataset. Zabbix proxy
database needs only the schema while Zabbix server database requires
also the dataset on top of the schema.
Having created a Zabbix database, proceed to the following steps of
compiling Zabbix.
##### 3 创建 Zabbix 数据库
对于Zabbix [server](/manual/concepts/server)和
[proxy](/manual/concepts/proxy)守护进程，以及Zabbix前端来说，
都需要数据库支持。但run Zabbix
[agent](/manual/concepts/agent)时不需要数据库。
SQL [scripts are provided](/manual/appendix/install/db_scripts)用于
创建数据库模式并插入数据集。Zabbix proxy
数据库仅需要模式，而Zabbix server数据库在
Top模式之外还需要数据集。
创建好Zabbix数据库后，请继续执行Zabbix编译的后续步骤。
# 3 Custom alert scripts
# 3 自定义告警脚本
# 3 Dashboards
[Dashboards](/manual/web_interface/frontend_sections/monitoring/dashboard)
and their widgets provide a strong visualization platform with such
tools as modern graphs, maps, slideshows, and many more.
{width="600"}
# 3 仪表板
[Dashboards](/manual/web_interface/frontend_sections/monitoring/dashboard)
及其小部件提供了强大的可视化平台，包含现代图表、地图、幻灯片等多种工具。
{width="600"}
# 3 Database upgrade to primary keys
# 3 数据库升级至主键
# 3 Data overview
# 3 数据概览
# 3 Data overview
# 3 数据概览
# 3 Date and time functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
::: noteimportant
Date and time functions cannot be used in the expression by themselves; at least one function from [another group](/manual/appendix/functions), referencing the host item, must be included in the expression (except the nodata function). For detailed information on how date and time functions work within expressions, see [Calculation time](/manual/config/triggers#calculation_time).
:::
|FUNCTION|<|<|
|--|--|--|
|**Description**|**Function-specific parameters**|**Comments**|
|**date**|<|<|
|Current date in YYYYMMDD format.| |Example:<br>=> **date**()<20220101|
|**dayofmonth**|<|<|
|Day of month in range of 1 to 31.| |Example:<br>=> **dayofmonth**()=1|
|**dayofweek**|<|<|
|Day of week in range of 1 to 7 (Mon - 1, Sun - 7).| |Example (only weekdays):<br>=> **dayofweek**()<6<br><br>Example (only weekend):<br>=> **dayofweek**()>5|
|**now**|<|<|
|Number of seconds since the Epoch (00:00:00 UTC, January 1, 1970).| |Example:<br>=> **now**()<1640998800|
|**time**|<|<|
|Current time in HHMMSS format.| |Example (only nighttime, 00:00-06:00):<br>=> **time**()<060000|
# 3 日期时间函数
以下列出的所有函数均支持于:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
::: noteimportant
日期时间函数不能单独在表达式中使用，必须至少包含一个来自[another group](/manual/appendix/functions)的函数（引用主机 监控项），但nodata函数除外。有关日期时间函数在表达式中如何工作的详细信息，请参阅[计算时间](/manual/config/triggers#计算时间)。
:::
| 函数 | < | < |
|--|--|--|
| **Description** | **函数特定参数** | **说明** |
| **date** | < | < |
| Current date in YYYYMMDD format. | | 示例:<br>=> **date**()<20220101 |
| **dayofmonth** | < | < |
| Day of month in range of 1 to 31. | | 示例:<br>=> **dayofmonth**()=1 |
| **dayofweek** | < | < |
| Day of week in range of 1 to 7 (Mon - 1, Sun - 7). | | 示例（仅工作日）:<br>=> **dayofweek**()<6<br><br>示例（仅周末）:<br>=> **dayofweek**()>5 |
| **now** | < | < |
| Number of seconds since the Epoch (00:00:00 UTC, January 1, 1970). | | 示例:<br>=> **now**()<1640998800 |
| **time** | < | < |
| Current time in HHMMSS format. | | 示例（仅夜间时段00:00-06:00）:<br>=> **time**()<060000 |
# 3 Discovery of CPUs and CPU cores
In a similar way as [file
systems](/manual/discovery/low_level_discovery#configuring_low-level_discovery)
are discovered, it is possible to also discover CPUs and CPU cores.
# 3 CPU 与 CPU 核心的发现
与[file
systems](/manual/discovery/low_level_discovery#configuring_low-level_discovery)的发现方式类似，也可以发现CPU和CPU核心。
# 3 Ember+ plugin
# 3 Ember+ 插件
# 3 Graph prototypes
# 3 图表原型
# 3 Graph prototypes
# 3 图表原型
# 3 Graph prototypes
We can create graph prototypes, too:
Attributes that are specific for graph prototypes:
|Parameter|Description|
|--|--------|
|*Discover*|If checked (default) the graph will be added to a discovered entity.<br>If unchecked, the graph will not be added to a discovered entity, unless this setting is [overridden](/manual/discovery/low_level_discovery#override) in the discovery rule.|
Finally, we have created a discovery rule that looks as shown below. It
has five item prototypes, two trigger prototypes, and one graph
prototype.
*Note*: For configuring host prototypes, see the section about [host
prototype](/manual/vm_monitoring#host_prototypes) configuration in
virtual machine monitoring.
# 3 图表原型
我们也可以create图形原型:
图形原型特有的属性:
| 参数 | 描述 |
|--|--------|
| *Discover* | 如果勾选(默认)，图形将被添加到发现的实体中。<br>如果不勾选，除非在发现规则中[覆盖](/manual/discovery/low_level_discovery#覆盖)此设置，否则图形不会被添加到发现的实体中。 |
最终，我们创建了一个如下所示的发现规则。它
包含五个监控项原型、两个触发器原型和一个图形
原型。
*注意*: 关于配置主机原型，请参阅虚拟机监控中关于[主机原型](/manual/vm_monitoring#主机原型)配置的部分。
# 3 Graphs
# 3 图形
# 3 Graphs
# 3 图形
# 3 Hosts
# 3 主机
# 3 Hosts
# 3 主机
# 3 Hosts
# 3 主机
# 3 Installation from sources
You can get the very latest version of Zabbix by compiling it from the
sources.
A step-by-step tutorial for installing Zabbix from the sources is
provided here.
# 3 从源代码安装
您可以通过从源代码编译来get最新version的Zabbix.
这里提供了从源代码安装Zabbix的逐步教程.
##### 3 Install new agent binaries
Use these
[instructions](/manual/installation/install#installing_zabbix_daemons)
to compile Zabbix agent from sources.
Alternatively, you may download pre-compiled Zabbix agents from the
[Zabbix download page](http://www.zabbix.com/download.php).
##### 3 安装新的 agent 二进制文件
使用这些
[安装-zabbix-守护进程](/manual/installation/install#安装-zabbix-守护进程)
从源代码编译Zabbix agent.
或者，您可以从
[Zabbix download page](http://www.zabbix.com/download.php)
下载预编译的Zabbix agents.
##### 3 Install new proxy binaries
Use these
[instructions](/manual/installation/install#installing_zabbix_daemons)
to compile Zabbix proxy from sources.
##### 3 安装新的 proxy 二进制文件
使用这些
[安装-zabbix-守护进程](/manual/installation/install#安装-zabbix-守护进程)
从源代码编译Zabbix proxy.
# 3 Inventory
# 3 资产清单
# 3 Inventory
# 3 资产清单
# 3 Item types
# 3 监控项 类型
# 3 JSONPath functionality
# 3 JSONPath 功能
# 3 Link indicators
# 3 链接指示器
# 3 Low-level discovery
# 3 低级发现
# 3 Manual closing of problems
# 3 手动关闭问题
# 3 MIB files
# 3 MIB文件
# 3 Nesting
# 3 嵌套
# 3 New item
# 3 新建 监控项
# 3 Passive and active agent checks
# 3 被动与主动 agent 检查
# 3 Passive and active agent checks
# 3 被动和主动Agent检查
# 3 Protocols
Please use the sidebar to access content in this section.
# 3 协议
请使用侧边栏访问本节内容。
# 3 PSK problems
[comment]: # (tags: ssl)
# 3 个 PSK 问题
[comment]: # (tags: ssl)
# 3 Receiving notification on unsupported items
# 3 接收关于不受支持的 监控项 的通知
# 3 Recommended UnixODBC settings for Oracle
# 3 适用于 Oracle 的推荐 UnixODBC 设置
# 3 Recovery operations
# 3 恢复操作
# 3 Reports
# 3 报告
# 3 Setup from Debian/Ubuntu packages
# 3 从Debian/Ubuntu软件包安装
# 3 SLA
# 3 SLA
# 3 SLA
# 3 SLA
# 3 SNMP traps
# 3 SNMP陷阱
# 3 SUSE Linux Enterprise Server
# 3 SUSE Linux Enterprise Server
# 3 Trigger dependencies
# 3 触发器依赖
# 3 Triggers
# 3 触发器
# 3 Troubleshooting
# 3 故障排除
# 3 User groups
# 3 用户组
# 3 User macros with context
# 3 带上下文的用户宏
# 3 User settings
# 3 用户设置
# 3 Zabbix agent 2 protocol
# 3 Zabbix agent 2 协议
# 3 Zabbix agent (UNIX)
# 3 Zabbix agent (UNIX)
# 3 Zabbix features
# 3 项 Zabbix 功能
# 3 Zabbix processes
Please use the sidebar to access content in the Zabbix process section.
# 3 个 Zabbix 进程
请使用侧边栏访问Zabbix流程部分的内容。
# 40 Upgrade notes for 6.0.30
This minor version doesn't have any upgrade notes.
# 40 6.0.30版本升级说明
此次次要版本没有任何升级说明。
# 40 What's new in Zabbix 6.0.35
# 40 Zabbix 6.0.35 新特性
# 41 Upgrade notes for 6.0.31
This minor version doesn't have any upgrade notes.
# 41 6.0.31 版本升级说明
此次要version没有升级说明。
# 41 What's new in Zabbix 6.0.36
# 41 Zabbix 6.0.36 新特性
# 42 Upgrade notes for 6.0.32
# 42 6.0.32 版本升级说明
# 42 What's new in Zabbix 6.0.37
This minor version does not have any functional changes.
# 42 Zabbix 6.0.37 新特性
此次要version不包含任何功能性变更.
# 43 Upgrade notes for 6.0.33
This minor version does not have any upgrade notes.
# 43 6.0.33 版本升级说明
此次要version没有任何升级说明。
# 43 What's new in Zabbix 6.0.38
See [breaking changes](/manual/installation/upgrade_notes_6038#breaking-changes) for this version.
# 43 Zabbix 6.0.38 新特性
有关version请参阅[重大变更](/manual/installation/upgrade_notes_6038#重大变更).
# 44 Upgrade notes for 6.0.34
# 44 6.0.34 版本升级说明
# 44 What's new in Zabbix 6.0.39
See [breaking changes](/manual/installation/upgrade_notes_6039#breaking-changes) for this version.
# 44 Zabbix 6.0.39 新特性
有关version的详情，请参阅[重大变更](/manual/installation/upgrade_notes_6039#重大变更)。
# 45 Upgrade notes for 6.0.35
# 45 6.0.35 版本升级说明
# 45 What's new in Zabbix 6.0.40
# 45 Zabbix 6.0.40 新特性
# 46 Upgrade notes for 6.0.36
This minor version does not have any upgrade notes.
# 46 6.0.36 版本升级说明
此次要version版本没有任何升级说明。
# 46 What's new in Zabbix 6.0.41
# 46 Zabbix 6.0.41 新特性
# 47 Upgrade notes for 6.0.37
This minor version does not have any upgrade notes.
# 47 6.0.37 版本升级说明
此次要version没有任何升级说明。
# 47 What's new in Zabbix 6.0.42
# 47 What's new in Zabbix 6.0.42
# 48 Upgrade notes for 6.0.38
# 48 6.0.38 版本升级说明
# 49 Upgrade notes for 6.0.39
# 49 6.0.39 版本升级注意事项
# 4 Aggregation in graphs
# 4 图表中的聚合
# 4 Configuration
# 4 配置
# 4 Discovery of SNMP OIDs
# 4 SNMP OID 发现
# 4 Discovery rules
# 4 发现规则
# 4 Discovery rules
# 4 发现规则
# 4 Discovery status
# 4 发现状态
# 4 Global search
It is possible to search Zabbix frontend for hosts, host groups and
templates.
The search input box is located below the Zabbix logo in the menu. The
search can be started by pressing *Enter* or clicking on the
 search
icon.
If there is a host that contains the entered string in any part of the
name, a dropdown will appear, listing all such hosts (with the matching
part highlighted in orange). The dropdown will also list a host if that
host's visible name is a match to the technical name entered as a search
string; the matching host will be listed, but without any highlighting.
# 4 全局搜索
可以在Zabbix前端中搜索主机、主机组和
模板
搜索输入框位于菜单中Zabbix徽标下方。
搜索可通过按下*Enter*键或点击开始
 搜索
图标.
如果存在一个主机包含输入的任何部分的string
名称, 将出现一个下拉菜单, 列出所有此类主机 (包含匹配的
橙色高亮部分）。下拉菜单还会列出一个主机（如果存在）
主机的可见名称与作为搜索输入的技术名称相匹配
string; 匹配的 主机 将被列出，但不会进行任何高亮显示。
# 4 History and trends
# 4 历史数据与趋势
# 4 History functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
- Function-specific parameters are described with each function
- `/host/key` and `(sec|#num)<:time shift>` parameters must never be
quoted
# 4 历史数据函数
此处列出的所有函数均支持以下场景:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
关于函数参数的通用说明:
- 函数参数之间用逗号分隔
- 可选函数参数(或参数部分)用`<` `>`表示
- 函数特定参数将在各函数中单独说明
- `/host/key`和`(sec|#num)<:time shift>`参数绝对不可加引号
# 4 Host dashboards
# 4 主机仪表盘
# 4 Host prototypes
# 4 主机原型
# 4 Host prototypes
# 4 主机原型
# 4 Installation from packages
# 4 从软件包安装
# 4 Installation
Please use the sidebar to access content in the Installation section.
# 4 安装
请使用侧边栏访问安装部分的内容。
#### 4 Installing Zabbix web service
Installing Zabbix web service is only required if you want to use
[scheduled
reports](/manual/web_interface/frontend_sections/reports/scheduled).
To install from sources, first
[download](/manual/installation/install#download_the_source_archive) and
extract the source archive.
To compile Zabbix web service, run the `./configure` script with
`--enable-webservice` option.
::: noteclassic
A configured [Go](https://golang.org/doc/install) version
1.13+ environment is required for building Zabbix web service.
:::
#### 4 安装Zabbix网络服务
只有当你想用[预设报告](/manual/web_interface/frontend_sections/reports/scheduled) 事才需要安装Zabbix网络服务。
从源安装，先[下载](/manual/installation/install#download_the_source_archive) 并提取归档数据。
要编译 Zabbix 网络服务，运行 `./configure` 脚本和 `--enable-webservice` 选项。
::: noteclassic
构建Zabbix网络服务需要配置好的1.13以上版本环境的 [Go](https://golang.org/doc/install)。
:::
##### 4 Install new server binaries
Use these
[instructions](/manual/installation/install#installing_zabbix_daemons)
to compile Zabbix server from sources.
##### 4 安装新服务器二进制文件
使用这些
[安装-zabbix-守护进程](/manual/installation/install#安装-zabbix-守护进程)
从源代码编译Zabbix server.
# 4 IPMI checks
# 4 项 IPMI 检查
# 4 Items
Please use the sidebar to access content in this section.
# 4 监控项
请使用侧边栏访问本节内容。
# 4 JavaScript preprocessing
# 4 JavaScript 预处理
# 4 Latest data
# 4 最新数据
# 4 Low-level discovery macros
# 4 低级发现宏
# 4 Maintenance
# 4 维护
# 4 Mass update
# 4 批量更新
# 4 Mass update
# 4 批量更新
# 4 Memcached plugin
# 4 Memcached 插件
# 4 Network maps
# 4 网络拓扑图
# 4 New trigger
# 4 新建触发器
# 4 New trigger
[comment]: # (tags: trigger)
# 4 新触发器
[comment]: # (tags: trigger)
# 4 Notes on low-level discovery
# 4 低级发现注意事项
# 4 Proxy
# 4 Proxy
# 4 Recommended UnixODBC settings for MSSQL
# 4 适用于 MSSQL 的推荐 UnixODBC 设置
# 4 Reports
# 4 报告
# 4 Secure connection to the database
# 4 数据库安全连接
# 4 Setup example
# 4 设置示例
# 4 SLA report
# 4 SLA 报告
# 4 Trapper items
# 4 捕获器 监控项
# 4 Trigger severity
Trigger severity represents the level of importance of a trigger.
Zabbix supports the following default trigger severities.
|Severity|Color|Description|
|-|-|--------|
|Not classified|Gray|Can be used where the severity level of an event is unknown, has not been determined, is not part of the regular monitoring scope, etc., for example, during initial configuration, as a placeholder for future assessment, or as part of an integration process.|
|Information|Light blue|Can be used for informational events that do not require immediate attention, but can still provide valuable insights.|
|Warning|Yellow|Can be used to indicate a potential issue that might require investigation or action, but that is not critical.|
|Average|Orange|Can be used to indicate a significant issue that should be addressed relatively soon to prevent further problems.|
|High|Light red|Can be used to indicate critical issues that need immediate attention to avoid significant disruptions.|
|Disaster|Red|Can be used to indicate a severe incident that requires immediate action to prevent, for example, system outages or data loss.|
::: noteclassic
Trigger severity names and colors can be [customized](/manual/config/triggers/customseverities).
:::
Trigger severities are used for:
- visual representation of triggers - different colors for different severities;
- audio in global alarms - different audio for different severities;
- user media - different media (notification channel) for different severities (for example, SMS for triggers of *High* and *Disaster* severity, and Email for triggers of other severities);
- limiting actions by conditions against trigger severities.
# 4 触发器严重性
触发器严重性代表触发器的重要性级别。
Zabbix支持以下默认触发器严重性级别。
| 严重性 | 颜色 | 描述 |
|-|-|--------|
| 未分类 | 灰色 | 可用于事件严重性级别未知、尚未确定、不属于常规监控范围等情况，例如在初始配置期间作为未来评估的占位符或作为集成流程的一部分。 |
| 信息 | 浅蓝色 | 可用于不需要立即关注但仍能提供有价值见解的信息性事件。 |
| 警告 | 黄色 | 可用于指示可能需要调查或操作但非关键性的潜在问题。 |
| 一般 | 橙色 | 可用于指示应相对较快解决的重大问题以防止进一步问题。 |
| 高 | 浅红色 | 可用于指示需要立即关注以避免重大中断的关键问题。 |
| 灾难 | 红色 | 可用于指示需要立即采取行动以防止系统中断或数据丢失等严重后果的事件。 |
::: noteclassic
触发器严重性名称和颜色可以[customized](/manual/config/triggers/customseverities)。
:::
触发器严重性用于：
- 触发器的可视化呈现 - 不同严重性使用不同颜色；
- 全局告警的音频 - 不同严重性使用不同音频；
- 用户媒介 - 不同严重性使用不同媒介（通知渠道）（例如，*高*和*灾难*严重性的触发器使用SMS，其他严重性的触发器使用Email）；
- 通过针对触发器严重性的条件限制操作。
# 4 Triggers top 100
# 4 触发器 Top 100
# 4 Update operations
# 4 更新操作
##### 4 Update repository configuration package
Before proceeding with the upgrade, uninstall your current repository package:
rm -Rf /etc/apt/sources.list.d/zabbix.list
Then, install the latest repository configuration package to ensure compatibility with the newest packages and to include any recent security patches or bug fixes.
On **Debian 12**, run:
wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_latest+debian12_all.deb
dpkg -i zabbix-release_latest+debian12_all.deb
On **Debian 11**, run:
wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_latest+debian11_all.deb
dpkg -i zabbix-release_latest+debian11_all.deb
On **Debian 10**, run:
wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_latest+debian10_all.deb
dpkg -i zabbix-release_latest+debian10_all.deb
For older Debian versions, replace the link above with the correct one from [Zabbix repository](https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/).
Note, however, that packages for those versions may not include all Zabbix components.
For a list of components included, see [Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=debian&os_version=9&components=agent&db=&ws=).
On **Ubuntu 24.04**, run:
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu24.04_all.deb
dpkg -i zabbix-release_latest+ubuntu24.04_all.deb
On **Ubuntu 22.04**, run:
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu22.04_all.deb
dpkg -i zabbix-release_latest+ubuntu22.04_all.deb
On **Ubuntu 20.04**, run:
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu20.04_all.deb
dpkg -i zabbix-release_latest+ubuntu20.04_all.deb
On **Ubuntu 18.04**, run:
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu18.04_all.deb
dpkg -i zabbix-release_latest+ubuntu18.04_all.deb
For older Ubuntu versions, replace the link above with the correct one from [Zabbix repository](https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/).
Note, however, that packages for those versions may not include all Zabbix components.
For a list of components included, see [Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=ubuntu&os_version=16.04&components=agent&db=&ws=).
You may see a prompt about the Zabbix repository configuration:
Configuration file '/etc/apt/sources.list.d/zabbix.list'
==> Deleted (by you or by a script) since installation.
==> Package distributor has shipped an updated version.
What would you like to do about it ? Your options are:
Y or I : install the package maintainer's version
N or O : keep your currently-installed version
D : show the differences between the versions
Z : start a shell to examine the situation
The default action is to keep your current version.
*** zabbix.list (Y/I/N/O/D/Z) [default=N] ?
Enter `Y` (or `I`) to install the package maintainer's version of the Zabbix repository configuration.
Then, update the repository information:
apt update
##### 4 更新仓库配置包
在升级前，请先卸载当前的仓库软件包：
rm -Rf /etc/apt/sources.list.d/zabbix.list
然后安装最新的仓库配置包，以确保与新版本软件包的兼容性，并包含最新的安全补丁或错误修复。
在 **Debian 12** 上，run：
wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_latest+debian12_all.deb
dpkg -i zabbix-release_latest+debian12_all.deb
在 **Debian 11** 上，run：
wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_latest+debian11_all.deb
dpkg -i zabbix-release_latest+debian11_all.deb
在 **Debian 10** 上，run：
wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_latest+debian10_all.deb
dpkg -i zabbix-release_latest+debian10_all.deb
对于更旧的 Debian 版本，请将上述链接替换为 [Zabbix repository](https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/) 中正确的链接。
但请注意，这些版本的软件包可能不包含所有 Zabbix 组件。
有关包含的组件列表，请参阅 [Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=debian&os_version=9&components=agent&db=&ws=)。
在 **Ubuntu 24.04** 上，run：
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu24.04_all.deb
dpkg -i zabbix-release_latest+ubuntu24.04_all.deb
在 **Ubuntu 22.04** 上，run：
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu22.04_all.deb
dpkg -i zabbix-release_latest+ubuntu22.04_all.deb
在 **Ubuntu 20.04** 上，run：
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu20.04_all.deb
dpkg -i zabbix-release_latest+ubuntu20.04_all.deb
在 **Ubuntu 18.04** 上，run：
wget https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest+ubuntu18.04_all.deb
dpkg -i zabbix-release_latest+ubuntu18.04_all.deb
对于更旧的 Ubuntu 版本，请将上述链接替换为 [Zabbix repository](https://repo.zabbix.com/zabbix/6.0/ubuntu/pool/main/z/zabbix-release/) 中正确的链接。
但请注意，这些版本的软件包可能不包含所有 Zabbix 组件。
有关包含的组件列表，请参阅 [Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=ubuntu&os_version=16.04&components=agent&db=&ws=)。
您可能会看到关于 Zabbix 仓库配置的提示：
Configuration file '/etc/apt/sources.list.d/zabbix.list'
==> Deleted (by you or by a script) since installation.
==> Package distributor has shipped an updated version.
What would you like to do about it ? Your options are:
Y or I : install the package maintainer's version
N or O : keep your currently-installed version
D : show the differences between the versions
Z : start a shell to examine the situation
The default action is to keep your current version.
*** zabbix.list (Y/I/N/O/D/Z) [default=N] ?
输入 `Y`（或 `I`）以安装软件包维护者的 Zabbix 仓库配置 version。
然后，update 仓库信息：
apt update
##### 4 Update repository configuration package
Before proceeding with the upgrade, update your current repository package to the latest version to ensure compatibility with the newest packages and to include any recent security patches or bug fixes.
On **RHEL 9**, run:
rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/9/x86_64/zabbix-release-latest.el9.noarch.rpm
On **RHEL 8**, run:
rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/8/x86_64/zabbix-release-latest.el8.noarch.rpm
For older RHEL versions, replace the link above with the correct one from [Zabbix repository](https://repo.zabbix.com/zabbix/6.0/rhel/).
Note, however, that packages for those versions may not include all Zabbix components.
For a list of components included, see [Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=red_hat_enterprise_linux&os_version=7&components=agent&db=&ws=).
Then, clean up the `dnf` package manager's cache (including headers, metadata, and package files downloaded during previous installations or updates):
dnf clean all
On the next `dnf` operation, `dnf` will download fresh metadata from the repositories since the old metadata is cleared.
See also: [Known issues](/manual/installation/known_issues#expired-signing-key-for-rhel-packages) for updating the repository configuration package on RHEL.
##### 4 更新仓库配置包
在升级前，请update您当前的仓库包至最新的version，以确保与新版本包的兼容性并包含最新的安全补丁或错误修复。
在**RHEL 9**上，run：
rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/9/x86_64/zabbix-release-latest.el9.noarch.rpm
在**RHEL 8**上，run：
rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/8/x86_64/zabbix-release-latest.el8.noarch.rpm
对于较旧的RHEL版本，请将上述链接替换为[Zabbix repository](https://repo.zabbix.com/zabbix/6.0/rhel/)中的正确链接。
但请注意，这些版本的包可能不包含所有Zabbix组件。
有关包含的组件列表，请参阅[Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=red_hat_enterprise_linux&os_version=7&components=agent&db=&ws=)。
然后，清理`dnf`包管理器的缓存（包括之前安装或更新过程中下载的头部信息、元数据和包文件）：
dnf clean all
在下次`dnf`操作时，`dnf`将从仓库下载新的元数据，因为旧的元数据已被清除。
另请参阅：[rhel包签名密钥过期](/manual/installation/known_issues#rhel包签名密钥过期)以了解如何在RHEL上更新仓库配置包。
##### 4 Update repository configuration package
To proceed with the update your current repository package has to be
uninstalled.
# rm -Rf /etc/apt/sources.list.d/zabbix.list
Then install the new repository configuration package.
On **Debian 10** run:
# wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_6.0-1+debian10_all.deb
# dpkg -i zabbix-release_5.4-1+debian10_all.deb
On **Debian 9** run:
# wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_6.0-1+debian9_all.deb
# dpkg -i zabbix-release_5.4-1+debian9_all.deb
On **Debian 8** run:
# wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_6.0-1+debian8_all.deb
# dpkg -i zabbix-release_5.4-1+debian8_all.deb
On **Ubuntu 20.04** run:
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu20.04_all.deb
# dpkg -i zabbix-release_5.4-1+ubuntu20.04_all.deb
On **Ubuntu 18.04** run:
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu18.04_all.deb
# dpkg -i zabbix-release_6.0-1+ubuntu18.04_all.deb
On **Ubuntu 16.04** run:
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu16.04_all.deb
# dpkg -i zabbix-release_5.4-1+ubuntu16.04_all.deb
On **Ubuntu 14.04** run:
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu14.04_all.deb
# dpkg -i zabbix-release_6.0-1+ubuntu14.04_all.deb
Update the repository information.
# apt-get update
##### 4 升级 Zabbix 软件仓库配置包
在升级之前，必须卸载当前的软件仓库包：
# rm -Rf /etc/apt/sources.list.d/zabbix.list
然后再安装新的软件仓库包：
在 **Debian 10** 上运行：
# wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_6.0-1+debian10_all.deb
# dpkg -i zabbix-release_5.4-1+debian10_all.deb
在 **Debian 9** 上运行：
# wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_6.0-1+debian9_all.deb
# dpkg -i zabbix-release_5.4-1+debian9_all.deb
在 **Debian 8** 上运行：
# wget https://repo.zabbix.com/zabbix/6.0/debian/pool/main/z/zabbix-release/zabbix-release_6.0-1+debian8_all.deb
# dpkg -i zabbix-release_5.4-1+debian8_all.deb
在 **Ubuntu 20.04** 上运行：
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu20.04_all.deb
# dpkg -i zabbix-release_5.4-1+ubuntu20.04_all.deb
在 **Ubuntu 18.04** 上运行：
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu18.04_all.deb
# dpkg -i zabbix-release_6.0-1+ubuntu18.04_all.deb
在 **Ubuntu 16.04** 上运行：
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu16.04_all.deb
# dpkg -i zabbix-release_5.4-1+ubuntu16.04_all.deb
在 **Ubuntu 14.04** 上运行：
# wget https://repo.zabbix.com/zabbix/5.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_6.0-1+ubuntu14.04_all.deb
# dpkg -i zabbix-release_6.0-1+ubuntu14.04_all.deb
更新软件仓库信息。
# apt-get update
##### 4 Update repository configuration package
To proceed with the upgrade your current repository package has to be
updated.
# rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/8/x86_64/zabbix-release-6.0-1.el8.noarch.rpm
##### 4 升级 Zabbix 软件仓库配置包
在升级之前，必须更新当前的软件仓库包：
# rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/8/x86_64/zabbix-release-6.0-1.el8.noarch.rpm
##### 4 Update repository configuration package
To proceed with the upgrade your current repository package has to be
updated.
# rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/8/x86_64/zabbix-release-6.0-1.el8.noarch.rpm
##### 4 升级 Zabbix 软件仓库配置包
在升级之前，必须更新当前的软件仓库包：
# rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/8/x86_64/zabbix-release-6.0-1.el8.noarch.rpm
# 4 User groups
# 4 用户组
# 4 Using macros in messages
# 4 在消息中使用宏
# 4 Webhook
# 4 Webhook
# 4 Windows agent installation from MSI
# 4 Windows agent 通过 MSI 安装
# 4 Zabbix agent 2 plugin protocol
Please refer to the [connection protocol](https://www.zabbix.com/documentation/guidelines/en/plugins#connection-protocol) section on *Building plugins* page
for more information.
# 4 Zabbix agent 2 插件协议
有关详细信息，请参阅*构建插件*页面上的[连接协议] (https://www.zabbix.com/documentation/guidelines/en/plugins#connection-protocol) 部分。
# 4 Zabbix agent 2 plugin protocol
Zabbix agent 2 protocol is based on code, size and data model.
# 4 Zabbix agent 2 插件协议
Zabbix agent 2协议基于代码、大小和数据模型。
# 4 Zabbix agent 2 (UNIX)
# 4 Zabbix agent 2 (UNIX)
# 4 Zabbix overview
# 4 Zabbix 概览
# 50 Upgrade notes for 6.0.40
This minor version does not have any upgrade notes.
# 50 6.0.40 版本升级说明
此次要version版本没有任何升级说明。
# 51 Upgrade notes for 6.0.41
# 51 6.0.41 版本升级说明
# 52 Upgrade notes for 6.0.42
This minor version does not have any upgrade notes.
# 52 Upgrade notes for 6.0.42
此次要version没有任何升级说明。
# 5 Actions
# 5 动作
# 5 Administration
# 5 管理
# 5 Audit
# 5 审计
# 5 Configuration
# 5 配置
# 5 CSV to JSON preprocessing
# 5 CSV 到 JSON 预处理
# 5 Customizing trigger severities
Trigger severity names and colors for severity related GUI elements can
be configured in *Administration → General → Trigger displaying
options*. Colors are shared among all GUI themes.
# 5 自定义触发器严重性级别
触发器严重性名称及关联GUI元素的颜色配置可在*管理 → 常规 → 触发器显示选项*中进行设置。颜色配置在所有GUI主题间共享生效。
# 5 Discovery of JMX objects
# 5 JMX 发现 objects
# 5 Discovery rules
Please use the sidebar to see discovery rule configuration examples for
various cases.
# 5 条发现规则
请通过侧边栏查看不同场景下的自动发现规则配置示例。
# 5 Escalations
# 5 Escalations
# 5 Event correlation
# 5 事件关联
# 5 Expression macros
# 5 表达式宏
# 5 Favorite graphs
# 5 收藏图表
# 5 Frontend maintenance mode
# 5 前端维护模式
# 5 Installation from containers
# 5 从容器安装
# 5 Java gateway
# 5 Java 网关
# 5 Mac OS agent installation from PKG
# 5 从PKG安装Mac OS agent
# 5 Maps
# 8 拓扑图
# 5 Maps
[comment]: # (tags: map)
# 5 地图
[comment]: # (tags: map)
# 5 Media types
# 5 媒体类型
# 5 Minimum permission level for Windows agent items
# 5 Windows agent 监控项 的最低权限级别
# 5 Modbus plugin
# 5 Modbus 插件
# 5 Quickstart
Please use the sidebar to access content in the Quickstart section.
# 5 快速入门
请使用侧边栏访问快速入门部分的内容。
# 5 Receiving problem notification
# 5 接收问题通知
# 5 Simple checks
# 5 种简单检查
##### 5 Start new Zabbix agent
Start the new Zabbix agent. Check log files to see if the agent has
started successfully.
##### 5 启动新的Zabbix agent
启动新的Zabbix agent。检查日志文件确认agent是否已成功启动。
##### 5 Start new Zabbix proxy
Start the new Zabbix proxy. Check log files to see if the proxy has
started successfully.
Zabbix proxy will automatically upgrade the database. Database upgrade
takes place similarly as when starting [Zabbix server](/manual/installation/upgrade/sources#start-new-zabbix-binaries).
##### 5 启动新的 Zabbix proxy
启动新的Zabbix proxy. 检查日志文件确认proxy是否已成功启动.
Zabbix proxy将自动升级数据库. 数据库升级过程与启动[6-启动新的-zabbix-二进制文件](/manual/installation/upgrade/sources#6-启动新的-zabbix-二进制文件)时类似.
# 5 TimescaleDB setup
# 5 TimescaleDB 设置
# 5 Trend functions
Trend functions, in contrast to [history functions](/manual/appendix/functions/history), use
[trend](/manual/config/items/history_and_trends#keeping-trends) data for calculations.
Trends store hourly aggregate values. Trend functions use these hourly averages, and thus are useful for
long-term analysis.
Trend function results are cached so multiple calls to the same function with the same parameters
fetch info from the database only once. The trend function cache is controlled by the
[TrendFunctionCacheSize](/manual/appendix/config/zabbix_server) server parameter.
Triggers that reference trend functions **only** are evaluated once per the smallest time period
in the expression. For instance, a trigger like
trendavg(/host/key,1d:now/d) > 1 or trendavg(/host/key2,1w:now/w) > 2
will be evaluated once per day. If the trigger contains both trend and history (or [date and time](/manual/appendix/functions/time) and/or nodata()) functions,
it is calculated in accordance with the [usual principles](/manual/config/triggers#calculation-time).
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
- Function-specific parameters are described with each function
- `/host/key` and `time period:time shift` parameters must never be
quoted
# 5 趋势函数
趋势函数与[history functions](/manual/appendix/functions/history)不同，使用[保留趋势数据](/manual/config/items/history_and_trends#保留趋势数据)数据进行计算。
趋势存储每小时聚合值。趋势函数使用这些每小时平均值，因此适用于长期分析。
趋势函数结果会被缓存，因此多次调用相同参数的同个函数只会从数据库获取一次信息。趋势函数缓存由[TrendFunctionCacheSize](/manual/appendix/config/zabbix_server)服务器参数控制。
仅引用趋势函数的触发器**仅**按表达式中最小时间周期评估一次。例如，类似
trendavg(/host/key,1d:now/d) > 1 or trendavg(/host/key2,1w:now/w) > 2
的触发器将每天评估一次。若触发器同时包含趋势和历史函数（或[date and time](/manual/appendix/functions/time)及/或nodata()函数），则根据[计算时间](/manual/config/triggers#计算时间)规则计算。
以下场景支持列出的所有函数：
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
关于函数参数的通用说明：
- 函数参数用逗号分隔
- 可选参数（或参数部分）用`<` `>`表示
- 函数特定参数详见各函数说明
- `/host/key`和`time period:time shift`参数禁止加引号
##### 5 Upgrade Zabbix components
To upgrade Zabbix components you may run something like:
apt install --only-upgrade zabbix-server-mysql zabbix-frontend-php zabbix-agent
- If using PostgreSQL, substitute `mysql` with `pgsql` in the command.
- If upgrading the proxy, substitute `server` with `proxy` in the command.
- If upgrading the Zabbix agent 2, substitute `zabbix-agent` with `zabbix-agent2 zabbix-agent2-plugin-*` in the command.
::: noteimportant
Upgrading Zabbix agent 2 with the `apt install zabbix-agent2` command could lead to an error.
For more information, see [*Known issues*](/manual/installation/known_issues#upgrading-zabbix-agent-2-6.0.5-or-older).
:::
You may see a prompt about the Zabbix server (or proxy) configuration:
Configuration file '/etc/zabbix/zabbix_server.conf'
==> Modified (by you or by a script) since installation.
==> Package distributor has shipped an updated version.
What would you like to do about it ? Your options are:
Y or I : install the package maintainer's version
N or O : keep your currently-installed version
D : show the differences between the versions
Z : start a shell to examine the situation
The default action is to keep your current version.
*** zabbix_server.conf (Y/I/N/O/D/Z) [default=N] ?
Enter the option that best fits your situation.
For example, enter `D` to compare the current and new configuration, then decide if you want to install the package maintainer's version (`Y` or `I`).
Then, to upgrade the web frontend with Apache and restart Apache, run:
apt install zabbix-apache-conf
systemctl restart apache2
Distributions **prior to Debian 10 (buster) / Ubuntu 18.04 (bionic) / Raspbian 10 (buster)** do not provide PHP 7.2 or newer, which is required for Zabbix frontend 6.0.
See [information](/manual/installation/frontend/frontend_on_debian) about installing Zabbix frontend on older distributions.
##### 5 升级Zabbix组件
要升级Zabbix组件，您可以run类似以下命令：
apt install --only-upgrade zabbix-server-mysql zabbix-frontend-php zabbix-agent
- 如果使用PostgreSQL，请将命令中的`mysql`替换为`pgsql`
- 如果升级proxy，请将命令中的`server`替换为`proxy`
- 如果升级Zabbix agent 2，请将命令中的`zabbix-agent`替换为`zabbix-agent2 zabbix-agent2-plugin-*`
::: noteimportant
使用`apt install zabbix-agent2`命令升级Zabbix agent 2可能会导致错误。
更多信息请参阅[*已知问题*](/manual/installation/known_issues#upgrading-zabbix-agent-2-6.0.5-or-older)。
:::
您可能会看到关于Zabbix server（或proxy）配置的提示：
Configuration file '/etc/zabbix/zabbix_server.conf'
==> Modified (by you or by a script) since installation.
==> Package distributor has shipped an updated version.
What would you like to do about it ? Your options are:
Y or I : install the package maintainer's version
N or O : keep your currently-installed version
D : show the differences between the versions
Z : start a shell to examine the situation
The default action is to keep your current version.
*** zabbix_server.conf (Y/I/N/O/D/Z) [default=N] ?
选择最适合您情况的选项。
例如，输入`D`可以比较当前配置与新配置，然后决定是否安装软件包维护者的version（`Y`或`I`）。
然后，要升级Apache下的Web前端并重启Apache，请run：
apt install zabbix-apache-conf
systemctl restart apache2
**Debian 10(buster)/Ubuntu 18.04(bionic)/Raspbian 10(buster)之前的发行版**不提供Zabbix前端6.0所需的PHP 7.2或更新版本。
有关在旧版发行版上安装Zabbix前端的信息，请参阅[information](/manual/installation/frontend/frontend_on_debian)。
##### 5 Upgrade Zabbix components
To upgrade Zabbix components you may run something like:
dnf install zabbix-server-mysql zabbix-web-mysql zabbix-agent
- If using PostgreSQL, substitute `mysql` with `pgsql` in the command.
- If upgrading the proxy, substitute `server` with `proxy` in the command.
- If upgrading the agent 2, substitute `zabbix-agent` with `zabbix-agent2 zabbix-agent2-plugin-*` in the command.
::: noteimportant
Upgrading Zabbix agent 2 with the `dnf install zabbix-agent2` command could lead to an error.
For more information, see [*Known issues*](/manual/installation/known_issues#upgrading-zabbix-agent-2-6.0.5-or-older).
:::
Then, to upgrade the web frontend with Apache and restart Apache, run:
dnf install zabbix-apache-conf
systemctl restart httpd
##### 5 升级Zabbix组件
要升级Zabbix组件，您可以run类似以下命令：
dnf install zabbix-server-mysql zabbix-web-mysql zabbix-agent
- 如果使用PostgreSQL，请将命令中的`mysql`替换为`pgsql`
- 如果升级proxy，请将命令中的`server`替换为`proxy`
- 如果升级agent 2，请将命令中的`zabbix-agent`替换为`zabbix-agent2 zabbix-agent2-plugin-*`
::: noteimportant
使用`dnf install zabbix-agent2`命令升级Zabbix agent 2可能会导致错误。
更多信息请参阅[*已知问题*](/manual/installation/known_issues#upgrading-zabbix-agent-2-6.0.5-or-older)。
:::
然后，要升级Apache的Web前端并重启Apache，请run：
dnf install zabbix-apache-conf
systemctl restart httpd
##### 5 Upgrade Zabbix components
To upgrade Zabbix components you may run something like:
# yum upgrade zabbix-server-mysql zabbix-web-mysql zabbix-agent
If using PostgreSQL, substitute `mysql` with `pgsql` in the command. If
upgrading the proxy, substitute `server` with `proxy` in the command. If
upgrading the agent 2, substitute `zabbix-agent` with `zabbix-agent2` in
the command.
To upgrade the web frontend with Apache **on RHEL 8** correctly, also
run:
# yum install zabbix-apache-conf
and make the necessary
[changes](/manual/installation/install_from_packages/rhel#zabbix_frontend_configuration)
to this file.
To upgrade the web frontend **on RHEL 7** follow [distribution-specific
instructions](/manual/installation/frontend/frontend_on_rhel7) (extra
steps are required to install PHP 7.2 or newer).
##### 5 升级Zabbix组件
要升级Zabbix组件，您可以run类似以下命令：
# yum upgrade zabbix-server-mysql zabbix-web-mysql zabbix-agent
如果使用PostgreSQL，请将命令中的`mysql`替换为`pgsql`。如果
升级proxy，请将命令中的`server`替换为`proxy`。如果
升级agent 2，请将命令中的`zabbix-agent`替换为`zabbix-agent2`。
要在RHEL 8系统上正确升级Apache的Web前端，还需run：
# yum install zabbix-apache-conf
并对此file进行必要的
[changes](/manual/installation/install_from_packages/rhel#zabbix_frontend_configuration)。
要在RHEL 7系统上升级Web前端，请遵循[distribution-specific
instructions](/manual/installation/frontend/frontend_on_rhel7)（需要额外
步骤安装PHP 7.2或更新版本）。
# 5 User parameters
# 5 用户参数
# 5 User roles
# 5 用户角色
# 5 Web scenarios
# 5 Web 场景
# 5 Web scenarios
# 5 Web 场景
# 5 What's new in Zabbix 6.0.0
See [breaking changes](#breaking_changes) for this version.
# 5 Zabbix 6.0.0 新特性
参见[重大变更](#breaking_changes)了解此version。
# 5 Zabbix agent (Windows)
# 5 Zabbix agent (Windows)
# 5 Zabbix sender protocol
Please refer to the [trapper item](/manual/appendix/items/trapper) page
for more information.
# 5 Zabbix sender 协议
更多信息请参阅[trapper item](/manual/appendix/items/trapper)页面
### 6.0.13
### 6.0.13
### 6.0.14
### 6.0.14
### 6.0.15
### 6.0.15
### 6.0.19
### 6.0.19
### 6.0.22
### 6.0.22
### 6.0.3
### 6.0.3
### 6.0.34
### 6.0.34
### 6.0.38
### 6.0.38
### 6.0.39
### 6.0.39
### 6.0.7
### 6.0.7
### 6.0.9
### 6.0.9
##### 64 bit
Open MinGW environment (Windows command prompt) and navigate to
*build/mingw* directory in the Zabbix source tree.
Run:
mingw32-make clean
mingw32-make PCRE=c:\dev\pcre OPENSSL=c:\dev\openssl
::: noteclassic
Both 32- and 64- bit versions can be built on a 64-bit
platform, but only a 32-bit version can be built on a 32-bit platform.
When working on the 32-bit platform, follow the same steps as for 64-bit
version on 64-bit platform.
:::
##### 64 位
打开MinGW环境（Windows命令提示符）并导航至
Zabbix源代码树的*build/mingw*目录。
运行：
mingw32-make clean
mingw32-make PCRE=c:\dev\pcre OPENSSL=c:\dev\openssl
::: noteclassic
在64位平台上可以构建32位和64位版本，
但32位平台只能构建32位version。
在32位平台上操作时，遵循与64位平台上
构建64位version相同的步骤。
:::
# 6 Action log
# 6 操作日志
# 6 Administration
# 6 管理
# 6 Custom LLD rules
# 6 条自定义 LLD 规则
# 6 Discovery
# 6 发现
# 6 Discovery of IPMI sensors
# 6 IPMI 传感器发现
# 6 Elasticsearch setup
::: noteimportant
Elasticsearch support is experimental!
:::
Zabbix supports the storage of historical data by means of Elasticsearch
instead of a database. Users can choose the storage place for historical
data between a compatible database and Elasticsearch. The setup
procedure described in this section is applicable to Elasticsearch
version 7.X. In case an earlier or later version of Elasticsearch is
used, some functionality may not work as intended.
::: notewarning
If all history data is stored in Elasticsearch,
trends are **not** calculated nor stored in the database. With no trends
calculated and stored, the history storage period may need to be
extended.
:::
# 6 Elasticsearch 配置
::: noteimportant
Elasticsearch支持尚处于实验阶段！
:::
Zabbix支持通过Elasticsearch替代数据库存储历史数据。用户可在兼容数据库与Elasticsearch之间选择历史数据的存储位置。本节描述的配置流程适用于Elasticsearch version 7.X版本。若使用更早或更新的version版本，部分功能可能无法按预期工作。
::: notewarning
若所有历史数据均存储于Elasticsearch，
则趋势数据将**不会**被计算或存储于数据库中。由于未计算和存储趋势数据，可能需要延长历史数据的存储周期。
:::
# 6 Encoding of returned values
Zabbix server expects every returned text value in the UTF8 encoding.
This is related to any type of checks: zabbix agent, ssh, telnet, etc.
Different monitored systems/devices and checks can return non-ASCII
characters in the value. For such cases, almost all possible zabbix keys
contain an additional item key parameter - **<encoding>**. This
key parameter is optional but it should be specified if the returned
value is not in the UTF8 encoding and it contains non-ASCII characters.
Otherwise the result can be unexpected and unpredictable.
A description of behavior with different database backends in such cases
follows.
# 6 返回值编码
Zabbix server 要求所有返回的文本值都采用UTF8编码。
这适用于任何类型的检查：Zabbix agent、ssh、telnet等。
不同的被监控系统/设备和检查可能会在返回值中包含非ASCII字符。对于这种情况，几乎所有可能的zabbix键值都包含一个额外的监控项键参数——**<encoding>**。这个键参数是可选的，但如果返回值不是UTF8编码且包含非ASCII字符，则应指定该参数。否则结果可能会出乎意料且不可预测。
接下来描述在这种情况下不同数据库后端的行为。
# 6 Event correlation
# 6 事件关联
# 6 Favorite maps
# 6 收藏地图
# 6 Header
# 6 标题
# 6 Loadable modules
# 6 可加载模块
# 6 Log file monitoring
# 6 日志文件监控
# 6 Log file monitoring
[comment]: # (tags: logrt, logfile, log)
# 6 日志文件监控
[comment]: # (标签: logrt, logfile, log)
# 6 Macros
It is possible to use out-of-the-box [Supported macros](/manual/appendix/macros/supported_by_location) and [User macros supported by location](/manual/appendix/macros/supported_by_location_user).
# 6 宏
可以直接使用开箱即用的[Supported macros](/manual/appendix/macros/supported_by_location)和[User macros supported by location](/manual/appendix/macros/supported_by_location_user)。
# 6 Mass update
# 6 批量更新
# 6 Mathematical functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Mathematical functions are supported with float and integer value types,
unless stated otherwise.
Some general notes on function parameters:
- Function parameters are separated by a comma
- Expressions are accepted as parameters
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
|FUNCTION|<|<|
|--|--|--|
|**Description**|**Function-specific parameters**|**Comments**|
|**abs** (value)|<|<|
|The absolute value (from 0) of a value.|**value** - value to check|For example, the absolute value of either '3' or '-3' will be '3'.<br><br>Example:<br>=> **abs**(last(/host/key))>10|
|**acos** (value)|<|<|
|The arccosine of a value as an angle, expressed in radians.|**value** - value to check|The value must be between -1 and 1.<br><br>For example, the arccosine of a value '0.5' will be '2.0943951'.<br><br>Example:<br>=> **acos**(last(/host/key))|
|**asin** (value)|<|<|
|The arcsine of a value as an angle, expressed in radians.|**value** - value to check|The value must be between -1 and 1.<br><br>For example, the arcsine of a value '0.5' will be '-0.523598776'.<br><br>Example:<br>=> **asin**(last(/host/key))|
|**atan** (value)|<|<|
|The arctangent of a value as an angle, expressed in radians.|**value** - value to check|For example, the arctangent of a value '1' will be '0.785398163'.<br><br>Example:<br>=> **atan**(last(/host/key))|
|**atan2** (value,abscissa)|<|<|
|The arctangent of the ordinate (value) and abscissa coordinates specified as an angle, expressed in radians.|**value** - value to check<br>**abscissa** - abscissa value|For example, the arctangent of the ordinate and abscissa coordinates of a value '1' will be '2.21429744'.<br><br>Example:<br>=> **atan2**(last(/host/key),2)|
|**avg** (<value1>,<value2>,...)|<|<|
|Average value of the referenced item values.|**valueX** - value returned by another function that is working with item history|Example:<br>=> **avg**(avg(/host/key),avg(/host2/key2))|
|**cbrt** (value)|<|<|
|Cube root of a value.|**value** - value to check|For example, the cube root of '64' will be '4', of '63' will be '3.97905721'.<br><br>Example:<br>=> **cbrt**(last(/host/key))|
|**ceil (value)**|<|<|
|Round the value up to the nearest greater or equal integer.|**value** - value to check|For example, '2.4' will be rounded up to '3'.<br><br>Example:<br>=> **ceil**(last(/host/key))<br><br>See also floor().|
|**cos (value)**|<|<|
|The cosine of a value, where the value is an angle expressed in radians.|**value** - value to check|For example, the cosine of a value '1' will be '0.54030230586'.<br><br>Example:<br>=> **cos**(last(/host/key))|
|**cosh (value)**|<|<|
|The hyperbolic cosine of a value.|**value** - value to check|For example, the hyperbolic cosine of a value '1' will be '1.54308063482'.<br><br>Returns value as a real number, not as scientific notation.<br><br>Example:<br>=> **cosh**(last(/host/key))|
|**cot (value)**|<|<|
|The cotangent of a value, where the value is an angle, expressed in radians.|**value** - value to check|For example, the cotangent of a value '1' will be '0.54030230586'.<br><br>Example:<br>=> **cot**(last(/host/key))|
|**degrees (value)**|<|<|
|Converts a value from radians to degrees.|**value** - value to check|For example, a value '1' converted to degrees will be '57.2957795'.<br><br>Example:<br>=> **degrees**(last(/host/key))|
|**e**|<|<|
|Euler's number (2.718281828459045).|<|Example:<br>=> **e**()|
|**exp** (value)|<|<|
|Euler's number at a power of a value.|**value** - value to check|For example, Euler's number at a power of a value '2' will be '7.38905609893065'.<br><br>Example:<br>=> **exp**(last(/host/key))|
|**expm1 (value)**|<|<|
|Euler's number at a power of a value minus 1.|**value** - value to check|For example, Euler's number at a power of a value '2' minus 1 will be '6.38905609893065'.<br><br>Example:<br>=> **expm1**(last(/host/key))|
|**floor** (value)|<|<|
|Round the value down to the nearest smaller or equal integer.|**value** - value to check|For example, '2.6' will be rounded down to '2'.<br><br>Example:<br>=> **floor**(last(/host/key))<br><br>See also ceil().|
|**log** (value)|<|<|
|Natural logarithm.|**value** - value to check|For example, the natural logarithm of a value '2' will be '0.69314718055994529'.<br><br>Example:<br>=> **log**(last(/host/key))|
|**log10** (value)|<|<|
|Decimal logarithm.|**value** - value to check|For example, the decimal logarithm of a value '5' will be '0.69897000433'.<br><br>Example:<br>=> **log10**(last(/host/key))|
|**max** (<value1>,<value2>,...)|<|<|
|Highest value of the referenced item values.|**valueX** - value returned by another function that is working with item history|Example:<br>=> **max**(avg(/host/key),avg(/host2/key2))|
|**min** (<value1>,<value2>,...)|<|<|
|Lowest value of the referenced item values.|**valueX** - value returned by another function that is working with item history|Example:<br>=> **min**(avg(/host/key),avg(/host2/key2))|
|**mod** (value,denominator)|<|<|
|Division remainder.|**value** - value to check<br>**denominator** - division denominator|For example, division remainder of a value '5' with division denominator '2' will be '1'.<br><br>Example:<br>=> **mod**(last(/host/key),2)|
|**pi**|<|<|
|Pi constant (3.14159265358979).|<|Example:<br>=> **pi**()|
|**power** (value,power value)|<|<|
|The power of a value.|**value** - value to check<br>**power value** - the Nth power to use|For example, the 3rd power of a value '2' will be '8'.<br><br>Example:<br>=> **power**(last(/host/key),3)|
|**radians** (value)|<|<|
|Convert a value from degrees to radians.|**value** - value to check|For example, a value '1' converted to radians will be '0.0174532925'.<br><br>Example:<br>=> **radians**(last(/host/key))|
|**rand**|<|<|
|Return a random integer value.| |A pseudo-random generated number using time as seed (enough for mathematical purposes, but not cryptography).<br><br>Example:<br>=> **rand**()|
|**round** (value,decimal places)|<|<|
|Round the value to decimal places.|**value** - value to check<br>**decimal places** - specify decimal places for rounding (0 is also possible)|For example, a value '2.5482' rounded to 2 decimal places will be '2.55'.<br><br>Example:<br>=> **round**(last(/host/key),2)|
|**signum** (value)|<|<|
|Returns '-1' if a value is negative, '0' if a value is zero, '1' if a value is positive.|**value** - value to check|Example:<br>=> **signum**(last(/host/key))|
|**sin** (value)|<|<|
|The sine of a value, where the value is an angle expressed in radians.|**value** - value to check|For example, the sine of a value '1' will be '0.8414709848'.<br><br>Example:<br>=> **sin**(last(/host/key))|
|**sinh** (value)|<|<|
|The hyperbolical sine of a value.|**value** - value to check|For example, the hyperbolical sine of a value '1' will be '1.17520119364'.<br><br>Example:<br>=> **sinh**(last(/host/key))|
|**sqrt** (value)|<|<|
|Square root of a value.|**value** - value to check|This function will fail with a negative value.<br><br>For example, the square root of a value '3.5' will be '1.87082869339'.<br><br>Example:<br>=> **sqrt**(last(/host/key))|
|**sum** (<value1>,<value2>,...)|<|<|
|Sum of the referenced item values.|**valueX** - value returned by another function that is working with item history|Example:<br>=> **sum**(avg(/host/key),avg(/host2/key2))|
|**tan** (value)|<|<|
|The tangent of a value.|**value** - value to check|For example, the tangent of a value '1' will be '1.55740772465'.<br><br>Example:<br>=> **tan**(last(/host/key))|
|**truncate** (value,decimal places)|<|<|
|Truncate the value to decimal places.|**value** - value to check<br>**decimal places** - specify decimal places for truncating (0 is also possible)|Example:<br>=> **truncate**(last(/host/key),2)|
# 6 数学函数
此处列出的所有函数均支持以下场景:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
除非特别说明，数学函数支持float和integer值类型。
关于函数参数的通用说明:
- 函数参数使用逗号分隔
- 参数支持表达式
- 可选参数(或参数部分)通过
`<` `>`
`<` `>`
| 函数 | < | < |
|--|--|--|
| **Description** | **函数特定参数** | **说明** |
| **abs** (value) | < | < |
| The absolute value (from 0) of a value. | **value** - 待检查值 | 例如：'3'或'-3'的绝对值均为'3'<br><br>示例:<br>=> **abs**(last(/主机/key))>10 |
| **acos** (value) | < | < |
| The arccosine of a value as an angle, expressed in radians. | **value** - 待检查值 | 值必须在-1到1之间<br><br>例如：'0.5'的反余弦值为'2.0943951'<br><br>示例:<br>=> **acos**(last(/主机/key)) |
| **asin** (value) | < | < |
| The arcsine of a value as an angle, expressed in radians. | **value** - 待检查值 | 值必须在-1到1之间<br><br>例如：'0.5'的反正弦值为'-0.523598776'<br><br>示例:<br>=> **asin**(last(/主机/key)) |
| **atan** (value) | < | < |
| The arctangent of a value as an angle, expressed in radians. | **value** - 待检查值 | 例如：'1'的反正切值为'0.785398163'<br><br>示例:<br>=> **atan**(last(/主机/key)) |
| **atan2** (value,abscissa) | < | < |
| The arctangent of the ordinate (value) and abscissa coordinates specified as an angle, expressed in radians. | **value** - 待检查值<br>**abscissa** - 横坐标值 | 例如：纵坐标和横坐标为'1'的反正切值为'2.21429744'<br><br>示例:<br>=> **atan2**(last(/主机/key),2) |
| **avg** (<value1>,<value2>,...) | < | < |
| Average value of the referenced item values. | **valueX** - 其他函数返回的值(使用监控项历史数据) | 示例:<br>=> **avg**(avg(/主机/key),avg(/host2/key2)) |
| **cbrt** (value) | < | < |
| Cube root of a value. | **value** - 待检查值 | 例如：'64'的立方根为'4'，'63'为'3.97905721'<br><br>示例:<br>=> **cbrt**(last(/主机/key)) |
| **ceil (value)** | < | < |
| Round the value up to the nearest greater or equal integer. | **value** - 待检查值 | 例如：'2.4'向上取整为'3'<br><br>示例:<br>=> **ceil**(last(/主机/key))<br><br>另见floor() |
| **cos (value)** | < | < |
| The cosine of a value, where the value is an angle expressed in radians. | **value** - 待检查值 | 例如：'1'的余弦值为'0.54030230586'<br><br>示例:<br>=> **cos**(last(/主机/key)) |
| **cosh (value)** | < | < |
| The hyperbolic cosine of a value. | **value** - 待检查值 | 例如：'1'的双曲余弦值为'1.54308063482'<br><br>返回实数而非科学计数法<br><br>示例:<br>=> **cosh**(last(/主机/key)) |
| **cot (value)** | < | < |
| The cotangent of a value, where the value is an angle, expressed in radians. | **value** - 待检查值 | 例如：'1'的余切值为'0.54030230586'<br><br>示例:<br>=> **cot**(last(/主机/key)) |
| **degrees (value)** | < | < |
| Converts a value from radians to degrees. | **value** - 待检查值 | 例如：'1'转换为角度值为'57.2957795'<br><br>示例:<br>=> **degrees**(last(/主机/key)) |
| **e** | < | < |
| Euler's number (2.718281828459045). | < | 示例:<br>=> **e**() |
| **exp** (value) | < | < |
| Euler's number at a power of a value. | **value** - 待检查值 | 例如：欧拉数的'2'次方为'7.38905609893065'<br><br>示例:<br>=> **exp**(last(/主机/key)) |
| **expm1 (value)** | < | < |
| Euler's number at a power of a value minus 1. | **value** - 待检查值 | 例如：欧拉数的'2'次方减1为'6.38905609893065'<br><br>示例:<br>=> **expm1**(last(/主机/key)) |
| **floor** (value) | < | < |
| Round the value down to the nearest smaller or equal integer. | **value** - 待检查值 | 例如：'2.6'向下取整为'2'<br><br>示例:<br>=> **floor**(last(/主机/key))<br><br>另见ceil() |
| **log** (value) | < | < |
| Natural logarithm. | **value** - 待检查值 | 例如：'2'的自然对数为'0.69314718055994529'<br><br>示例:<br>=> **log**(last(/主机/key)) |
| **log10** (value) | < | < |
| Decimal logarithm. | **value** - 待检查值 | 例如：'5'的常用对数为'0.69897000433'<br><br>示例:<br>=> **log10**(last(/主机/key)) |
| **max** (<value1>,<value2>,...) | < | < |
| Highest value of the referenced item values. | **valueX** - 其他函数返回的值(使用监控项历史数据) | 示例:<br>=> **max**(avg(/主机/key),avg(/host2/key2)) |
| **min** (<value1>,<value2>,...) | < | < |
| Lowest value of the referenced item values. | **valueX** - 其他函数返回的值(使用监控项历史数据) | 示例:<br>=> **min**(avg(/主机/key),avg(/host2/key2)) |
| **mod** (value,denominator) | < | < |
| Division remainder. | **value** - 待检查值<br>**denominator** - 除数 | 例如：'5'除以'2'的余数为'1'<br><br>示例:<br>=> **mod**(last(/主机/key),2) |
| **pi** | < | < |
| Pi constant (3.14159265358979). | < | 示例:<br>=> **pi**() |
| **power** (value,power value) | < | < |
| The power of a value. | **value** - 待检查值<br>**power value** - N次方值 | 例如：'2'的3次方为'8'<br><br>示例:<br>=> **power**(last(/主机/key),3) |
| **radians** (value) | < | < |
| Convert a value from degrees to radians. | **value** - 待检查值 | 例如：'1'转换为弧度值为'0.0174532925'<br><br>示例:<br>=> **radians**(last(/主机/key)) |
| **rand** | < | < |
| Return a random integer value. | | 使用时间作为种子生成的伪随机数(适用于数学用途，不适用于加密)<br><br>示例:<br>=> **rand**() |
| **round** (value,decimal places) | < | < |
| Round the value to decimal places. | **value** - 待检查值<br>**decimal places** - 指定小数位数(可为0) | 例如：'2.5482'四舍五入到2位小数为'2.55'<br><br>示例:<br>=> **round**(last(/主机/key),2) |
| **signum** (value) | < | < |
| Returns '-1' if a value is negative, '0' if a value is zero, '1' if a value is positive. | **value** - 待检查值 | 示例:<br>=> **signum**(last(/主机/key)) |
| **sin** (value) | < | < |
| The sine of a value, where the value is an angle expressed in radians. | **value** - 待检查值 | 例如：'1'的正弦值为'0.8414709848'<br><br>示例:<br>=> **sin**(last(/主机/key)) |
| **sinh** (value) | < | < |
| The hyperbolical sine of a value. | **value** - 待检查值 | 例如：'1'的双曲正弦值为'1.17520119364'<br><br>示例:<br>=> **sinh**(last(/主机/key)) |
| **sqrt** (value) | < | < |
| Square root of a value. | **value** - 待检查值 | 负值会导致函数失败<br><br>例如：'3.5'的平方根为'1.87082869339'<br><br>示例:<br>=> **sqrt**(last(/主机/key)) |
| **sum** (<value1>,<value2>,...) | < | < |
| Sum of the referenced item values. | **valueX** - 其他函数返回的值(使用监控项历史数据) | 示例:<br>=> **sum**(avg(/主机/key),avg(/host2/key2)) |
| **tan** (value) | < | < |
| The tangent of a value. | **value** - 待检查值 | 例如：'1'的正切值为'1.55740772465'<br><br>示例:<br>=> **tan**(last(/主机/key)) |
| **truncate** (value,decimal places) | < | < |
| Truncate the value to decimal places. | **value** - 待检查值<br>**decimal places** - 指定截断小数位数(可为0) | 示例:<br>=> **truncate**(last(/主机/key),2) |
# 6 MongoDB plugin
# 6 MongoDB 插件
# 6 New template
# 6 新模板
# 6 Page parameters
# 6 页面参数
##### 6 Review and edit configuration files
- edit the Zabbix agent configuration file
**/usr/local/etc/zabbix\_agentd.conf**
You need to configure this file for every host with zabbix\_agentd
installed.
You must specify the Zabbix server **IP address** in the file.
Connections from other hosts will be denied.
- edit the Zabbix server configuration file
**/usr/local/etc/zabbix\_server.conf**
You must specify the database name, user and password (if using any).
The rest of the parameters will suit you with their defaults if you have
a small installation (up to ten monitored hosts). You should change the
default parameters if you want to maximize the performance of Zabbix
server (or proxy) though.
- if you have installed a Zabbix proxy, edit the proxy configuration
file **/usr/local/etc/zabbix\_proxy.conf**
You must specify the server IP address and proxy hostname (must be known
to the server), as well as the database name, user and password (if
using any).
::: noteclassic
With SQLite the full path to database file must be
specified; DB user and password are not required.
:::
##### 6 审查并编辑配置文件
- 编辑 Zabbix agent 配置 file
**/usr/local/etc/zabbix\_agentd.conf**
您需要为每个安装了 zabbix_agentd 的 主机 配置此 file
必须在 file 中指定 Zabbix server 的 **IP地址**
来自其他 主机 的连接将被拒绝
- 编辑 Zabbix server 配置 file
**/usr/local/etc/zabbix\_server.conf**
必须指定数据库名称、用户名和密码（如果使用）
如果您是小规模部署（监控不超过十个 主机），其余参数保持默认即可
但若要最大化Zabbix服务器（或 proxy）性能，则应修改默认参数
- 如果安装了 Zabbix proxy，请编辑 proxy 配置
file **/usr/local/etc/zabbix\_proxy.conf**
必须指定服务器IP地址和 proxy 主机名（必须被服务器识别）
以及数据库名称、用户名和密码（如果使用）
::: noteclassic
使用SQLite时必须指定数据库 file 的完整路径
不需要数据库用户和密码
:::
##### 6 Review component configuration parameters
Make sure to review [Upgrade notes](/manual/installation/upgrade_notes_600) to check if any changes in the configuration parameters are required.
##### 6 审查组件配置参数
请务必查阅[Upgrade notes](/manual/installation/upgrade_notes_600)以确认是否需要调整配置参数。
##### 6 Review component configuration parameters
Make sure to review [Upgrade notes](/manual/installation/upgrade_notes_600) to check if any changes in the configuration parameters are required.
##### 6 审查组件配置参数
请务必查阅[Upgrade notes](/manual/installation/upgrade_notes_600)以确认是否需要调整配置参数。
##### 6 Review component configuration parameters
See the upgrade notes for details on [mandatory
changes](/manual/installation/upgrade_notes_600#configuration_parameters).
##### 6 检查 Zabbix 组件配置文件的参数
在新版本中，Zabbix组件的配置文件发生了一些变化，请详见升级说明。 [mandatory changes](/manual/installation/upgrade_notes_600#configuration_parameters).
# 6 Sender
# 6 Sender
##### 6 Start new Zabbix binaries
Start new binaries. Check log files to see if the binaries have started
successfully.
Zabbix server will automatically upgrade the database. When starting up,
Zabbix server reports the current (mandatory and optional) and required
database versions. If the current mandatory version is older than the
required version, Zabbix server automatically executes the required
database upgrade patches. The start and progress level (percentage) of
the database upgrade is written to the Zabbix server log file. When the
upgrade is completed, a "database upgrade fully completed" message is
written to the log file. If any of the upgrade patches fail, Zabbix
server will not start. Zabbix server will also not start if the current
mandatory database version is newer than the required one. Zabbix server
will only start if the current mandatory database version corresponds to
the required mandatory version.
8673:20161117:104750.259 current database version (mandatory/optional): 03040000/03040000
8673:20161117:104750.259 required mandatory version: 03040000
Before you start the server:
- Make sure the database user has enough permissions (create table,
drop table, create index, drop index)
- Make sure you have enough free disk space.
##### 6 启动新的 Zabbix 二进制文件
启动新的二进制文件。检查日志文件确认二进制文件是否已成功启动。
Zabbix server 将自动升级数据库。启动时，
Zabbix server 会报告当前（强制和可选）及所需的
数据库版本。如果当前强制 version 比所需 version 旧，
Zabbix server 会自动执行所需的数据库升级补丁。数据库升级的
开始和进度级别（百分比）会被写入 Zabbix server 日志 file。当
升级完成时，一条"数据库升级完全完成"的消息会被
写入日志 file。如果任何升级补丁失败，Zabbix
服务器将不会启动。如果当前强制数据库 version 比所需版本新，
Zabbix server 也不会启动。Zabbix server
只会在当前强制数据库 version 与所需强制 version 匹配时启动。
8673:20161117:104750.259 current database version (mandatory/optional): 03040000/03040000
8673:20161117:104750.259 required mandatory version: 03040000
在启动服务器之前：
- 确保数据库用户拥有足够的权限（create 表，
删除表，create 索引，删除索引）
- 确保有足够的可用磁盘空间。
# 6 Supported functions
Click on the respective function group to see more details.
|Function group|Functions|
|-------|----------------|
|[Aggregate functions](/manual/appendix/functions/aggregate)|avg, bucket\_percentile, count, histogram\_quantile, item\_count, kurtosis, mad, max, min, skewness, stddevpop, stddevsamp, sum, sumofsquares, varpop, varsamp|
|[Bitwise functions](/manual/appendix/functions/bitwise)|bitand, bitlshift, bitnot, bitor, bitrshift, bitxor|
|[Date and time functions](/manual/appendix/functions/time)|date, dayofmonth, dayofweek, now, time|
|[History functions](/manual/appendix/functions/history)|change, changecount, count, countunique, find, first, fuzzytime, last, logeventid, logseverity, logsource, monodec, monoinc, nodata, percentile, rate|
|[Trend functions](/manual/appendix/functions/trends)|baselinedev, baselinewma, trendavg, trendcount, trendmax, trendmin, trendstl, trendsum|
|[Mathematical functions](/manual/appendix/functions/math)|abs, acos, asin, atan, atan2, avg, cbrt, ceil, cos, cosh, cot, degrees, e, exp, expm1, floor, log, log10, max, min, mod, pi, power, radians, rand, round, signum, sin, sinh, sqrt, sum, tan, truncate|
|[Operator functions](/manual/appendix/functions/operator)|between, in|
|[Prediction functions](/manual/appendix/functions/prediction)|forecast, timeleft|
|[String functions](/manual/appendix/functions/string)|ascii, bitlength, bytelength, char, concat, insert, left, length, ltrim, mid, repeat, replace, right, rtrim, trim|
These functions are supported in [trigger
expressions](/manual/config/triggers/expression) and [calculated
items](/manual/config/items/itemtypes/calculated).
# 6 支持的函数
单击相应的功能组以查看更多详细信息。
|函数组|函数|
|--------------|---------|
|[聚合函数](/manual/appendix/functions/aggregate)|avg, bucket\_percentile, count, histogram\_quantile, item\_count, kurtosis, mad, max, min, skewness, stddevpop, stddevsamp, sum, sumofsquares, varpop, varsamp|
|[位运算函数](/manual/appendix/functions/bitwise)|bitand, bitlshift, bitnot, bitor, bitrshift, bitxor|
|[日期和时间函数](/manual/appendix/functions/time)|date, dayofmonth, dayofweek, now, time|
|[历史函数](/manual/appendix/functions/history)|change, changecount, count, countunique, find, first, fuzzytime, last, logeventid, logseverity, logsource, monodec, monoinc, nodata, percentile, rate|
|[趋势函数](/manual/appendix/functions/trends)|baselinedev, baselinewma, trendavg, trendcount, trendmax, trendmin, trendstl, trendsum|
|[数学函数](/manual/appendix/functions/math)|abs, acos, asin, atan, atan2, avg, cbrt, ceil, cos, cosh, cot, degrees, e, exp, expm1, floor, log, log10, max, min, mod, pi, power, radians, rand, round, signum, sin, sinh, sqrt, sum, tan, truncate|
|[运算符函数](/manual/appendix/functions/operator)|between, in|
|[预测函数](/manual/appendix/functions/prediction)|forecast, timeleft|
|[字符串函数](/manual/appendix/functions/string)|ascii, bitlength, bytelength, char, concat, insert, left, length, ltrim, mid, repeat, replace, right, rtrim, trim|
[触发器表达式](/manual/config/triggers/expression)和[可计算监控项](/manual/config/items/itemtypes/calculated)支持这些函数。
# 6 Supported functions
Click on the respective function group to see more details.
|Function group|Functions|
|--------------|---------|
|[Aggregate functions](/manual/appendix/functions/aggregate)|avg, bucket\_percentile, count, histogram\_quantile, item\_count, kurtosis, mad, max, min, skewness, stddevpop, stddevsamp, sum, sumofsquares, varpop, varsamp|
|[Bitwise functions](/manual/appendix/functions/bitwise)|bitand, bitlshift, bitnot, bitor, bitrshift, bitxor|
|[Date and time functions](/manual/appendix/functions/time)|date, dayofmonth, dayofweek, now, time|
|[History functions](/manual/appendix/functions/history)|change, changecount, count, countunique, first, fuzzytime, last, logeventid, logseverity, logsource, monodec, monoinc, nodata, percentile, rate, trendavg, trendcount, trendmax, trendmin, trendstl, trendsum|
|[Mathematical functions](/manual/appendix/functions/math)|abs, acos, asin, atan, atan2, avg, cbrt, ceil, cos, cosh, cot, degrees, e, exp, expm1, floor, log, log10, max, min, mod, pi, power, radians, rand, round, signum, sin, sinh, sqrt, sum, tan, truncate|
|[Operator functions](/manual/appendix/functions/operator)|between, in|
|[Prediction functions](/manual/appendix/functions/prediction)|forecast, timeleft|
|[String functions](/manual/appendix/functions/string)|ascii, bitlength, bytelength, char, concat, find, insert, left, length, ltrim, mid, repeat, replace, right, rtrim, trim|
These functions are supported in [trigger
expressions](/manual/config/triggers/expression) and [calculated
items](/manual/config/items/itemtypes/calculated).
# 6 Supported functions
Click on the respective function group to see more details.
|Function group|Functions|
|--------------|---------|
|[Aggregate functions](/manual/appendix/functions/aggregate)|avg, bucket\_percentile, count, histogram\_quantile, item\_count, kurtosis, mad, max, min, skewness, stddevpop, stddevsamp, sum, sumofsquares, varpop, varsamp|
|[Bitwise functions](/manual/appendix/functions/bitwise)|bitand, bitlshift, bitnot, bitor, bitrshift, bitxor|
|[Date and time functions](/manual/appendix/functions/time)|date, dayofmonth, dayofweek, now, time|
|[History functions](/manual/appendix/functions/history)|change, changecount, count, countunique, first, fuzzytime, last, logeventid, logseverity, logsource, monodec, monoinc, nodata, percentile, rate, trendavg, trendcount, trendmax, trendmin, trendsum|
|[Mathematical functions](/manual/appendix/functions/math)|abs, acos, asin, atan, atan2, avg, cbrt, ceil, cos, cosh, cot, degrees, e, exp, expm1, floor, log, log10, max, min, mod, pi, power, radians, rand, round, signum, sin, sinh, sqrt, sum, tan, truncate|
|[Operator functions](/manual/appendix/functions/operator)|between, in|
|[Prediction functions](/manual/appendix/functions/prediction)|forecast, timeleft|
|[String functions](/manual/appendix/functions/string)|ascii, bitlength, bytelength, char, concat, find, insert, left, length, ltrim, mid, repeat, replace, right, rtrim, trim|
These functions are supported in [trigger
expressions](/manual/config/triggers/expression) and [calculated
items](/manual/config/items/itemtypes/calculated).
# 6 Tagging
# 6 标记
# 6 Unstable releases
# 6 不稳定版本
# 6 Users
# 6 用户
# 6 Web interface installation
This section provides step-by-step instructions for installing Zabbix
web interface. Zabbix frontend is written in PHP, so to run it a PHP
supported webserver is needed.
# 6 Web界面安装
本节提供安装Zabbix web界面的分步指南。Zabbix前端使用PHP编写，因此要run它需要支持PHP的web服务器。
# 6 What's new in Zabbix 6.0.1
# 6 Zabbix 6.0.1 的新特性
# 6 Zabbix agent 2 (Windows)
# 6 Zabbix agent 2 (Windows)
# 6 Zabbix appliance
# 6 Zabbix设备
# 7 Calculated items
# 7 计算型 监控项
# 7 Configuration
Please use the sidebar to access content in the Configuration section.
# 7 配置
请使用侧边栏访问配置部分的内容。
# 7 Definitions
# 7 定义
# 7 Discovery
# 7 发现
# 7 Discovery of systemd services
# 7 systemd 服务发现
# 7 Geomap
# 7 地理地图
# 7 Geomap
# 7 地理地图
# 7 Get
# 7 获取
##### 7 Install new Zabbix web interface
The minimum required PHP version is 7.2.5. Update if needed and follow
[installation instructions](/manual/installation/frontend).
##### 7 安装新的Zabbix web界面
PHP最低要求版本为version 7.2.5。如有需要请更新并遵循
[installation instructions](/manual/installation/frontend)。
# 7 Large file support
Large file support, often abbreviated to LFS, is the term applied to the
ability to work with files larger than 2 GB on 32-bit operating systems.
Since Zabbix 2.0 support for large files has been added. This change
affects at least [log file
monitoring](/manual/config/items/itemtypes/log_items) and all
[vfs.file.\*
items](/manual/config/items/itemtypes/zabbix_agent#virtual-file-system-data).
Large file support depends on the capabilities of a system at Zabbix
compilation time, but is completely disabled on a 32-bit Solaris due to
its incompatibility with procfs and swapctl.
# 7 大文件支持
大文件file支持，通常缩写为LFS，指的是在32位操作系统上处理超过2GB文件的能力。
自Zabbix 2.0起已添加对大文件的支持。这一变更至少影响[log file
monitoring](/manual/config/items/itemtypes/log_items)以及所有
[vfs.file.\*
监控项](/manual/config/监控项/itemtypes/zabbix_agent#virtual-file-system-data).
大文件file支持取决于Zabbix编译时系统的能力，但在32位Solaris系统上完全禁用，
因其与procfs和swapctl不兼容。
# 7 Media types
# 7 媒介类型
# 7 MQTT plugin
# 7 MQTT 插件
# 7 Notifications
# 7 通知
# 7 Operator functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Expressions are accepted as parameters
|FUNCTION|<|<|
|--|--|--|
|**Description**|**Function-specific parameters**|**Comments**|
|**between** (value,min,max)|<|<|
|Check if a value belongs to the given range.|**value** - value to check<br>**min** - minimum value<br>**max** - maximum value|Supported value types: integer, float<br><br>Returns:<br>1 - in range<br>0 - otherwise<br><br>Example:<br>=> **between**(last(/host/key),**1**,**10**)=1 - trigger if the value is between 1 and 10.|
|**in** (value,value1,value2,...valueN)|<|<|
|Check if a value is equal to at least one of the listed values.|**value** - value to check<br>**value1,value2,...valueN** - listed values (string values must be double-quoted)|Supported value types: all<br><br>Returns:<br>1 - if equal<br>0 - otherwise<br><br>The value is compared to the listed values as numbers, if all of these values can be converted to numeric; otherwise compared as strings.<br><br>Example:<br>=> **in**(last(/host/key),**5**,**10**)=1 - trigger if the last value is equal to 5 or 10<br>=> **in**(**"text"**, last(/host/key),last(/host/key,\#2))=1 - trigger if "text" is equal to either of the last 2 values.|
# 7 操作员功能
此处列出的所有函数均支持以下场景:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
关于函数参数的通用说明:
- 函数参数使用逗号分隔
- 支持表达式作为参数
| 函数 | < | < |
|--|--|--|
| **Description** | **函数特定参数** | **说明** |
| **between** (value,min,max) | < | < |
| Check if a value belongs to the given range. | **value** - 待检测值<br>**min** - 最小值<br>**max** - 最大值 | 支持的值类型: integer, float<br><br>返回值:<br>1 - 在范围内<br>0 - 其他情况<br><br>示例:<br>=> **between**(last(/主机/key),**1**,**10**)=1 - 当值介于1和10之间时触发 |
| **in** (value,value1,value2,...valueN) | < | < |
| Check if a value is equal to at least one of the listed values. | **value** - 待检测值<br>**value1,value2,...valueN** - 枚举值(string值必须使用双引号) | 支持的值类型: 所有类型<br><br>返回值:<br>1 - 相等时<br>0 - 其他情况<br><br>如果所有枚举值都可转换为数字，则进行数值比较；否则进行字符串比较。<br><br>示例:<br>=> **in**(last(/主机/key),**5**,**10**)=1 - 当最后值与5或10相等时触发<br>=> **in**(**"text"**, last(/主机/key),last(/主机/key,\#2))=1 - 当"text"与最后两个值中任意一个相等时触发 |
# 7 Predictive trigger functions
# 7 种预测性触发器函数
# 7 Real-time export of events, item values, trends
# 7 事件、监控项值和趋势的实时导出
# 7 Real-time export protocol
This section presents details of the [real-time
export](/manual/appendix/install/real_time_export) protocol in a
newline-delimited JSON format for:
- [trigger events](#trigger_events)
- [item values](#item_values)
- [trends](#trends)
All files have a .ndjson extension. Each line of the export file is a
JSON object.
# 7 实时导出协议
本节以换行符分隔的JSON格式详细说明[real-time
export](/manual/appendix/install/real_time_export)协议，适用于：
- [触发器事件](#trigger_events)
- [监控项值](#item_values)
- [趋势数据](#trends)
所有文件均采用.ndjson扩展名。exportfile的每一行均为一个JSONobject。
# 7 Services
# 7 服务
# 7 Standardized templates for network devices
# 7 标准化网络设备模板
##### 7 Start Zabbix processes
Start the updated Zabbix components.
# systemctl start zabbix-server
# systemctl start zabbix-proxy
# systemctl start zabbix-agent
# systemctl start zabbix-agent2
##### 7 启动 Zabbix 进程
启动升级后的 Zabbix 组件。
# systemctl start zabbix-server
# systemctl start zabbix-proxy
# systemctl start zabbix-agent
# systemctl start zabbix-agent2
##### 7 Start Zabbix processes
Start the updated Zabbix components.
systemctl start zabbix-server
systemctl start zabbix-proxy
systemctl start zabbix-agent
systemctl start zabbix-agent2
##### 7 启动Zabbix进程
启动更新后的Zabbix组件。
systemctl start zabbix-server
systemctl start zabbix-proxy
systemctl start zabbix-agent
systemctl start zabbix-agent2
##### 7 Start Zabbix processes
Start the updated Zabbix components.
systemctl start zabbix-server
systemctl start zabbix-proxy
systemctl start zabbix-agent
systemctl start zabbix-agent2
##### 7 启动Zabbix进程
启动更新后的Zabbix组件.
systemctl start zabbix-server
systemctl start zabbix-proxy
systemctl start zabbix-agent
systemctl start zabbix-agent2
# 7 Unit symbols
# 7 单位符号
# 7 Upgrade procedure
# 7 升级流程
# 7 Upgrade procedure
# 7 升级步骤
# 7 Visualization
# 7 可视化
# 7 What's new in Zabbix 6.0.2
# 7 Zabbix 6.0.2 新特性
# 7 Windows performance counters
# 7 个 Windows 性能计数器
# 7 Zabbix agent 2 plugins
# 7 Zabbix agent 2 插件
##### 8 Clear web browser cookies and cache
After the upgrade you may need to clear web browser cookies and web
browser cache for the Zabbix web interface to work properly.
##### 8 清除浏览器cookie和缓存
升级后，您可能需要clear网页浏览器cookies和网页浏览器缓存以使Zabbix web界面正常工作。
##### 8 Clear web browser cookies and cache
After the upgrade you may need to clear web browser cookies and web
browser cache for the Zabbix web interface to work properly.
##### 8 清除浏览器cookie和缓存
升级后，您可能需要clear网页浏览器cookies和网页浏览器缓存以使Zabbix web界面正常工作。
##### 8 Clear web browser cookies and cache
After the upgrade you may need to clear web browser cookies and web
browser cache for the Zabbix web interface to work properly.
##### 8 清除浏览器cookie和缓存
升级后，您可能需要clear网页浏览器cookies和网页浏览器缓存以使Zabbix网页界面正常工作。
##### 8 Clear web browser cookies and cache
After the upgrade you may need to clear web browser cookies and web
browser cache for the Zabbix web interface to work properly.
##### 8 清除浏览器的 Cookies 和缓存
待升级完毕后，可能需要清除浏览器的 Cookies 和缓存，以便 Zabbix 的 Web
界面能正常工作。
# 8 Creating your own theme
# 8 创建自定义主题
# 8 Discovery of Windows services
# 8 Windows 服务发现
# 8 Distribution-specific notes on setting up Nginx for Zabbix
# 8 针对 Zabbix 设置 nginx 的发行版特定说明
# 8 Graph
# 8 图形
# 8 Graph
# 8 图形
# 8 Internal checks
# 8 项内部检查
# 8 JS
# 8 JS
# 8 Known issues
See also: [Compilation issues](/manual/installation/known_issues/compilation_issues).
# 8 已知问题
另请参阅: [Compilation issues](/manual/installation/known_issues/compilation_issues).
# 8 Mass update
# 8 批量更新
# 8 MSSQL plugin
# 8 MSSQL 插件
# 8 Prediction functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
- Function-specific parameters are described with each function
- `/host/key` and `(sec|#num)<:time shift>` parameters must never be
quoted
# 8 预测函数
以下列出的所有函数均支持:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
关于函数参数的一般说明:
- 函数参数由逗号分隔
- 可选函数参数(或参数部分)由`<` `>`表示
- 函数特定参数将在每个函数中单独描述
- `/host/key`和`(sec|#num)<:time shift>`参数绝不能加引号
# 8 Scripts
# 8 脚本
# 8 Sensor
Each sensor chip gets its own directory in the sysfs /sys/devices tree.
To find all sensor chips, it is easier to follow the device symlinks
from /sys/class/hwmon/hwmon\*, where \* is a real number (0,1,2,...).
The sensor readings are located either in /sys/class/hwmon/hwmon\*/
directory for virtual devices, or in /sys/class/hwmon/hwmon\*/device
directory for non-virtual devices. A file, called name, located inside
hwmon\* or hwmon\*/device directories contains the name of the chip,
which corresponds to the name of the kernel driver used by the sensor
chip.
There is only one sensor reading value per file. The common scheme for
naming the files that contain sensor readings inside any of the
directories mentioned above is:
<type><number>\_<item>, where
- **type** - for sensor chips is "in" (voltage), "temp" (temperature),
"fan" (fan), etc.,
- **item** - "input" (measured value), "max" (high threshold), "min"
(low threshold), etc.,
- **number** - always used for elements that can be present more than
once (usually starts from 1, except for voltages which start from
0). If files do not refer to a specific element they have a simple
name with no number.
The information regarding sensors available on the host can be acquired
using **sensor-detect** and **sensors** tools (lm-sensors package:
<http://lm-sensors.org/>). **Sensors-detect** helps to determine which
modules are necessary for available sensors. When modules are loaded the
**sensors** program can be used to show the readings of all sensor
chips. The labeling of sensor readings, used by this program, can be
different from the common naming scheme
(<type><number>\_<item> ):
- if there is a file called <type><number>\_label, then
the label inside this file will be used instead of
<type><number><item> name;
- if there is no <type><number>\_label file, then the
program searches inside the /etc/sensors.conf (could be also
/etc/sensors3.conf, or different) for the name substitution.
This labeling allows user to determine what kind of hardware is used. If
there is neither <type><number>\_label file nor label inside
the configuration file the type of hardware can be determined by the
name attribute (hwmon\*/device/name). The actual names of sensors, which
zabbix\_agent accepts, can be obtained by running **sensors** program
with -u parameter (**sensors -u**).
In **sensor** program the available sensors are separated by the bus
type (ISA adapter, PCI adapter, SPI adapter, Virtual device, ACPI
interface, HID adapter).
# 8 传感器
每个传感器芯片在sysfs的/sys/devices树状结构中都有其专属目录。
要查找所有传感器芯片，更简便的方法是跟踪来自/sys/class/hwmon/hwmon\*的设备符号链接，
其中\*代表实际数字(0,1,2,...)。
传感器读数位于虚拟设备的/sys/class/hwmon/hwmon\*/目录，
或非虚拟设备的/sys/class/hwmon/hwmon\*/device目录中。一个名为file的文件，
位于hwmon\*或hwmon\*/device目录内，包含芯片名称，
对应传感器芯片所使用的内核驱动名称。
每个file仅包含一个传感器读数值。上述任一目录中，
包含传感器读数的文件命名通用规则为：
<类型><编号>\_<监控项>，其中
- **type** - 对传感器芯片而言是"in"(电压)、"temp"(温度)、
"fan"(风扇)等，
- **监控项** - "input"(测量值)、"max"(高阈值)、"min"
(低阈值)等，
- **number** - 始终用于可能存在多个元素的场景
once (usually starts from 1, except for voltages which start from
0). If files do not refer to a specific element they have a simple
name with no number.
关于主机上可用传感器的信息可通过
**sensor-detect**和**sensors**工具(lm-sensors包:
<http://lm-sensors.org/>)获取。**Sensors-detect**帮助确定
可用传感器所需的模块。加载模块后，
**sensors**程序可显示所有传感器芯片的读数。该程序使用的
传感器读数标签可能不同于通用命名规则
(<类型><编号>\_<监控项>):
- 若存在名为<类型><编号>\_label的file，
则该file内的标签将替代
<类型><编号><监控项>名称；
- 若不存在<类型><编号>\_label的file，则
program searches inside the /etc/sensors.conf (could be also
/etc/sensors3.conf, or different) for the name substitution.
这种标签机制使用户能确定所用硬件类型。如果
既无<类型><编号>\_label的file也无配置file中的标签，
硬件类型可通过name属性(hwmon\*/device/name)确定。zabbix\_agent
接受的传感器实际名称可通过带-u参数运行**sensors**程序
(**sensors -u**)获取。
在**sensor**程序中，可用传感器按总线类型分隔
(ISA适配器、PCI适配器、SPI适配器、虚拟设备、ACPI
接口、HID适配器)。
# 8 Service monitoring
# 8 服务监控
# 8 String functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Expressions are accepted as parameters
- String parameters must be double-quoted; otherwise they might get
misinterpreted
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
|FUNCTION|<|<|<|
|--------|-|-|-|
|<|**Description**|**Function-specific parameters**|**Comments**|
|**ascii** (value)|<|<|<|
|<|The ASCII code of the leftmost character of the value.|**value** - value to check|Supported value types: string, text, log<br><br>For example, a value like 'Abc' will return '65' (ASCII code for 'A').<br><br>Example:<br>=> **ascii**(last(/host/key))|
|**bitlength** (value)|<|<|<|
|<|The length of value in bits.|**value** - value to check|Supported value types: string, text, log, integer<br><br>Example:<br>=> **bitlength**(last(/host/key))|
|**bytelength** (value)|<|<|<|
|<|The length of value in bytes.|**value** - value to check|Supported value types: string, text, log, integer<br><br>Example:<br>=> **bytelength**(last(/host/key))|
|**char** (value)|<|<|<|
|<|Return the character by interpreting the value as ASCII code.|**value** - value to check|Supported value types: integer<br><br>The value must be in the 0-255 range. For example, a value like '65' (interpreted as ASCII code) will return 'A'.<br><br>Example:<br>=> **char**(last(/host/key))|
|**concat** (value,string)|<|<|<|
|<|The string resulting from concatenating the value to the specified string.|**value** - value to check<br>**string** - the string to concatenate to|Supported value types: string, text, log<br><br>For example, a value like 'Zab' concatenated to 'bix' (the specified string) will return 'Zabbix'.<br><br>Example:<br>=> **concat**(last(/host/key),**"bix"**)|
|**insert** (value,start,length,replacement)|<|<|<|
|<|Insert specified characters or spaces into the character string beginning at the specified position in the string.|**value** - value to check<br>**start** - start position<br>**length** - positions to replace<br>**replacement** - replacement string|Supported value types: string, text, log<br><br>For example, a value like 'Zabbbix' will be replaced by 'Zabbix' if 'bb' (starting position 3, positions to replace 2) is replaced by 'b'.<br><br>Example:<br>=> **insert**(last(/host/key),**3**,**2**,**"b"**)|
|**left** (value,count)|<|<|<|
|<|The leftmost characters of the value.|**value** - value to check<br>**count** - number of characters to return|Supported value types: string, text, log<br><br>For example, you may return 'Zab' from 'Zabbix' by specifying 3 leftmost characters to return.<br><br>Example:<br>=> **left**(last(/host/key),**3**) - return three leftmost characters<br><br>See also right().|
|**length** (value)|<|<|<|
|<|The length of value in characters.|**value** - value to check|Supported value types: str, text, log<br><br>Example:<br>=> **length**(last(/host/key)) → length of the latest value<br>=> **length**(last(/host/key,\#3)) → length of the third most recent value<br>=> **length**(last(/host/key,\#1:now-1d)) → length of the most recent value one day ago|
|**ltrim** (value,<chars>)|<|<|<|
|<|Remove specified characters from the beginning of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is left-trimmed by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **ltrim**(last(/host/key)) - remove whitespace from the beginning of string<br>=> **ltrim**(last(/host/key),**"Z"**) - remove any 'Z' from the beginning of string<br>=> **ltrim**(last(/host/key),**" Z"**) - remove any space and 'Z' from the beginning of string<br><br>See also: rtrim(), trim()|
|**mid** (value,start,length)|<|<|<|
|<|Return a substring of N characters beginning at the character position specified by 'start'.|**value** - value to check<br>**start** - start position of substring<br>**length** - positions to return in substring|Supported value types: string, text, log<br><br>For example, it is possible return 'abbi' from a value like 'Zabbix' if starting position is 2, and positions to return is 4).<br><br>Example:<br>=> **mid**(last(/host/key),**2**,**4**)="abbi"|
|**repeat** (value,count)|<|<|<|
|<|Repeat a string.|**value** - value to check<br>**count** - number of times to repeat|Supported value types: string, text, log<br><br>Example:<br>=> **repeat**(last(/host/key),**2**) - repeat the value two times|
|**replace** (value,pattern,replacement)|<|<|<|
|<|Find pattern in the value and replace with replacement. All occurrences of the pattern will be replaced.|**value** - value to check<br>**pattern** - pattern to find<br>**replacement** - string to replace the pattern with|Supported value types: string, text, log<br><br>Example:<br>=> **replace**(last(/host/key),**"ibb"**,**"abb"**) - replace all 'ibb' with 'abb'|
|**right** (value,count)|<|<|<|
|<|The rightmost characters of the value.|**value** - value to check<br>**count** - number of characters to return|Supported value types: string, text, log<br><br>For example, you may return 'bix' from 'Zabbix' by specifying 3 rightmost characters to return.<br><br>Example:<br>=> **right**(last(/host/key),**3**) - return three rightmost characters<br><br>See also left().|
|**rtrim** (value,<chars>)|<|<|<|
|<|Remove specified characters from the end of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is right-trimmed by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **rtrim**(last(/host/key)) - remove whitespace from the end of string<br>=> **rtrim**(last(/host/key),**"x"**) - remove any 'x' from the end of string<br>=> **rtrim**(last(/host/key),**"x "**) - remove any 'x' or space from the end of string<br><br>See also: ltrim(), trim()|
|**trim** (value,<chars>)|<|<|<|
|<|Remove specified characters from the beginning and end of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is trimmed from both sides by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **trim**(last(/host/key)) - remove whitespace from the beginning and end of string<br>=> **trim**(last(/host/key),**"\_"**) - remove '\_' from the beginning and end of string<br><br>See also: ltrim(), rtrim()|
# 8 String functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Expressions are accepted as parameters
- String parameters must be double-quoted; otherwise they might get
misinterpreted
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
|FUNCTION|<|<|<|
|--------|-|-|-|
|<|**Description**|**Function-specific parameters**|**Comments**|
|**ascii** (value)|<|<|<|
|<|The ASCII code of the leftmost character of the value.|**value** - value to check|Supported value types: string, text, log<br><br>For example, a value like 'Abc' will return '65' (ASCII code for 'A').<br><br>Example:<br>=> **ascii**(last(/host/key))|
|**bitlength** (value)|<|<|<|
|<|The length of value in bits.|**value** - value to check|Supported value types: string, text, log, integer<br><br>Example:<br>=> **bitlength**(last(/host/key))|
|**bytelength** (value)|<|<|<|
|<|The length of value in bytes.|**value** - value to check|Supported value types: string, text, log, integer<br><br>Example:<br>=> **bytelength**(last(/host/key))|
|**char** (value)|<|<|<|
|<|Return the character by interpreting the value as ASCII code.|**value** - value to check|Supported value types: integer<br><br>The value must be in the 0-255 range. For example, a value like '65' (interpreted as ASCII code) will return 'A'.<br><br>Example:<br>=> **char**(last(/host/key))|
|**concat** (value,string)|<|<|<|
|<|The string resulting from concatenating the value to the specified string.|**value** - value to check<br>**string** - the string to concatenate to|Supported value types: string, text, log<br><br>For example, a value like 'Zab' concatenated to 'bix' (the specified string) will return 'Zabbix'.<br><br>Example:<br>=> **concat**(last(/host/key),**"bix"**)|
|**insert** (value,start,length,replacement)|<|<|<|
|<|Insert specified characters or spaces into the character string beginning at the specified position in the string.|**value** - value to check<br>**start** - start position<br>**length** - positions to replace<br>**replacement** - replacement string|Supported value types: string, text, log<br><br>For example, a value like 'Zabbbix' will be replaced by 'Zabbix' if 'bb' (starting position 3, positions to replace 2) is replaced by 'b'.<br><br>Example:<br>=> **insert**(last(/host/key),**3**,**2**,**"b"**)|
|**left** (value,count)|<|<|<|
|<|The leftmost characters of the value.|**value** - value to check<br>**count** - number of characters to return|Supported value types: string, text, log<br><br>For example, you may return 'Zab' from 'Zabbix' by specifying 3 leftmost characters to return.<br><br>Example:<br>=> **left**(last(/host/key),**3**) - return three leftmost characters<br><br>See also right().|
|**length** (value)|<|<|<|
|<|The length of value in characters.|**value** - value to check|Supported value types: str, text, log<br><br>Example:<br>=> **length**(last(/host/key)) → length of the latest value<br>=> **length**(last(/host/key,\#3)) → length of the third most recent value<br>=> **length**(last(/host/key,\#1:now-1d)) → length of the most recent value one day ago|
|**ltrim** (value,<chars>)|<|<|<|
|<|Remove specified characters from the beginning of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is left-trimmed by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **ltrim**(last(/host/key)) - remove whitespace from the beginning of string<br>=> **ltrim**(last(/host/key),**"Z"**) - remove any 'Z' from the beginning of string<br>=> **ltrim**(last(/host/key),**" Z"**) - remove any space and 'Z' from the beginning of string<br><br>See also: rtrim(), trim()|
|**mid** (value,start,length)|<|<|<|
|<|Return a substring of N characters beginning at the character position specified by 'start'.|**value** - value to check<br>**start** - start position of substring<br>**length** - positions to return in substring|Supported value types: string, text, log<br><br>For example, it is possible return 'abbi' from a value like 'Zabbix' if starting position is 2, and positions to return is 4).<br><br>Example:<br>=> **mid**(last(/host/key),**2**,**4**)="abbi"|
|**repeat** (value,count)|<|<|<|
|<|Repeat a string.|**value** - value to check<br>**count** - number of times to repeat|Supported value types: string, text, log<br><br>Example:<br>=> **repeat**(last(/host/key),**2**) - repeat the value two times|
|**replace** (value,pattern,replacement)|<|<|<|
|<|Find pattern in the value and replace with replacement. All occurrences of the pattern will be replaced.|**value** - value to check<br>**pattern** - pattern to find<br>**replacement** - string to replace the pattern with|Supported value types: string, text, log<br><br>Example:<br>=> **replace**(last(/host/key),**"ibb"**,**"abb"**) - replace all 'ibb' with 'abb'|
|**right** (value,count)|<|<|<|
|<|The rightmost characters of the value.|**value** - value to check<br>**count** - number of characters to return|Supported value types: string, text, log<br><br>For example, you may return 'bix' from 'Zabbix' by specifying 3 rightmost characters to return.<br><br>Example:<br>=> **right**(last(/host/key),**3**) - return three rightmost characters<br><br>See also left().|
|**rtrim** (value,<chars>)|<|<|<|
|<|Remove specified characters from the end of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is right-trimmed by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **rtrim**(last(/host/key)) - remove whitespace from the end of string<br>=> **rtrim**(last(/host/key),**"x"**) - remove any 'x' from the end of string<br>=> **rtrim**(last(/host/key),**"x "**) - remove any 'x' or space from the end of string<br><br>See also: ltrim(), trim()|
|**trim** (value,<chars>)|<|<|<|
|<|Remove specified characters from the beginning and end of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is trimmed from both sides by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **trim**(last(/host/key)) - remove whitespace from the beginning and end of string<br>=> **trim**(last(/host/key),**"\_"**) - remove '\_' from the beginning and end of string<br><br>See also: ltrim(), rtrim()|
# 8 Templates
# 8 模板
# 8 Time period syntax
# 8 时间段语法
# 8 What's new in Zabbix 6.0.3
# 8 Zabbix 6.0.3 新特性
# 8 Zabbix Java gateway
If you use `startup.sh` and `shutdown.sh` scripts for starting [Zabbix
Java gateway](/manual/concepts/java), then you can specify the necessary
configuration parameters in the `settings.sh` file. The startup and
shutdown scripts source the settings file and take care of converting
shell variables (listed in the first column) to Java properties (listed
in the second column).
If you start Zabbix Java gateway manually by running `java` directly,
then you specify the corresponding Java properties on the command line.
|Variable|Property|Mandatory|Range|Default|Description|
|--------|--------|---------|-----|-------|-----------|
|LISTEN\_IP|zabbix.listenIP|no| |0.0.0.0|IP address to listen on.|
|LISTEN\_PORT|zabbix.listenPort|no|1024-32767|10052|Port to listen on.|
|PID\_FILE|zabbix.pidFile|no| |/tmp/zabbix\_java.pid|Name of PID file. If omitted, Zabbix Java Gateway is started as a console application.|
|PROPERTIES\_FILE|zabbix.propertiesFile|no| | |Name of properties file. Can be used to set additional properties using a key-value format in such a way that they are not visible on a command line or to overwrite existing ones.<br>For example: "javax.net.ssl.trustStorePassword=<password>"|
|START\_POLLERS|zabbix.startPollers|no|1-1000|5|Number of worker threads to start.|
|TIMEOUT|zabbix.timeout|no|1-30|3|How long to wait for network operations.|
::: notewarning
Port 10052 is not [IANA
registered](http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt).
:::
# 8 Zabbix Java gateway
如果使用`startup.sh`和`shutdown.sh`脚本来启动[Zabbix
Java gateway](/manual/concepts/java)，则可以在`settings.sh` file中指定必要的配置参数。启动和关闭脚本会加载该设置file，并负责将shell变量（第一列列出）转换为Java属性（第二列列出）。
如果通过直接运行`java`手动启动Zabbix Java网关，则需在命令行中指定相应的Java属性。
| 变量 | 属性 | 必填 | 范围 | 默认值 | 描述 |
|--------|--------|---------|-----|-------|-----------|
| LISTEN\_IP | zabbix.listenIP | no | | 0.0.0.0 | 监听的IP地址。 |
| LISTEN\_PORT | zabbix.listenPort | no | 1024-32767 | 10052 | 监听的端口。 |
| PID\_FILE | zabbix.pidFile | no | | /tmp/zabbix\_java.pid | PID file的名称。如果省略，Zabbix Java网关将以控制台应用程序形式启动。 |
| PROPERTIES\_FILE | zabbix.propertiesFile | no | | | 属性file的名称。可用于以键值格式设置额外属性，使其不会在命令行中显示，或覆盖现有属性。<br>例如："javax.net.ssl.trustStorePassword=<password>" |
| START\_POLLERS | zabbix.startPollers | no | 1-1000 | 5 | 启动的工作线程数。 |
| TIMEOUT | zabbix.timeout | no | 1-30 | 3 | 等待网络操作的最长时间。 |
::: notewarning
端口10052不是[IANA
registered](http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt)。
:::
# 9 Command execution
Zabbix uses common functionality for external checks, user parameters,
system.run items, custom alert scripts, remote commands and global
scripts.
# 9 命令执行
Zabbix使用通用功能来实现外部检查、用户参数、
系统.run 监控项、自定义告警脚本、远程命令以及全局
脚本。
# 9 Debug mode
# 9 调试模式
# 9 Discovery of Windows performance counter instances
# 9 Windows性能计数器实例的发现
# 9 Graph (classic)
# 9 图形（经典）
# 9 Graph (classic)
# 9 图形（经典）
# 9 MySQL plugin
[comment]: # (tags: mysql)
# 9 MySQL 插件
[comment]: # (tags: mysql)
# 9 Notes on memtype parameter in proc.mem items
# 9 proc.mem 监控项中 memtype 参数的使用说明
# 9 Queue
# 9 队列
# 9 Running agent as root
Since Zabbix **5.0.0**, the systemd service file for Zabbix agent in [official
packages](https://www.zabbix.com/download) explicitly includes directives for `User` and `Group`.
Both are set to `zabbix`.
It is no longer possible to configure which user Zabbix agent runs as via `zabbix_agentd.conf` file,
because the agent will bypass this configuration and run as the user specified in the systemd service file.
To run Zabbix agent as root you need to make the modifications described below.
# 9 以 root 身份运行 agent
自Zabbix **5.0.0**起，[official
packages](https://www.zabbix.com/download)中用于Zabbix agent的systemd服务file明确包含了针对`User`和`Group`的指令。
两者均被设置为`zabbix`。
不再能通过`zabbix_agentd.conf` file配置Zabbix agent的运行用户，
因为agent将绕过此配置，并按照systemd服务file中指定的用户run。
若要以root用户run Zabbix agent，需按以下说明进行修改。
# 9 SSH checks
# 9 SSH检查
# 9 String functions
All functions listed here are supported in:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
Some general notes on function parameters:
- Function parameters are separated by a comma
- Expressions are accepted as parameters
- String parameters must be double-quoted; otherwise they might get
misinterpreted
- Optional function parameters (or parameter parts) are indicated by
`<` `>`
|FUNCTION|<|<|
|--|--|--|
|**Description**|**Function-specific parameters**|**Comments**|
|**ascii** (value)|<|<|
|The ASCII code of the leftmost character of the value.|**value** - value to check|Supported value types: string, text, log<br><br>For example, a value like 'Abc' will return '65' (ASCII code for 'A').<br><br>Example:<br>=> **ascii**(last(/host/key))|
|**bitlength** (value)|<|<|
|The length of value in bits.|**value** - value to check|Supported value types: string, text, log, integer<br><br>Example:<br>=> **bitlength**(last(/host/key))|
|**bytelength** (value)|<|<|
|The length of value in bytes.|**value** - value to check|Supported value types: string, text, log, integer<br><br>Example:<br>=> **bytelength**(last(/host/key))|
|**char** (value)|<|<|
|Return the character by interpreting the value as ASCII code.|**value** - value to check|Supported value types: integer<br><br>The value must be in the 0-255 range. For example, a value like '65' (interpreted as ASCII code) will return 'A'.<br><br>Example:<br>=> **char**(last(/host/key))|
|**concat** (<value1>,<value2>,...)|<|<|
|The string resulting from concatenating referenced item values or constant values. |**value** - a value returned by one of the history functions or a constant value (string, integer, or float number)|Supported value types: string, text, log, float, integer <br><br>For example, a value like 'Zab' concatenated to 'bix' (the constant string) will return 'Zabbix'. <br><br> Must contain at least two parameters. <br><br>Examples:<br>=> **concat**(last(/host/key),**"bix"**)<br>=> **concat**("1 min: ",last(/host/system.cpu.load[all,avg1]),", 15 min: ",last(/host/system.cpu.load[all,avg15])) |
|**insert** (value,start,length,replacement)|<|<|
|Insert specified characters or spaces into the character string beginning at the specified position in the string.|**value** - value to check<br>**start** - start position<br>**length** - positions to replace<br>**replacement** - replacement string|Supported value types: string, text, log<br><br>For example, a value like 'Zabbbix' will be replaced by 'Zabbix' if 'bb' (starting position 3, positions to replace 2) is replaced by 'b'.<br><br>Example:<br>=> **insert**(last(/host/key),**3**,**2**,**"b"**)|
|**left** (value,count)|<|<|
|The leftmost characters of the value.|**value** - value to check<br>**count** - number of characters to return|Supported value types: string, text, log<br><br>For example, you may return 'Zab' from 'Zabbix' by specifying 3 leftmost characters to return.<br><br>Example:<br>=> **left**(last(/host/key),**3**) - return three leftmost characters<br><br>See also right().|
|**length** (value)|<|<|
|The length of value in characters.|**value** - value to check|Supported value types: str, text, log<br><br>Example:<br>=> **length**(last(/host/key)) → length of the latest value<br>=> **length**(last(/host/key,\#3)) → length of the third most recent value<br>=> **length**(last(/host/key,\#1:now-1d)) → length of the most recent value one day ago|
|**ltrim** (value,<chars>)|<|<|
|Remove specified characters from the beginning of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is left-trimmed by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **ltrim**(last(/host/key)) - remove whitespace from the beginning of string<br>=> **ltrim**(last(/host/key),**"Z"**) - remove any 'Z' from the beginning of string<br>=> **ltrim**(last(/host/key),**" Z"**) - remove any space and 'Z' from the beginning of string<br><br>See also: rtrim(), trim()|
|**mid** (value,start,length)|<|<|
|Return a substring of N characters beginning at the character position specified by 'start'.|**value** - value to check<br>**start** - start position of substring<br>**length** - positions to return in substring|Supported value types: string, text, log<br><br>For example, it is possible return 'abbi' from a value like 'Zabbix' if starting position is 2, and positions to return is 4).<br><br>Example:<br>=> **mid**(last(/host/key),**2**,**4**)="abbi"|
|**repeat** (value,count)|<|<|
|Repeat a string.|**value** - value to check<br>**count** - number of times to repeat|Supported value types: string, text, log<br><br>Example:<br>=> **repeat**(last(/host/key),**2**) - repeat the value two times|
|**replace** (value,pattern,replacement)|<|<|
|Find pattern in the value and replace with replacement. All occurrences of the pattern will be replaced.|**value** - value to check<br>**pattern** - pattern to find<br>**replacement** - string to replace the pattern with|Supported value types: string, text, log<br><br>Example:<br>=> **replace**(last(/host/key),**"ibb"**,**"abb"**) - replace all 'ibb' with 'abb'|
|**right** (value,count)|<|<|
|The rightmost characters of the value.|**value** - value to check<br>**count** - number of characters to return|Supported value types: string, text, log<br><br>For example, you may return 'bix' from 'Zabbix' by specifying 3 rightmost characters to return.<br><br>Example:<br>=> **right**(last(/host/key),**3**) - return three rightmost characters<br><br>See also left().|
|**rtrim** (value,<chars>)|<|<|
|Remove specified characters from the end of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is right-trimmed by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **rtrim**(last(/host/key)) - remove whitespace from the end of string<br>=> **rtrim**(last(/host/key),**"x"**) - remove any 'x' from the end of string<br>=> **rtrim**(last(/host/key),**"x "**) - remove any 'x' or space from the end of string<br><br>See also: ltrim(), trim()|
|**trim** (value,<chars>)|<|<|
|Remove specified characters from the beginning and end of string.|**value** - value to check<br>**chars** - (optional) specify characters to remove<br><br>Whitespace is trimmed from both sides by default (if no optional characters are specified).|Supported value types: string, text, log<br><br>Example:<br>=> **trim**(last(/host/key)) - remove whitespace from the beginning and end of string<br>=> **trim**(last(/host/key),**"\_"**) - remove '\_' from the beginning and end of string<br><br>See also: ltrim(), rtrim()|
# 9 string 函数
此处列出的所有函数均支持以下场景:
- [Trigger expressions](/manual/config/triggers/expression)
- [Calculated items](/manual/config/items/itemtypes/calculated)
关于函数参数的通用说明:
- 函数参数通过逗号分隔
- 表达式可作为参数使用
- string参数必须使用双引号包裹，否则可能被get错误解析
- 可选函数参数（或参数部分）通过
`<` `>`
`<` `>`标识
| 函数 | < | < |
|--|--|--|
| **Description** | **函数特定参数** | **说明** |
| **ascii** (value) | < | < |
| The ASCII code of the leftmost character of the value. | **value** - 待检查的值 | 支持的值类型: string, 文本, 日志<br><br>例如: 'Abc'将返回'65'（'A'的ASCII码）<br><br>示例:<br>=> **ascii**(last(/主机/key)) |
| **bitlength** (value) | < | < |
| The length of value in bits. | **value** - 待检查的值 | 支持的值类型: string, 文本, 日志, integer<br><br>示例:<br>=> **bitlength**(last(/主机/key)) |
| **bytelength** (value) | < | < |
| The length of value in bytes. | **value** - 待检查的值 | 支持的值类型: string, 文本, 日志, integer<br><br>示例:<br>=> **bytelength**(last(/主机/key)) |
| **char** (value) | < | < |
| Return the character by interpreting the value as ASCII code. | **value** - 待检查的值 | 支持的值类型: integer<br><br>值必须在0-255范围内。例如: '65'（ASCII码）将返回'A'<br><br>示例:<br>=> **char**(last(/主机/key)) |
| **concat** (<value1>,<value2>,...) | < | < |
| The string resulting from concatenating referenced item values or constant values. | **value** - 历史函数返回值或常量值（string, integer或float数字） | 支持的值类型: string, 文本, 日志, float, integer <br><br>例如: 'Zab'与常量string'bix'连接将返回'Zabbix'<br><br>必须包含至少两个参数<br><br>示例:<br>=> **concat**(last(/主机/key),**"bix"**)<br>=> **concat**("1 min: ",last(/主机/system.cpu.load[all,avg1]),", 15 min: ",last(/主机/system.cpu.load[all,avg15])) |
| **insert** (value,start,length,replacement) | < | < |
| Insert specified characters or spaces into the character string beginning at the specified position in the string. | **value** - 待检查的值<br>**start** - 起始位置<br>**length** - 替换长度<br>**replacement** - 替换string | 支持的值类型: string, 文本, 日志<br><br>例如: 'Zabbbix'从第3位开始替换2个字符为'b'将返回'Zabbix'<br><br>示例:<br>=> **insert**(last(/主机/key),**3**,**2**,**"b"**) |
| **left** (value,count) | < | < |
| The leftmost characters of the value. | **value** - 待检查的值<br>**count** - 返回字符数 | 支持的值类型: string, 文本, 日志<br><br>例如: 从'Zabbix'中指定返回左侧3个字符将得到'Zab'<br><br>示例:<br>=> **left**(last(/主机/key),**3**) - 返回左侧3个字符<br><br>另见right()函数 |
| **length** (value) | < | < |
| The length of value in characters. | **value** - 待检查的值 | 支持的值类型: str, 文本, 日志<br><br>示例:<br>=> **length**(last(/主机/key)) → 最新值的长度<br>=> **length**(last(/主机/key,\#3)) → 倒数第三个值的长度<br>=> **length**(last(/主机/key,\#1:now-1d)) → 一天前最新值的长度 |
| **ltrim** (value,<chars>) | < | < |
| Remove specified characters from the beginning of string. | **value** - 待检查的值<br>**chars** - (可选)指定要移除的字符<br><br>默认移除左侧空白字符（如未指定可选字符） | 支持的值类型: string, 文本, 日志<br><br>示例:<br>=> **ltrim**(last(/主机/key)) - 移除string开头的空白<br>=> **ltrim**(last(/主机/key),**"Z"**) - 移除string开头的所有'Z'<br>=> **ltrim**(last(/主机/key),**" Z"**) - 移除string开头的空格和'Z'<br><br>另见: rtrim(), trim() |
| **mid** (value,start,length) | < | < |
| Return a substring of N characters beginning at the character position specified by 'start'. | **value** - 待检查的值<br>**start** - 子串起始位置<br>**length** - 子串长度 | 支持的值类型: string, 文本, 日志<br><br>例如: 从'Zabbix'中第2位开始取4个字符将返回'abbi'<br><br>示例:<br>=> **mid**(last(/主机/key),**2**,**4**)="abbi" |
| **repeat** (value,count) | < | < |
| Repeat a string. | **value** - 待检查的值<br>**count** - 重复次数 | 支持的值类型: string, 文本, 日志<br><br>示例:<br>=> **repeat**(last(/主机/key),**2**) - 将值重复两次 |
| **replace** (value,pattern,replacement) | < | < |
| Find pattern in the value and replace with replacement. All occurrences of the pattern will be replaced. | **value** - 待检查的值<br>**pattern** - 查找模式<br>**replacement** - 替换string | 支持的值类型: string, 文本, 日志<br><br>示例:<br>=> **replace**(last(/主机/key),**"ibb"**,**"abb"**) - 将所有'ibb'替换为'abb' |
| **right** (value,count) | < | < |
| The rightmost characters of the value. | **value** - 待检查的值<br>**count** - 返回字符数 | 支持的值类型: string, 文本, 日志<br><br>例如: 从'Zabbix'中指定返回右侧3个字符将得到'bix'<br><br>示例:<br>=> **right**(last(/主机/key),**3**) - 返回右侧3个字符<br><br>另见left()函数 |
| **rtrim** (value,<chars>) | < | < |
| Remove specified characters from the end of string. | **value** - 待检查的值<br>**chars** - (可选)指定要移除的字符<br><br>默认移除右侧空白字符（如未指定可选字符） | 支持的值类型: string, 文本, 日志<br><br>示例:<br>=> **rtrim**(last(/主机/key)) - 移除string末尾的空白<br>=> **rtrim**(last(/主机/key),**"x"**) - 移除string末尾的所有'x'<br>=> **rtrim**(last(/主机/key),**"x "**) - 移除string末尾的'x'或空格<br><br>另见: ltrim(), trim() |
| **trim** (value,<chars>) | < | < |
| Remove specified characters from the beginning and end of string. | **value** - 待检查的值<br>**chars** - (可选)指定要移除的字符<br><br>默认移除两侧空白字符（如未指定可选字符） | 支持的值类型: string, 文本, 日志<br><br>示例:<br>=> **trim**(last(/主机/key)) - 移除string两端的空白<br>=> **trim**(last(/主机/key),**"\_"**) - 移除string两端的'_'<br><br>另见: ltrim(), rtrim() |
# 9 Template changes
This page lists all changes to the stock templates that are shipped with
Zabbix.
Note that upgrading to the latest Zabbix version will not automatically
upgrade the templates used. It is suggested to modify the templates in
existing installations by:
- Downloading the latest templates from the [Zabbix Git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates);
- Then, while in *Configuration* → *Templates* you can import them
manually into Zabbix. If templates with the same names already
exist, the *Delete missing* options should be checked when importing
to achieve a clean import. This way the old items that are no longer
in the updated template will be removed (note that it will mean
losing history of these old items).
# 9 模板变更
本页面列出了Zabbix内置标准模板的所有变更内容。
请注意升级到最新Zabbix version不会自动更新已使用的模板。建议通过以下方式修改现有安装中的模板：
- 从[Zabbix Git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates)下载最新模板；
- 然后在*配置* → *模板*界面中手动import到Zabbix。若存在同名模板，导入时应勾选*删除缺失项*选项以实现干净的import。这种方式将移除更新模板中不再包含的旧监控项（注意这意味着会丢失这些旧监控项的历史数据）。
# 9 Templates out of the box
# 9 开箱即用模板
# 9 Value mapping
# 9 值映射
# 9 Web monitoring
# 9 Web 监控
# 9 Web service
# 9 Web 服务
# 9 What's new in Zabbix 6.0.4
# 9 Zabbix 6.0.4 新特性
# 9 Zabbix web service
# 9 Zabbix Web 服务
#### Absence of data
For items with a regular update interval, nothing is displayed in the
graph if item data are not collected.
However, for trapper items and items with a scheduled update interval
(and regular update interval set to 0), a straight line is drawn leading
up to the first collected value and from the last collected value to the
end of graph; the line is on the level of the first/last value
respectively.
#### 数据缺失
对于具有常规update间隔的监控项，如果未收集到监控项数据，图表中将不显示任何内容。
然而，对于trapper类型的监控项以及具有计划update间隔的监控项（且常规update间隔设置为0），系统会绘制一条直线从图表起始位置延伸至首个采集到的数值点，并从最后一个采集值延伸至图表末端；该直线分别保持与首/末数值相同的水平位置。
### Access control
### 访问控制
#### Accessing host dashboards
Access to host dashboards is provided:
- From the [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu)
that is available in many frontend locations:
- click on the host name and then select *Dashboards* from the
drop-down menu
- When searching for a host name in [global
search](/manual/web_interface/global_search):
- click on the *Dashboards* link provided in search results
```{=html}
<!-- -->
```
- When clicking on a host name in *Inventory* →
*[Hosts](/manual/web_interface/frontend_sections/inventory/hosts)*:
- click on the *Dashboards* link provided
#### 访问主机仪表盘
访问主机仪表盘的途径:
- 从[host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu)
that is available in many frontend locations:
- click on the host name and then select *Dashboards* from the
drop-down menu
- 在[global
search](/manual/web_interface/global_search):
- click on the *Dashboards* link provided in search results
```{=html}
<!-- -->
```
- When clicking on a host name in *Inventory* →
*[Hosts](/manual/web_interface/frontend_sections/inventory/hosts)*中搜索一个主机名称时:
- 点击提供的*Dashboards*链接
#### Access permissions
Make sure that the 'zabbix' user has execute permissions for configured
commands. One may be interested in using **sudo** to give access to
privileged commands. To configure access, execute as root:
visudo
Example lines that could be used in *sudoers* file:
# allows 'zabbix' user to run all commands without password.
zabbix ALL=NOPASSWD: ALL
# allows 'zabbix' user to restart apache without password.
zabbix ALL=NOPASSWD: /etc/init.d/apache restart
::: notetip
On some systems *sudoers* file will prevent non-local
users from executing commands. To change this, comment out
**requiretty** option in */etc/sudoers*.
:::
#### 访问权限
确保'zabbix'用户对配置的命令拥有execute权限。可以考虑使用**sudo**来授予特权命令的访问权限。要配置访问权限，请以root身份execute：
visudo
可在*sudoers* file中使用的示例行：
# allows 'zabbix' user to run all commands without password.
zabbix ALL=NOPASSWD: ALL
# 允许'zabbix'用户无需密码重启apache
zabbix ALL=NOPASSWD: /etc/init.d/apache restart
::: notetip
在某些系统上，*sudoers* file会阻止非本地用户执行命令。要更改此设置，请在*/etc/sudoers*中注释掉**requiretty**选项。
:::
#### Accidental installation of EPEL Zabbix packages
With EPEL repository installed and enabled, installing Zabbix from packages will lead to EPEL Zabbix packages being installed rather than official Zabbix packages.
In this case uninstall Zabbix packages from EPEL, i.e.:
dnf remove zabbix-server-mysql
Block Zabbix packages from EPEL. Add the following line in the `/etc/yum.conf` file:
exclude=zabbix6.0*
Install Zabbix server again:
dnf install zabbix-server-mysql
Notice that official Zabbix packages have the word `release` in their version string:
6.0.25-release1.el8
#### 意外安装 EPEL Zabbix 软件包
当已安装并启用EPEL仓库时，从软件包安装Zabbix将导致安装EPEL的Zabbix软件包而非官方Zabbix软件包。
这种情况下需卸载来自EPEL的Zabbix软件包，例如：
dnf remove zabbix-server-mysql
屏蔽EPEL的Zabbix软件包。在`/etc/yum.conf` file中添加以下行：
exclude=zabbix6.0*
重新安装Zabbix server：
dnf install zabbix-server-mysql
注意官方Zabbix软件包在其version string中包含`release`字样：
6.0.25-release1.el8
#### Acknowledging an event
Acknowledge a single event and leave a message.
Request:
```json
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": "20427",
"action": 6,
"message": "Problem resolved."
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"eventids": [
"20427"
]
},
"id": 1
}
```
#### 确认事件
确认单个事件并留下消息.
请求:
```json
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": "20427",
"action": 6,
"message": "Problem resolved."
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"eventids": [
"20427"
]
},
"id": 1
}
```
# action.create
# action.create
# action.delete
# action.delete
#### Action filter condition
The action filter condition object defines a specific condition that
must be checked before running the action operations.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|conditionid|string|*(readonly)* ID of the action condition.|
|**conditiontype**<br>(required)|integer|Type of condition.<br><br>Possible values for trigger actions:<br>0 - host group;<br>1 - host;<br>2 - trigger;<br>3 - event name;<br>4 - trigger severity;<br>6 - time period;<br>13 - host template;<br>16 - problem is suppressed;<br>25 - event tag;<br>26 - event tag value.<br><br>Possible values for discovery actions:<br>7 - host IP;<br>8 - discovered service type;<br>9 - discovered service port;<br>10 - discovery status;<br>11 - uptime or downtime duration;<br>12 - received value;<br>18 - discovery rule;<br>19 - discovery check;<br>20 - proxy;<br>21 - discovery object.<br><br>Possible values for autoregistration actions:<br>20 - proxy;<br>22 - host name;<br>24 - host metadata.<br><br>Possible values for internal actions:<br>0 - host group;<br>1 - host;<br>13 - host template;<br>23 - event type;<br>25 - event tag;<br>26 - event tag value.<br><br>Possible values for service actions:<br>25 - event tag;<br>26 - event tag value;<br>27 - service;<br>28 - service name.|
|**value**<br>(required)|string|Value to compare with.|
|value2<br>|string|Secondary value to compare with. Required for trigger, internal and service actions when condition type is *26*.|
|actionid|string|*(readonly)* ID of the action that the condition belongs to.|
|formulaid|string|Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - *(default)* equals;<br>1 - does not equal;<br>2 - contains;<br>3 - does not contain;<br>4 - in;<br>5 - is greater than or equals;<br>6 - is less than or equals;<br>7 - not in;<br>8 - matches;<br>9 - does not match;<br>10 - Yes;<br>11 - No.|
::: notetip
To better understand how to use filters with various
types of expressions, see examples on the
[action.get](get#retrieve_discovery_actions) and
[action.create](create#using_a_custom_expression_filter) method
pages.
:::
The following operators and values are supported for each condition
type.
|Condition|Condition name|Supported operators|Expected value|
|-|--|--|------|
|0|Host group|equals,<br>does not equal|Host group ID.|
|1|Host|equals,<br>does not equal|Host ID.|
|2|Trigger|equals,<br>does not equal|Trigger ID.|
|3|Event name|contains,<br>does not contain|Event name.|
|4|Trigger severity|equals,<br>does not equal,<br>is greater than or equals,<br>is less than or equals|Trigger severity. Refer to the [trigger "severity" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger severities.|
|5|Trigger value|equals|Trigger value. Refer to the [trigger "value" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger values.|
|6|Time period|in, not in|Time when the event was triggered as a [time period](/manual/appendix/time_period).|
|7|Host IP|equals,<br>does not equal|One or several IP ranges to check separated by commas. Refer to the [network discovery configuration](/manual/discovery/network_discovery/rule) section for more information on supported formats of IP ranges.|
|8|Discovered service type|equals,<br>does not equal|Type of discovered service. The type of service matches the type of the discovery check used to detect the service. Refer to the [discovery check "type" property](/manual/api/reference/dcheck/object#discovery_check) for a list of supported types.|
|9|Discovered service port|equals,<br>does not equal|One or several port ranges separated by commas.|
|10|Discovery status|equals|Status of a discovered object.<br><br>Possible values:<br>0 - host or service up;<br>1 - host or service down;<br>2 - host or service discovered;<br>3 - host or service lost.|
|11|Uptime or downtime duration|is greater than or equals,<br>is less than or equals|Time indicating how long has the discovered object been in the current status in seconds.|
|12|Received values|equals,<br>does not equal,<br>is greater than or equals,<br>is less than or equals,<br>contains,<br>does not contain|Value returned when performing a Zabbix agent, SNMPv1, SNMPv2 or SNMPv3 discovery check.|
|13|Host template|equals,<br>does not equal|Linked template ID.|
|16|Problem is suppressed|Yes, No|No value required: using the "Yes" operator means that problem must be suppressed, "No" - not suppressed.|
|18|Discovery rule|equals,<br>does not equal|ID of the discovery rule.|
|19|Discovery check|equals,<br>does not equal|ID of the discovery check.|
|20|Proxy|equals,<br>does not equal|ID of the proxy.|
|21|Discovery object|equals|Type of object that triggered the discovery event.<br><br>Possible values:<br>1 - discovered host;<br>2 - discovered service.|
|22|Host name|contains,<br>does not contain,<br>matches,<br>does not match|Host name.<br>Using a regular expression is supported for operators *matches* and *does not match* in autoregistration conditions.|
|23|Event type|equals|Specific internal event.<br><br>Possible values:<br>0 - item in "not supported" state;<br>1 - item in "normal" state;<br>2 - LLD rule in "not supported" state;<br>3 - LLD rule in "normal" state;<br>4 - trigger in "unknown" state;<br>5 - trigger in "normal" state.|
|24|Host metadata|contains,<br>does not contain,<br>matches,<br>does not match|Metadata of the auto-registered host.<br>Using a regular expression is supported for operators *matches* and *does not match*.|
|25|Tag|equals,<br>does not equal,<br>contains,<br>does not contain|Event tag.|
|26|Tag value|equals,<br>does not equal,<br>contains,<br>does not contain|Event tag value.|
|27|Service|equals,<br>does not equal|Service ID.|
|28|Service name|equals,<br>does not equal|Service name.|
#### Action 过滤条件
动作过滤器条件object定义了在执行动作操作前必须检查的特定条件。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| conditionid | string | *(只读)* 动作条件的ID。 |
| **conditiontype**<br>(required) | integer | 条件类型。<br><br>触发器动作的可能值:<br>0 - 主机组;<br>1 - 主机;<br>2 - 触发器;<br>3 - 事件名称;<br>4 - 触发器严重性;<br>6 - 时间段;<br>13 - 主机模板;<br>16 - 问题被抑制;<br>25 - 事件标签;<br>26 - 事件标签值。<br><br>发现动作的可能值:<br>7 - 主机IP;<br>8 - 发现的服务类型;<br>9 - 发现的服务端口;<br>10 - 发现状态;<br>11 - 运行时间或停机时间;<br>12 - 接收到的值;<br>18 - 发现规则;<br>19 - 发现检查;<br>20 - proxy;<br>21 - 发现object。<br><br>自动注册动作的可能值:<br>20 - proxy;<br>22 - 主机名;<br>24 - 主机元数据。<br><br>内部动作的可能值:<br>0 - 主机组;<br>1 - 主机;<br>13 - 主机模板;<br>23 - 事件类型;<br>25 - 事件标签;<br>26 - 事件标签值。<br><br>服务动作的可能值:<br>25 - 事件标签;<br>26 - 事件标签值;<br>27 - 服务;<br>28 - 服务名称。 |
| **value**<br>(required) | string | 要比较的值。 |
| value2<br> | string | 要比较的次要值。当条件类型为*26*时，触发器、内部和服务动作需要此值。 |
| actionid | string | *(只读)* 条件所属的动作ID。 |
| formulaid | string | 用于从自定义表达式中引用条件的任意唯一ID。只能包含大写字母。修改过滤条件时必须由用户定义ID，但在后续请求时会重新生成。 |
| operator | integer | 条件运算符。<br><br>可能值:<br>0 - *(默认)* 等于;<br>1 - 不等于;<br>2 - 包含;<br>3 - 不包含;<br>4 - 在...中;<br>5 - 大于或等于;<br>6 - 小于或等于;<br>7 - 不在...中;<br>8 - 匹配;<br>9 - 不匹配;<br>10 - 是;<br>11 - 否。 |
::: notetip
要更好地理解如何将过滤器与各种表达式类型结合使用，请参阅
[action.get](get#retrieve_discovery_actions)和
[action.create](create#using_a_custom_expression_filter)方法页面上的示例。
:::
每种条件类型支持以下运算符和值。
| 条件 | 条件名称 | 支持的运算符 | 期望值 |
|-|--|--|------|
| 0 | Host group | equals,<br>does not equal | 主机组 ID。 |
| 1 | Host | equals,<br>does not equal | 主机 ID。 |
| 2 | Trigger | equals,<br>does not equal | 触发器ID。 |
| 3 | Event name | contains,<br>does not contain | 事件名称。 |
| 4 | Trigger severity | equals,<br>does not equal,<br>is greater than or equals,<br>is less than or equals | 触发器严重性。参考[触发器](/manual/api/reference/trigger/object#触发器)获取支持的触发器严重性列表。 |
| 5 | Trigger value | equals | 触发器值。参考[触发器](/manual/api/reference/trigger/object#触发器)获取支持的触发器值列表。 |
| 6 | Time period | in, not in | 事件触发时间，格式为[time period](/manual/appendix/time_period)。 |
| 7 | Host IP | equals,<br>does not equal | 一个或多个以逗号分隔的IP范围。参考[network discovery configuration](/manual/discovery/network_discovery/rule)部分获取支持的IP范围格式的更多信息。 |
| 8 | Discovered service type | equals,<br>does not equal | 发现的服务类型。服务类型与用于检测服务的发现检查类型匹配。参考[发现检查](/manual/api/reference/dcheck/object#发现检查)获取支持的类型列表。 |
| 9 | Discovered service port | equals,<br>does not equal | 一个或多个以逗号分隔的端口范围。 |
| 10 | Discovery status | equals | 发现object的状态。<br><br>可能值:<br>0 - 主机或服务运行;<br>1 - 主机或服务停止;<br>2 - 主机或服务被发现;<br>3 - 主机或服务丢失。 |
| 11 | Uptime or downtime duration | is greater than or equals,<br>is less than or equals | 表示发现的object处于当前状态的秒数。 |
| 12 | Received values | equals,<br>does not equal,<br>is greater than or equals,<br>is less than or equals,<br>contains,<br>does not contain | 执行Zabbix agent、SNMPv1、SNMPv2或SNMPv3发现检查时返回的值。 |
| 13 | Host template | equals,<br>does not equal | 链接模板ID。 |
| 16 | Problem is suppressed | Yes, No | 不需要值: 使用"是"运算符表示问题必须被抑制，"否"表示不被抑制。 |
| 18 | Discovery rule | equals,<br>does not equal | 发现规则ID。 |
| 19 | Discovery check | equals,<br>does not equal | 发现检查ID。 |
| 20 | Proxy | equals,<br>does not equal | proxy的ID。 |
| 21 | Discovery object | equals | 触发发现事件的object类型。<br><br>可能值:<br>1 - 发现的主机;<br>2 - 发现的服务。 |
| 22 | Host name | contains,<br>does not contain,<br>matches,<br>does not match | 主机名。<br>在自动注册条件中，运算符*匹配*和*不匹配*支持使用正则表达式。 |
| 23 | Event type | equals | 特定的内部事件。<br><br>可能值:<br>0 - 监控项处于"不支持"状态;<br>1 - 监控项处于"正常"状态;<br>2 - LLD规则处于"不支持"状态;<br>3 - LLD规则处于"正常"状态;<br>4 - 触发器处于"未知"状态;<br>5 - 触发器处于"正常"状态。 |
| 24 | Host metadata | contains,<br>does not contain,<br>matches,<br>does not match | 自动注册主机的元数据。<br>运算符*匹配*和*不匹配*支持使用正则表达式。 |
| 25 | Tag | equals,<br>does not equal,<br>contains,<br>does not contain | 事件标签。 |
| 26 | Tag value | equals,<br>does not equal,<br>contains,<br>does not contain | 事件标签值。 |
| 27 | Service | equals,<br>does not equal | 服务ID。 |
| 28 | Service name | equals,<br>does not equal | 服务名称。 |
#### Action filter condition
The action filter condition object defines a specific condition that
must be checked before running the action operations.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|conditionid|string|*(readonly)* ID of the action condition.|
|**conditiontype**<br>(required)|integer|Type of condition.<br><br>Possible values for trigger actions:<br>0 - host group;<br>1 - host;<br>2 - trigger;<br>3 - trigger name;<br>4 - trigger severity;<br>6 - time period;<br>13 - host template;<br>16 - problem is suppressed;<br>25 - event tag;<br>26 - event tag value.<br><br>Possible values for discovery actions:<br>7 - host IP;<br>8 - discovered service type;<br>9 - discovered service port;<br>10 - discovery status;<br>11 - uptime or downtime duration;<br>12 - received value;<br>18 - discovery rule;<br>19 - discovery check;<br>20 - proxy;<br>21 - discovery object.<br><br>Possible values for autoregistration actions:<br>20 - proxy;<br>22 - host name;<br>24 - host metadata.<br><br>Possible values for internal actions:<br>0 - host group;<br>1 - host;<br>13 - host template;<br>23 - event type;<br>25 - event tag;<br>26 - event tag value.<br><br>Possible values for service actions:<br>25 - event tag;<br>26 - event tag value;<br>27 - service;<br>28 - service name.|
|**value**<br>(required)|string|Value to compare with.|
|value2<br>|string|Secondary value to compare with. Required for trigger actions when condition type is *26*.|
|actionid|string|*(readonly)* ID of the action that the condition belongs to.|
|formulaid|string|Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - *(default)* equals;<br>1 - does not equal;<br>2 - contains;<br>3 - does not contain;<br>4 - in;<br>5 - is greater than or equals;<br>6 - is less than or equals;<br>7 - not in;<br>8 - matches;<br>9 - does not match;<br>10 - Yes;<br>11 - No.|
::: notetip
To better understand how to use filters with various
types of expressions, see examples on the
[action.get](get#retrieve_discovery_actions) and
[action.create](create#using_a_custom_expression_filter) method
pages.
:::
The following operators and values are supported for each condition
type.
|Condition|Condition name|Supported operators|Expected value|
|---------|--------------|-------------------|--------------|
|0|Host group|equals,<br>does not equal|Host group ID.|
|1|Host|equals,<br>does not equal|Host ID.|
|2|Trigger|equals,<br>does not equal|Trigger ID.|
|3|Trigger name|contains,<br>does not contain|Trigger name.|
|4|Trigger severity|equals,<br>does not equal,<br>is greater than or equals,<br>is less than or equals|Trigger severity. Refer to the [trigger "severity" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger severities.|
|5|Trigger value|equals|Trigger value. Refer to the [trigger "value" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger values.|
|6|Time period|in, not in|Time when the event was triggered as a [time period](/manual/appendix/time_period).|
|7|Host IP|equals,<br>does not equal|One or several IP ranges to check separated by commas. Refer to the [network discovery configuration](/manual/discovery/network_discovery/rule) section for more information on supported formats of IP ranges.|
|8|Discovered service type|equals,<br>does not equal|Type of discovered service. The type of service matches the type of the discovery check used to detect the service. Refer to the [discovery check "type" property](/manual/api/reference/dcheck/object#discovery_check) for a list of supported types.|
|9|Discovered service port|equals,<br>does not equal|One or several port ranges separated by commas.|
|10|Discovery status|equals|Status of a discovered object.<br><br>Possible values:<br>0 - host or service up;<br>1 - host or service down;<br>2 - host or service discovered;<br>3 - host or service lost.|
|11|Uptime or downtime duration|is greater than or equals,<br>is less than or equals|Time indicating how long has the discovered object been in the current status in seconds.|
|12|Received values|equals,<br>does not equal,<br>is greater than or equals,<br>is less than or equals,<br>contains,<br>does not contain|Value returned when performing a Zabbix agent, SNMPv1, SNMPv2 or SNMPv3 discovery check.|
|13|Host template|equals,<br>does not equal|Linked template ID.|
|16|Problem is suppressed|Yes, No|No value required: using the "Yes" operator means that problem must be suppressed, "No" - not suppressed.|
|18|Discovery rule|equals,<br>does not equal|ID of the discovery rule.|
|19|Discovery check|equals,<br>does not equal|ID of the discovery check.|
|20|Proxy|equals,<br>does not equal|ID of the proxy.|
|21|Discovery object|equals|Type of object that triggered the discovery event.<br><br>Possible values:<br>1 - discovered host;<br>2 - discovered service.|
|22|Host name|contains,<br>does not contain,<br>matches,<br>does not match|Host name.<br>Using a regular expression is supported for operators *matches* and *does not match* in autoregistration conditions.|
|23|Event type|equals|Specific internal event.<br><br>Possible values:<br>0 - item in "not supported" state;<br>1 - item in "normal" state;<br>2 - LLD rule in "not supported" state;<br>3 - LLD rule in "normal" state;<br>4 - trigger in "unknown" state;<br>5 - trigger in "normal" state.|
|24|Host metadata|contains,<br>does not contain,<br>matches,<br>does not match|Metadata of the auto-registered host.<br>Using a regular expression is supported for operators *matches* and *does not match*.|
|25|Tag|equals,<br>does not equal,<br>contains,<br>does not contain|Event tag.|
|26|Tag value|equals,<br>does not equal,<br>contains,<br>does not contain|Event tag value.|
|27|Service|equals,<br>does not equal|Service ID.|
|28|Service name|equals,<br>does not equal|Service name.|
### Action filter
The action filter object defines a set of conditions that must be met to
perform the configured action operations. It has the following
properties.
|Property|Type|Description|
|--------|----|-----------|
|**conditions**<br>(required)|array|Set of filter conditions to use for filtering results.|
|**evaltype**<br>(required)|integer|Filter condition evaluation method.<br><br>Possible values:<br>0 - and/or;<br>1 - and;<br>2 - or;<br>3 - custom expression.|
|eval\_formula|string|*(readonly)* Generated expression that will be used for evaluating filter conditions. The expression contains IDs that reference specific filter conditions by its `formulaid`. The value of `eval_formula` is equal to the value of `formula` for filters with a custom expression.|
|formula|string|User-defined expression to be used for evaluating conditions of filters with a custom expression. The expression must contain IDs that reference specific filter conditions by its `formulaid`. The IDs used in the expression must exactly match the ones defined in the filter conditions: no condition can remain unused or omitted.<br><br>Required for custom expression filters.|
#### Action filter condition
The action filter condition object defines a specific condition that
must be checked before running the action operations.
|Property|Type|Description|
|--------|----|-----------|
|conditionid|string|*(readonly)* ID of the action condition.|
|**conditiontype**<br>(required)|integer|Type of condition.<br><br>Possible values for trigger actions:<br>0 - host group;<br>1 - host;<br>2 - trigger;<br>3 - trigger name;<br>4 - trigger severity;<br>6 - time period;<br>13 - host template;<br>15 - application;<br>16 - maintenance status;<br>25 - event tag;<br>26 - event tag value.<br><br>Possible values for discovery actions:<br>7 - host IP;<br>8 - discovered service type;<br>9 - discovered service port;<br>10 - discovery status;<br>11 - uptime or downtime duration;<br>12 - received value;<br>18 - discovery rule;<br>19 - discovery check;<br>20 - proxy;<br>21 - discovery object.<br><br>Possible values for auto-registration actions:<br>20 - proxy;<br>22 - host name;<br>24 - host metadata.<br><br>Possible values for internal actions:<br>0 - host group;<br>1 - host;<br>13 - host template;<br>15 - application;<br>23 - event type.|
|**value**<br>(required)|string|Value to compare with.|
|value2<br>|string|Secondary value to compare with. Requried for trigger actions when condition type is *26*.|
|actionid|string|*(readonly)* ID of the action that the condition belongs to.|
|formulaid|string|Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - *(default)* =;<br>1 - <>;<br>2 - like;<br>3 - not like;<br>4 - in;<br>5 - >=;<br>6 - <=;<br>7 - not in.|
::: notetip
To better understand how to use filters with various
types of expressions, see examples on the
[action.get](get#retrieve_discovery_actions) and
[action.create](create#using_a_custom_expression_filter) method
pages.
:::
The following operators and values are supported for each condition
type.
|Condition|Condition name|Supported operators|Expected value|
|---------|--------------|-------------------|--------------|
|0|Host group|=, <>|Host group ID.|
|1|Host|=, <>|Host ID.|
|2|Trigger|=, <>|Trigger ID.|
|3|Trigger name|like, not like|Trigger name.|
|4|Trigger severity|=, <>, >=, <=|Trigger severity. Refer to the [trigger "severity" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger severities.|
|5|Trigger value|=|Trigger value. Refer to the [trigger "value" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger values.|
|6|Time period|in, not in|Time when the event was triggered as a [time period](/manual/appendix/time_period).|
|7|Host IP|=, <>|One or several IP ranges to check separated by commas. Refer to the [network discovery configuration](/manual/discovery/network_discovery/rule) section for more information on supported formats of IP ranges.|
|8|Discovered service type|=, <>|Type of discovered service. The type of service matches the type of the discovery check used to detect the service. Refer to the [discovery check "type" property](/manual/api/reference/dcheck/object#discovery_check) for a list of supported types.|
|9|Discovered service port|=, <>|One or several port ranges separated by commas.|
|10|Discovery status|=|Status of a discovered object.<br><br>Possible values:<br>0 - host or service up;<br>1 - host or service down;<br>2 - host or service discovered;<br>3 - host or service lost.|
|11|Uptime or downtime duration|>=, <=|Time indicating how long has the discovered object been in the current status in seconds.|
|12|Received values|=, <>, >=, <=, like, not like|Value returned when performing a Zabbix agent, SNMPv1, SNMPv2 or SNMPv3 discovery check.|
|13|Host template|=, <>|Linked template ID.|
|15|Application|=, like, not like|Name of the application.|
|16|Maintenance status|in, not in|No value required: using the "in" operator means that the host must be in maintenance, "not in" - not in maintenance.|
|18|Discovery rule|=, <>|ID of the discovery rule.|
|19|Discovery check|=, <>|ID of the discovery check.|
|20|Proxy|=, <>|ID of the proxy.|
|21|Discovery object|=|Type of object that triggered the discovery event.<br><br>Possible values:<br>1 - discovered host;<br>2 - discovered service.|
|22|Host name|like, not like|Host name.|
|23|Event type|=|Specific internal event.<br><br>Possible values:<br>0 - item in "not supported" state;<br>1 - item in "normal" state;<br>2 - LLD rule in "not supported" state;<br>3 - LLD rule in "normal" state;<br>4 - trigger in "unknown" state;<br>5 - trigger in "normal" state.|
|24|Host metadata|like, not like|Metadata of the auto-registered host.|
|25|Tag|=, <>, like, not like|Event tag.|
|26|Tag value|=, <>, like, not like|Event tag value.|
The following objects are directly related to the `action` API.
### Action
The action object has the following properties.
|Property|Type|Description|
|--------|----|-----------|
|actionid|string|*(readonly)* ID of the action.|
|**esc\_period**<br>(required)|string|Default operation step duration. Must be greater than 60 seconds. Accepts seconds, time unit with suffix and user macro.|
|**eventsource**<br>(required)|integer|*(constant)* Type of events that the action will handle.<br><br>Refer to the [event "source" property](/manual/api/reference/event/object#event) for a list of supported event types.|
|**name**<br>(required)|string|Name of the action.|
|def\_longdata|string|Problem message text.|
|def\_shortdata|string|Problem message subject.|
|r\_longdata|string|Recovery message text.|
|r\_shortdata|string|Recovery message subject.|
|ack\_longdata|string|Acknowledge operation message text.|
|ack\_shortdata|string|Acknowledge operation message subject.|
|status|integer|Whether the action is enabled or disabled.<br><br>Possible values:<br>0 - *(default)* enabled;<br>1 - disabled.|
|pause\_suppressed|integer|Whether to pause escalation during maintenance periods or not.<br><br>Possible values:<br>0 - Don't pause escalation;<br>1 - *(default)* Pause escalation.|
### Action operation
The action operation object defines an operation that will be performed
when an action is executed. It has the following properties.
|Property|Type|Description|
|--------|----|-----------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values:<br>0 - send message;<br>1 - remote command;<br>2 - add host;<br>3 - remove host;<br>4 - add to host group;<br>5 - remove from host group;<br>6 - link to template;<br>7 - unlink from template;<br>8 - enable host;<br>9 - disable host;<br>10 - set host inventory mode.|
|actionid|string|ID of the action that the operation belongs to.|
|esc\_period|string|Duration of an escalation step in seconds. Must be greater than 60 seconds. Accepts seconds, time unit with suffix and user macro. If set to 0 or 0s, the default action escalation period will be used.<br><br>Default: 0s.|
|esc\_step\_from|integer|Step to start escalation from.<br><br>Default: 1.|
|esc\_step\_to|integer|Step to end escalation at.<br><br>Default: 1.|
|evaltype|integer|Operation condition evaluation method.<br><br>Possible values:<br>0 - *(default)* AND / OR;<br>1 - AND;<br>2 - OR.|
|opcommand|object|Object containing the data about the command run by the operation.<br><br>The operation command object is [described in detail below](/manual/api/reference/action/object#action_operation_command).<br><br>Required for remote command operations.|
|opcommand\_grp|array|Host groups to run remote commands on.<br><br>Each object has the following properties:<br>`opcommand_grpid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for remote command operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run remote commands on.<br><br>Each object has the following properties:<br>`opcommand_hstid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for remote command operations if `opcommand_grp` is not set.|
|opconditions|array|Operation conditions used for trigger actions.<br><br>The operation condition object is [described in detail below](/manual/api/reference/action/object#action_operation_condition).|
|opgroup|array|Host groups to add hosts to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for "add to host group" and "remove from host group" operations.|
|opmessage|object|Object containing the data about the message sent by the operation.<br><br>The operation message object is [described in detail below](/manual/api/reference/action/object#action_operation_message).<br><br>Required for message operations.|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required for message operations if `opmessage_usr` is not set.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`userid` - *(string)* ID of the user.<br><br>Required for message operations if `opmessage_grp` is not set.|
|optemplate|array|Templates to link the hosts to to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`templateid` - *(string)* ID of the template.<br><br>Required for "link to template" and "unlink from template" operations.|
|opinventory|object|Inventory mode set host to.<br><br>Object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`inventory_mode` - *(string)* Inventory mode.<br><br>Required for "Set host inventory mode" operations.|
#### Action operation command
The operation command object contains data about the command that will
be run by the operation.
|Property|Type|Description|
|--------|----|-----------|
|operationid|string|*(readonly)* ID of the operation.|
|command|string|Command to run. Required when type IN (0,1,2,3)|
|**type**<br>(required)|integer|Type of operation command.<br><br>Possible values:<br>0 - custom script;<br>1 - IPMI;<br>2 - SSH;<br>3 - Telnet;<br>4 - global script.|
|authtype|integer|Authentication method used for SSH commands.<br><br>Possible values:<br>0 - password;<br>1 - public key.<br><br>Required for SSH commands.|
|execute\_on|integer|Target on which the custom script operation command will be executed.<br><br>Possible values:<br>0 - Zabbix agent;<br>1 - Zabbix server;<br>2 - Zabbix server (proxy).<br><br>Required for custom script commands.|
|password|string|Password used for SSH commands with password authentication and Telnet commands.|
|port|string|Port number used for SSH and Telnet commands.|
|privatekey|string|Name of the private key file used for SSH commands with public key authentication.<br><br>Required for SSH commands with public key authentication.|
|publickey|string|Name of the public key file used for SSH commands with public key authentication.<br><br>Required for SSH commands with public key authentication.|
|scriptid|string|ID of the script used for global script commands.<br><br>Required for global script commands.|
|username|string|User name used for authentication.<br><br>Required for SSH and Telnet commands.|
#### Action operation message
The operation message object contains data about the message that will
be sent by the operation.
|Property|Type|Description|
|--------|----|-----------|
|operationid|string|*(readonly)* ID of the action operation.|
|default\_msg|integer|Whether to use the default action message text and subject.<br><br>Possible values:<br>0 - *(default)* use the data from the operation;<br>1 - use the data from the action.|
|mediatypeid|string|ID of the media type that will be used to send the message.|
|message|string|Operation message text.|
|subject|string|Operation message subject.|
#### Action operation condition
The action operation condition object defines a condition that must be
met to perform the current operation. It has the following properties.
|Property|Type|Description|
|--------|----|-----------|
|opconditionid|string|*(readonly)* ID of the action operation condition|
|**conditiontype**<br>(required)|integer|Type of condition.<br><br>Possible values:<br>14 - event acknowledged.|
|**value**<br>(required)|string|Value to compare with.|
|operationid|string|*(readonly)* ID of the operation.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - *(default)* =.|
The following operators and values are supported for each operation
condition type.
|Condition|Condition name|Supported operators|Expected value|
|---------|--------------|-------------------|--------------|
|14|Event acknowledged|=|Whether the event is acknowledged.<br><br>Possible values:<br>0 - not acknowledged;<br>1 - acknowledged.|
#### Action filter condition
The action filter condition object defines a specific condition that
must be checked before running the action operations.
|Property|Type|Description|
|--------|----|-----------|
|conditionid|string|*(readonly)* ID of the action condition.|
|**conditiontype**<br>(required)|integer|Type of condition.<br><br>Possible values for trigger actions:<br>0 - host group;<br>1 - host;<br>2 - trigger;<br>3 - trigger name;<br>4 - trigger severity;<br>6 - time period;<br>13 - host template;<br>15 - application;<br>16 - maintenance status;<br>25 - event tag;<br>26 - event tag value.<br><br>Possible values for discovery actions:<br>7 - host IP;<br>8 - discovered service type;<br>9 - discovered service port;<br>10 - discovery status;<br>11 - uptime or downtime duration;<br>12 - received value;<br>18 - discovery rule;<br>19 - discovery check;<br>20 - proxy;<br>21 - discovery object.<br><br>Possible values for auto-registration actions:<br>20 - proxy;<br>22 - host name;<br>24 - host metadata.<br><br>Possible values for internal actions:<br>0 - host group;<br>1 - host;<br>13 - host template;<br>15 - application;<br>23 - event type.|
|**value**<br>(required)|string|Value to compare with.|
|value2<br>|string|Secondary value to compare with. Requried for trigger actions when condition type is *26*.|
|actionid|string|*(readonly)* ID of the action that the condition belongs to.|
|formulaid|string|Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - *(default)* =;<br>1 - <>;<br>2 - like;<br>3 - not like;<br>4 - in;<br>5 - >=;<br>6 - <=;<br>7 - not in.|
::: notetip
To better understand how to use filters with various
types of expressions, see examples on the
[action.get](get#retrieve_discovery_actions) and
[action.create](create#using_a_custom_expression_filter) method
pages.
:::
The following operators and values are supported for each condition
type.
|Condition|Condition name|Supported operators|Expected value|
|---------|--------------|-------------------|--------------|
|0|Host group|=, <>|Host group ID.|
|1|Host|=, <>|Host ID.|
|2|Trigger|=, <>|Trigger ID.|
|3|Trigger name|like, not like|Trigger name.|
|4|Trigger severity|=, <>, >=, <=|Trigger severity. Refer to the [trigger "severity" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger severities.|
|5|Trigger value|=|Trigger value. Refer to the [trigger "value" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger values.|
|6|Time period|in, not in|Time when the event was triggered as a [time period](/manual/appendix/time_period).|
|7|Host IP|=, <>|One or several IP ranges to check separated by commas. Refer to the [network discovery configuration](/manual/discovery/network_discovery/rule) section for more information on supported formats of IP ranges.|
|8|Discovered service type|=, <>|Type of discovered service. The type of service matches the type of the discovery check used to detect the service. Refer to the [discovery check "type" property](/manual/api/reference/dcheck/object#discovery_check) for a list of supported types.|
|9|Discovered service port|=, <>|One or several port ranges separated by commas.|
|10|Discovery status|=|Status of a discovered object.<br><br>Possible values:<br>0 - host or service up;<br>1 - host or service down;<br>2 - host or service discovered;<br>3 - host or service lost.|
|11|Uptime or downtime duration|>=, <=|Time indicating how long has the discovered object been in the current status in seconds.|
|12|Received values|=, <>, >=, <=, like, not like|Value returned when performing a Zabbix agent, SNMPv1, SNMPv2 or SNMPv3 discovery check.|
|13|Host template|=, <>|Linked template ID.|
|15|Application|=, like, not like|Name of the application.|
|16|Maintenance status|in, not in|No value required: using the "in" operator means that the host must be in maintenance, "not in" - not in maintenance.|
|18|Discovery rule|=, <>|ID of the discovery rule.|
|19|Discovery check|=, <>|ID of the discovery check.|
|20|Proxy|=, <>|ID of the proxy.|
|21|Discovery object|=|Type of object that triggered the discovery event.<br><br>Possible values:<br>1 - discovered host;<br>2 - discovered service.|
|22|Host name|like, not like|Host name.|
|23|Event type|=|Specific internal event.<br><br>Possible values:<br>0 - item in "not supported" state;<br>1 - item in "normal" state;<br>2 - LLD rule in "not supported" state;<br>3 - LLD rule in "normal" state;<br>4 - trigger in "unknown" state;<br>5 - trigger in "normal" state.|
|24|Host metadata|like, not like|Metadata of the auto-registered host.|
|25|Tag|=, <>, like, not like|Event tag.|
|26|Tag value|=, <>, like, not like|Event tag value.|
### Action filter
The action filter object defines a set of conditions that must be met to
perform the configured action operations. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**conditions**<br>(required)|array|Set of filter conditions to use for filtering results.|
|**evaltype**<br>(required)|integer|Filter condition evaluation method.<br><br>Possible values:<br>0 - and/or;<br>1 - and;<br>2 - or;<br>3 - custom expression.|
|eval\_formula|string|*(readonly)* Generated expression that will be used for evaluating filter conditions. The expression contains IDs that reference specific filter conditions by its `formulaid`. The value of `eval_formula` is equal to the value of `formula` for filters with a custom expression.|
|formula|string|User-defined expression to be used for evaluating conditions of filters with a custom expression. The expression must contain IDs that reference specific filter conditions by its `formulaid`. The IDs used in the expression must exactly match the ones defined in the filter conditions: no condition can remain unused or omitted.<br><br>Required for custom expression filters.|
### 操作过滤器
操作过滤器object定义了一组必须满足的条件才能执行配置的操作。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **conditions**<br>(required) | array | 用于过滤结果的过滤条件集合。 |
| **evaltype**<br>(required) | integer | 过滤条件评估方法。<br><br>可能的值：<br>0 - 与/或；<br>1 - 与；<br>2 - 或；<br>3 - 自定义表达式。 |
| eval\_formula | string | *(只读)* 用于评估过滤条件的生成表达式。该表达式包含通过`formulaid`引用特定过滤条件的ID。对于具有自定义表达式的过滤器，`eval_formula`的值等于`formula`的值。 |
| formula | string | 用户定义的表达式，用于评估具有自定义表达式的过滤器的条件。该表达式必须包含通过`formulaid`引用特定过滤条件的ID。表达式中使用的ID必须与过滤条件中定义的ID完全匹配：不能有任何条件未被使用或遗漏。<br><br>自定义表达式过滤器必需。 |
##### Action for active agent autoregistration
When server receives an autoregistration request from an agent it calls
an [action](/manual/config/notifications/action). An action of event
source "Autoregistration" must be configured for agent autoregistration.
::: noteclassic
Setting up [network discovery](network_discovery) is not
required to have active agents autoregister.
:::
In the Zabbix frontend, go to *Configuration → Actions*, select
*Autoregistration actions* and click on *Create action*:
- In the Action tab, give your action a name
- Optionally specify
[conditions](/manual/config/notifications/action/conditions#autoregistration_actions).
You can do a substring match or regular expression match in the
conditions for host name/host metadata. If you are going to use the
"Host metadata" condition, see the next section.
- In the Operations tab, add relevant operations, such as - 'Add
host', 'Add to host group' (for example, *Discovered hosts*), 'Link
to templates', etc.
::: notetip
If the hosts that will be autoregistering are likely to
be supported for active monitoring only (such as hosts that are
firewalled from your Zabbix server) then you might want to create a
specific template like *Template\_Linux-active* to link to.
:::
Created hosts are added to the *Discovered hosts* group (by default,
configurable in *Administration* → *General* →
*[Other](/manual/web_interface/frontend_sections/administration/general#other_parameters)*).
If you wish hosts to be added to another group, add a *Remove from host
group* operation (specifying "Discovered hosts") and also add an *Add to
host group* operation (specifying another host group), because a host
must belong to a host group.
##### 主动agent自动注册动作
当服务器收到来自agent的自动注册请求时，它会调用
一个[action](/manual/config/notifications/action). 一个事件动作
必须为agent自动注册配置"Autoregistration"源。
::: noteclassic
设置[network discovery](network_discovery)不
需要具有活动的agents自动注册功能。
:::
在Zabbix前端界面中，导航至*配置 → 动作*，选择
*自动注册操作* 并点击 *创建操作*:
- 在Action选项卡中，为您的操作命名
- 可选指定
[自动注册动作](/manual/config/notifications/action/conditions#自动注册动作).
您可以在其中执行子字符串匹配或正则表达式匹配
主机名/主机元数据的条件。如果您打算使用
"主机元数据"条件，详见下一节。
- 在Operations选项卡中，添加相关操作，例如 - 'Add
host', 'Add to host group' (for example, *Discovered hosts*), 'Link
to templates', etc.
::: notetip
如果将要自动注册的主机可能
仅支持主动监控（例如主机）
从您的Zabbix server防火墙隔离后，您可能需要create一个
特定模板如*Template\_Linux-active*进行关联。
:::
创建的主机会被添加到*已发现的主机*组中（默认情况下
可配置于*管理* → *常规* →
*[其他参数](/manual/web_interface/frontend_sections/administration/general#其他参数)*).
如果您希望主机被添加到另一个组，请添加一个*从主机移除
group* 操作（指定"已发现的 主机"）并同时添加一个*添加到
主机组*操作（指定另一个主机组），因为一个主机
必须属于一个主机组。
# action.get
# action.get
#### Action operation condition
The action operation condition object defines a condition that must be
met to perform the current operation. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|opconditionid|string|*(readonly)* ID of the action operation condition|
|**conditiontype**<br>(required)|integer|Type of condition.<br><br>Possible values:<br>14 - event acknowledged.|
|**value**<br>(required)|string|Value to compare with.|
|operationid|string|*(readonly)* ID of the operation.|
|operator|integer|Condition operator.<br><br>Possible values:<br>0 - *(default)* =.|
The following operators and values are supported for each operation
condition type.
|Condition|Condition name|Supported operators|Expected value|
|---------|--------------|-------------------|--------------|
|14|Event acknowledged|=|Whether the event is acknowledged.<br><br>Possible values:<br>0 - not acknowledged;<br>1 - acknowledged.|
#### Action 操作条件
动作操作条件object定义了执行当前操作必须满足的条件。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| opconditionid | string | *(只读)* 动作操作条件的ID |
| **conditiontype**<br>(required) | integer | 条件类型。<br><br>可能的值:<br>14 - 事件已确认。 |
| **value**<br>(required) | string | 要比较的值。 |
| operationid | string | *(只读)* 操作的ID。 |
| operator | integer | 条件运算符。<br><br>可能的值:<br>0 - *(默认)* =。 |
每种操作条件类型支持以下运算符和值。
| 条件 | 条件名称 | 支持的运算符 | 期望值 |
|---------|--------------|-------------------|--------------|
| 14 | Event acknowledged | = | 事件是否已确认。<br><br>可能的值:<br>0 - 未确认;<br>1 - 已确认。 |
#### Action operation message
The operation message object contains data about the message that will
be sent by the operation.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|default\_msg|integer|Whether to use the default action message text and subject.<br><br>Possible values:<br>0 - use the data from the operation;<br>1 - *(default)* use the data from the media type.|
|mediatypeid|string|ID of the media type that will be used to send the message.|
|message|string|Operation message text.|
|subject|string|Operation message subject.|
#### Action 操作消息
操作消息object包含有关该操作将发送消息的数据。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| default\_msg | integer | 是否使用默认动作消息文本和主题。<br><br>可能值：<br>0 - 使用操作中的数据；<br>1 - *(默认)* 使用媒介类型中的数据。 |
| mediatypeid | string | 用于发送消息的媒介类型ID。 |
| message | string | 操作消息文本。 |
| subject | string | 操作消息主题。 |
### Action operation
The action operation object defines an operation that will be performed
when an action is executed. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values:<br>0 - send message;<br>1 - global script;<br>2 - add host;<br>3 - remove host;<br>4 - add to host group;<br>5 - remove from host group;<br>6 - link to template;<br>7 - unlink from template;<br>8 - enable host;<br>9 - disable host;<br>10 - set host inventory mode.<br><br>Note that only types '0' and '1' are supported for trigger actions, only '0' is supported for internal actions. All types are supported for discovery and autoregistration actions.|
|actionid|string|ID of the action that the operation belongs to.|
|esc\_period|string|Duration of an escalation step in seconds. Must be greater than 60 seconds. Accepts seconds, time unit with suffix and user macro. If set to 0 or 0s, the default action escalation period will be used.<br><br>Default: 0s.<br><br>Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.|
|esc\_step\_from|integer|Step to start escalation from.<br><br>Default: 1.<br><br>Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.|
|esc\_step\_to|integer|Step to end escalation at.<br><br>Default: 1.<br><br>Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.|
|evaltype|integer|Operation condition evaluation method.<br><br>Possible values:<br>0 - *(default)* AND / OR;<br>1 - AND;<br>2 - OR.|
|opcommand|object|Object containing data on global script run by the operation.<br><br>Each object has one following property: `scriptid` - *(string)* ID of the script.<br><br>Required for global script operations.|
|opcommand\_grp|array|Host groups to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_grpid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for global script operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_hstid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for global script operations if `opcommand_grp` is not set.|
|opconditions|array|Operation conditions used for trigger actions.<br><br>The operation condition object is [described in detail below](/manual/api/reference/action/object#action_operation_condition).|
|opgroup|array|Host groups to add hosts to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for "add to host group" and "remove from host group" operations.|
|opmessage|object|Object containing the data about the message sent by the operation.<br><br>The operation message object is [described in detail below](/manual/api/reference/action/object#action_operation_message).<br><br>Required for message operations.|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required for message operations if `opmessage_usr` is not set.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`userid` - *(string)* ID of the user.<br><br>Required for message operations if `opmessage_grp` is not set.|
|optemplate|array|Templates to link the hosts to to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`templateid` - *(string)* ID of the template.<br><br>Required for "link to template" and "unlink from template" operations.|
|opinventory|object|Inventory mode set host to.<br><br>Object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`inventory_mode` - *(string)* Inventory mode.<br><br>Required for "Set host inventory mode" operations.|
### 动作操作
动作操作对象定义执行动作时执行的操作。它具有以下属性。
|属性 类|描述|<|
|--------------------------|------|-|
|operationid|string|*(readonly)* 动作操作的 ID。|
|**operationtype**<br>(required)|integer|操作类型<br><br>可能的值：<br>0 - 发送消息;<br>1 - 远程命令;<br>2 - 添加主机;<br>3 - 删除主机;<br>4 - 添加到主机组;<br>5 - 从主机组删除;<br>6 - 链接到模板;<br>7 - 取消与模板的关联;<br>8 - 启用主机;<br>9 - 禁用主机;<br>10 - 设置主机库存模式。|
|actionid|string|操作所属的动作的 ID。|
|esc\_period|string|以秒为单位的升级步骤的持续时间。必须大于 60 秒。接受秒，时间单位后缀和用户宏。如果设置为 0 或0s，则将使用默认的动作升级周期。<br><br>默认: 0s.|
|esc\_step\_from|integer|步骤开始升级。<br><br>默认: 1.|
|esc\_step\_to|integer|步骤结束升级。<br><br>默认: 1.|
|evaltype|integer|运行状态计算方法。<br><br>可能的值:<br>0 - *(默认)* AND / OR;<br>1 - AND;<br>2 - OR.|
|opcommand|object|包含操作所运行的命令的数据。<br><br>操作命令对象是 [described in detail below](/zh/manual/api/reference/action/object#action_operation_command).<br><br>远程命令操作所需的。|
|opcommand\_grp|array|运行远程命令的主机组。<br><br>每个对象具有以下属性：<br>`opcommand_grpid` - *(string, readonly)* 对象的 ID;<br>`operationid` - *(string)* 操作 ID；<br>`groupid` - *(string)* 主机组的 ID。<br><br>如果没有设置 `opcommand_hst`，则需要远程命令操作。|
|opcommand\_hst|array|主机上运行远程命令。<br><br>每个对象具有以下属性：<br>`opcommand_hstid` - *(string, readonly)* 对象的 ID;<br>`operationid` - *(string)* 操作 ID;<br>`hostid` - *(string)* 主机 ID; 如果设置为 0，则命令将在当前主机上运行。<br><br>如果没有设置 `opcommand_grp`，则需要远程命令操作。|
|opconditions|array|用于触发动作的操作条件<br><br>操作条件对象是 [下面详细描述](/zh/manual/api/reference/action/object#action_operation_condition).|
|opgroup|array|用于添加主机的主机组。<br><br>每个对象都具有以下属性:<br>`operationid` - *(string)* ID of the operation;<br>`groupid` - *(string)* 主机组的 ID。<br><br>`添加到主机组` 和 `从主机组中删除` 操作所必需的。|
|opmessage|object|包含有关操作发送的消息的数据的对象。<br><br>操作消息对象是 [下面详细描述](/zh/manual/api/reference/action/object#action_operation_message).<br><br>消息操作必需。|
|opmessage\_grp|array|要发送消息的用户组。<br><br>每个对象都具有以下属性：<br>`operationid` - *(string)* 操作 ID;<br>`usrgrpid` - *(string)* 用户组的ID。<br><br>如果未设置 `opmessage_usr`，则消息操作必需。|
|opmessage\_usr|array|发送消息给的用户。<br><br>每个对象都具有以下属性：<br>`operationid` - *(string)* 操作 ID;<br>`userid` - *(string)* 用户的ID。<br><br>如果未设置 `opmessage_grp`，则消息操作必需。|
|optemplate|array|用于将主机链接到的模板。<br><br>每个对象都具有以下属性：<br>`operationid` - *(string)* 操作 ID;<br>`templateid` - *(string)* 模板 ID.<br><br>必须有 "link to template" 和 "unlink from template" 操作|
|opinventory|object|库存模式设置主机。<br><br>每个对象都具有以下属性:<br>`operationid` - *(string)* 操作 ID;<br>`inventory_mode` - *(string)* Inventory mode.<br><br>需要有 "Set host inventory mode" 操作。|
### Action operation
The action operation object defines an operation that will be performed
when an action is executed. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values:<br>0 - send message;<br>1 - global script;<br>2 - add host;<br>3 - remove host;<br>4 - add to host group;<br>5 - remove from host group;<br>6 - link to template;<br>7 - unlink from template;<br>8 - enable host;<br>9 - disable host;<br>10 - set host inventory mode.<br><br>Note that only types '0' and '1' are supported for trigger and service actions, only '0' is supported for internal actions. All types are supported for discovery and autoregistration actions.|
|actionid|string|*(readonly)* ID of the action that the operation belongs to.|
|esc\_period|string|Duration of an escalation step in seconds. Must be greater than 60 seconds. Accepts seconds, time unit with suffix and user macro. If set to 0 or 0s, the default action escalation period will be used.<br><br>Default: 0s.<br><br>Note that escalations are supported only for trigger, internal and service actions, and only in normal operations.|
|esc\_step\_from|integer|Step to start escalation from.<br><br>Default: 1.<br><br>Note that escalations are supported only for trigger, internal and service actions, and only in normal operations.|
|esc\_step\_to|integer|Step to end escalation at.<br><br>Default: 1.<br><br>Note that escalations are supported only for trigger, internal and service actions, and only in normal operations.|
|evaltype|integer|Operation condition evaluation method.<br><br>Possible values:<br>0 - *(default)* AND / OR;<br>1 - AND;<br>2 - OR.|
|opcommand|object|Object containing data on global script run by the operation.<br><br>Each object has one following property: `scriptid` - *(string)* ID of the script.<br><br>Required for global script operations.|
|opcommand\_grp|array|Host groups to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_grpid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string, readonly)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for global script operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_hstid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string, readonly)* ID of the operation;<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for global script operations if `opcommand_grp` is not set.|
|opconditions|array|Operation conditions used for trigger actions.<br><br>The operation condition object is [described in detail below](/manual/api/reference/action/object#action_operation_condition).|
|opgroup|array|Host groups to add hosts to.<br><br>Each object has the following properties:<br>`operationid` - *(string, readonly)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for "add to host group" and "remove from host group" operations.|
|opmessage|object|Object containing the data about the message sent by the operation.<br><br>The operation message object is [described in detail below](/manual/api/reference/action/object#action_operation_message).<br><br>Required for message operations.|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string, readonly)* ID of the operation;<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required for message operations if `opmessage_usr` is not set.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string, readonly)* ID of the operation;<br>`userid` - *(string)* ID of the user.<br><br>Required for message operations if `opmessage_grp` is not set.|
|optemplate|array|Templates to link the hosts to.<br><br>Each object has the following properties:<br>`operationid` - *(string, readonly)* ID of the operation;<br>`templateid` - *(string)* ID of the template.<br><br>Required for "link to template" and "unlink from template" operations.|
|opinventory|object|Inventory mode set host to.<br><br>Object has the following properties:<br>`operationid` - *(string, readonly)* ID of the operation;<br>`inventory_mode` - *(string)* Inventory mode.<br><br>Required for "Set host inventory mode" operations.|
### Action 操作
操作object定义了将要执行的动作
当动作执行时。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| operationid | string | *(只读)* 动作操作的ID。 |
| **operationtype**<br>(required) | integer | 操作类型.<br><br>可选值:<br>0 - 发送消息;<br>1 - 全局脚本;<br>2 - 添加主机;<br>3 - 移除主机;<br>4 - 添加到主机组;<br>5 - 从主机组移除;<br>6 - 链接到模板;<br>7 - 从模板取消链接;<br>8 - 启用主机;<br>9 - 禁用主机;<br>10 - 设置主机资产清单模式.<br><br>注意: 对于触发器和服务动作仅支持类型'0'和'1'，内部动作仅支持'0'。发现和自动注册动作支持所有类型。 |
| actionid | string | *(只读)* 操作所属动作的ID。 |
| esc\_period | string | 升级步骤的持续时间（以秒为单位）。必须大于60秒。接受秒数、带后缀的时间单位及用户宏。若设置为0或0s，将使用默认动作升级周期。<br><br>默认值：0s。<br><br>注意：升级功能仅支持触发器动作、内部动作和服务动作，且仅在正常操作模式下生效。 |
| esc\_step\_from | integer | 升级起始步骤。<br><br>默认值：1。<br><br>注意升级仅支持触发器、内部和服务类操作，且仅在正常运营模式下生效。 |
| esc\_step\_to | integer | 升级终止步骤.<br><br>默认值: 1.<br><br>注意: 升级仅支持触发器、内部和服务类型的告警动作，且仅在正常运营模式下生效. |
| evaltype | integer | 操作条件评估方法.<br><br>可选值:<br>0 - *(默认)* AND / OR;<br>1 - AND;<br>2 - OR. |
| opcommand | object | object 包含通过操作获取的全局脚本 run 数据.<br><br>每个 object 具有以下属性之一: `scriptid` - *(string)* 脚本的ID.<br><br>全局脚本操作必需项.
| opcommand\_grp | array | 将主机组关联到run全局脚本上.<br><br>每个object具有以下属性:<br>`opcommand_grpid` - *(string, 只读)* object的ID;<br>`operationid` - *(string, 只读)* 操作ID;<br>`groupid` - *(string)* 主机组的ID.<br><br>当`opcommand_hst`未设置时，全局脚本操作必需此参数. |
| opcommand\_hst | array | 将全局脚本run到主机。<br><br>每个object具有以下属性:<br>`opcommand_hstid` - *(string, 只读)* object的ID;<br>`operationid` - *(string, 只读)* 操作ID;<br>`hostid` - *(string)* 主机的ID; 若设为0则命令会在当前主机上run.<br><br>当`opcommand_grp`未设置时，全局脚本操作必需此参数。 |
| opconditions | array | 触发器操作使用的运行条件。<br><br>操作条件object为[action-操作条件](/manual/api/reference/action/object#action-操作条件)。 |
| opgroup | array | 要添加主机的主机组。<br><br>每个object具有以下属性:<br>`operationid` - *(string, 只读)* 操作ID;<br>`groupid` - *(string)* 主机组ID。<br><br>该字段为"添加到主机组"和"从主机组移除"操作所必需。 |
| opmessage | object | object 包含操作发送消息的相关数据。<br><br>操作消息 object 是 [action-操作消息](/manual/api/reference/action/object#action-操作消息)。<br><br>消息操作必需字段。
| opmessage\_grp | array | 接收消息的用户组.<br><br>每个object包含以下属性:<br>`operationid` - *(string, 只读)* 操作ID;<br>`usrgrpid` - *(string)* 用户组ID.<br><br>当未设置`opmessage_usr`时，消息操作必须指定此参数. |
| opmessage\_usr | array | 接收消息的用户列表。<br><br>每个object包含以下属性:<br>`operationid` - *(string, 只读)* 操作ID;<br>`userid` - *(string)* 用户ID。<br><br>当`opmessage_grp`未设置时，消息操作必须提供此参数。 |
| optemplate | array | 要链接主机的模板.<br><br>每个object具有以下属性:<br>`operationid` - *(string, 只读)* 操作的ID;<br>`templateid` - *(string)* 模板的ID.<br><br>对于"链接到模板"和"从模板取消链接"操作是必需的. |
| opinventory | object | 库存模式设置为 主机。<br><br>object 具有以下属性：<br>`operationid` - *(string, 只读)* 操作ID；<br>`inventory_mode` - *(string)* 库存模式。<br><br>该操作用于"设置 主机 库存模式"。
### Action recovery operation
The action recovery operation object defines an operation that will be
performed when a problem is resolved. Recovery operations are possible
for trigger actions and internal actions. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values for trigger actions:<br>0 - send message;<br>1 - global script;<br>11 - notify all involved.<br><br>Possible values for internal actions:<br>0 - send message;<br>11 - notify all involved.|
|actionid|string|ID of the action that the recovery operation belongs to.|
|opcommand|object|Object containnig data on global action type script run by the operation.<br><br>Each object has one following property: `scriptid` - *(string)* ID of the action type script.<br><br>Required for global script operations.|
|opcommand\_grp|array|Host groups to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_grpid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for global script operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_hstid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for global script operations if `opcommand_grp` is not set.|
|opmessage|object|Object containing the data about the message sent by the recovery operation.<br><br>The operation message object is [described in detail above](/manual/api/reference/action/object#action_operation_message).<br><br>Required for message operations.|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required for message operations if `opmessage_usr` is not set.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`userid` - *(string)* ID of the user.<br><br>Required for message operations if `opmessage_grp` is not set.|
#### 动作操作条件
动作操作条件对象定义了一个必须满足的条件来执行当前操作。它具有以下属性。
|属性 类|说明|<|
|--------------------------|------|-|
|opconditionid|string|*(readonly)* 动作操作条件的 ID|
|**conditiontype**<br>(required)|integer|条件的类型。<br><br>可能的值:<br>14 - event acknowledged.|
|**value**<br>(required)|string|与之比较的值。|
|operationid|string|*(readonly)* 动作操作的 ID|
|operator|integer|条件运算符<br><br>可能的值：<br>0 - *(default)* =.|
每个操作条件类型都支持以下运算符和值。
|条件 条|名称 支持的运算|期望值|<|
|------------|----------------------------------|---------|-|
|14|Event acknowledged|=|件是否被确认。<br><br>可能的值:<br>0 - 没有确认;<br>1 - 已确认。|
### Action recovery operation
The action recovery operation object defines an operation that will be
performed when a problem is resolved. Recovery operations are possible
for trigger, internal and service actions. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values for trigger and service actions:<br>0 - send message;<br>1 - global script;<br>11 - notify all involved.<br><br>Possible values for internal actions:<br>0 - send message;<br>11 - notify all involved.|
|actionid|string|*(readonly)* ID of the action that the recovery operation belongs to.|
|opcommand|object|Object containing data on global action type script run by the operation.<br><br>Each object has one following property: `scriptid` - *(string)* ID of the action type script.<br><br>Required for global script operations.|
|opcommand\_grp|array|Host groups to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_grpid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string, readonly)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for global script operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run global scripts on.<br><br>Each object has the following properties:<br>`opcommand_hstid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string, readonly)* ID of the operation;<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for global script operations if `opcommand_grp` is not set.|
|opmessage|object|Object containing the data about the message sent by the recovery operation.<br><br>The operation message object is [described in detail above](/manual/api/reference/action/object#action_operation_message).<br><br>Required for message operations.|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string, readonly)* ID of the operation;<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required for message operations if `opmessage_usr` is not set.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string, readonly)* ID of the operation;<br>`userid` - *(string)* ID of the user.<br><br>Required for message operations if `opmessage_grp` is not set.|
### Action 恢复操作
动作恢复操作object定义了当问题被解决时将执行的操作。恢复操作可用于触发器、内部和服务动作。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| operationid | string | *(只读)* 动作操作的ID。 |
| **operationtype**<br>(required) | integer | 操作类型。<br><br>触发器和服务动作的可能值:<br>0 - 发送消息;<br>1 - 全局脚本;<br>11 - 通知所有相关人员。<br><br>内部动作的可能值:<br>0 - 发送消息;<br>11 - 通知所有相关人员。 |
| actionid | string | *(只读)* 恢复操作所属的动作ID。 |
| opcommand | object | object包含操作执行的全局动作类型脚本run的数据。<br><br>每个object具有以下属性: `scriptid` - *(string)* 动作类型脚本的ID。<br><br>全局脚本操作必需。 |
| opcommand\_grp | array | 主机组用于run全局脚本。<br><br>每个object具有以下属性:<br>`opcommand_grpid` - *(string, 只读)* object的ID;<br>`operationid` - *(string, 只读)* 操作的ID;<br>`groupid` - *(string)* 主机组的ID。<br><br>如果未设置`opcommand_hst`，全局脚本操作必需。 |
| opcommand\_hst | array | 主机用于run全局脚本。<br><br>每个object具有以下属性:<br>`opcommand_hstid` - *(string, 只读)* object的ID;<br>`operationid` - *(string, 只读)* 操作的ID;<br>`hostid` - *(string)* 主机的ID; 如果设置为0，命令将在当前主机上run。<br><br>如果未设置`opcommand_grp`，全局脚本操作必需。 |
| opmessage | object | object包含恢复操作发送的消息数据。<br><br>操作消息object是[action-操作消息](/manual/api/reference/action/object#action-操作消息)。<br><br>消息操作必需。 |
| opmessage\_grp | array | 发送消息的用户组。<br><br>每个object具有以下属性:<br>`operationid` - *(string, 只读)* 操作的ID;<br>`usrgrpid` - *(string)* 用户组的ID。<br><br>如果未设置`opmessage_usr`，消息操作必需。 |
| opmessage\_usr | array | 发送消息的用户。<br><br>每个object具有以下属性:<br>`operationid` - *(string, 只读)* 操作的ID;<br>`userid` - *(string)* 用户的ID。<br><br>如果未设置`opmessage_grp`，消息操作必需。 |
#### Actions and alerts
Define actions and operations to notify users about certain events or
automatically execute remote commands. Gain access to information about
generated alerts and their receivers.
[Action API](/manual/api/reference/action) | [Alert
API](/manual/api/reference/alert)
#### Actions and alerts
定义动作和操作以通知用户特定事件或自动execute远程命令。获取有关生成警报及其接收者的信息。
[Action API](/manual/api/reference/action) | [Alert
API](/manual/api/reference/alert)
#### Actions disabled due to deleted objects
If a certain object (host, template, trigger, etc.) used in an action
condition/operation is deleted, the condition/operation is removed and
the action is disabled to avoid incorrect execution of the action. The
action can be re-enabled by the user.
This behavior takes place when deleting:
- host groups ("host group" condition, "remote command" operation on a
specific host group);
- hosts ("host" condition, "remote command" operation on a specific
host);
- templates ("template" condition, "link to template" and "unlink from
template" operations);
- triggers ("trigger" condition);
- discovery rules (when using "discovery rule" and "discovery check"
conditions).
*Note*: If a remote command has many target hosts, and we delete one of
them, only this host will be removed from the target list, the operation
itself will remain. But, if it's the only host, the operation will be
removed, too. The same goes for "link to template" and "unlink from
template" operations.
Actions are not disabled when deleting a user or user group used in a
"send message" operation.
#### 由于删除的objects导致操作被禁用
如果在动作条件/操作中使用的某个object（主机、模板、触发器等）被删除，系统将移除该条件/操作并禁用该动作，以避免动作的错误执行。用户可手动重新启用该动作。
此行为在删除以下对象时触发：
- 主机组（"主机组"条件，针对特定主机组的"远程命令"操作）；
- 主机（"主机"条件，针对特定主机的"远程命令"操作）；
- 模板（"模板"条件，"关联模板"和"取消关联模板"操作）；
- 触发器（"触发器"条件）；
- 发现规则（当使用"发现规则"和"发现检查"时）
conditions).
*注意*：如果远程命令包含多个目标主机，而我们delete其中一个时，仅会从目标列表中移除该主机，操作本身仍会保留。但若这是唯一的主机，则该操作也会被移除。"关联模板"和"取消关联模板"操作同理。
当删除"发送消息"操作中使用的用户或用户组时，动作不会被禁用。
#### Actions
Discovery events can be the basis of relevant
[actions](/manual/config/notifications/action), such as:
- Sending notifications
- Adding/removing hosts
- Enabling/disabling hosts
- Adding hosts to a group
- Removing hosts from a group
- Linking hosts to/unlinking from a template
- Executing remote scripts
These actions can be configured with respect to the device type, IP,
status, uptime/downtime, etc. For full details on configuring actions
for network-discovery based events, see action
[operation](/manual/config/notifications/action/operation) and
[conditions](/manual/config/notifications/action/conditions) pages.
Since network discovery actions are event-based, they will
be triggered both when a discovered host is online and when it is offline. It is highly
recommended to add an action [condition](/manual/config/notifications/action/conditions) *Discovery status: up* to avoid such actions as *Add host* being triggered upon *Service Lost*/*Service Down* events.
Otherwise, if a discovered host is manually removed, it will still generate *Service Lost*/*Service Down* events and will be recreated during the next discovery cycle.
::: noteclassic
Linking a discovered host to templates will fail
collectively if any of the linkable templates has a unique entity (e.g.
item key) that is the same as a unique entity (e.g. item key) already
existing on the host or on another of the linkable
templates.
:::
#### 动作
发现事件可以作为相关
[actions](/manual/config/notifications/action)的基础，例如：
- 发送通知
- 添加/删除 主机
- 启用/禁用 主机
- 将 主机 添加到组
- 从组中移除 主机
- 将 主机 链接到模板/从模板取消链接
- 执行远程脚本
这些操作可以根据设备类型、IP、
状态、运行时间/停机时间等进行配置。有关为基于网络发现的事件配置操作的完整详细信息，请参阅操作
[operation](/manual/config/notifications/action/operation) 和
[conditions](/manual/config/notifications/action/conditions) 页面。
由于网络发现操作是基于事件的，它们会在发现的 主机 在线和离线时触发。强烈建议添加一个操作 [condition](/manual/config/notifications/action/conditions) *发现状态：在线* 以避免诸如 *添加 主机* 之类的操作在 *服务丢失*/*服务停机* 事件时被触发。否则，如果手动移除一个发现的 主机，它仍然会 generate *服务丢失*/*服务停机* 事件，并在下一个发现周期中重新创建。
::: noteclassic
如果任何可链接模板具有与 主机 或另一个可链接模板上已存在的唯一实体（例如 监控项 键）相同的唯一实体（例如 监控项 键），则链接发现的 主机 到模板将整体失败。
:::
#### Actions if communication fails between agent and server
Each matching line from `log[]` and `logrt[]` item and a result of each
`log.count[]` and `logrt.count[]` item check requires a free slot in the
designated 50% area in the agent send buffer. The buffer elements are
regularly sent to server (or proxy) and the buffer slots are free again.
While there are free slots in the designated log area in the agent send
buffer and communication fails between agent and server (or proxy) the
log monitoring results are accumulated in the send buffer. This helps to
mitigate short communication failures.
During longer communication failures all log slots get occupied and the
following actions are taken:
- `log[]` and `logrt[]` item checks are stopped. When communication is
restored and free slots in the buffer are available the checks are
resumed from the previous position. No matching lines are lost, they
are just reported later.
- `log.count[]` and `logrt.count[]` checks are stopped if
`maxdelay = 0` (default). Behavior is similar to `log[]` and
`logrt[]` items as described above. Note that this can affect
`log.count[]` and `logrt.count[]` results: for example, one check
counts 100 matching lines in a log file, but as there are no free
slots in the buffer the check is stopped. When communication is
restored the agent counts the same 100 matching lines and also 70
new matching lines. The agent now sends count = 170 as if they were
found in one check.
- `log.count[]` and `logrt.count[]` checks with `maxdelay > 0`: if
there was no "jump" during the check, then behavior is similar to
described above. If a "jump" over log file lines took place then the
position after "jump" is kept and the counted result is discarded.
So, the agent tries to keep up with a growing log file even in case
of communication failure.
#### 当 agent 与服务器通信失败时的操作
来自`log[]`和`logrt[]`的每个匹配行监控项以及每个结果
`log.count[]` 和 `logrt.count[]` 监控项 检查需要一个空闲插槽
在agent发送缓冲区中指定了50%的区域。缓冲区元素是
定期发送到服务器（或proxy），缓冲区槽位再次释放。
当agent发送缓冲区中有空闲槽位时
agent与服务器（或proxy）之间的缓冲区和通信故障
日志监控结果会累积在发送缓冲区中。这有助于
缓解短暂的通信故障。
在长时间通信故障期间，所有日志槽位get被占满且
采取以下操作：
- `log[]` 和 `logrt[]` 监控项 检查已停止。当通信
缓冲区中的已恢复和空闲槽位可用时，检查将
从先前位置恢复。不会丢失任何匹配行，它们
稍后才会报告。
- `log.count[]` 和 `logrt.count[]` 检查会在以下情况停止
`maxdelay = 0`（默认）。行为类似于`log[]`和
`logrt[]` 监控项 如上所述。请注意这可能会影响
`log.count[]` 和 `logrt.count[]` 结果：例如，一次检查
在日志中统计100条匹配行file，但由于没有可用的
缓冲区中的槽位检查停止。当通信时
恢复了agent计数相同的100条匹配行以及70条
新匹配的行。agent现在发送count = 170，就好像它们是
在一次检查中发现。
- `log.count[]` 和 `logrt.count[]` 检查与 `maxdelay > 0`：如果
检查期间没有出现"跳跃"，则行为类似于
上述描述。如果发生了跳过日志file行的情况，则
"jump"后的位置被保留，计数结果被丢弃。
因此，agent会持续追踪不断增长的日志file，即使出现异常情况
通信故障
#### Actions
In [actions](/manual/config/notifications/action), user macros can be
used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|-|------------------------------|----------|
|Trigger-based notifications and commands|<|yes|
|Trigger-based internal notifications|<|yes|
|Problem update notifications|<|yes|
|Service-based notifications and commands|<|yes|
|Service update notifications|<|yes|
|Time period condition|<|no|
|*Operations*|<|<|
| |Default operation step duration|no|
|^|Step duration|no|
#### 动作
在[actions](/manual/config/notifications/action)中，用户宏可以
用于以下字段：
| 位置 | < | 多个宏/与文本混合^[1](supported_by_location_user#脚注)^ |
|-|------------------------------|----------|
| 基于触发器的通知和命令 | < | 是 |
| 基于触发器的内部通知 | < | 是 |
| 问题update通知 | < | 是 |
| 基于服务的通知和命令 | < | 是 |
| 服务update通知 | < | 是 |
| 时间段条件 | < | 否 |
| *操作* | < | < |
| | 默认操作步骤持续时间 | 否 |
| ^ | 步骤持续时间 | 否 |
##### Actions
The module will have control over frontend actions defined within the
*actions* object in the manifest.json file. This way new actions are
defined. In the same way you may redefine existing actions. Each key of
actions should represent the action name and the corresponding value
should contain `class` and optionally `layout` and `view` keys.
One action is defined by four counterparts: name, controller, view and
layout. Data validation and preparation is typically done in the
controller, output formatting is done in the view or partials, and the
layout is responsible for decorating the page with elements such as
menu, header, footer and others.
Module actions must be defined in the manifest.json file as *actions*
object:
|Parameter|Required|Type|Default|Description|
|---------|---|----|--|-------------------|
|key|Yes|String|\-|Action name, in lowercase \[a-z\], separating words with dot.|
|class|Yes|String|\-|Action class name, including subdirectory path (if used) within the `actions` directory.|
|layout|No|String|"layout.htmlpage"|Action layout.|
|view|No|String|null|Action view.|
There are several predefined layouts, like `layout.json` or
`layout.xml`. These are intended for actions which produce different
result than an HTML. You may explore predefined layouts in the
app/views/ directory or even create your own.
Sometimes it is necessary to only redefine the view part of some action
leaving the controller intact. In such case just place the necessary
view and/or partial files inside the `views` directory of the module.
For reference, please see an example action controller file in the
[Reference](#reference) section. Please do not hesitate to explore
current actions of Zabbix source code, located in the app/ directory.
**Module.php**
This optional PHP file is responsible for module initialization as well
as event handling. Class 'Module' is expected to be defined in this
file, extending base class `\Core\CModule`. The Module class must be
defined within the namespace specified in the manifest.json file.
``` {.php}
<?php
namespace Modules\Example;
use Core\CModule as BaseModule;
class Module extends BaseModule {
...
}
```
For reference, please see an example of Module.php in the
[Reference](#reference) section.
##### 动作
该模块将控制manifest.jsonfile中*actions*object定义的前端操作。通过这种方式定义新操作。同样地，您可以重定义现有操作。actions的每个键应表示操作名称，对应的值应包含`class`，并可选择性地包含`layout`和`view`键。
一个操作由四个部分组成：名称、控制器、视图和布局。数据验证和准备通常在控制器中完成，输出格式化在视图或部分视图中完成，布局负责用菜单、页眉、页脚等元素装饰页面。
模块操作必须在manifest.jsonfile中定义为*actions*object：
| 参数 | 必填 | 类型 | 默认值 | 描述 |
|---------|---|----|--|-------------------|
| key | 是 | String | \- | 操作名称，小写字母[a-z]，用点分隔单词。 |
| class | 是 | String | \- | 操作类名，包括`actions`目录内的子目录路径（如果使用）。 |
| layout | 否 | String | "layout.htmlpage" | 操作布局。 |
| view | 否 | String | null | 操作视图。 |
有几种预定义的布局，如`layout.json`或`layout.xml`。这些适用于产生不同于HTML结果的操作。您可以在app/views/目录中探索预定义的布局，甚至可以create自己的布局。
有时只需要重定义某些操作的视图部分，而保持控制器不变。在这种情况下，只需将必要的视图和/或部分文件放在模块的`views`目录中。
作为参考，请参阅[参考](#reference)部分中的示例操作控制器file。请不要犹豫探索Zabbix源代码中位于app/目录下的当前操作。
**Module.php**
这个可选的PHPfile负责模块初始化以及事件处理。类'模块'应在此file中定义，扩展基类`\Core\CModule`。Module类必须在manifest.jsonfile中指定的命名空间中定义。
```{.php}
<?php
namespace Modules\Example;
use Core\CModule as BaseModule;
class Module extends BaseModule {
...
}
```
作为参考，请参阅[参考](#reference)部分中的Module.php示例。
### Action
The action object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|actionid|string|*(readonly)* ID of the action.|
|**esc\_period**<br>(required)|string|Default operation step duration. Must be at least 60 seconds. Accepts seconds, time unit with suffix and user macro.<br><br>Note that escalations are supported only for trigger and internal actions. In trigger actions, escalations are not supported in problem recovery and update operations.|
|**eventsource**<br>(required)|integer|*(constant)* Type of events that the action will handle.<br><br>Refer to the [event "source" property](/manual/api/reference/event/object#event) for a list of supported event types.|
|**name**<br>(required)|string|Name of the action.|
|status|integer|Whether the action is enabled or disabled.<br><br>Possible values:<br>0 - *(default)* enabled;<br>1 - disabled.|
|pause\_suppressed|integer|Whether to pause escalation during maintenance periods or not.<br><br>Possible values:<br>0 - Don't pause escalation;<br>1 - *(default)* Pause escalation.<br><br>Note that this parameter is valid for trigger actions only.|
|notify\_if\_canceled|integer|Whether to notify when escalation is canceled.<br><br>Possible values:<br>0 - Don't notify when escalation is canceled;<br>1 - *(default)* Notify when escalation is canceled.<br><br>Note that this parameter is valid for trigger actions only.|
### 动作
动作对象具有以下属性。
|属性 类|描述|<|
|-------------------------|------|-|
|actionid|string|*(readonly)* 动作的 ID。|
|**esc\_period**<br>(required)|string|默认操作步骤持续时间。必须大于 60 秒。接受秒，带后缀的时间单位和用户宏。|
|**eventsource**<br>(required)|integer|*(constant)* 动作将处理的事件的类型。<br><br>参见 [event "source" property](/zh/manual/api/reference/event/object#event) 以获取支持的事件类型列表。|
|**name**<br>(required)|string|动作的名称。|
|def\_longdata|string|异常消息文本。|
|def\_shortdata|string|异常消息主题。|
|r\_longdata|string|恢复消息文本。|
|r\_shortdata|string|恢复消息主题。|
|ack\_longdata|string|确认操作消息文本。|
|ack\_shortdata|string|确认操作消息主题。|
|status|integer|动作是启动还是禁用。<br><br>取值：<br>0 - *(默认)* 启用；<br>1 - 禁用。|
|pause\_suppressed|integer|是否在维护期间暂停升级。<br><br>可能的值：<br>0 - 不要暂停升级;<br>1 - *(默认)* 暂停升级。|
### Action
The action object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|actionid|string|*(readonly)* ID of the action.|
|**esc\_period**<br>(required)|string|Default operation step duration. Must be at least 60 seconds. Accepts seconds, time unit with suffix and user macro.<br><br>Note that escalations are supported only for trigger, internal and service actions, and only in normal operations.|
|**eventsource**<br>(required)|integer|*(constant)* Type of events that the action will handle.<br><br>Refer to the [event "source" property](/manual/api/reference/event/object#event) for a list of supported event types.|
|**name**<br>(required)|string|Name of the action.|
|status|integer|Whether the action is enabled or disabled.<br><br>Possible values:<br>0 - *(default)* enabled;<br>1 - disabled.|
|pause\_suppressed|integer|Whether to pause escalation during maintenance periods or not.<br><br>Possible values:<br>0 - Don't pause escalation;<br>1 - *(default)* Pause escalation.<br><br>Note that this parameter is valid for trigger actions only.|
|notify\_if\_canceled|integer|Whether to notify when escalation is canceled.<br><br>Possible values:<br>0 - Don't notify when escalation is canceled;<br>1 - *(default)* Notify when escalation is canceled.<br><br>Note that this parameter is valid for trigger actions only.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 动作
动作 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| actionid | string | *(只读)* 动作的ID。 |
| **esc\_period**<br>(required) | string | 默认操作步骤持续时间。必须至少为60秒。接受秒数、带后缀的时间单位和用户宏。<br><br>注意，升级仅支持触发器、内部和服务动作，并且仅在正常操作中支持。 |
| **eventsource**<br>(required) | integer | *(常量)* 动作将处理的事件类型。<br><br>有关支持的事件类型列表，请参阅[事件](/manual/api/reference/event/object#事件)。 |
| **name**<br>(required) | string | 动作的名称。 |
| status | integer | 动作是否启用或禁用。<br><br>可能的值：<br>0 - *(默认)* 启用；<br>1 - 禁用。 |
| pause\_suppressed | integer | 是否在维护期间暂停升级。<br><br>可能的值：<br>0 - 不暂停升级；<br>1 - *(默认)* 暂停升级。<br><br>注意，此参数仅对触发器动作有效。 |
| notify\_if\_canceled | integer | 是否在升级取消时通知。<br><br>可能的值：<br>0 - 升级取消时不通知；<br>1 - *(默认)* 升级取消时通知。<br><br>注意，此参数仅对触发器动作有效。 |
注意，对于某些方法（update、delete），必需/可选参数的组合是不同的。
### Action
The action object has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**name**<br>(required)|string|Name of the action.<br><br>Possible values for users of any type:<br>`edit_dashboards` - Create and edit dashboards;<br>`edit_maps` - Create and edit maps;<br>`add_problem_comments` - Add problem comments;<br>`change_severity` - Change problem severity;<br>`acknowledge_problems` - Acknowledge problems;<br>`close_problems` - Close problems;<br>`execute_scripts` - Execute scripts;<br>`manage_api_tokens` - Manage API tokens.<br><br>Possible values only for users of *Admin* and *Super admin* user types:<br>`edit_maintenance` - Create and edit maintenances;<br>`manage_scheduled_reports` - Manage scheduled reports;<br>`manage_sla` - Manage SLA.|
|status|integer|Whether access to perform the action is enabled.<br><br>Possible values:<br>0 - Disabled;<br>1 - *(default)* Enabled.|
### 动作
操作object具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **name**<br>(required) | string | 操作名称.<br><br>适用于所有用户类型的可能值:<br>`edit_dashboards` - 创建和编辑仪表板;<br>`edit_maps` - 创建和编辑地图;<br>`add_problem_comments` - 添加问题评论;<br>`change_severity` - 更改问题严重性;<br>`acknowledge_problems` - 确认问题;<br>`close_problems` - 关闭问题;<br>`execute_scripts` - 执行脚本;<br>`manage_api_tokens` - 管理API令牌.<br><br>仅适用于*管理员*和*超级管理员*用户类型的可能值:<br>`edit_maintenance` - 创建和编辑维护;<br>`manage_scheduled_reports` - 管理计划报告;<br>`manage_sla` - 管理SLA. |
| status | integer | 是否启用执行操作的权限.<br><br>可能值:<br>0 - 禁用;<br>1 - *(默认)* 启用. |
# action.update
# action.update
### Action update operation
The action update operation object defines an operation that will be
performed when a problem is updated (commented upon, acknowledged,
severity changed, or manually closed). Update operations are possible
for trigger actions. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values for trigger actions:<br>0 - send message;<br>1 - global script;<br>12 - notify all involved.|
|opcommand|object|Object containing data on global action type script run by the operation.<br><br>Each object has one following property: `scriptid` - *(string)* ID of the action type script.<br><br>Required for global script operations.|
|opcommand\_grp|array|Host groups to run global scripts on.<br><br>Each object has the following properties:<br>`groupid` - *(string)* ID of the host group.<br><br>Required for global script operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run global scripts on.<br><br>Each object has the following properties:<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for global script operations if `opcommand_grp` is not set.|
|opmessage|object|Object containing the data about the message sent by the update operation.<br><br>The operation message object is [described in detail above](/manual/api/reference/action/object#action_operation_message).|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required only for `send message` operations if `opmessage_usr` is not set.<br>Is ignored for `send update message` operations.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`userid` - *(string)* ID of the user.<br><br>Required only for `send message` operations if `opmessage_grp` is not set.<br>Is ignored for `send update message` operations.|
### Action recovery operation
The action recovery operation object defines an operation that will be
performed when a problem is resolved. Recovery operations are possible
for trigger actions and internal actions. It has the following
properties.
|Property|Type|Description|
|--------|----|-----------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values for trigger actions:<br>0 - send message;<br>1 - remote command;<br>11 - notify all involved.<br><br>Possible values for internal actions:<br>0 - send message;<br>11 - notify all involved.|
|actionid|string|ID of the action that the recovery operation belongs to.|
|opcommand|object|Object containing the data about the command run by the recovery operation.<br><br>The operation command object is [described in detail above](/manual/api/reference/action/object#action_operation_command).<br><br>Required for remote command operations.|
|opcommand\_grp|array|Host groups to run remote commands on.<br><br>Each object has the following properties:<br>`opcommand_grpid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`groupid` - *(string)* ID of the host group.<br><br>Required for remote command operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run remote commands on.<br><br>Each object has the following properties:<br>`opcommand_hstid` - *(string, readonly)* ID of the object;<br>`operationid` - *(string)* ID of the operation;<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for remote command operations if `opcommand_grp` is not set.|
|opmessage|object|Object containing the data about the message sent by the recovery operation.<br><br>The operation message object is [described in detail above](/manual/api/reference/action/object#action_operation_message).<br><br>Required for message operations.|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required for message operations if `opmessage_usr` is not set.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`operationid` - *(string)* ID of the operation;<br>`userid` - *(string)* ID of the user.<br><br>Required for message operations if `opmessage_grp` is not set.|
### Action update operation
The action update operation object defines an operation that will be
performed when a problem is updated (commented upon, acknowledged,
severity changed, or manually closed). Update operations are possible
for trigger and service actions. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|operationid|string|*(readonly)* ID of the action operation.|
|**operationtype**<br>(required)|integer|Type of operation.<br><br>Possible values for trigger and service actions:<br>0 - send message;<br>1 - global script;<br>12 - notify all involved.|
|opcommand|object|Object containing data on global action type script run by the operation.<br><br>Each object has one following property: `scriptid` - *(string)* ID of the action type script.<br><br>Required for global script operations.|
|opcommand\_grp|array|Host groups to run global scripts on.<br><br>Each object has the following properties:<br>`groupid` - *(string)* ID of the host group.<br><br>Required for global script operations if `opcommand_hst` is not set.|
|opcommand\_hst|array|Host to run global scripts on.<br><br>Each object has the following properties:<br>`hostid` - *(string)* ID of the host; if set to 0 the command will be run on the current host.<br><br>Required for global script operations if `opcommand_grp` is not set.|
|opmessage|object|Object containing the data about the message sent by the update operation.<br><br>The operation message object is [described in detail above](/manual/api/reference/action/object#action_operation_message).|
|opmessage\_grp|array|User groups to send messages to.<br><br>Each object has the following properties:<br>`usrgrpid` - *(string)* ID of the user group.<br><br>Required only for `send message` operations if `opmessage_usr` is not set.<br>Is ignored for `send update message` operations.|
|opmessage\_usr|array|Users to send messages to.<br><br>Each object has the following properties:<br>`userid` - *(string)* ID of the user.<br><br>Required only for `send message` operations if `opmessage_grp` is not set.<br>Is ignored for `send update message` operations.|
### Action 更新操作
操作 update 定义了一个将执行的 object 操作
当问题被更新（评论、确认）时执行
严重性变更或手动关闭）。可执行更新操作
用于触发器和服务动作。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| operationid | string | *(只读)* 动作操作的ID。 |
| **operationtype**<br>(required) | integer | 操作类型.<br><br>触发器与服务动作的可能取值:<br>0 - 发送消息;<br>1 - 全局脚本;<br>12 - 通知所有相关人员. |
| opcommand | object | object 包含通过操作获取的全局动作类型脚本run的数据.<br><br>每个object具有以下属性之一: `scriptid` - *(string)* 动作类型脚本的ID.<br><br>全局脚本操作必需项. |
| opcommand\_grp | array | 将主机组关联至run全局脚本.<br><br>每个object具有以下属性:<br>`groupid` - *(string)* 主机组的ID.<br><br>若未设置`opcommand_hst`，则全局脚本操作必需此参数. |
| opcommand\_hst | array | 主机 到 run 全局脚本。<br><br>每个 object 具有以下属性:<br>`hostid` - *(string)* 主机 的ID；若设为0则该命令将在当前 主机 上 run。<br><br>当未设置 `opcommand_grp` 时，全局脚本操作必需此参数。 |
| opmessage | object | object 包含由update操作发送的消息数据.<br><br>操作消息object为[action-操作消息](/manual/api/reference/action/object#action-操作消息). |
| opmessage\_grp | array | 接收消息的用户组.<br><br>每个object包含以下属性:<br>`usrgrpid` - *(string)* 用户组ID.<br><br>仅当`opmessage_usr`未设置时，`send message`操作必需此参数.<br>`send update message`操作将忽略此参数. |
| opmessage\_usr | array | 接收消息的用户.<br><br>每个object包含以下属性:<br>`userid` - *(string)* 用户ID.<br><br>仅当`opmessage_grp`未设置时，`send message`操作需要此字段.<br>`send update message`操作会忽略此字段. |
#### Active agent autoregistration events
Active agent autoregistration creates events in Zabbix.
If configured, active agent autoregistration event is created when a
previously unknown active agent asks for checks or if the host metadata
has changed. The server adds a new auto-registered host, using the
received IP address and port of the agent.
For more information, see the [active agent
autoregistration](/manual/discovery/auto_registration) page.
#### Active agent 自动注册事件
主动式agent自动注册会在Zabbix中创建事件.
当配置启用时，如果之前未知的主动式agent请求检查或主机元数据发生变更，
系统会创建主动式agent自动注册事件。服务器会使用接收到的agentIP地址和端口
添加一个新的自动注册主机。
更多信息请参阅[active agent
autoregistration](/manual/discovery/auto_registration)页面。
#### Active checks
Active checks require more complex processing. The agent must first
retrieve from the server(s) a list of items for independent processing.
The servers to get the active checks from are listed in the
'ServerActive' parameter of the agent [configuration
file](/manual/appendix/config/zabbix_agentd). The frequency of asking
for these checks is set by the 'RefreshActiveChecks' parameter in the
same configuration file. However, if refreshing active checks fails, it
is retried after hardcoded 60 seconds.
The agent then periodically sends the new values to the server(s).
::: notetip
If an agent is behind the firewall you might consider
using only Active checks because in this case you wouldn't need to
modify the firewall to allow initial incoming connections.
:::
#### 主动检查
主动检查需要更复杂的处理。agent首先必须
从服务器检索一组监控项以进行独立处理
用于get主动检查的服务器列在
'ServerActive' 参数用于 agent [configuration
file](/manual/appendix/config/zabbix_agentd)。询问频率
这些检查的间隔时间由配置文件中的'RefreshActiveChecks'参数设置
相同配置file. 但如果刷新主动检查失败, 它
在硬编码的60秒后重试。
agent随后会定期将新值发送到服务器
::: notetip
如果 agent 位于防火墙后方，您可能需要考虑
仅使用主动检查，因为在这种情况下您不需要
修改防火墙以允许初始传入连接。
:::
### Active checks response
The active checks response is sent by the server back to agent after processing active checks request.
| Field |<| Type | Mandatory | Value |
|-|------|--|-|-----------------------|
| response |<| _string_ | yes | `success` \| `failed` |
| info |<| _string_ | no | Error information in the case of failure. |
| data |<| _array of objects_ | no | Active check items. |
| | key | _string_ | no | Item key with expanded macros. |
|^| itemid | _number_ | no | Item identifier. |
|^| delay | _string_ | no | Item update interval. |
|^| lastlogsize | _number_ | no | Item lastlogsize. |
|^| mtime | _number_ | no | Item mtime. |
| regexp |<| _array of objects_ | no | Global regular expressions. |
| | name | _string_ | no | Global regular expression name. |
|^| expression | _string_ | no | Global regular expression. |
|^| expression_type | _number_ | no | Global regular expression type. |
|^| exp_delimiter | _string_ | no | Global regular expression delimiter. |
|^| case_sensitive | _number_ | no | Global regular expression case sensitivity setting. |
Example:
```json
{
"response": "success",
"data": [
{
"key": "log[/home/zabbix/logs/zabbix_agentd.log]",
"itemid": 1234,
"delay": "30s",
"lastlogsize": 0,
"mtime": 0
},
{
"key": "agent.version",
"itemid": 5678,
"delay": "10m",
"lastlogsize": 0,
"mtime": 0
}
]
}
```
### 主动检查响应
主动检查响应由服务器在处理完主动检查请求后发送回agent.
| 字段 | < | 类型 | 必填 | 值 |
|-|------|--|-|-----------------------|
| response | < | _string_ | yes | `success` \ | `failed` |
| info | < | _string_ | no | 失败时的错误信息. |
| data | < | _array of objects_ | no | 主动检查监控项. |
| | key | _string_ | no | 带扩展宏的监控项键值. |
| ^ | itemid | _number_ | no | 监控项标识符. |
| ^ | delay | _string_ | no | 监控项update间隔. |
| ^ | lastlogsize | _number_ | no | 监控项lastlogsize. |
| ^ | mtime | _number_ | no | 监控项mtime. |
| regexp | < | _array of objects_ | no | 全局正则表达式. |
| | name | _string_ | no | 全局正则表达式名称. |
| ^ | expression | _string_ | no | 全局正则表达式. |
| ^ | expression_type | _number_ | no | 全局正则表达式类型. |
| ^ | exp_delimiter | _string_ | no | 全局正则表达式分隔符. |
| ^ | case_sensitive | _number_ | no | 全局正则表达式大小写敏感设置. |
示例:
```json
{
"response": "success",
"data": [
{
"key": "log[/home/zabbix/logs/zabbix_agentd.log]",
"itemid": 1234,
"delay": "30s",
"lastlogsize": 0,
"mtime": 0
},
{
"key": "agent.version",
"itemid": 5678,
"delay": "10m",
"lastlogsize": 0,
"mtime": 0
}
]
}
```
#### Active proxy
#### Active 代理
#### Add a trigger dependency
Make trigger "14092" dependent on trigger "13565."
Request:
```json
{
"jsonrpc": "2.0",
"method": "trigger.adddependencies",
"params": {
"triggerid": "14092",
"dependsOnTriggerid": "13565"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"14092"
]
},
"id": 1
}
```
#### 添加触发器依赖
将触发器"14092"设置为依赖于触发器"13565".
请求:
```json
{
"jsonrpc": "2.0",
"method": "trigger.adddependencies",
"params": {
"triggerid": "14092",
"dependsOnTriggerid": "13565"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"14092"
]
},
"id": 1
}
```
#### Adding a filter to an LLD rule
Add a filter so that the contents of the *{\#FSTYPE}* macro would match
the *\@File systems for discovery* regexp.
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.update",
"params": {
"itemid": "22450",
"filter": {
"evaltype": 1,
"conditions": [
{
"macro": "{#FSTYPE}",
"value": "@File systems for discovery"
}
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"22450"
]
},
"id": 1
}
```
#### 向 LLD 规则添加过滤器
添加过滤器，使*{\#FSTYPE}*宏的内容能够匹配
*\@File systems for discovery*正则表达式。
请求：
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.update",
"params": {
"itemid": "22450",
"filter": {
"evaltype": 1,
"conditions": [
{
"macro": "{#FSTYPE}",
"value": "@File systems for discovery"
}
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"22450"
]
},
"id": 1
}
```
#### Adding a scheduled downtime
Add a downtime for service with ID "4" scheduled weekly from Monday
22:00 till Tuesday 10:00.
Request:
```json
{
"jsonrpc": "2.0",
"method": "service.update",
"params": {
"serviceid": "4",
"times": [
{
"type": "1",
"ts_from": "165600",
"ts_to": "201600"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"4"
]
},
"id": 1
}
```
#### 添加计划停机时间
为ID为"4"的服务添加每周从周一22:00至周二10:00的维护时段
请求:
```json
{
"jsonrpc": "2.0",
"method": "service.update",
"params": {
"serviceid": "4",
"times": [
{
"type": "1",
"ts_from": "165600",
"ts_to": "201600"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"4"
]
},
"id": 1
}
```
#### Adding dashboards
To add dashboards to a template in *Configuration → Templates*, do the
following:
- Click on *Dashboards* in the row of the template
- Configure a dashboard following the guidelines of [configuring
dashboards](/manual/web_interface/frontend_sections/monitoring/dashboard)
::: noteimportant
The widgets that can be included in a template dashboard are: *Clock*, *Graph (classic)*, *Graph prototype*, *Item value*, *Plain text*, *URL*.
:::
::: notetip
For details on accessing host dashboards that are
created from template dashboards, see the [host
dashboard](/manual/config/visualization/host_screens#accessing_host_dashboards)
section.
:::
#### 添加仪表板
要在*配置 → 模板*中向模板添加仪表板，请执行以下操作：
- 点击模板所在行的*仪表板*
- 按照[configuring
dashboards](/manual/web_interface/frontend_sections/monitoring/dashboard)
::: noteimportant
The widgets that can be included in a template dashboard are: *Clock*, *Graph (classic)*, *Graph prototype*, *Item value*, *Plain text*, *URL*.
:::
::: notetip
For details on accessing host dashboards that are
created from template dashboards, see the [host
dashboard](/manual/config/visualization/host_screens#accessing_host_dashboards)章节的指导配置仪表板
:::
##### Adding host
Hosts are added during the discovery process, as soon as a host is
discovered, rather than at the end of the discovery process.
::: notetip
As network discovery can take some time due to many
unavailable hosts/services having patience and using reasonable IP
ranges is advisable.
:::
When adding a host, its name is decided by the standard
**gethostbyname** function. If the host can be resolved, resolved name
is used. If not, the IP address is used. Besides, if IPv6 address must
be used for a host name, then all ":" (colons) are replaced by "\_"
(underscores), since colons are not allowed in host names.
::: noteimportant
If performing discovery by a proxy, currently
hostname lookup still takes place on Zabbix server.
:::
::: noteimportant
If a host already exists in Zabbix configuration
with the same name as a newly discovered one, versions of Zabbix prior
to 1.8 would add another host with the same name. Zabbix 1.8.1 and later
adds **\_N** to the hostname, where **N** is increasing number, starting
with 2.
:::
##### 添加主机
主机会在发现过程中被立即添加，一旦一个主机被发现，而不是等到发现过程结束时才添加。
::: notetip
由于网络发现可能因许多不可用的主机/服务而耗时较长，建议保持耐心并使用合理的IP范围。
:::
在添加一个主机时，其名称由标准的**gethostbyname**函数决定。如果主机可以被解析，则使用解析后的名称。如果不能解析，则使用IP地址。此外，如果必须使用IPv6地址作为一个主机的名称，则所有":"（冒号）将被替换为"\_"（下划线），因为冒号不允许出现在主机名称中。
::: noteimportant
如果通过proxy执行发现，目前主机名查找仍然发生在Zabbix server上。
:::
::: noteimportant
如果一个主机已经存在于Zabbix配置中，并且与新发现的名称相同，Zabbix 1.8之前的版本会添加另一个相同名称的主机。Zabbix 1.8.1及更高版本会在主机名后添加**\_N**，其中**N**是从2开始的递增数字。
:::
#### Adding hosts to host groups
Add two hosts to host groups with IDs 5 and 6.
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostgroup.massadd",
"params": {
"groups": [
{
"groupid": "5"
},
{
"groupid": "6"
}
],
"hosts": [
{
"hostid": "30050"
},
{
"hostid": "30001"
}
]
},
"auth": "f223adf833b2bf2ff38574a67bba6372",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"5",
"6"
]
},
"id": 1
}
```
#### 将主机添加到主机组
将两个主机添加到ID为5和6的主机组中.
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostgroup.massadd",
"params": {
"groups": [
{
"groupid": "5"
},
{
"groupid": "6"
}
],
"hosts": [
{
"hostid": "30050"
},
{
"hostid": "30001"
}
]
},
"auth": "f223adf833b2bf2ff38574a67bba6372",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"5",
"6"
]
},
"id": 1
}
```
#### Adding item to template
To add an item to the template, go to the item list for 'New host'. In
*Configuration → Hosts* click on *Items* next to 'New host'.
Then:
- mark the checkbox of the 'CPU Load' item in the list
- click on *Copy* below the list
- select the template to copy item to
All mandatory input fields are marked with a red asterisk.
- click on *Copy*
If you now go to *Configuration → Templates*, 'New template' should have
one new item in it.
We will stop at one item only for now, but similarly you can add any
other items, triggers or other entities to the template until it's a
fairly complete set of entities for given purpose (monitoring OS,
monitoring single application).
#### 向模板添加监控项
要添加一个监控项到模板，请转到'新建主机'的监控项列表。在
*配置 → 主机* 点击 *监控项* 旁边的 '新建 主机'.
然后:
- 在列表中勾选'CPU负载' 监控项的复选框
- 点击列表下方的*复制*
- 选择模板以copy 监控项
所有必填字段均以红色星号标记。
- 点击*Copy*
如果您现在前往*配置 → 模板*，应该能看到'新建模板'选项
一个新的监控项在其中。
我们暂时只讨论一个监控项，但同样地你可以添加任意
其他监控项、触发器或其他实体添加到模板，直到它成为
针对特定目的（监控操作系统）的一套相当完整的实体集合
监控单一应用程序).
#### Adding lines
In addition to shapes, it is also possible to add some lines. Lines can
be used to link elements or shapes in a map.
To add a line, click on *Add* next to Shape. A new shape will appear at
the top left corner of the map. Select it and click on *Line* in the
editing form to change the shape into a line. Then adjust line
properties, such as line type, width, color, etc.
{width="600"}
#### 添加行
除了形状之外，还可以添加一些线条。线条可用于连接地图中的元素或形状。
要添加线条，点击形状旁边的*添加*。一个新形状将出现在地图的Top左角。选中它并在编辑表单中点击*线条*，将形状更改为线条。然后调整线条属性，如线条类型、宽度、颜色等。
{width="600"}
#### Adding LLD macro paths
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.update",
"params": {
"itemid": "22450",
"lld_macro_paths": [
{
"lld_macro": "{#MACRO1}",
"path": "$.json.path"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"22450"
]
},
"id": 1
}
```
#### 添加 LLD 宏路径
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.update",
"params": {
"itemid": "22450",
"lld_macro_paths": [
{
"lld_macro": "{#MACRO1}",
"path": "$.json.path"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"22450"
]
},
"id": 1
}
```
#### Adding macros
Add two new macros to two hosts.
Request:
```json
{
"jsonrpc": "2.0",
"method": "host.massadd",
"params": {
"hosts": [
{
"hostid": "10160"
},
{
"hostid": "10167"
}
],
"macros": [
{
"macro": "{$TEST1}",
"value": "MACROTEST1"
},
{
"macro": "{$TEST2}",
"value": "MACROTEST2",
"description": "Test description"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10160",
"10167"
]
},
"id": 1
}
```
#### 添加宏
向两个主机添加两个新宏.
请求:
```json
{
"jsonrpc": "2.0",
"method": "host.massadd",
"params": {
"hosts": [
{
"hostid": "10160"
},
{
"hostid": "10167"
}
],
"macros": [
{
"macro": "{$TEST1}",
"value": "MACROTEST1"
},
{
"macro": "{$TEST2}",
"value": "MACROTEST2",
"description": "Test description"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10160",
"10167"
]
},
"id": 1
}
```
#### Adding pages
To add a new page to a dashboard:
- Make sure the dashboard is in the [editing
mode](#viewing_and_editing_a_dashboard)
- Click on the arrow next to the *Add* button and select the *Add
page* option
- Fill the general page parameters and click on *Apply*. If you leave
the name empty, the page will be added with a `Page N` name where
'N' is the incremental number of the page. The page display period
allows to customize how long a page is displayed in a slideshow.
A new page will be added, indicated by a new tab (*Page 2*).
The pages can be reordered by dragging-and-dropping the page tabs.
Reordering maintains the original page naming. It is always possible to
go to each page by clicking on its tab.
When a new page is added, it is empty. You can add widgets to it as
described above.
#### 添加页面
向仪表板添加新页面：
- 确保仪表板处于[编辑模式](#viewing_and_editing_a_dashboard)
- 点击*添加*按钮旁的箭头并选择*添加
page* option
- 填写页面常规参数并点击*应用*。如果保留
the name empty, the page will be added with a `Page N` name where
'N' is the incremental number of the page. The page display period
allows to customize how long a page is displayed in a slideshow.
`Page N`名称（其中
'N'表示页面的递增编号）。页面显示周期可自定义幻灯片放映中页面的显示时长。
新页面将被添加，并通过新标签页（*页面2*）显示。
可通过拖拽页面标签页来重新排序页面。重新排序会保持原始页面命名。始终可以通过点击标签页切换到每个页面。
添加新页面时，该页面为空。可以按照上述方法向其添加小部件。
##### Adding permissions
By default, a new user has no permissions to access hosts. To grant the
user rights, click on the group of the user in the *Groups* column (in
this case - 'Zabbix administrators'). In the group properties form, go
to the *Permissions* tab.
{width="600"}
This user is to have read-only access to *Linux servers* group, so click
on *Select* next to the host group selection field.
In this popup, mark the checkbox next to 'Linux servers', then click
*Select*. *Linux servers* should be displayed in the selection field.
Click the 'Read' button to set the permission level and then *Add* to
add the group to the list of permissions. In the user group properties
form, click *Update*.
::: noteimportant
In Zabbix, access rights to hosts are assigned to
[user groups](/manual/config/users_and_usergroups/usergroup), not
individual users.
:::
Done! You may try to log in using the credentials of the new user.
##### 添加权限
默认情况下，新用户无权访问主机。要授予用户权限，请点击*Groups*列中的用户组（本例中为'Zabbix administrators'）。在组属性表单中，转到*Permissions*选项卡。
{width="600"}
该用户需要对*Linux servers*组具有只读访问权限，因此点击主机组选择字段旁的*Select*。
在此弹出窗口中，勾选'Linux servers'旁的复选框，然后点击*Select*。*Linux servers*应显示在选择字段中。点击'Read'按钮设置权限级别，然后点击*Add*将该组添加到权限列表中。在用户组属性表单中，点击*Update*。
::: noteimportant
在Zabbix中，对主机的访问权限是分配给[user groups](/manual/config/users_and_usergroups/usergroup)的，而非单个用户。
:::
完成！您可以尝试使用新用户的凭据登录。
##### Adding proxies
To configure a proxy in Zabbix frontend:
- Go to: *Administration → Proxies*
- Click on *Create proxy*
{width="600"}
|Parameter|<|Description|
|-|----------|----------------------------------------|
|*Proxy name*|<|Enter the proxy name. It must be the same name as in the *Hostname* parameter in the proxy configuration file.|
|*Proxy mode*|<|Select the proxy mode.<br>**Active** - the proxy will connect to the Zabbix server and request configuration data<br>**Passive** - Zabbix server connects to the proxy<br>*Note* that without encrypted communications (sensitive) proxy configuration data may become available to parties having access to the Zabbix server trapper port when using an active proxy. This is possible because anyone may pretend to be an active proxy and request configuration data if authentication does not take place or proxy addresses are not limited in the *Proxy address* field.|
|*Proxy address*|<|If specified then active proxy requests are only accepted from this list of comma-delimited IP addresses, optionally in CIDR notation, or DNS names of active Zabbix proxy.<br>This field is only available if an active proxy is selected in the *Proxy mode* field. Macros are not supported.<br>This option is supported since Zabbix 4.0.0.|
|*Interface*|<|Enter interface details for the passive proxy.<br>This field is only available if a passive proxy is selected in the *Proxy mode* field.|
| |*IP address*|IP address of the passive proxy (optional).|
|^|*DNS name*|DNS name of the passive proxy (optional).|
|^|*Connect to*|Clicking the respective button will tell Zabbix server what to use to retrieve data from proxy:<br>**IP** - Connect to the proxy IP address (recommended)<br>**DNS** - Connect to the proxy DNS name|
|^|*Port*|TCP port number of the passive proxy (10051 by default).|
|*Description*|<|Enter the proxy description.|
The **Encryption** tab allows you to require encrypted connections with
the proxy.
|Parameter|Description|
|--|--------|
|*Connections to proxy*|How the server connects to the passive proxy: no encryption (default), using PSK (pre-shared key) or certificate.|
|*Connections from proxy*|Select what type of connections are allowed from the active proxy. Several connection types can be selected at the same time (useful for testing and switching to other connection type). Default is "No encryption".|
|*Issuer*|Allowed issuer of certificate. Certificate is first validated with CA (certificate authority). If it is valid, signed by the CA, then the *Issuer* field can be used to further restrict allowed CA. This field is optional, intended to use if your Zabbix installation uses certificates from multiple CAs.|
|*Subject*|Allowed subject of certificate. Certificate is first validated with CA. If it is valid, signed by the CA, then the *Subject* field can be used to allow only one value of *Subject* string. If this field is empty then any valid certificate signed by the configured CA is accepted.|
|*PSK identity*|Pre-shared key identity string.<br>Do not put sensitive information in the PSK identity, it is transmitted unencrypted over the network to inform a receiver which PSK to use.|
|*PSK*|Pre-shared key (hex-string). Maximum length: 512 hex-digits (256-byte PSK) if Zabbix uses GnuTLS or OpenSSL library, 64 hex-digits (32-byte PSK) if Zabbix uses mbed TLS (PolarSSL) library. Example: 1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952|
##### 添加 proxies
要在Zabbix前端配置proxy:
- 前往: *管理 → Proxies*
- 点击*创建proxy*
{width="600"}
| 参数 | < | 描述 |
|-|----------|----------------------------------------|
| *Proxy name* | < | 输入proxy名称。必须与proxy配置file中的*主机名*参数相同。 |
| *Proxy mode* | < | 选择proxy模式。<br>**主动** - proxy将连接到Zabbix server并请求配置数据<br>**被动** - Zabbix server连接到proxy<br>*注意* 当使用主动proxy时，如果没有加密通信(敏感)，proxy配置数据可能会被能够访问Zabbix server trapper端口的第三方获取。这是因为如果未进行身份验证或未在*Proxy地址*字段中限制proxy地址，任何人都可以伪装成主动proxy并请求配置数据。 |
| *Proxy address* | < | 如果指定，则仅接受来自此逗号分隔的IP地址列表(可选CIDR表示法)或主动Zabbix proxy的DNS名称的主动proxy请求。<br>此字段仅在*Proxy模式*字段中选择主动proxy时可用。不支持宏。<br>此选项自Zabbix 4.0.0起支持。 |
| *Interface* | < | 输入被动proxy的接口详情。<br>此字段仅在*Proxy模式*字段中选择被动proxy时可用。 |
| | *IP地址* | 被动proxy的IP地址(可选)。 |
| ^ | *DNS名称* | 被动proxy的DNS名称(可选)。 |
| ^ | *连接到* | 点击相应按钮将告诉Zabbix server使用什么从proxy检索数据:<br>**IP** - 连接到proxy IP地址(推荐)<br>**DNS** - 连接到proxy DNS名称 |
| ^ | *端口* | 被动proxy的TCP端口号(默认为10051)。 |
| *Description* | < | 输入proxy描述。 |
**加密**选项卡允许您要求与proxy建立加密连接。
| 参数 | 描述 |
|--|--------|
| *Connections to proxy* | 服务器如何连接到被动proxy: 无加密(默认)、使用PSK(预共享密钥)或证书。 |
| *Connections from proxy* | 选择允许从主动proxy建立哪些类型的连接。可以同时选择多种连接类型(用于测试和切换到其他连接类型)。默认为"无加密"。 |
| *Issuer* | 允许的证书颁发者。证书首先由CA(证书颁发机构)验证。如果有效并由CA签名，则可以使用*颁发者*字段进一步限制允许的CA。此字段是可选的，当您的Zabbix安装使用来自多个CA的证书时使用。 |
| *Subject* | 允许的证书主题。证书首先由CA验证。如果有效并由CA签名，则可以使用*主题*字段仅允许一个*主题*string值。如果此字段为空，则接受由配置的CA签名的任何有效证书。 |
| *PSK identity* | 预共享密钥标识string。<br>不要在PSK标识中放置敏感信息，它通过网络以明文传输，用于通知接收方使用哪个PSK。 |
| *PSK* | 预共享密钥(十六进制string)。最大长度: 如果Zabbix使用GnuTLS或OpenSSL库，为512个十六进制数字(256字节PSK)；如果Zabbix使用mbed TLS(PolarSSL)库，为64个十六进制数字(32字节PSK)。示例: 1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952 |
#### Adding shapes
In addition to map elements, it is also possible to add some shapes.
Shapes are not map elements; they are just a visual representation. For
example, a rectangle shape can be used as a background to group some
hosts. Rectangle and ellipse shapes can be added.
To add a shape, click on *Add* next to Shape. The new shape will appear
at the top left corner of the map. Drag and drop it wherever you like.
A new shape is added with default colors. By clicking on the shape, a
form is displayed and you can customize the way a shape looks, add text,
etc.
{width="600"}
To select shapes, select one and then hold down *Ctrl* to select the
others. With several shapes selected, common properties can be mass
updated, similarly as with elements.
Text can be added in the shapes. Expression
[macros](/manual/appendix/macros/supported_by_location) are supported in
the text, but only with `avg`, `last`, `min` and `max` functions, with
time as parameter (for example, `{?avg(/host/key,1h)}`).
To display text only the shape can be made invisible by removing the
shape border (select 'None' in the *Border* field). For example, take
note of how the {MAP.NAME} macro, visible in the screenshot above, is
actually a rectangle shape with text, which can be seen when clicking on
the macro:
{MAP.NAME} resolves to the configured map name when viewing the map.
If hyperlinks are used in the text, they become clickable when viewing
the map.
Line wrapping for text is always "on" within shapes. However, within an
ellipse, the lines are wrapped as though the ellipse were a rectangle.
Word wrapping is not implemented, so long words (words that do not fit
the shape) are not wrapped, but are masked (constructor page) or clipped
(other pages with maps).
#### 添加形状
除了地图元素外，还可以添加一些形状。
形状并非地图元素，它们仅作为视觉呈现。例如，
矩形形状可用作背景来分组某些主机。可添加矩形和椭圆形形状。
要添加形状，点击形状旁的*添加*。新形状将出现在
地图的Top左上角。可将其拖放至任意位置。
新添加的形状会使用默认颜色。点击形状时，
将显示表单供您自定义形状外观、添加文本等。
{width="600"}
选择形状时，先选中一个再按住*Ctrl*键选择其他。
选中多个形状后，可批量更新共同属性，与元素操作类似。
可在形状中添加文本。文本支持
[macros](/manual/appendix/macros/supported_by_location)表达式，
但仅限`avg`、`last`、`min`和`max`函数，
且时间作为参数（例如`{?avg(/host/key,1h)}`）。
若仅需显示文本，可通过移除形状边框（在*边框*字段选择'无'）
使形状不可见。例如注意上图中可见的{MAP.NAME}宏，
实际是带文本的矩形形状，点击宏时可见：
查看地图时，{MAP.NAME}会解析为配置的地图名称。
若文本中使用超链接，查看地图时将可点击。
形状内文本始终启用自动换行。但在椭圆内，
换行方式与矩形相同。未实现单词换行，
因此过长的单词（超出形状范围的单词）不会被换行，
而是被遮罩（构造器页面）或裁剪（其他含地图的页面）。
#### Adding user
To view information about users, go to *Administration → Users*.
{width="600"}
To add a new user, click on *Create user*.
In the new user form, make sure to add your user to one of the existing
[user groups](/manual/config/users_and_usergroups/usergroup), for
example 'Zabbix administrators'.
All mandatory input fields are marked with a red asterisk.
By default, new users have no media (notification delivery methods)
defined for them. To create one, go to the 'Media' tab and click on
*Add*.
In this pop-up, enter an email address for the user.
You can specify a time period when the medium will be active (see [Time
period specification](/manual/appendix/time_period) page for a
description of the format), by default a medium is always active. You
can also customize [trigger severity](/manual/config/triggers/severity)
levels for which the medium will be active, but leave all of them
enabled for now.
Click on *Add* to save the medium, then go to the Permissions tab.
Permissions tab has a mandatory field *Role*. The role determines which
frontend elements the user can view and which actions he is allowed to
perform. Press Select and select one of the roles from the list. For
example, select *Admin role* to allow access to all Zabbix frontend
sections, except Administration. Later on, you can modify permissions or
create more user roles. Upon selecting a role, permissions will appear
in the same tab:
{width="600"}
Click *Add* in the user properties form to save the user. The new user
appears in the userlist.
{width="600"}
#### 添加用户
要查看用户信息，请前往*管理 → 用户*。
{width="600"}
要添加新用户，点击*创建用户*。
在新用户表单中，请确保将用户添加到现有的[user groups](/manual/config/users_and_usergroups/usergroup)之一，例如'Zabbix管理员'。
所有必填字段都用红色星号标记。
默认情况下，新用户没有定义媒体（通知传递方法）。要create一个，请转到'媒体'标签页并点击*添加*。
在此弹出窗口中，输入用户的电子邮件地址。
您可以指定媒体活动的时间段（有关格式描述，请参见[Time
period specification](/manual/appendix/time_period)页面），默认情况下媒体始终处于活动状态。您还可以自定义[trigger severity](/manual/config/triggers/severity)级别以确定媒体何时活动，但现在请保持所有级别启用。
点击*添加*保存媒体，然后转到权限标签页。
权限标签页有一个必填字段*角色*。角色决定了用户可以查看哪些前端元素以及允许执行哪些操作。点击选择并从列表中选择一个角色。例如，选择*管理员角色*以允许访问除管理部分外的所有Zabbix前端部分。之后，您可以修改权限或create更多用户角色。选择角色后，权限将显示在同一标签页中：
{width="600"}
在用户属性表单中点击*添加*保存用户。新用户将出现在用户列表中。
{width="600"}
#### Adding web scenarios
To add web scenarios to a template in *Configuration → Templates*, do
the following:
- Click on *Web* in the row of the template
- Configure a web scenario following the usual method of [configuring
web scenarios](/manual/web_monitoring#configuring_a_web_scenario)
#### 添加 Web 场景
要在*配置 → 模板*中向模板添加Web场景，请执行以下操作：
- 点击模板所在行的*Web*
- 按照[配置web场景](/manual/web_monitoring#配置web场景)的常规方法配置Web场景
#### Adding widgets
To add a widget to a dashboard:
- Click on the
button or the *Add widget* option in the action menu that can be
opened by clicking on the arrow. Fill the widget configuration form.
The widget will be created in its default size and placed after the
existing widgets (if any);
Or
- Move your mouse to the desired empty spot for the new widget. Notice
how a placeholder appears, on mouseover, on any empty slot on the
dashboard. Then click to open the widget configuration form. After
filling the form the widget will be created in its default size or,
if its default size is bigger than is available, take up the
available space. Alternatively, you may click and drag the
placeholder to the desired widget size, then release, and then fill
the widget configuration form. (Note that when there is a widget
copied onto the clipboard, you will be first prompted to select
between *Add widget* and *Paste widget* options to create a widget.)
In the widget configuration form:
- Select the *Type* of widget
- Enter widget parameters
- Click on *Add*
#### Widgets
A wide variety of [widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) (e.g. [Clock](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/clock), [Host availability](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/host_availability) or [Trigger overview](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/trigger_overview)) can be added to a dashboard: these can be resized and moved around the dashboard in dashboard editing mode by clicking on the widget title bar and dragging it to a new location. Also, you can click on the following buttons in the top-right corner of the widget to:
-  -
edit a widget;
-  -
access the [widget menu](#widget_menu)
Click on *Save changes* for the dashboard to make any changes to the
widgets permanent.
#### 添加部件
向仪表板添加小部件：
- 点击
button or the *Add widget* option in the action menu that can be
opened by clicking on the arrow. Fill the widget configuration form.
The widget will be created in its default size and placed after the
existing widgets (if any);
或
- 将鼠标移动到新小部件所需的空白位置。注意
how a placeholder appears, on mouseover, on any empty slot on the
dashboard. Then click to open the widget configuration form. After
filling the form the widget will be created in its default size or,
if its default size is bigger than is available, take up the
available space. Alternatively, you may click and drag the
placeholder to the desired widget size, then release, and then fill
the widget configuration form. (Note that when there is a widget
copied onto the clipboard, you will be first prompted to select
between *Add widget* and *Paste widget* options to create a widget.)
在小部件配置表单中：
- 选择小部件的*类型*
- 输入小部件参数
- 点击*添加*
#### 部件
多种[widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)（例如[Clock](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/clock)、[Host availability](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/host_availability)或[Trigger overview](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/trigger_overview)）可以添加到仪表板：在仪表板编辑模式下，通过点击小部件标题栏并将其拖动到新位置，可以调整大小和移动。此外，您可以点击小部件Top-右上角的以下按钮来：
-  -
编辑小部件；
-  -
access the [widget menu](#widget_menu)
点击*保存更改*以使对小部件的任何更改永久生效。
#### Adding widgets
To add a widget to a dashboard:
- Click on the
button or the *Add widget* option in the action menu that can be
opened by clicking on the arrow. Fill the widget configuration form.
The widget will be created in its default size and placed after the
existing widgets (if any);
Or
- Move your mouse to the desired empty spot for the new widget. Notice
how a placeholder appears, on mouseover, on any empty slot on the
dashboard. Then click to open the widget configuration form. After
filling the form the widget will be created in its default size or,
if its default size is bigger than is available, take up the
available space. Alternatively, you may click and drag the
placeholder to the desired widget size, then release, and then fill
the widget configuration form. (Note that when there is a widget
copied onto the clipboard, you will be first prompted to select
between *Add widget* and *Paste widget* options to create a widget.)
In the widget configuration form:
- Select the *Type* of widget
- Enter widget parameters
- Click on *Add*
#### Widgets
The following widgets can be added to a dashboard:
- [Action
log](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/action_log)
- [Clock](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/clock)
- [Data
overview](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/data_overview)
- [Discovery
status](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/discovery_status)
- [Favorite
graphs](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/favorite_graphs)
- [Favorite
maps](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/favorite_maps)
- [Geomap](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)
- [Graph](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph)
- [Graph
(classic)](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph_classic)
- [Graph
prototype](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph_prototype)
- [Host
availability](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/host_availability)
- [Item value](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/item_value)
- [Map](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/map)
- [Map navigation
tree](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/map_tree)
- [Plain
text](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/plain_text)
- [Problem
hosts](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problem_hosts)
- [Problems](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problems)
- [System
information](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/system)
- [Problems by
severity](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problems_severity)
- [Trigger
overview](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/trigger_overview)
- [URL](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/url)
- [Web
monitoring](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/web_monitoring)
In dashboard editing mode widgets can be resized and moved around the
dashboard by clicking on the widget title bar and dragging it to a new
location. Also, you can click on the following buttons in the top-right
corner of the widget to:
-  -
edit a widget;
-  -
access the [widget menu](#widget_menu)
Click on *Save changes* for the dashboard to make any changes to the
widgets permanent.
#### 动态小构件
在
[配置](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)
一些小部件的时:
- 图形 (或者简单图形)
- 纯文本
- URL
还有一个特别的选项 *动态监控项*。
如果你勾选此项，便可以根据选择不同的主机展示不同的内容，或者持续展示更新最新的数据信息。
当你勾选动态监控后，在保存仪表板时，您会注意到仪表板上方出现了两个新的下拉列表，用于选择主机组/主机:
因此，您有一个窗口小构件，它可以显示基于下拉列表中所选主机的数据的内容。
这样做的好处是您不需要创建额外的小构件，例如，您希望看到包含来自不同主机的数据的相同图形。
### Adding Zabbix repository
Install the repository configuration package. This package contains yum
(software package manager) configuration files.
SLES 15:
rpm -Uvh --nosignature https://repo.zabbix.com/zabbix/6.0/sles/15/x86_64/zabbix-release-latest.sles15.noarch.rpm
zypper --gpg-auto-import-keys refresh 'Zabbix Official Repository'
SLES 12:
rpm -Uvh --nosignature https://repo.zabbix.com/zabbix/6.0/sles/12/x86_64/zabbix-release-latest.sles12.noarch.rpm
zypper --gpg-auto-import-keys refresh 'Zabbix Official Repository'
Please note that Zabbix web service process, which is used for
[scheduled report
generation](/manual/web_interface/frontend_sections/reports/scheduled),
requires Google Chrome browser. The browser is not included into
packages and has to be installed manually.
### 添加Zabbix仓库
安装仓库配置包。该软件包包含yum（软件包管理器）配置文件。
SLES 15：
rpm -Uvh --nosignature https://repo.zabbix.com/zabbix/6.0/sles/15/x86_64/zabbix-release-latest.sles15.noarch.rpm
zypper --gpg-auto-import-keys refresh 'Zabbix Official Repository'
SLES 12：
rpm -Uvh --nosignature https://repo.zabbix.com/zabbix/6.0/sles/12/x86_64/zabbix-release-latest.sles12.noarch.rpm
zypper --gpg-auto-import-keys refresh 'Zabbix Official Repository'
请注意，用于[scheduled report
generation](/manual/web_interface/frontend_sections/reports/scheduled)的Zabbix网页服务进程需要Google Chrome浏览器。该浏览器不包含在软件包中，需手动安装。
#### Additional information
#### 附加信息
##### Additional parameters
A third optional parameter is supported by the *bucket\_rate\_foreach*
function:
bucket_rate_foreach(item filter,time period,<parameter number>)
where <parameter number> is the position of the "bucket" value in
the item key. For example, if the "bucket" value in myItem\[aaa,0.2\] is
'0.2', then its position is 2.
The default value of <parameter number> is '1'.
See [aggregate calculations](/manual/config/items/itemtypes/calculated/aggregate) for
more details and examples on using foreach functions.
##### 附加参数
*bucket\_rate\_foreach* 函数支持第三个可选参数：
bucket_rate_foreach(item filter,time period,<parameter number>)
其中<parameter number>表示"bucket"值在监控项键中的位置。例如，如果myItem\[aaa,0.2\]中的"bucket"值是'0.2'，那么它的位置就是2。
<parameter number>的默认值为'1'。
关于foreach函数的使用详情和示例，请参阅[aggregate calculations](/manual/config/items/itemtypes/calculated/aggregate)。
#### Additional ssh.run options
The **ssh.run[]** item has been updated and now allows passing additional SSH options as a part of the item key.
These options are supported only using libssh of version 0.9.0 and higher or libssh2.
Supported option keys and values depend on the SSH library.
See [SSH checks](/manual/config/items/itemtypes/ssh_checks) for details.
#### 附加 ssh.run 选项
**ssh.run[]** 监控项已更新，现在允许作为监控项键的一部分传递额外的SSH选项。
这些选项仅在使用version 0.9.0及以上版本的libssh或libssh2时受支持。
支持的选项键和值取决于SSH库。
详情请参阅[SSH checks](/manual/config/items/itemtypes/ssh_checks)。
### Administration
With the Zabbix API you can change administration settings of your
monitoring system.
### 管理
通过Zabbix API，您可以更改监控系统的管理设置。
#### Advanced configuration
Advanced configuration options become available if the *Advanced
configuration* checkbox is marked (see screenshot) and only for
those elements that are selected in the *Show* field (see above).
Additionally, advanced configuration allows to change the background
color for the whole widget.
| | |
|--|--------|
|_**Description**_ |Enter the item description. This description may override the default item name. Multiline descriptions are supported. A combination of text and supported macros is possible.<br>{HOST.\*}, {ITEM.\*}, {INVENTORY.\*} and user macros are supported. |
|*Horizontal position* |Select horizontal position of the item description - left, right or center. |
|*Vertical position* |Select vertical position of the item description - top, bottom or middle. |
|*Size* |Enter font size height for the item description (in percent relative to total widget height). |
|*Bold* |Mark the checkbox to display item description in bold type. |
|*Color* |Select the item description color from the color picker.<br>`D` stands for default color (depends on the frontend theme). To return to the default value, click the *Use default* button in the color picker. |
|_**Value**_ | |
|*Decimal places* |Select how many decimal places will be displayed with the value. This value will affect only float items. For items with units set to "s", if this value is greater than 0 (the default is 2), the widget rounds the most significant time unit and displays a numeric value (e.g. "10.43m") instead of converting the value into a full time string. When set to 0, the seconds are converted to a human-readable time string (for example, "4h 56m 30s"). |
|*Size* |Enter font size height for the decimal places (in percent relative to total widget height). |
|*Horizontal position* |Select horizontal position of the item value - left, right or center. |
|*Vertical position* |Select vertical position of the item value - top, bottom or middle. |
|*Size* |Enter font size height for the item value (in percent relative to total widget height).<br>*Note* that the size of item value is prioritised; other elements have to concede space for the value. With the change indicator though, if the value is too large, it will be truncated to show the change indicator. |
|*Bold* |Mark the checkbox to display item value in bold type. |
|*Color* |Select the item value color from the color picker.<br>`D` stands for default color (depends on the frontend theme). To return to the default value, click the *Use default* button in the color picker. |
|*Units* |Mark the checkbox to display units with the item value. If you enter a unit name, it will override the unit from item configuration. |
|*Position* |Select the item unit position - above, below, before or after the value. |
|*Size* |Enter font size height for the item unit (in percent relative to total widget height). |
|*Bold* |Mark the checkbox to display item unit in bold type. |
|*Color* |Select the item unit color from the color picker.<br>`D` stands for default color (depends on the frontend theme). To return to the default value, click the *Use default* button in the color picker. |
|_**Time**_ |Time is the clock value from item history. |
|*Horizontal position* |Select horizontal position of the time - left, right or center. |
|*Vertical position* |Select vertical position of the time - top, bottom or middle. |
|*Size* |Enter font size height for the time (in percent relative to total widget height). |
|*Bold* |Mark the checkbox to display time in bold type. |
|*Color* |Select the time color from the color picker.<br>`D` stands for default color (depends on the frontend theme). To return to the default value, click the *Use default* button in the color picker. |
|_**Change indicator**_ |Select the color of change indicators from the color picker. The change indicators are as follows:<br>**↑** - item value is up (for numeric items)<br>**↓** - item value is down (for numeric items)<br>**↕** - item value has changed (for string items and items with value mapping)<br>`D` stands for default color (depends on the frontend theme). To return to the default value, click the *Use default* button in the color picker.<br>Vertical size of the change indicator is equal to the size of the value (integer part of the value for numeric items).<br>*Note* that up and down indicators are not shown with just one value. |
|_**Background color**_ |Select the background color for the whole widget from the color picker.<br>`D` stands for default color (depends on the frontend theme). To return to the default value, click the *Use default* button in the color picker. |
*Note* that multiple elements cannot occupy the same space; if they are placed in the same space, an error message will be displayed.
#### 高级配置
若勾选*高级配置*复选框（参见截图），则高级配置选项将可用，且仅针对*显示*字段中选定的元素生效（参见上文）。
此外，高级配置允许更改整个小部件的背景颜色。
| | |
|--|--------|
| _**描述**_ | 输入监控项描述。此描述可覆盖默认监控项名称。支持多行描述，可组合文本与支持的宏。<br>支持{主机.\*}, {监控项.\*}、{INVENTORY.\*}及用户宏。 |
| *水平位置* | 选择监控项描述的水平位置 - 左、右或居中。 |
| *垂直位置* | 选择监控项描述的垂直位置 - Top、底部或中部。 |
| *字号* | 输入监控项描述的字体高度（相对于小部件总高度的百分比）。 |
| *加粗* | 勾选复选框以加粗显示监控项描述。 |
| *颜色* | 从颜色选择器中选择监控项描述颜色。<br>`D`表示默认颜色（取决于前端主题）。要恢复默认值，点击颜色选择器中的*使用默认*按钮。 |
| _**数值**_ | |
| *小数位数* | 选择数值显示的小数位数。此设置仅影响浮点型监控项。对于单位设为"s"的监控项，若此值大于0（默认为2），小部件会四舍五入最高有效时间单位并显示数值（如"10.43m"），而非转换为完整时间string。设为0时，秒数将转换为人类可读时间string（例如"4h 56m 30s"）。 |
| *字号* | 输入小数位数字体高度（相对于小部件总高度的百分比）。 |
| *水平位置* | 选择监控项数值的水平位置 - 左、右或居中。 |
| *垂直位置* | 选择监控项数值的垂直位置 - Top、底部或中部。 |
| *字号* | 输入监控项数值的字体高度（相对于小部件总高度的百分比）。<br>*注意*：监控项数值字号具有优先级；其他元素需为其预留空间。但带变化指示器时，若数值过大将被截断以显示变化指示器。 |
| *加粗* | 勾选复选框以加粗显示监控项数值。 |
| *颜色* | 从颜色选择器中选择监控项数值颜色。<br>`D`表示默认颜色（取决于前端主题）。要恢复默认值，点击颜色选择器中的*使用默认*按钮。 |
| *单位* | 勾选复选框以显示监控项数值单位。若输入单位名称，将覆盖监控项配置中的单位。 |
| *位置* | 选择监控项单位位置 - 数值上方、下方、之前或之后。 |
| *字号* | 输入监控项单位字体高度（相对于小部件总高度的百分比）。 |
| *加粗* | 勾选复选框以加粗显示监控项单位。 |
| *颜色* | 从颜色选择器中选择监控项单位颜色。<br>`D`表示默认颜色（取决于前端主题）。要恢复默认值，点击颜色选择器中的*使用默认*按钮。 |
| _**时间**_ | 时间指监控项历史记录中的时钟值。 |
| *水平位置* | 选择时间的水平位置 - 左、右或居中。 |
| *垂直位置* | 选择时间的垂直位置 - Top、底部或中部。 |
| *字号* | 输入时间字体高度（相对于小部件总高度的百分比）。 |
| *加粗* | 勾选复选框以加粗显示时间。 |
| *颜色* | 从颜色选择器中选择时间颜色。<br>`D`表示默认颜色（取决于前端主题）。要恢复默认值，点击颜色选择器中的*使用默认*按钮。 |
| _**变化指示器**_ | 从颜色选择器中选择变化指示器颜色。指示器含义如下：<br>**↑** - 监控项数值上升（针对数值型监控项）<br>**↓** - 监控项数值下降（针对数值型监控项）<br>**↕** - 监控项数值已变化（针对string型监控项及带值映射的监控项）<br>`D`表示默认颜色（取决于前端主题）。要恢复默认值，点击颜色选择器中的*使用默认*按钮。<br>变化指示器的垂直高度与数值字号相同（数值型监控项则为数值的integer部分）。<br>*注意*：仅单个数值时不显示升降指示器。 |
| _**背景颜色**_ | 从颜色选择器中选择整个小部件的背景颜色。<br>`D`表示默认颜色（取决于前端主题）。要恢复默认值，点击颜色选择器中的*使用默认*按钮。 |
*注意*：多个元素不能占据同一空间；若被放置在同一位置，将显示错误消息。
#### Advanced configuration
{width=600}
|Parameter|Description|
|--|--------|
|_**Additional rules**_|Click on *Add* to define additional status calculation rules.|
|*Set status to*|Set service status to either *OK* (default), *Not classified*, *Information*, *Warning*, *Average*, *High* or *Disaster* in case of a condition match.|
|*Condition*|Select the condition for direct child services:<br>**if at least (N) child services have (Status) status or above**<br>**if at least (N%) of child services have (Status) status or above**<br>**if less than (N) child services have (Status) status or below**<br>**if less than (N%) of child services have (Status) status or below**<br>**if weight of child services with (Status) status or above is at least (W)**<br>**if weight of child services with (Status) status or above is at least (N%)**<br>**if weight of child services with (Status) status or below is less than (W)**<br>**if weight of child services with (Status) status or below is less than (N%)** <br><br> If several conditions are specified and the situation matches more than one condition, the highest severity will be set.|
|*N (W)*|Set the value of N or W (1-100000), or N% (1-100) in the condition.|
|*Status*|Select the value of *Status* in the condition: *OK* (default), *Not classified*, *Information*, *Warning*, *Average*, *High* or *Disaster*.|
|_**Status propagation rule**_|Rule for propagating the service status to the parent service:<br>**As is** - the status is propagated without change<br>**Increase by** - you may increase the propagated status by 1 to 5 severities<br>**Decrease by** - you may decrease the propagated status by 1 to 5 severities<br>**Ignore this service** - the status is not propagated to the parent service at all<br>**Fixed status** - the status is propagated statically, i.e. as always the same|
|_**Weight**_|Weight of the service (integer in the range from 0 (default) to 1000000).|
:::noteclassic
Additional status calculation rules can only be used to increase severity level over the level calculated according to the main *Status calculation rule* parameter. If according to additional rules the status should be Warning, but according to the *Status calculation rule* the status is Disaster - the service will have status Disaster.
:::
#### 高级配置
{width=600}
| 参数 | 描述 |
|--|--------|
| _**Additional rules**_ | 点击*添加*以定义额外的状态计算规则 |
| *Set status to* | 当条件匹配时，将服务状态设置为*正常*(默认)、*未分类*、*信息*、*警告*、*一般严重*、*严重*或*灾难* |
| *Condition* | 为直接子服务选择条件:<br>**如果至少(N)个子服务达到(状态)或更高状态**<br>**如果至少(N%)的子服务达到(状态)或更高状态**<br>**如果少于(N)个子服务达到(状态)或更低状态**<br>**如果少于(N%)的子服务达到(状态)或更低状态**<br>**如果达到(状态)或更高状态的子服务权重至少为(W)**<br>**如果达到(状态)或更高状态的子服务权重至少为(N%)**<br>**如果达到(状态)或更低状态的子服务权重小于(W)**<br>**如果达到(状态)或更低状态的子服务权重小于(N%)** <br><br> 如果指定了多个条件且情况匹配多个条件，则将设置最高严重级别 |
| *N (W)* | 在条件中设置N或W的值(1-100000)，或N%(1-100) |
| *Status* | 在条件中选择*状态*值: *正常*(默认)、*未分类*、*信息*、*警告*、*一般严重*、*严重*或*灾难* |
| _**Status propagation rule**_ | 服务状态传播到父服务的规则:<br>**原样** - 状态不变传播<br>**增加** - 可将传播状态提高1至5个严重级别<br>**减少** - 可将传播状态降低1至5个严重级别<br>**忽略此服务** - 状态完全不传播到父服务<br>**固定状态** - 状态静态传播，即始终保持相同 |
| _**Weight**_ | 服务的权重(integer范围从0(默认)到1000000) |
:::noteclassic
附加状态计算规则仅可用于将严重级别提升至超过根据主*状态计算规则*参数计算得出的级别。如果根据附加规则状态应为警告，但根据*状态计算规则*状态为灾难 - 服务将显示灾难状态。
:::
#### Advanced configuration
The following parameters are supported if *Advanced configuration* is set to "Enabled".
|Parameter|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-|--------|--|--------|-------------------------------|
|*Background color*|<|1|bg_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: `""` (empty).|
#### 高级配置
若*高级配置*设置为"启用"，则支持以下参数。
| 参数 | < | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-|--------|--|--------|-------------------------------|
| *Background color* | < | 1 | bg_color | 十六进制颜色代码（例如`FF0000`）。<br><br>默认值：`""`（空）。 |
After receiving a list of active checks the agent marks obsolete persistent
files for removal. A persistent file becomes obsolete if: 1) the corresponding
log item is no longer monitored, 2) a log item is reconfigured with a different
**persistent\_dir** location than before.
Removing is done with delay 24 hours because log files in NOTSUPPORTED state
are not included in the list of active checks but they may become SUPPORTED
later and their persistent files will be useful.
If the agent is stopped before 24 hours expire, then the obsolete files will
not be deleted as Zabbix agent is not getting info about their location from
Zabbix server anymore.
::: notewarning
Reconfiguring a log item's **persistent\_dir** back to the old
**persistent\_dir** location while the agent is stopped, without deleting the
old persistent file by user - will cause restoring the agent state from the old
persistent file resulting in missed messages or false alerts.
:::
在接收到活动检查列表后，agent会标记过时的持久化文件以便删除。一个持久化file在以下情况下会变为过时：1) 对应的日志监控项不再被监控，2) 日志监控项被重新配置为与之前不同的**persistent\_dir**位置。
删除操作会延迟24小时执行，因为处于NOTSUPPORTED状态的日志文件不会包含在活动检查列表中，但它们可能稍后变为SUPPORTED状态，此时它们的持久化文件将派上用场。
如果agent在24小时到期前停止，那么过时文件将不会被删除，因为Zabbix agent无法再从Zabbix server获取这些文件的位置信息。
::: notewarning
当agent停止时，若用户未手动删除旧的持久化file，而将日志监控项的**persistent\_dir**重新配置回旧位置，会导致从旧的持久化file恢复agent状态，从而引发消息丢失或误报警报。
:::
#### Agent 2 package support for RHEL 6 dropped
Since Zabbix 6.0.35, Zabbix agent 2 packages are no longer available for [RHEL 6](https://repo.zabbix.com/zabbix/6.0/rhel/6/x86_64/) due to Go 1.22 (and newer) being incompatible with GCC 4.4.7 provided by RHEL 6, which results in compilation errors.
Note, however, that [Zabbix agent packages](/manual/installation/install_from_packages/rhel) are still supported.
#### Agent 2 软件包对 RHEL 6 的支持已终止
自Zabbix 6.0.35起，由于Go 1.22（及更新版本）与RHEL 6提供的GCC 4.4.7不兼容导致编译错误，Zabbix agent 2软件包不再为[RHEL 6](https://repo.zabbix.com/zabbix/6.0/rhel/6/x86_64/)提供。
但请注意，[Zabbix agent packages](/manual/installation/install_from_packages/rhel)仍受支持。
#### Agent 2 plugins
##### MySQL
The correct master host is now returned if specified in the `mysql.replication.get_slave_status[]`
[item](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#mysql) "masterHost" parameter.
Previously the "masterHost" parameter was ignored and always the first master host was returned.
If this parameter is not specified, all hosts are returned.
#### Agent 2 插件
##### MySQL
如果指定了正确的master 主机，现在会在`mysql.replication.get_slave_status[]`中返回
[mysql](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#mysql) "masterHost"参数。
之前"masterHost"参数会被忽略，总是返回第一个主节点主机。
如果未指定此参数，则返回所有主机。
##### Agent 2
|Requirement|Mandatory status|Description|
|--|-|-------|
|*Go*|Yes|Required to build Zabbix agent 2 and its plugins from source.<br>Go 1.23 or later is supported. See [go.dev](https://go.dev/doc/install) for installation instructions.<br>Go libraries used by Zabbix agent 2 and its plugins are listed in the Zabbix Git repository (libraries marked as `indirect` in the repository are dependencies of other required libraries):<br>- [Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [Plugin support](https://git.zabbix.com/projects/AP/repos/plugin-support/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [PostgreSQL](https://git.zabbix.com/projects/AP/repos/postgresql/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [MongoDB](https://git.zabbix.com/projects/AP/repos/mongodb/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [MSSQL](https://git.zabbix.com/projects/AP/repos/mssql/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [Ember+](https://git.zabbix.com/projects/AP/repos/ember-plus/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)|
|*libpcre/libpcre2*|One of|PCRE/PCRE2 library is required for [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) support.<br>The naming may differ depending on the GNU/Linux distribution, for example 'libpcre3' or 'libpcre1'. PCRE v8.x and PCRE2 v10.x (from Zabbix 6.0.0) are supported.<br>Required for log monitoring. Also required on Windows.|
|*libopenssl*|No|Required when using encryption.<br>OpenSSL 1.0.1 or later is required on UNIX platforms.<br>The OpenSSL library must have PSK support enabled. LibreSSL is not supported.<br>On Microsoft Windows systems OpenSSL 1.1.1 or later is required.|
##### Agent 2
| 需求 | 强制状态 | 描述 |
|--|-|-------|
| *Go* | Yes | 从源码构建Zabbix agent 2及其插件所需.<br>支持Go 1.23或更高版本. 安装说明参见[go.dev](https://go.dev/doc/install).<br>Zabbix agent 2及其插件使用的Go库列在Zabbix Git仓库中(仓库中标记为`indirect`的库是其他必需库的依赖项):<br>- [Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [Plugin support](https://git.zabbix.com/projects/AP/repos/plugin-support/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [PostgreSQL](https://git.zabbix.com/projects/AP/repos/postgresql/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [MongoDB](https://git.zabbix.com/projects/AP/repos/mongodb/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [MSSQL](https://git.zabbix.com/projects/AP/repos/mssql/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0)<br>- [Ember+](https://git.zabbix.com/projects/AP/repos/ember-plus/browse/go.mod?at=refs%2Fheads%2Frelease%2F6.0) |
| *libpcre/libpcre2* | One of | PCRE/PCRE2库为[Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions)(PCRE)支持所需.<br>命名可能因GNU/Linux发行版而异,例如'libpcre3'或'libpcre1'. 支持PCRE v8.x和PCRE2 v10.x(从Zabbix 6.0.0开始).<br>日志监控所需. Windows系统同样需要. |
| *libopenssl* | No | 使用加密时所需.<br>UNIX平台需要OpenSSL 1.0.1或更高版本.<br>OpenSSL库必须启用PSK支持. 不支持LibreSSL.<br>Microsoft Windows系统需要OpenSSL 1.1.1或更高版本. |
**Agent configuration**
Add the next line to the agent configuration file:
HostMetadata=Linux 21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae
where "Linux" is a platform, and the rest of the string is the
hard-to-guess secret text.
Do not forget to restart the agent after making any changes to the
configuration file.
***Step 2***
It is possible to add additional monitoring for an already registered
host.
**Agent 配置**
将以下行添加到 agent 配置文件 file 中：
HostMetadata=Linux 21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae
其中 "Linux" 是平台名称，其余部分 string 是难以猜测的密钥文本。
修改配置文件 file 后，不要忘记重启 agent。
***步骤 2***
可以为已注册的 主机 添加额外的监控。
##### Agent configuration
HA cluster nodes (servers) must be listed in the configuration of
Zabbix agent or Zabbix agent 2.
To enable passive checks, the node names must be listed in the Server
[parameter](/manual/appendix/config/zabbix_agentd), separated by a **comma**.
```
Server=zabbix-node-01,zabbix-node-02
```
To enable active checks, the node names must be listed in the ServerActive
[parameter](/manual/appendix/config/zabbix_agentd). Note that for
active checks the nodes must be separated by a comma from any other
servers, while the nodes themselves must be separated by a **semicolon**, e.g.:
```
ServerActive=zabbix-node-01;zabbix-node-02
```
##### Agent 配置
高可用集群节点（服务器）必须列在
Zabbix agent 或 Zabbix agent 2 的配置中。
要启用被动检查，节点名称必须列在 Server
[parameter](/manual/appendix/config/zabbix_agentd) 中，用**逗号**分隔。
```Server=zabbix-node-01,zabbix-node-02
```
To enable active checks, the node names must be listed in the ServerActive
[parameter](/manual/appendix/config/zabbix_agentd). Note that for
active checks the nodes must be separated by a comma from any other
servers, while the nodes themselves must be separated by a **semicolon**, e.g.:
```
ServerActive=zabbix-node-01;zabbix-node-02
```
**Agent configuration**
Now you need to configure the agents. Add the next line to the agent
configuration files:
HostMetadataItem=system.uname
This way you make sure host metadata will contain "Linux" or "Windows"
depending on the host an agent is running on. An example of host
metadata in this case:
Linux: Linux server3 3.2.0-4-686-pae #1 SMP Debian 3.2.41-2 i686 GNU/Linux
Windows: Windows WIN-0PXGGSTYNHO 6.0.6001 Windows Server 2008 Service Pack 1 Intel IA-32
Do not forget to restart the agent after making any changes to the
configuration file.
**Agent配置**
现在您需要配置agents. 将以下行添加到agent
配置文件中:
HostMetadataItem=system.uname
通过这种方式，您可以确保主机元数据将包含"Linux"或"Windows"
具体取决于主机运行的agent. 这种情况下主机
元数据的示例:
Linux: Linux server3 3.2.0-4-686-pae #1 SMP Debian 3.2.41-2 i686 GNU/Linux
Windows: Windows WIN-0PXGGSTYNHO 6.0.6001 Windows Server 2008 Service Pack 1 Intel IA-32
在对配置file进行任何更改后，
不要忘记重启agent.
**Agent configuration**
Update the next line in the agent configuration file:
HostMetadata=MySQL on Linux 21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae
Do not forget to restart the agent after making any changes to the
configuration file.
**Agent 配置**
更新 agent 配置文件 file 中的下一行:
HostMetadata=MySQL on Linux 21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae
修改完配置文件 file 后，别忘了重启 agent。
### Agent data request
The agent data request contains the gathered item values.
| Field |<| Type | Mandatory | Value |
|-|------|--|-|-----------------------|
| request |<| _string_ | yes | `agent data` |
| host |<| _string_ | yes | Host name. |
| version |<| _string_ | yes | The agent version: \<major>.\<minor>. |
| session |<| _string_ | yes | Unique session identifier generated each time when agent is started. |
| data |<| _array of objects_ | yes | Item values. |
| | id | _number_ | yes | The value identifier (incremental counter used for checking duplicated values in the case of network problems). |
|^| itemid | _number_ | yes | Item identifier. |
|^| value | _string_ | no | The item value. |
|^| lastlogsize | _number_ | no | The item lastlogsize. |
|^| mtime | _number_ | no | The item mtime. |
|^| state | _number_ | no | The item state. |
|^| source | _string_ | no | The value event log source. |
|^| eventid | _number_ | no | The value event log eventid. |
|^| severity | _number_ | no | The value event log severity. |
|^| timestamp | _number_ | no | The value event log timestamp. |
|^| clock | _number_ | yes | The value timestamp (seconds since Epoch). |
|^| ns | _number_ | yes | The value timestamp nanoseconds. |
Example:
```json
{
"request": "agent data",
"data": [
{
"id": 1,
"itemid": 5678,
"value": "2.4.0",
"clock": 1400675595,
"ns": 76808644
},
{
"id": 2,
"itemid": 1234,
"lastlogsize": 112,
"value": " 19845:20140621:141708.521 Starting Zabbix Agent [<hostname>]. Zabbix 2.4.0 (revision 50000).",
"clock": 1400675595,
"ns": 77053975
}
],
"host": "Zabbix server",
"version": "6.0",
"session": "1234456akdsjhfoui"
}
```
### Agent 数据请求
agent数据请求包含收集的监控项值.
| 字段 | < | 类型 | 必填 | 值 |
|-|------|--|-|-----------------------|
| request | < | _string_ | yes | `agent data` |
| host | < | _string_ | yes | 主机名. |
| version | < | _string_ | yes | agentversion: \<major>.\<minor>. |
| session | < | _string_ | yes | 每次启动agent时生成的唯一会话标识符. |
| data | < | _array of objects_ | yes | 监控项值. |
| | id | _number_ | yes | 值标识符(用于在网络问题情况下检查重复值的递增计数器). |
| ^ | itemid | _number_ | yes | 监控项标识符. |
| ^ | value | _string_ | no | 监控项值. |
| ^ | lastlogsize | _number_ | no | 监控项lastlogsize. |
| ^ | mtime | _number_ | no | 监控项mtime. |
| ^ | state | _number_ | no | 监控项状态. |
| ^ | source | _string_ | no | 值事件日志来源. |
| ^ | eventid | _number_ | no | 值事件日志eventid. |
| ^ | severity | _number_ | no | 值事件日志严重级别. |
| ^ | timestamp | _number_ | no | 值事件日志时间戳. |
| ^ | clock | _number_ | yes | 值时间戳(自Epoch起的秒数). |
| ^ | ns | _number_ | yes | 值时间戳纳秒部分. |
示例:
```json
{
"request": "agent data",
"data": [
{
"id": 1,
"itemid": 5678,
"value": "2.4.0",
"clock": 1400675595,
"ns": 76808644
},
{
"id": 2,
"itemid": 1234,
"lastlogsize": 112,
"value": " 19845:20140621:141708.521 Starting Zabbix Agent [<hostname>]. Zabbix 2.4.0 (revision 50000).",
"clock": 1400675595,
"ns": 77053975
}
],
"host": "Zabbix server",
"version": "6.0",
"session": "1234456akdsjhfoui"
}
```
### Agent data response
The agent data response is sent by the server back to agent after processing the agent data request.
| Field | Type | Mandatory | Value |
|-|-|-|--------|
| response | _string_ | yes | `success` \| `failed` |
| info | _string_ | yes | Item processing results. |
Example:
```json
{
"response": "success",
"info": "processed: 2; failed: 0; total: 2; seconds spent: 0.003534"
}
```
### Agent 数据响应
服务器在处理完agent数据请求后，会将agent数据响应发送回agent。
| 字段 | 类型 | 必填 | 值 |
|-|-|-|--------|
| response | _string_ | yes | `success` \ | `failed` |
| info | _string_ | yes | 监控项处理结果。 |
示例:
```json
{
"response": "success",
"info": "processed: 2; failed: 0; total: 2; seconds spent: 0.003534"
}
```
#### Agent items
Several **new** items have been added to Zabbix agent/agent 2:
- **agent.hostmetadata** - return host metadata
- **kernel.openfiles** - return the number of open file descriptors
- **net.tcp.socket.count\[\]** - return the number of TCP sockets that
match parameters
- **net.udp.socket.count\[\]** - return the number of UDP sockets that
match parameters
- **vfs.dir.get\[\]** - return list of directory files as JSON
- **vfs.file.get\[\]** - return information about a file as JSON
- **vfs.file.owner\[\]** - return the ownership of a file
- **vfs.file.permissions\[\]** - return a 4-digit string containing
octal number with Unix permissions
Additionally:
- **vfs.file.cksum\[\]** now supports a second `mode` parameter
(*crc32*, *md5*, *sha256*)
- **vfs.file.size\[\]** now supports a second `mode` parameter
(*bytes* or *lines*)
- **vfs.fs.discovery** and **vfs.fs.get** now return an {\#FSLABEL}
macro on Windows (with volume names)
For more details see [agent items](/manual/config/items/itemtypes/zabbix_agent).
#### Agent 监控项
多个**新**监控项已添加到Zabbix agent/agent 2:
- **agent.hostmetadata** - 返回 主机 元数据
- **kernel.openfiles** - 返回已打开的file描述符数量
- **net.tcp.socket.count\[\]** - 返回TCP套接字的数量
匹配参数
- **net.udp.socket.count\[\]** - 返回UDP套接字的数量
匹配参数
- **vfs.dir.get\[\]** - 以JSON格式返回目录文件列表
- **vfs.file.get\[\]** - 以JSON格式返回file的相关信息
- **vfs.file.owner\[\]** - 返回file的所有权信息
- **vfs.file.permissions\[\]** - 返回一个包含4位数字的string
octal number with Unix permissions
此外：
- **vfs.file.cksum\[\]** 现在支持第二个 `mode` 参数
(*crc32*, *md5*, *sha256*)
- **vfs.file.size[]** 现在支持第二个 `mode` 参数
(*字节* 或 *行*)
- **vfs.fs.discovery** 和 **vfs.fs.get** 现在会返回一个 {\#FSLABEL}
macro on Windows (with volume names)
更多详情请参阅[agent items](/manual/config/items/itemtypes/zabbix_agent)。
#### Agent on UNIX-like systems
Zabbix agent on UNIX-like systems is run on the host being monitored.
#### 类 UNIX 系统上的 Agent
类UNIX系统上的Zabbix agent是指被监控的主机上的run。
#### Agent on Windows systems
Zabbix agent on Windows runs as a Windows service.
#### Windows 系统上的 Agent
Zabbix agent 在Windows上作为Windows服务运行。
##### Agent operation with persistent file
On startup Zabbix agent knows nothing about persistent files. Only after
receiving a list of active checks from Zabbix server \(proxy\) the agent sees that some log
items should be backed by persistent files under specified directories.
During agent operation the persistent files are opened for writing (with
fopen(filename, "w")) and overwritten with the latest data. The chance of
losing persistent file data if the overwriting and file system mirror split
happen at the same time is very small, no special handling for it. Writing
into persistent file is NOT followed by enforced synchronization to storage
media \(fsync\(\) is not called\).
Overwriting with the latest data is done after successful reporting of matching
log file record or metadata \(processed log size and modification time\) to
Zabbix server. That may happen as often as every item check if log file keeps
changing.
No special actions during agent shutdown.
##### Agent 持久化文件操作
启动时 Zabbix agent 对持久化文件一无所知。只有在从 Zabbix server（proxy）接收到活动检查列表后，agent 才会发现某些日志 监控项 应由指定目录下的持久化文件支持。
在 agent 运行期间，持久化文件会以写入模式打开（使用 fopen(filename, "w")）并用最新数据覆盖。如果在覆盖操作和 file 系统镜像分裂同时发生，导致持久化 file 数据丢失的概率非常小，因此未做特殊处理。写入持久化 file 后不会强制同步到存储介质（未调用 fsync()）。
在成功向 Zabbix server 报告匹配的日志 file 记录或元数据（处理的日志大小和修改时间）后，会用最新数据覆盖。如果日志 file 持续变化，这种情况可能每 监控项 检查周期就会发生一次。
agent 关闭时不执行特殊操作。
##### Agent
|Requirement|Mandatory status|Description|
|--|-|-------|
|*libpcre/libpcre2*|One of|PCRE/PCRE2 library is required for [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) support.<br>The naming may differ depending on the GNU/Linux distribution, for example 'libpcre3' or 'libpcre1'. PCRE v8.x and PCRE2 v10.x (from Zabbix 6.0.0) are supported.<br>Required for log monitoring. Also required on Windows.|
|*libpthread*|Yes|Required for mutex and read-write lock support (could be part of libc). Not required on Windows.|
|*libresolv*|^|Required for DNS resolution (could be part of libc). Not required on Windows.|
|*libiconv*|^|Required for text encoding/format conversion to UTF-8 in log items, file content, file regex and regmatch items (could be part of libc). Not required on Windows.|
|*libgnutls* or *libopenssl*|No|Required if using [encryption](/manual/encryption#compiling_zabbix_with_encryption_support).<br>Minimum versions: *libgnutls* - 3.1.18, *libopenssl* - 1.0.1<br>On Microsoft Windows OpenSSL 1.1.1 or later is required.|
|*libldap*|^|Required if LDAP is used. Not supported on Windows.|
|*libcurl*|^|Required for `web.page.*` Zabbix agent [items](/manual/config/items/itemtypes/zabbix_agent). Not supported on Windows.<br>Version 7.28.0 or higher is recommended.|
|*libmodbus*|^|Only required if Modbus monitoring is used.<br>Version 3.0 or higher.|
::: noteclassic
Starting from version 5.0.3, Zabbix agent will not work on
AIX platforms below versions 6.1 TL07 / AIX 7.1 TL01.
:::
##### Agent
| 需求 | 强制状态 | 描述 |
|--|-|-------|
| *libpcre/libpcre2* | One of | PCRE/PCRE2库是[Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE)支持所必需的。<br>命名可能因GNU/Linux发行版而异，例如'libpcre3'或'libpcre1'。支持PCRE v8.x和PCRE2 v10.x（从Zabbix 6.0.0开始）。<br>日志监控需要。Windows平台同样需要。 |
| *libpthread* | Yes | 互斥锁和读写锁支持所需（可能是libc的一部分）。Windows平台不需要。 |
| *libresolv* | ^ | DNS解析所需（可能是libc的一部分）。Windows平台不需要。 |
| *libiconv* | ^ | 日志监控项、file内容、file正则表达式和regmatch 监控项中文本编码/格式转换为UTF-8所需（可能是libc的一部分）。Windows平台不需要。 |
| *libgnutls* 或 *libopenssl* | No | 使用[编译带加密支持的zabbix](/manual/encryption#编译带加密支持的zabbix)时必需。<br>最低版本：*libgnutls* - 3.1.18，*libopenssl* - 1.0.1<br>Microsoft Windows需要OpenSSL 1.1.1或更高版本。 |
| *libldap* | ^ | 使用LDAP时必需。Windows平台不支持。 |
| *libcurl* | ^ | `web.page.*` Zabbix agent [items](/manual/config/items/itemtypes/zabbix_agent)所需。Windows平台不支持。<br>建议版本7.28.0或更高。 |
| *libmodbus* | ^ | 仅在使用Modbus监控时需要。<br>版本3.0或更高。 |
::: noteclassic
从version 5.0.3开始，Zabbix agent将无法在
AIX平台版本低于6.1 TL07 / AIX 7.1 TL01的系统上运行。
:::
#### Agent upgrade process
::: noteimportant
Upgrading agents is not mandatory. You only need
to upgrade agents if it is required to access the new
functionality.
:::
The upgrade procedure described in this section may be used for
upgrading both the Zabbix agent and the Zabbix agent 2.
#### Agent升级过程
::: noteimportant
升级 agents 并非强制要求。只有当需要访问新功能时，才需要升级 agents。
:::
本节描述的升级流程既适用于升级 Zabbix agent 也适用于升级 Zabbix agent 2。
##### Agent
Zabbix agents are deployed on monitoring targets to actively monitor
local resources and applications and report the gathered data to Zabbix
server. Since Zabbix 4.4, there are two types of agents available: the
[Zabbix agent](/manual/concepts/agent) (lightweight, supported on many
platforms, written in C) and the [Zabbix agent 2](/manual/concepts/agent2)
(extra-flexible, easily extendable with plugins, written in Go).
##### Agent
Zabbix agents 被部署在监控目标上，用于主动监控本地资源和应用程序，并将收集到的数据报告给Zabbix服务器。自Zabbix 4.4起，有两种类型的agents可用：[Zabbix agent](/manual/concepts/agent)（轻量级，支持多种平台，使用C语言编写）和[Zabbix agent 2](/manual/concepts/agent2)（高度灵活，易于通过插件扩展，使用Go语言编写）。
#### Aggregate functions
|FUNCTION|<|<|<|
|--------|-|-|-|
|<|**Description**|**Function-specific parameters**|**Comments**|
|**avg** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Average value of an item within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Examples:<br>=> **avg**(/host/key,**1h**) → average value for the last hour until [now](/manual/config/triggers#evaluation_period)<br>=> **avg**(/host/key,**1h:now-1d**) → average value for an hour from 25 hours ago to 24 hours ago from [now](/manual/config/triggers#evaluation_period)<br>=> **avg**(/host/key,**\#5**) → average value of the five latest values<br>=> **avg**(/host/key,**\#5:now-1d**) → average value of the five latest values excluding the values received in the last 24 hours<br><br>Time shift is useful when there is a need to compare the current average value with the average value some time ago.|
|**bucket\_percentile** (item filter,time period,percentage)|<|<|<|
|<|Calculates the percentile from the buckets of a histogram.|**item filter** - see [item filter](/manual/appendix/functions/aggregate/foreach#item_filter)<br>**time period** - see [time period](/manual/appendix/functions/aggregate/foreach#time_period)<br>**percentage** - percentage (0-100)|Supported only in calculated items.<br><br>This function is an alias for `histogram_quantile(percentage/100, bucket_rate_foreach(item filter, time period, 1))`|
|**count** (func\_foreach(item filter,<time period>))|<|<|<|
|<|Count of values in an array returned by a foreach function.|**func\_foreach** - foreach function for which the number of returned values should be counted (with supported arguments). See [foreach functions](/manual/appendix/functions/aggregate/foreach) for details.|Supported value type: int<br><br>Example:<br>=> **count**(max\_foreach(/\*/net.if.in\[\*\],1h)) → number of net.if.in items that received data in the last hour until [now](/manual/config/triggers#evaluation_period)<br><br>Note that using **count()** with a history-related foreach function (max\_foreach, avg\_foreach, etc.) may lead to performance implications, whereas using **exists\_foreach()**, which works only with configuration data, will not have such effect.|
|**histogram\_quantile** (quantile,bucket1,value1,bucket2,value2,...)|<|<|<|
|<|Calculates the φ-quantile from the buckets of a histogram.|**quantile** - 0 ≤ φ ≤ 1<br>**bucketN, valueN** - manually entered pairs (>=2) of parameters or response of [bucket\_rate\_foreach](/manual/appendix/functions/aggregate/foreach)|Supported only in calculated items.<br><br>Functionally corresponds to '[histogram\_quantile](https://prometheus.io/docs/prometheus/latest/querying/functions/#histogram_quantile)' of PromQL.<br><br>Example:<br>=> **histogram\_quantile**(0.75,1.0,last(/host/rate\_bucket\[1.0\]),"+Inf",last(/host/rate\_bucket\[Inf\])<br>=> **histogram\_quantile**(0.5,bucket\_rate\_foreach(//item\_key,30s))|
|**item\_count** (item filter)|<|<|<|
|<|Count of existing items in configuration that match filter criteria.|**item filter** - criteria for item selection, allows referencing by host group, host, item key, and tags. Wildcards are supported. See [item filter](/manual/appendix/functions/aggregate/foreach#item_filter) for more details.|Supported value type: int<br><br>Works as an alias for the *count(exists\_foreach(item\_filter))* function.<br><br>Example:<br>=> **item\_count**(/\*/agent.ping?\[group="Host group 1"\]) → number of hosts with the *agent.ping* item in the "Host group 1"|
|**kurtosis** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|"Tailedness" of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Kurtosis](https://en.wikipedia.org/wiki/Kurtosis)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **kurtosis**(/host/key,**1h**) → kurtosis for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**mad** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Median absolute deviation in collected values within the defined evaluation period.<br><br>See also: [Median absolute deviation](https://en.wikipedia.org/wiki/Median_absolute_deviation)|See [common-parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **mad**(/host/key,**1h**) → median absolute deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**max** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Highest value of an item within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **max**(/host/key,**1h**) - **min**(/host/key,**1h**) → calculate the difference between the maximum and minimum values within the last hour until [now](/manual/config/triggers#evaluation_period) (delta of values)|
|**min** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Lowest value of an item within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **max**(/host/key,**1h**) - **min**(/host/key,**1h**) → calculate the difference between the maximum and minimum values within the last hour until [now](/manual/config/triggers#evaluation_period) (delta of values)|
|**skewness** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Asymmetry of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Skewness](https://en.wikipedia.org/wiki/Skewness)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **skewness**(/host/key,**1h**) → skewness for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**stddevpop** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Population standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **stddevpop**(/host/key,**1h**) → population standard deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**stddevsamp** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Sample standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>At least two data values are required for this function to work.<br><br>Example:<br>=> **stddevsamp**(/host/key,**1h**) → sample standard deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**sum** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Sum of collected values within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **sum**(/host/key,**1h**) → sum of values for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**sumofsquares** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|The sum of squares in collected values within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **sumofsquares**(/host/key,**1h**) → sum of squares for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**varpop** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Population variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Example:<br>=> **varpop**(/host/key,**1h**) → population variance for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**varsamp** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Sample variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>At least two data values are required for this function to work.<br><br>Example:<br>=> **varsamp**(/host/key,**1h**) → sample variance for the last hour until [now](/manual/config/triggers#evaluation_period)|
#### Aggregate functions
|FUNCTION|<|<|<|
|--------|-|-|-|
|<|**Description**|**Function-specific parameters**|**Comments**|
|**avg** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Average value of an item within the defined evaluation period.|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Examples:<br>=> **avg**(/host/key,**1h**) → average value for the last hour until [now](/manual/config/triggers#evaluation_period)<br>=> **avg**(/host/key,**1h:now-1d**) → average value for an hour from 25 hours ago to 24 hours ago from [now](/manual/config/triggers#evaluation_period)<br>=> **avg**(/host/key,**\#5**) → average value of the five latest values<br>=> **avg**(/host/key,**\#5:now-1d**) → average value of the five latest values excluding the values received in the last 24 hours<br><br>Time shift is useful when there is a need to compare the current average value with the average value some time ago.|
|**bucket\_percentile** (item filter,time period,percentage)|<|<|<|
|<|Calculates the percentile from the buckets of a histogram.|**item filter** - see [item filter](/manual/appendix/functions/aggregate/foreach#item_filter)<br>**time period** - see [time period](/manual/appendix/functions/aggregate/foreach#time_period)<br>**percentage** - percentage (0-100)|Supported only in calculated items.<br><br>This function is an alias for `histogram_quantile(percentage/100, bucket_rate_foreach(item filter, time period, 1))`|
|**count** (func\_foreach(item filter,<time period>))|<|<|<|
|<|Count of values in an array returned by a foreach function.|**func\_foreach** - foreach function for which the number of returned values should be counted (with supported arguments). See [foreach functions](/manual/appendix/functions/aggregate/foreach) for details.|Supported value type: int<br><br>Example:<br>=> **count**(max\_foreach(/\*/net.if.in\[\*\],1h)) → number of net.if.in items that received data in the last hour until [now](/manual/config/triggers#evaluation_period)<br><br>Note that using **count()** with a history-related foreach function (max\_foreach, avg\_foreach, etc.) may lead to performance implications, whereas using **exists\_foreach()**, which works only with configuration data, will not have such effect.|
|**histogram\_quantile** (quantile,bucket1,value1,bucket2,value2,...)|<|<|<|
|<|Calculates the φ-quantile from the buckets of a histogram.|**quantile** - 0 ≤ φ ≤ 1<br>**bucketN, valueN** - manually entered pairs (>=2) of parameters or response of [bucket\_rate\_foreach](/manual/appendix/functions/aggregate/foreach)|Supported only in calculated items.<br><br>Functionally corresponds to '[histogram\_quantile](https://prometheus.io/docs/prometheus/latest/querying/functions/#histogram_quantile)' of PromQL.<br><br>Example:<br>=> **histogram\_quantile**(0.75,1.0,last(/host/rate\_bucket\[1.0\]),"+Inf",last(/host/rate\_bucket\[Inf\])<br>=> **histogram\_quantile**(0.5,bucket\_rate\_foreach(//item\_key,30s))|
|**item\_count** (item filter)|<|<|<|
|<|Count of existing items in configuration that match filter criteria.|**item filter** - criteria for item selection, allows referencing by host group, host, item key, and tags. Wildcards are supported. See [item filter](/manual/appendix/functions/aggregate/foreach#item_filter) for more details.|Supported value type: int<br><br>Works as an alias for the *count(exists\_foreach(item\_filter))* function.<br><br>Example:<br>=> **item\_count**(/\*/agent.ping?\[group="Host group 1"\]) → number of hosts with the *agent.ping* item in the "Host group 1"|
|**kurtosis** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|"Tailedness" of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Kurtosis](https://en.wikipedia.org/wiki/Kurtosis)|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **kurtosis**(/host/key,**1h**) → kurtosis for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**mad** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Median absolute deviation in collected values within the defined evaluation period.<br><br>See also: [Median absolute deviation](https://en.wikipedia.org/wiki/Median_absolute_deviation)|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **mad**(/host/key,**1h**) → median absolute deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**max** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Highest value of an item within the defined evaluation period.|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **max**(/host/key,**1h**) - **min**(/host/key,**1h**) → calculate the difference between the maximum and minimum values within the last hour until [now](/manual/config/triggers#evaluation_period) (delta of values)|
|**min** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Lowest value of an item within the defined evaluation period.|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **max**(/host/key,**1h**) - **min**(/host/key,**1h**) → calculate the difference between the maximum and minimum values within the last hour until [now](/manual/config/triggers#evaluation_period) (delta of values)|
|**skewness** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Asymmetry of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Skewness](https://en.wikipedia.org/wiki/Skewness)|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **skewness**(/host/key,**1h**) → skewness for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**stddevpop** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Population standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation)|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **stddevpop**(/host/key,**1h**) → population standard deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**stddevsamp** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Sample standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation)|See [common parameters](#common parameters).|Supported value types: float, int<br><br>At least two data values are required for this function to work.<br><br>Example:<br>=> **stddevsamp**(/host/key,**1h**) → sample standard deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**sum** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Sum of collected values within the defined evaluation period.|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **sum**(/host/key,**1h**) → sum of values for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**sumofsquares** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|The sum of squares in collected values within the defined evaluation period.|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **sumofsquares**(/host/key,**1h**) → sum of squares for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**varpop** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Population variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance)|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Example:<br>=> **varpop**(/host/key,**1h**) → population variance for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**varsamp** (/host/key,(sec\|\#num)<:time shift>)|<|<|<|
|<|Sample variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance)|See [common parameters](#common parameters).|Supported value types: float, int<br><br>At least two data values are required for this function to work.<br><br>Example:<br>=> **varsamp**(/host/key,**1h**) → sample variance for the last hour until [now](/manual/config/triggers#evaluation_period)|
#### Aggregate functions
|FUNCTION|<|<|
|--|--|--|
|**Description**|**Function-specific parameters**|**Comments**|
|**avg** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Average value of an item within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>Examples:<br>=> **avg**(/host/key,**1h**) → average value for the last hour until [now](/manual/config/triggers#evaluation_period)<br>=> **avg**(/host/key,**1h:now-1d**) → average value for an hour from 25 hours ago to 24 hours ago from [now](/manual/config/triggers#evaluation_period)<br>=> **avg**(/host/key,**\#5**) → average value of the five latest values<br>=> **avg**(/host/key,**\#5:now-1d**) → average value of the five latest values excluding the values received in the last 24 hours<br><br>Time shift is useful when there is a need to compare the current average value with the average value some time ago.|
|**bucket\_percentile** (item filter,time period,percentage)|<|<|
|Calculates the percentile from the buckets of a histogram.|**item filter** - see [item filter](/manual/appendix/functions/aggregate/foreach#item_filter_syntax)<br>**time period** - see [time period](/manual/appendix/functions/aggregate/foreach#time_period)<br>**percentage** - percentage (0-100)|Supported only in calculated items.<br><br>This function is an alias for `histogram_quantile(percentage/100, bucket_rate_foreach(item filter, time period, 1))`|
|**count** (func\_foreach(item filter,<time period>))|<|<|
|Count of values in an array returned by a foreach function.|**func\_foreach** - foreach function for which the number of returned values should be counted (with supported arguments). See [foreach functions](/manual/appendix/functions/aggregate/foreach) for details.|Supported value type: int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>Example:<br>=> **count**(max\_foreach(/\*/net.if.in\[\*\],1h)) → number of net.if.in items that received data in the last hour until [now](/manual/config/triggers#evaluation_period)<br><br>Note that using **count()** with a history-related foreach function (max\_foreach, avg\_foreach, etc.) may lead to performance implications, whereas using **exists\_foreach()**, which works only with configuration data, will not have such effect.|
|**histogram\_quantile** (quantile,bucket1,value1,bucket2,value2,...)|<|<|
|Calculates the φ-quantile from the buckets of a histogram.|**quantile** - 0 ≤ φ ≤ 1<br>**bucketN, valueN** - manually entered pairs (>=2) of parameters or response of [bucket\_rate\_foreach](/manual/appendix/functions/aggregate/foreach)|Supported only in calculated items.<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): bucket_rate_foreach<br><br>Functionally corresponds to '[histogram\_quantile](https://prometheus.io/docs/prometheus/latest/querying/functions/#histogram_quantile)' of PromQL.<br><br> Returns -1 if values of the last 'Infinity' bucket (*"+inf"*) are equal to 0. <br><br>Examples:<br>=> **histogram\_quantile**(0.75,1.0,last(/host/rate\_bucket\[1.0\]),"+Inf",last(/host/rate\_bucket\[Inf\])<br>=> **histogram\_quantile**(0.5,bucket\_rate\_foreach(//item\_key,30s))|
|**item\_count** (item filter)|<|<|
|Count of existing items in configuration that match filter criteria.|**item filter** - criteria for item selection, allows referencing by host group, host, item key, and tags. Wildcards are supported. See [item filter](/manual/appendix/functions/aggregate/foreach#item_filter_syntax) for more details.|Supported only in calculated items.<br><br>Supported value type: int<br><br>Works as an alias for the *count(exists\_foreach(item\_filter))* function.<br><br>Example:<br>=> **item\_count**(/\*/agent.ping?\[group="Host group 1"\]) → number of hosts with the *agent.ping* item in the "Host group 1"|
|**kurtosis** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|"Tailedness" of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Kurtosis](https://en.wikipedia.org/wiki/Kurtosis)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>Example:<br>=> **kurtosis**(/host/key,**1h**) → kurtosis for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**mad** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Median absolute deviation in collected values within the defined evaluation period.<br><br>See also: [Median absolute deviation](https://en.wikipedia.org/wiki/Median_absolute_deviation)|See [common-parameters](#common parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>Example:<br>=> **mad**(/host/key,**1h**) → median absolute deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**max** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Highest value of an item within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>Example:<br>=> **max**(/host/key,**1h**) - **min**(/host/key,**1h**) → calculate the difference between the maximum and minimum values within the last hour until [now](/manual/config/triggers#evaluation_period) (delta of values)|
|**min** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Lowest value of an item within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>Example:<br>=> **max**(/host/key,**1h**) - **min**(/host/key,**1h**) → calculate the difference between the maximum and minimum values within the last hour until [now](/manual/config/triggers#evaluation_period) (delta of values)|
|**skewness** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Asymmetry of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Skewness](https://en.wikipedia.org/wiki/Skewness)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>Example:<br>=> **skewness**(/host/key,**1h**) → skewness for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**stddevpop** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Population standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>Example:<br>=> **stddevpop**(/host/key,**1h**) → population standard deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**stddevsamp** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Sample standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>At least two data values are required for this function to work.<br><br>Example:<br>=> **stddevsamp**(/host/key,**1h**) → sample standard deviation for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**sum** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Sum of collected values within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>Example:<br>=> **sum**(/host/key,**1h**) → sum of values for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**sumofsquares** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|The sum of squares in collected values within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>Example:<br>=> **sumofsquares**(/host/key,**1h**) → sum of squares for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**varpop** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Population variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>Example:<br>=> **varpop**(/host/key,**1h**) → population variance for the last hour until [now](/manual/config/triggers#evaluation_period)|
|**varsamp** (/host/key,(sec\|\#num)<:time shift>)|<|<|
|Sample variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance)|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Supported [foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>At least two data values are required for this function to work.<br><br>Example:<br>=> **varsamp**(/host/key,**1h**) → sample variance for the last hour until [now](/manual/config/triggers#evaluation_period)|
#### 聚合函数
| 函数 | < | < |
|--|--|--|
| **Description** | **函数特定参数** | **注释** |
| **avg** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Average value of an item within the defined evaluation period. | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>示例:<br>=> **avg**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的平均值<br>=> **avg**(/主机/key,**1h:now-1d**) → 从[评估周期](/manual/config/triggers#评估周期)起25小时前至24小时前一小时内的平均值<br>=> **avg**(/主机/key,**\#5**) → 最近五个值的平均值<br>=> **avg**(/主机/key,**\#5:now-1d**) → 排除过去24小时内接收值的最近五个值的平均值<br><br>当需要将当前平均值与之前某时间段的平均值进行比较时，时间偏移非常有用。 |
| **bucket\_percentile** (item filter,time period,percentage) | < | < |
| Calculates the percentile from the buckets of a histogram. | **监控项过滤器** - 参见[监控项-过滤器语法](/manual/appendix/functions/aggregate/foreach#监控项-过滤器语法)<br>**时间段** - 参见[时间段](/manual/appendix/functions/aggregate/foreach#时间段)<br>**百分比** - 百分比(0-100) | 仅支持在计算型监控项中使用。<br><br>此函数是`histogram_quantile(percentage/100, bucket_rate_foreach(item filter, time period, 1))`的alias |
| **count** (func\_foreach(item filter,<time period>)) | < | < |
| Count of values in an array returned by a foreach function. | **func\_foreach** - 需要统计返回值数量的foreach函数(带支持的参数)。详情参见[foreach functions](/manual/appendix/functions/aggregate/foreach)。 | 支持的值类型: int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>示例:<br>=> **count**(max\_foreach(/\*/net.if.in\[\*\],1h)) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时内接收数据的net.if.in 监控项数量<br><br>注意：将**count()**与历史相关的foreach函数(max\_foreach, avg\_foreach等)一起使用可能会影响性能，而使用仅处理配置数据的**exists\_foreach()**则不会有此影响。 |
| **histogram\_quantile** (quantile,bucket1,value1,bucket2,value2,...) | < | < |
| Calculates the φ-quantile from the buckets of a histogram. | **quantile** - 0 ≤ φ ≤ 1<br>**bucketN, valueN** - 手动输入的参数对(>=2)或[bucket\_rate\_foreach](/manual/appendix/functions/aggregate/foreach)的响应 | 仅支持在计算型监控项中使用。<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): bucket_rate_foreach<br><br>功能上对应PromQL的'[histogram\_quantile](https://prometheus.io/docs/prometheus/latest/querying/functions/#histogram_quantile)'。<br><br>如果最后一个'Infinity'桶(*"+inf"*)的值为0，则返回-1。<br><br>示例:<br>=> **histogram\_quantile**(0.75,1.0,last(/主机/rate\_bucket\[1.0\]),"+Inf",last(/主机/rate\_bucket\[Inf\])<br>=> **histogram\_quantile**(0.5,bucket\_rate\_foreach(//监控项\_key,30s)) |
| **item\_count** (item filter) | < | < |
| Count of existing items in configuration that match filter criteria. | **监控项过滤器** - 监控项选择条件，允许通过主机组、主机、监控项键和标签引用。支持通配符。详情参见[监控项-过滤器语法](/manual/appendix/functions/aggregate/foreach#监控项-过滤器语法)。 | 仅支持在计算型监控项中使用。<br><br>支持的值类型: int<br><br>作为*count(exists\_foreach(监控项\_filter))*函数的alias。<br><br>示例:<br>=> **监控项\_count**(/\*/agent.ping?\[group="主机组 1"\]) → 在"主机组 1"中具有*agent.ping* 监控项的主机数量 |
| **kurtosis** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| "Tailedness" of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Kurtosis](https://en.wikipedia.org/wiki/Kurtosis) | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>示例:<br>=> **kurtosis**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的峰度 |
| **mad** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Median absolute deviation in collected values within the defined evaluation period.<br><br>See also: [Median absolute deviation](https://en.wikipedia.org/wiki/Median_absolute_deviation) | 参见[通用参数](#common parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>示例:<br>=> **mad**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的中位数绝对偏差 |
| **max** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Highest value of an item within the defined evaluation period. | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>示例:<br>=> **max**(/主机/key,**1h**) - **min**(/主机/key,**1h**) → 计算从[评估周期](/manual/config/triggers#评估周期)起过去一小时内的最大值与最小值之差(值差) |
| **min** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Lowest value of an item within the defined evaluation period. | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>示例:<br>=> **max**(/主机/key,**1h**) - **min**(/主机/key,**1h**) → 计算从[评估周期](/manual/config/triggers#评估周期)起过去一小时内的最大值与最小值之差(值差) |
| **skewness** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Asymmetry of the probability distribution in collected values within the defined evaluation period.<br><br>See also: [Skewness](https://en.wikipedia.org/wiki/Skewness) | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>示例:<br>=> **skewness**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的偏度 |
| **stddevpop** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Population standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>示例:<br>=> **stddevpop**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的总体标准差 |
| **stddevsamp** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Sample standard deviation in collected values within the defined evaluation period.<br><br>See also: [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>此函数至少需要两个数据值才能工作。<br><br>示例:<br>=> **stddevsamp**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的样本标准差 |
| **sum** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Sum of collected values within the defined evaluation period. | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): avg_foreach, count_foreach, exists_foreach, last_foreach, max_foreach, min_foreach, sum_foreach<br><br>示例:<br>=> **sum**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的值总和 |
| **sumofsquares** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| The sum of squares in collected values within the defined evaluation period. | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>示例:<br>=> **sumofsquares**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的平方和 |
| **varpop** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Population variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance) | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>示例:<br>=> **varpop**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的总体方差 |
| **varsamp** (/host/key,(sec\ | \#num)<:时间偏移>) | < | < |
| Sample variance of collected values within the defined evaluation period.<br><br>See also: [Variance](https://en.wikipedia.org/wiki/Variance) | 参见[通用参数](#common-parameters). | 支持的值类型: float, int<br><br>支持的[foreach functions](/manual/appendix/functions/aggregate/foreach): last_foreach<br><br>此函数至少需要两个数据值才能工作。<br><br>示例:<br>=> **varsamp**(/主机/key,**1h**) → 从[评估周期](/manual/config/triggers#评估周期)起过去一小时的样本方差 |
### Aggregate functions
The **count_foreach** function now returns '0' for a matching item in the array, if no data are present for the item or the data do not match the filter.
Previously such items would be ignored (no data added to the aggregation).
### 聚合函数
**count_foreach** 函数现在会为监控项在array中的匹配项返回'0'，如果该监控项没有数据或数据不符合筛选条件。
此前这类监控项会被忽略（不会添加到聚合数据中）。
### Aggregate functions
The **count_foreach** function now returns '0' for a matching item in the array, if no data are present for the item or the data do not match the filter. Previously such items would be ignored (no data added to the aggregation).
### 聚合函数
**count_foreach** 函数现在对于监控项在array中的匹配项，如果该监控项没有数据或数据不符合筛选条件，将返回'0'。此前这类监控项会被忽略（不会将数据添加到聚合中）。
#### Aggregate functions
The **last_foreach** function is now also supported in the following [aggregate functions](/manual/appendix/functions/aggregate):
kurtosis, mad, skewness, stddevpop, stddevsamp, sumofsquares, varpop, and varsamp.
#### 聚合函数
**last_foreach** 函数现已支持以下[aggregate functions](/manual/appendix/functions/aggregate)：
峰度、平均绝对偏差、偏度、总体标准差、样本标准差、平方和、总体方差和样本方差。
##### AIX, HP-UX
If `watch` command is not available, one can try
while [ 1 ]; do ps -fu zabbix; sleep 1; clear; done
##### AIX, HP-UX
如果`watch` 命令不可用，可以尝试
while [ 1 ]; do ps -fu zabbix; sleep 1; clear; done
#### AIX
See values supported for 'memtype' parameter on AIX in the table.
|Supported value|Description|Source in procentry64 structure|Tries to be compatible with|
|--|------|--|--|
|vsize ^[1](proc_mem_notes#footnotes)^|Virtual memory size|pi\_size| |
|pmem|Percentage of real memory|pi\_prm|ps -o pmem|
|rss|Resident set size|pi\_trss + pi\_drss|ps -o rssize|
|size|Size of process (code + data)|pi\_dvm|"ps gvw" SIZE column|
|dsize|Data size|pi\_dsize|<|
|tsize|Text (code) size|pi\_tsize|"ps gvw" TSIZ column|
|sdsize|Data size from shared library|pi\_sdsize|<|
|drss|Data resident set size|pi\_drss| |
|trss|Text resident set size|pi\_trss| |
#### AIX
查看AIX系统中'memtype'参数支持的值如下表所示.
| 支持的值 | 描述 | 在procentry64结构中的来源 | 尝试兼容的对象 |
|--|------|--|--|
| vsize ^[1](proc_mem_notes#脚注)^ | 虚拟memory大小 | pi\_size | |
| pmem | 实际memory的百分比 | pi\_prm | ps -o pmem |
| rss | 驻留集大小 | pi\_trss + pi\_drss | ps -o rssize |
| size | 进程大小(代码+数据) | pi\_dvm | "ps gvw" SIZE列 |
| dsize | 数据大小 | pi\_dsize | < |
| tsize | 文本(代码)大小 | pi\_tsize | "ps gvw" TSIZ列 |
| sdsize | 共享库的数据大小 | pi\_sdsize | < |
| drss | 数据驻留集大小 | pi\_drss | |
| trss | 文本驻留集大小 | pi\_trss | |
#### Alerter process crash in RHEL 7
Instances of a Zabbix server alerter process crash have been encountered
in RHEL 7. Please see
[ZBX-10461](https://support.zabbix.com/browse/ZBX-10461) for details.
#### RHEL 7中的Alerter进程崩溃
在RHEL 7系统中已发现多起Zabbix server告警进程崩溃实例
详情请参阅
[ZBX-10461](https://support.zabbix.com/browse/ZBX-10461)
# alert.get
# alert.get
##### Alerting on service status change
It is now possible to receive automated alerts about service status
changes, similar to the alerts about trigger status changes.
A new [service action](/manual/config/notifications/action) type has
been added to the *Actions* menu. Service actions may include steps for
problem, recovery, and update operations related to services. It is
possible to configure two types of actions: sending a message to the
specified recipients and executing a remote command on Zabbix server.
Similarly to trigger actions, service actions support problem
[escalation](/manual/config/notifications/action/escalations) scenarios.
New message templates *Service*, *Service recovery*, and *Service
update* have been added to [media
types](/manual/config/notifications/media#common_parameters) and should
be defined to enable correct sending of notifications for service
actions.
#### Alerting on service status change
It is now possible to receive automated alerts about service status
changes, similar to the alerts about trigger status changes.
A new [service action](/manual/config/notifications/action) type has
been added to the *Actions* menu. Service actions may include steps for
problem, recovery, and update operations related to services. It is
possible to configure two types of actions: sending a message to the
specified recipients and executing a remote command on Zabbix server.
Similarly to trigger actions, service actions support problem
[escalation](/manual/config/notifications/action/escalations) scenarios.
New message templates *Service*, *Service recovery*, and *Service
update* have been added to [media
types](/manual/config/notifications/media#common_parameters) and should
be defined to enable correct sending of notifications for service
actions.
**Alerting on service status change**
It is now possible to receive automated alerts about service status changes, similar to the alerts about trigger status
changes.
A new [service action](/manual/it_services/service_actions) functionality has been added, similar to other actions in
Zabbix. Service actions may include steps for problem, recovery, and update operations related to services. It is
possible to configure two types of actions: sending a message to the specified recipients and executing a remote command
on Zabbix server. Similarly to trigger actions, service actions support problem
[escalation](/manual/config/notifications/action/escalations) scenarios.
New message templates *Service*, *Service recovery*, and *Service update* have been added to [media
types](/manual/config/notifications/media#common_parameters) and should be defined to enable correct sending of
notifications for service actions.
**服务状态变更告警**
现在可以接收关于服务状态变更的自动化告警，类似于触发器状态变更的告警。
新增了[service action](/manual/it_services/service_actions)功能，与Zabbix中的其他操作类似。服务操作可包含与服务相关的问题、恢复及update操作步骤。可配置两种类型的操作：向指定接收者发送消息以及在Zabbix server上执行远程命令。与触发器操作类似，服务操作支持问题[escalation](/manual/config/notifications/action/escalations)场景。
新的消息模板*服务*、*服务恢复*和*服务update*已添加到[通用参数](/manual/config/notifications/media#通用参数)中，需定义这些模板以确保正确发送服务操作的通知。
### Alert
::: noteclassic
Alerts are created by the Zabbix server and cannot be
modified via the API.
:::
The alert object contains information about whether certain action
operations have been executed successfully. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|alertid|string|ID of the alert.|
|actionid|string|ID of the action that generated the alert.|
|alerttype|integer|Alert type.<br><br>Possible values:<br>0 - message;<br>1 - remote command.|
|clock|timestamp|Time when the alert was generated.|
|error|string|Error text if there are problems sending a message or running a command.|
|esc\_step|integer|Action escalation step during which the alert was generated.|
|eventid|string|ID of the event that triggered the action.|
|mediatypeid|string|ID of the media type that was used to send the message.|
|message|text|Message text. Used for message alerts.|
|retries|integer|Number of times Zabbix tried to send the message.|
|sendto|string|Address, user name or other identifier of the recipient. Used for message alerts.|
|status|integer|Status indicating whether the action operation has been executed successfully.<br><br>Possible values for message alerts:<br>0 - message not sent.<br>1 - message sent.<br>2 - failed after a number of retries.<br>3 - new alert is not yet processed by alert manager.<br><br>Possible values for command alerts:<br>0 - command not run.<br>1 - command run.<br>2 - tried to run the command on the Zabbix agent but it was unavailable.|
|subject|string|Message subject. Used for message alerts.|
|userid|string|ID of the user that the message was sent to.|
|p\_eventid|string|ID of problem event, which generated the alert.|
|acknowledgeid|string|ID of acknowledgment, which generated the alert.|
### 告警
::: noteclassic
告警由Zabbix server创建且无法通过API修改。
:::
告警object包含特定操作是否成功执行的信息。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| alertid | string | 告警ID |
| actionid | string | 生成该告警的动作ID |
| alerttype | integer | 告警类型<br><br>可能值:<br>0 - 消息;<br>1 - 远程命令 |
| clock | timestamp | 告警生成时间 |
| error | string | 发送消息或执行命令出现错误时的错误文本 |
| esc\_step | integer | 生成告警时的动作升级步骤 |
| eventid | string | 触发动作的事件ID |
| mediatypeid | string | 用于发送消息的媒介类型ID |
| message | text | 消息文本(用于消息告警) |
| retries | integer | Zabbix尝试发送消息的次数 |
| sendto | string | 收件人地址、用户名或其他标识符(用于消息告警) |
| status | integer | 指示操作是否成功执行的状态<br><br>消息告警的可能值:<br>0 - 消息未发送<br>1 - 消息已发送<br>2 - 多次重试后失败<br>3 - 新告警尚未被告警管理器处理<br><br>命令告警的可能值:<br>0 - 命令未run<br>1 - 命令已run<br>2 - 尝试在Zabbix agent上run命令但代理不可用 |
| subject | string | 消息主题(用于消息告警) |
| userid | string | 接收消息的用户ID |
| p\_eventid | string | 生成告警的问题事件ID |
| acknowledgeid | string | 生成告警的确认ID |
##### Aligning time zones for proxies and agent 2
Note that Zabbix proxies and agent 2 use their local time zones when processing scheduling intervals.
For this reason, when scheduling intervals are applied to items monitored by Zabbix proxy or agent 2 active items, it is recommended to set the time zone of the respective proxies or agent 2 the same as Zabbix server, otherwise the [queue](/manual/config/items/queue) may report item delays incorrectly.
Custom intervals for active checks are supported by Zabbix agent 2 only. Ensure you are using Zabbix agent 2 if you intend to configure custom intervals for active checks.
The time zone for Zabbix proxy or agent 2 can be set using the environment variable `TZ` in the `systemd` unit file:
[Service]
...
Environment="TZ=Europe/Amsterdam"
##### 为 proxies 和 agent 2 对齐时区
请注意，Zabbix proxies和agent 2在处理调度间隔时使用其本地时区。
因此，当对由Zabbix proxy或agent 2监控的监控项应用调度间隔时，对于2个活跃的监控项，建议将相应proxies或agent 2的时区设置为与Zabbix server相同，否则[queue](/manual/config/items/queue)可能会错误地报告监控项延迟。
仅Zabbix agent 2支持主动检查的自定义间隔。如需配置主动检查的自定义间隔，请确保您使用的是Zabbix agent 2。
Zabbix proxy或agent 2的时区可以通过在`systemd`单元file中设置环境变量`TZ`来配置:
[服务]
...
Environment="TZ=Europe/Amsterdam"
环境变量="时区=欧洲/阿姆斯特丹"
All of these parameters can be changed in *Administration* → *General* →
*Housekeeping* after the installation.
::: notetip
You may want to run the timescaledb-tune tool provided
by TimescaleDB to optimize PostgreSQL configuration parameters in your
`postgresql.conf`.
:::
所有参数均可在安装后通过*管理*→*常规*→*数据清理*界面进行修改
::: notetip
建议使用TimescaleDB提供的run工具来优化`postgresql.conf`中的PostgreSQL配置参数
:::
##### Allow specific check, deny others
- Whitelist specific checks with AllowKey parameters, deny others with
`DenyKey=*`
For example:
# Allow reading logs:
AllowKey=vfs.file.*[/var/log/*]
# Allow localtime checks
AllowKey=system.localtime[*]
# Deny all other keys
DenyKey=*
##### 允许特定检查，拒绝其他
- 使用AllowKey参数白名单特定检查项，并通过
`DenyKey=*`
拒绝其他所有项
`DenyKey=*`
例如：
# Allow reading logs:
AllowKey=vfs.file.*[/var/log/*]
# 允许localtime检查
AllowKey=system.localtime[*]
# 拒绝所有其他键值
DenyKey=*
### AND/OR evaluation in LLD filters
The evaluation of AND/OR expressions in the low-level discovery filters/overrides may fail in this version. Fixed in Zabbix 6.0.12.
### LLD 过滤器中的 AND/OR 逻辑运算
在此version中，低级发现过滤器/覆盖中的AND/OR表达式评估可能会失败。该问题已在Zabbix 6.0.12中修复。
A new [template](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/gcp) *Google Cloud Platform by HTTP (GCP by HTTP)* is available.
See setup instructions for [HTTP templates](/manual/config/templates_out_of_the_box/http).
The template *Azure by HTTP* now also works with Azure Cosmos DB for MongoDB.
新的[template](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/gcp) *Google Cloud Platform by HTTP (GCP by HTTP)* 模板现已可用.
查看[HTTP templates](/manual/config/templates_out_of_the_box/http)的设置说明.
模板 *Azure by HTTP* 现在也支持 Azure Cosmos DB for MongoDB.
#### Anomaly detection
Zabbix 5.2 introduced new trend functions useful for baseline monitoring. However, they still require defining relative
thresholds (e.g. check that web traffic in September, 2021 is less than 2x higher compared to September, 2020). There
are use cases when such thresholds are hard to define. For instance, the web traffic of a new but highly popular web
site can organically grow many times over a year but the growth rate is unknown. Yet, a sudden traffic spike due to DDOS
attack must generate an alert regardless of organic traffic growth.
Anomaly detection algorithms do exactly this - find data that doesn't look normal (outliers) in a context of other
values.
New [trend function](/manual/appendix/functions/trends) **trendstl()** has been added which uses 'decomposition' method
to calculate the anomaly rate. It splits a single time series sequence into three other sequences:
- trend sequence that only contains big changes in the original data (e.g. website traffic shows growth)
- season sequence that only contains seasonal changes (e.g. less website traffic in summer, more in autumn)
- remainder sequence that only contains residual values that can not be interpreted as parts of trend or season
Anomaly detection works with remainder sequence and checks if there are values that are too far from the majority of
remainder values. "Far" means that the absolute value from the remainder sequence is N times greater than the standard
or mean deviation.
#### 异常检测
Zabbix 5.2引入了适用于基线监控的新趋势函数。然而这些函数仍需定义相对阈值（例如检查2021年9月的网络流量是否比2020年9月高出不到2倍）。在某些使用场景中此类阈值难以界定。例如一个新上线但极受欢迎的网站在一年内的自然流量可能增长数倍但增长率未知。然而无论自然流量如何增长由DDOS攻击导致的突发流量激增都必须generate触发告警。
异常检测算法正是为此而生——在其他数值的上下文中找出看起来不正常的数据（异常值）。
新增的[trend function](/manual/appendix/functions/trends) **trendstl()** 函数采用"分解"方法来计算异常率。它将单个时间序列分解为三个子序列：
- 仅包含原始数据重大变化的趋势序列（如网站流量增长）
- 仅包含季节性变化的周期序列（如夏季网站流量减少秋季增多）
- 仅包含无法归类为趋势或周期成分的残差序列
异常检测作用于残差序列检查是否存在偏离大多数残差值过远的数值。"过远"意味着残差序列中的绝对值超过标准偏差或平均偏差的N倍。
##### Another example with an inline regex modifier
Use of the following regular expression including multiple inline
modifiers to match the characters after a specific line:
(?<=match (?i)everything(?-i) after this line\n)(?sx).*# we add s modifier to allow . match newline characters
Chosen Expression type: "Result is TRUE". Characters after a specific
line are matched.
::: noteimportant
**g** modifier can't be specified in line. The
list of available modifiers can be found in [pcresyntax man
page](https://www.pcre.org/original/doc/html/pcresyntax.html#SEC16). For
more information about PCRE syntax please refer to [PCRE HTML
documentation](https://www.pcre.org/original/doc/html/pcrepattern.html).
:::
##### 另一个使用内联正则修饰符的示例
使用包含多个行内修饰符的以下正则表达式来匹配特定行之后的字符：
(?<=match (?i)everything(?-i) after this line\n)(?sx).*# we add s modifier to allow . match newline characters
选择的表达式类型："结果为TRUE"。匹配特定行之后的字符。
::: noteimportant
**g** 修饰符不能在行内指定。可用的修饰符列表可在[pcresyntax man
page](https://www.pcre.org/original/doc/html/pcresyntax.html#SEC16)中找到。有关PCRE语法的更多信息，请参阅[PCRE HTML
documentation](https://www.pcre.org/original/doc/html/pcrepattern.html)。
:::
##### API changes
See the list of [API changes](/manual/api/changes_5.4_-_6.0) in Zabbix
6.0.0.
##### API 变更
查看Zabbix 6.0.0中的[API changes](/manual/api/changes_5.4_-_6.0)列表
### API information
Retrieve the version of the Zabbix API so that your application could
use version-specific features.
[API info API](/manual/api/reference/apiinfo)
### API 信息
获取Zabbix API的version功能，以便您的应用程序能够
使用version特有的特性。
[API info API](/manual/api/reference/apiinfo)
# apiinfo.version
# apiinfo.version
#### API login
A large number of open user sessions can be created when using custom
scripts with the `user.login` [method](/manual/api/reference/user/login)
without a following `user.logout`.
#### API 登录
当使用带有`user.login` [method](/manual/api/reference/user/login)的自定义脚本时，
如果没有后续的`user.logout`操作，
可能会创建大量开放的用户会话。
#### API Tokens
Manage authorization tokens.
[Token API](/manual/api/reference/token)
#### Tokens
管理授权令牌.
[Token API](/manual/api/reference/token)
### API versions
To simplify API versioning, since Zabbix 2.0.4, the version of the API
matches the version of Zabbix itself. You can use the
[apiinfo.version](/manual/api/reference/apiinfo/version) method to find
out the version of the API you're working with. This can be useful for
adjusting your application to use version-specific features.
We guarantee feature backward compatibility inside of a major version.
When making backward incompatible changes between major releases, we
usually leave the old features as deprecated in the next release, and
only remove them in the release after that. Occasionally, we may remove
features between major releases without providing any backward
compatibility. It is important that you never rely on any deprecated
features and migrate to newer alternatives as soon as possible.
::: notetip
You can follow all of the changes made to the API in the
[API changelog](/manual/api/changes_5.4_-_6.0).
:::
### API 版本
为简化API版本管理，自Zabbix 2.0.4起，API的version
与Zabbix自身的version保持一致。您可通过
[apiinfo.version](/manual/api/reference/apiinfo/version)方法查询
当前使用的API的version。这有助于调整应用程序以使用
version专属功能。
我们保证在主版本version内的功能向后兼容性。当主版本间存在
不兼容变更时，通常会在下一版本中将旧功能标记为弃用，并在
后续版本中移除。极少数情况下，我们可能不提供兼容层就直接
移除主版本间的功能。请务必避免依赖任何弃用功能，并尽快
迁移至新方案。
::: notetip
您可通过[API changelog](/manual/api/changes_5.4_-_6.0)跟踪
API的所有变更记录。
:::
# Appendix 1. Reference commentary
# 附录 1. 参考注释
# Appendix 2. Changes from 5.4 to 6.0
# 附录 2. 从 5.4 到 6.0 的变更
#### Architecture
Zabbix consists of several major software components. Their
responsibilities are outlined below.
#### 架构
Zabbix由多个主要软件组件构成。各组件职责概述如下。
#### A real life scenario
In this example, we would like to set up network discovery for the local
network having an IP range of 192.168.1.1-192.168.1.254.
In our scenario we want to:
- discover those hosts that have Zabbix agent running
- run discovery every 10 minutes
- add a host to monitoring if the host uptime is more than 1 hour
- remove hosts if the host downtime is more than 24 hours
- add Linux hosts to the "Linux servers" group
- add Windows hosts to the "Windows servers" group
- use the template *Linux* for Linux hosts
- use the template *Windows* for Windows hosts
#### 实际应用场景
在此示例中，我们希望为IP范围为192.168.1.1-192.168.1.254的本地网络设置网络发现。
在我们的场景中，我们希望：
- 发现那些运行着Zabbix agent的主机
- 每10分钟run一次发现
- 如果主机运行时间超过1小时，则将一个主机添加到监控中
- 如果主机停机时间超过24小时，则移除主机
- 将Linux 主机添加到"Linux servers"组
- 将Windows 主机添加到"Windows servers"组
- 对Linux 主机使用*Linux*模板
- 对Windows 主机使用*Windows*模板
##### AS/400
IBM AS/400 platform can be monitored using SNMP. More information is
available at
<http://publib-b.boulder.ibm.com/Redbooks.nsf/RedbookAbstracts/sg244504.html?Open>.
##### AS/400
IBM AS/400 平台可以使用 SNMP 进行监控。如需更多信息，请访问
<http://publib-b.boulder.ibm.com/Redbooks.nsf/RedbookAbstracts/sg244504.html?Open>。
#### Assigning different hosts
Replace the hosts currently assigned to maintenance "3" with two
different ones.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "maintenance.update",
"params": {
"maintenanceid": "3",
"hostids": [
"10085",
"10084"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### Assigning different hosts 指定不同的主机
Replace the hosts currently assigned to maintenance "3" with two
different ones. 用两个不同的主机替换当前分配给维护“3”的主机。
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "maintenance.update",
"params": {
"maintenanceid": "3",
"hostids": [
"10085",
"10084"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### Assigning different hosts
Replace the hosts currently assigned to maintenance with two different ones.
Request:
```json
{
"jsonrpc": "2.0",
"method": "maintenance.update",
"params": {
"maintenanceid": "3",
"hosts": [
{"hostid": "10085"},
{"hostid": "10084"}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### 分配不同主机
将当前分配给维护的主机替换为两个不同的维护。
请求:
```json
{
"jsonrpc": "2.0",
"method": "maintenance.update",
"params": {
"maintenanceid": "3",
"hosts": [
{"hostid": "10085"},
{"hostid": "10084"}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### Attempting to use Zabbix sender compiled with TLS support to send data to Zabbix server/proxy compiled without TLS
#### 尝试使用编译时启用了 TLS 支持的 Zabbix sender 向未启用 TLS 编译的 Zabbix server/proxy 发送数据
##### Attributes returning composite data
It becomes more complicated when your attribute returns composite data.
For example: your attribute name is "apple" and it returns a hash
representing its parameters, like "weight", "color" etc. Your key may
look like this:
jmx[com.example:Type=Hello,apple.weight]
This is how an attribute name and a hash key are separated, by using a
dot symbol. Same way, if an attribute returns nested composite data the
parts are separated by a dot:
jmx[com.example:Type=Hello,fruits.apple.weight]
##### 返回复合数据的属性
当属性返回复合数据时，情况会变得更加复杂。
例如：属性名为"apple"，它返回一个表示其参数的哈希值，如"weight"、"color"等。键可能如下所示：
jmx[com.example:Type=Hello,apple.weight]
这就是属性名和哈希键通过点符号分隔的方式。同样地，如果属性返回嵌套的复合数据，各部分也通过点号分隔：
jmx[com.example:Type=Hello,fruits.apple.weight]
##### Attributes returning tabular data
Tabular data attributes consist of one or multiple composite attributes.
If such an attribute is specified in the attribute name parameter then
this item value will return the complete structure of the attribute in
JSON format. The individual element values inside the tabular data
attribute can be retrieved using preprocessing.
Tabular data attribute example:
jmx[com.example:type=Hello,foodinfo]
Item value:
``` {.javascript}
[
{
"a": "apple",
"b": "banana",
"c": "cherry"
},
{
"a": "potato",
"b": "lettuce",
"c": "onion"
}
]
```
##### 返回表格数据的属性
表格数据属性由一个或多个复合属性组成。
如果在属性名称参数中指定了此类属性，
则该监控项值将以JSON格式返回属性的完整结构。
表格数据属性中的各个元素值可以通过预处理来获取。
表格数据属性示例：
jmx[com.example:type=Hello,foodinfo]
监控项值：
```{.javascript}
[
{
"a": "apple",
"b": "banana",
"c": "cherry"
},
{
"a": "potato",
"b": "lettuce",
"c": "onion"
}
]
```
#### Audit log
#### 审计日志
### Audit log
Audit log functionality has been reworked significantly. The updated
Audit log contains records of all configuration changes of Zabbix
objects and has an improved filter, which allows to view records grouped
by frontend operation. Logging can be switched on or off in the
*Administration→General* menu section. In order to implement these
changes, the previously existing database structure had to be reworked.
During an upgrade DB tables `auditlog` and `auditlog_details` will be
replaced by the new table `auditlog` with a different format. **Existing
audit log records will be deleted.**
##### User macros in item name no longer supported
The support for user macros in item names (including discovery rule names), deprecated
since Zabbix 4.0, has been fully removed.
#### audit log
Changes:\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715) Audit log
object: dropped support of property `note`.\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715) Audit log
object: dropped support of `resourcetype` values `2`(Configuration of
Zabbix) and `7`(Graph element).\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715) Audit log
object: dropped support of `action` values `5`(Enable) and
`6`(Disable).\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715)
`auditlog.get`: dropped support of parameter `selectDetails`.\
[ZBXNEXT-6718](https://support.zabbix.com/browse/ZBXNEXT-6718) Audit log
object: dropped support of `action` value `3` (Login).\
#### audit log
Changes:\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715) Audit log
object: dropped support of property `note`.\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715) Audit log
object: dropped support of `resourcetype` values `2`(Configuration of
Zabbix) and `7`(Graph element).\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715) Audit log
object: dropped support of `action` values `5`(Enable) and
`6`(Disable).\
[ZBXNEXT-6715](https://support.zabbix.com/browse/ZBXNEXT-6715)
`auditlog.get`: dropped support of parameter `selectDetails`.\
[ZBXNEXT-6718](https://support.zabbix.com/browse/ZBXNEXT-6718) Audit log
object: dropped support of `action` value `3` (Login).\
### Audit log filter
Multiple actions now can be selected in the audit log filter in *Reports* -> *[Audit](/manual/web_interface/frontend_sections/reports/audit)*:
{width="600"}
This is useful to see all related actions (for example, successful and failed logins into the frontend)
in the audit list.
### 审计日志过滤器
现在可以在*报表* -> *[Audit](/manual/web_interface/frontend_sections/reports/audit)*中的审计日志过滤器中选择多个操作:
{width="600"}
这对于查看审计列表中所有相关操作(例如前端登录成功和失败的记录)非常有用.
# auditlog.get
# auditlog.get
#### Audit log
In order to implement the changes in [audit log functionality](#audit-log), the previously existing database structure
had to be reworked. During the upgrade `auditlog` and `auditlog_details` DB tables will be replaced by the new table
`auditlog` with a different format. **Existing audit log records will be deleted.**
#### 审计日志
为实现[审计日志功能](#audit-log)的变更，必须重构先前存在的数据库结构。在升级过程中，`auditlog`和`auditlog_details`数据库表将被格式不同的新表`auditlog`取代。**现有审计日志记录将被删除。**
##### Audit log
In order to improve audit logging in Zabbix and make the Audit log
complete and reliable, the previously existing database structure had to
be reworked. During an upgrade DB tables `auditlog` and
`auditlog_details` will be replaced by the new table `auditlog` with a
different format. **Old audit records will not be preserved.**
New
[section](/manual/web_interface/frontend_sections/administration/general#audit_log)
*Audit log* has been added to the *Administration→General* menu allowing
to enable (default) or disable audit logging. Housekeeping settings for
audit, previously located under the *Housekeeper* menu section, have
also been moved to the new *Audit log* section. Existing housekeeping
settings will be saved.
##### 审计日志
为了完善Zabbix的审计日志功能并确保审计日志的完整性和可靠性，我们重构了原有的数据库结构。升级过程中，数据库表`auditlog`和`auditlog_details`将被格式不同的新表`auditlog`替代。**旧的审计记录将不被保留。**
新增
[审计日志](/manual/web_interface/frontend_sections/administration/general#审计日志)
*审计日志*功能已添加到*管理→常规*菜单中，允许启用（默认）或禁用审计日志记录。原先位于*管家*菜单下的审计清理设置也已迁移至新的*审计日志*版块，现有清理设置将被保留。
### Audit log
The audit log object contains information about user actions. It has the
following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|auditid|string|*(readonly)* ID of audit log entry. Generated using CUID algorithm.|
|userid|string|Audit log entry author userid.|
|username|string|Audit log entry author username.|
|clock|timestamp|Audit log entry creation timestamp.|
|ip|string|Audit log entry author IP address.|
|action|integer|Audit log entry action.<br><br>Possible values are:<br>0 - Add;<br>1 - Update;<br>2 - Delete;<br>4 - Logout;<br>7 - Execute;<br>8 - Login;<br>9 - Failed login;<br>10 - History clear.|
|resourcetype|integer|Audit log entry resource type.<br><br>Possible values are:<br>0 - User;<br>3 - Media type;<br>4 - Host;<br>5 - Action;<br>6 - Graph;<br>11 - User group;<br>13 - Trigger;<br>14 - Host group;<br>15 - Item;<br>16 - Image;<br>17 - Value map;<br>18 - Service;<br>19 - Map;<br>22 - Web scenario;<br>23 - Discovery rule;<br>25 - Script;<br>26 - Proxy;<br>27 - Maintenance;<br>28 - Regular expression;<br>29 - Macro;<br>30 - Template;<br>31 - Trigger prototype;<br>32 - Icon mapping;<br>33 - Dashboard;<br>34 - Event correlation;<br>35 - Graph prototype;<br>36 - Item prototype;<br>37 - Host prototype;<br>38 - Autoregistration;<br>39 - Module;<br>40 - Settings;<br>41 - Housekeeping;<br>42 - Authentication;<br>43 - Template dashboard;<br>44 - User role;<br>45 - API token;<br>46 - Scheduled report;<br>47 - High availability node;<br>48 - SLA.|
|resourceid|string|Audit log entry resource identifier.|
|resourcename|string|Audit log entry resource human readable name.|
|recordsetid|string|Audit log entry recordset ID. The audit log records created during the same operation will have the same recordset ID. Generated using CUID algorithm.|
|details|text|Audit log entry details. The details are stored as JSON object where each property name is a path to property or nested object in which change occurred, and each value contain the data about the change of this property in array format.<br><br>Possible value formats are:<br>\["add"\] - Nested object has been added;<br>\["add", "<value>"\] - The property of added object contain <value>;<br>\["update"\] - Nested object has been updated;<br>\["update", "<new value>", "<old value>"\] - The value of property of updated object was changed from <old value> to <new value>;<br>\["delete"\] - Nested object has been deleted.|
### 审计日志
审计日志object包含用户操作的相关信息。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| auditid | string | *(只读)* 审计日志条目ID。使用CUID算法生成。 |
| userid | string | 审计日志条目作者用户ID。 |
| username | string | 审计日志条目作者用户名。 |
| clock | timestamp | 审计日志条目创建时间戳。 |
| ip | string | 审计日志条目作者IP地址。 |
| action | integer | 审计日志条目操作。<br><br>可能的值包括:<br>0 - 添加;<br>1 - 更新;<br>2 - 删除;<br>4 - 登出;<br>7 - 执行;<br>8 - 登录;<br>9 - 失败的login;<br>10 - 历史clear。 |
| resourcetype | integer | 审计日志条目资源类型。<br><br>可能的值包括:<br>0 - 用户;<br>3 - 媒介类型;<br>4 - 主机;<br>5 - 动作;<br>6 - 图形;<br>11 - 用户组;<br>13 - 触发器;<br>14 - 主机组;<br>15 - 监控项;<br>16 - 图像;<br>17 - 值映射;<br>18 - 服务;<br>19 - 地图;<br>22 - Web场景;<br>23 - 发现规则;<br>25 - 脚本;<br>26 - Proxy;<br>27 - 维护;<br>28 - 正则表达式;<br>29 - 宏;<br>30 - 模板;<br>31 - 触发器原型;<br>32 - 图标映射;<br>33 - 仪表板;<br>34 - 事件关联;<br>35 - 图形原型;<br>36 - 监控项原型;<br>37 - 主机原型;<br>38 - 自动注册;<br>39 - 模块;<br>40 - 设置;<br>41 - 数据清理;<br>42 - 认证;<br>43 - 模板仪表板;<br>44 - 用户角色;<br>45 - API令牌;<br>46 - 计划报告;<br>47 - 高可用节点;<br>48 - SLA。 |
| resourceid | string | 审计日志条目资源标识符。 |
| resourcename | string | 审计日志条目资源可读名称。 |
| recordsetid | string | 审计日志条目记录集ID。同一操作期间创建的审计日志记录将具有相同的记录集ID。使用CUID算法生成。 |
| details | text | 审计日志条目详情。详情以JSON object格式存储，其中每个属性名称是属性路径或发生更改的嵌套object，每个值包含array格式的该属性更改数据。<br><br>可能的格式包括:<br>\["add"\] - 已添加嵌套object;<br>\["add", "<value>"\] - 添加的object属性包含<value>;<br>\["update"\] - 已更新嵌套object;<br>\["update", "<new value>", "<old value>"\] - 更新的object属性值从<old value>更改为<new value>;<br>\["delete"\] - 已删除嵌套object。 |
**Audit settings**
New
[section](/manual/web_interface/frontend_sections/administration/general#audit_log)
*Audit log* has been added to the *Administration→General* menu allowing to enable or disable audit logging.
Housekeeping settings for audit, previously located under the *Housekeeper* section, have also been moved to the new
*Audit log* section.
**审计设置**
新增
[审计日志](/manual/web_interface/frontend_sections/administration/general#审计日志)
*审计日志*功能已添加到*管理→常规*菜单中，允许启用或禁用审计日志记录。
原先位于*Housekeeper*部分的审计数据清理设置也已迁移至新的*审计日志*版块。
#### Authenticating a user
Authenticate a user.
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": "0424bd59b807674191e7d77572075f33",
"id": 1
}
```
#### 用户认证
用户认证
请求:
```json
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": "0424bd59b807674191e7d77572075f33",
"id": 1
}
```
#### Authentication
Change authentication configuration options.
[Authentication API](/manual/api/reference/authentication)
#### 认证
修改认证配置选项。
[Authentication API](/manual/api/reference/authentication)
# authentication.get
# authentication.get
#### Authentication request signing
It is possible to configure Entra ID to [validate the signature](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/howto-enforce-signed-saml-authentication) of signed authentication requests.
To make this work, create public/private keys:
```bash
openssl req -x509 -newkey rsa:4096 -keyout /usr/share/zabbix/conf/certs/request-sign.key -out /usr/share/zabbix/conf/certs/request-sign.pem -sha256 -days 1825 -nodes
```
Assign permissions:
```bash
chown apache /usr/share/zabbix/conf/certs/request-sign.key
chmod 400 /usr/share/zabbix/conf/certs/request-sign.key
```
Update Zabbix frontend configuration by adding:
```php
$SSO['SP_KEY'] = 'conf/certs/request-sign.key';
$SSO['SP_CERT'] = 'conf/certs/request-sign.crt';
```
#### 认证请求签名
可以配置Entra ID以[validate the signature](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/howto-enforce-signed-saml-authentication)已签名的认证请求.
为实现此功能，create公钥/私钥对:
```bash
openssl req -x509 -newkey rsa:4096 -keyout /usr/share/zabbix/conf/certs/request-sign.key -out /usr/share/zabbix/conf/certs/request-sign.pem -sha256 -days 1825 -nodes
```
分配权限:
```bash
chown apache /usr/share/zabbix/conf/certs/request-sign.key
chmod 400 /usr/share/zabbix/conf/certs/request-sign.key
```
通过添加以下内容更新Zabbix前端配置:
```php
$SSO['SP_KEY'] = 'conf/certs/request-sign.key';
$SSO['SP_CERT'] = 'conf/certs/request-sign.crt';
```
### Authentication
The authentication object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|authentication\_type|integer|Default authentication.<br><br>Possible values:<br>0 - *(default)* Internal;<br>1 - LDAP.|
|http\_auth\_enabled|integer|Enable HTTP authentication.<br><br>Possible values:<br>0 - *(default)* Disable;<br>1 - Enable.|
|http\_login\_form|integer|Default login form.<br><br>Possible values:<br>0 - *(default)* Zabbix login form;<br>1 - HTTP login form.|
|http\_strip\_domains|string|Remove domain name.|
|http\_case\_sensitive|integer|HTTP case-sensitive login.<br><br>Possible values:<br>0 - Off;<br>1 - *(default)* On.|
|ldap\_configured|integer|Enable LDAP authentication.<br><br>Possible values:<br>0 - Disable;<br>1 - *(default)* Enable.|
|ldap\_host|string|LDAP host.|
|ldap\_port|integer|LDAP port.|
|ldap\_base\_dn|string|LDAP base DN.|
|ldap\_search\_attribute|string|LDAP search attribute.|
|ldap\_bind\_dn|string|LDAP bind DN.|
|ldap\_case\_sensitive|integer|LDAP case-sensitive login.<br><br>Possible values:<br>0 - Off;<br>1 - *(default)* On.|
|ldap\_bind\_password|string|LDAP bind password.|
|saml\_auth\_enabled|integer|Enable SAML authentication.<br><br>Possible values:<br>0 - *(default)* Disable;<br>1 - Enable.|
|saml\_idp\_entityid|string|SAML IdP entity ID.|
|saml\_sso\_url|string|SAML SSO service URL.|
|saml\_slo\_url|string|SAML SLO service URL.|
|saml\_username\_attribute|string|SAML username attribute.|
|saml\_sp\_entityid|string|SAML SP entity ID.|
|saml\_nameid\_format|string|SAML SP name ID format.|
|saml\_sign\_messages|integer|SAML sign messages.<br><br>Possible values:<br>0 - *(default)* Do not sign messages;<br>1 - Sign messages.|
|saml\_sign\_assertions|integer|SAML sign assertions.<br><br>Possible values:<br>0 - *(default)* Do not sign assertions;<br>1 - Sign assertions.|
|saml\_sign\_authn\_requests|integer|SAML sign AuthN requests.<br><br>Possible values:<br>0 - *(default)* Do not sign AuthN requests;<br>1 - Sign AuthN requests.|
|saml\_sign\_logout\_requests|integer|SAML sign logout requests.<br><br>Possible values:<br>0 - *(default)* Do not sign logout requests;<br>1 - Sign logout requests.|
|saml\_sign\_logout\_responses|integer|SAML sign logout responses.<br><br>Possible values:<br>0 - *(default)* Do not sign logout responses;<br>1 - Sign logout responses.|
|saml\_encrypt\_nameid|integer|SAML encrypt name ID.<br><br>Possible values:<br>0 - *(default)* Do not encrypt name ID;<br>1 - Encrypt name ID.|
|saml\_encrypt\_assertions|integer|SAML encrypt assertions.<br><br>Possible values:<br>0 - *(default)* Do not encrypt assertions;<br>1 - Encrypt assertions.|
|saml\_case\_sensitive|integer|SAML case-sensitive login.<br><br>Possible values:<br>0 - Off;<br>1 - *(default)* On.|
|passwd\_min\_length|integer|Password minimal length requirement.<br><br>Possible range of values: 1-70<br>8 - *default*|
|passwd\_check\_rules|integer|Password checking rules.<br><br>Possible bitmap values are:<br>0 - Check password length;<br>1 - Check if password uses uppercase and lowercase Latin letters;<br>2 - Check if password uses digits;<br>4 - Check if password uses special characters;<br>8 - *(default)* Check if password is not in the list of commonly used passwords and does not contain derivations of word "Zabbix" or user's name, last name, or username.<br><br>This is a bitmask field; any sum of possible bitmap values is acceptable (for example, 15 for checking all rules).|
### 认证
认证object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| authentication\_type | integer | 默认认证方式.<br><br>可选值:<br>0 - *(默认)* 内部认证;<br>1 - LDAP. |
| http\_auth\_enabled | integer | 启用HTTP认证.<br><br>可选值:<br>0 - *(默认)* 禁用;<br>1 - 启用. |
| http\_login\_form | integer | 默认login表单.<br><br>可选值:<br>0 - *(默认)* Zabbixlogin表单;<br>1 - HTTPlogin表单. |
| http\_strip\_domains | string | 移除域名. |
| http\_case\_sensitive | integer | HTTP区分大小写的login.<br><br>可选值:<br>0 - 关闭;<br>1 - *(默认)* 开启. |
| ldap\_configured | integer | 启用LDAP认证.<br><br>可选值:<br>0 - 禁用;<br>1 - *(默认)* 启用. |
| ldap\_host | string | LDAP主机. |
| ldap\_port | integer | LDAP端口. |
| ldap\_base\_dn | string | LDAP基础DN. |
| ldap\_search\_attribute | string | LDAP搜索属性. |
| ldap\_bind\_dn | string | LDAP绑定DN. |
| ldap\_case\_sensitive | integer | LDAP区分大小写的login.<br><br>可选值:<br>0 - 关闭;<br>1 - *(默认)* 开启. |
| ldap\_bind\_password | string | LDAP绑定密码. |
| saml\_auth\_enabled | integer | 启用SAML认证.<br><br>可选值:<br>0 - *(默认)* 禁用;<br>1 - 启用. |
| saml\_idp\_entityid | string | SAML IdP实体ID. |
| saml\_sso\_url | string | SAML SSO服务URL. |
| saml\_slo\_url | string | SAML SLO服务URL. |
| saml\_username\_attribute | string | SAML用户名属性. |
| saml\_sp\_entityid | string | SAML SP实体ID. |
| saml\_nameid\_format | string | SAML SP名称ID格式. |
| saml\_sign\_messages | integer | SAML签名消息.<br><br>可选值:<br>0 - *(默认)* 不签名消息;<br>1 - 签名消息. |
| saml\_sign\_assertions | integer | SAML签名断言.<br><br>可选值:<br>0 - *(默认)* 不签名断言;<br>1 - 签名断言. |
| saml\_sign\_authn\_requests | integer | SAML签名AuthN请求.<br><br>可选值:<br>0 - *(默认)* 不签名AuthN请求;<br>1 - 签名AuthN请求. |
| saml\_sign\_logout\_requests | integer | SAML签名logout请求.<br><br>可选值:<br>0 - *(默认)* 不签名logout请求;<br>1 - 签名logout请求. |
| saml\_sign\_logout\_responses | integer | SAML签名logout响应.<br><br>可选值:<br>0 - *(默认)* 不签名logout响应;<br>1 - 签名logout响应. |
| saml\_encrypt\_nameid | integer | SAML加密名称ID.<br><br>可选值:<br>0 - *(默认)* 不加密名称ID;<br>1 - 加密名称ID. |
| saml\_encrypt\_assertions | integer | SAML加密断言.<br><br>可选值:<br>0 - *(默认)* 不加密断言;<br>1 - 加密断言. |
| saml\_case\_sensitive | integer | SAML区分大小写的login.<br><br>可选值:<br>0 - 关闭;<br>1 - *(默认)* 开启. |
| passwd\_min\_length | integer | 密码最小长度要求.<br><br>可选值范围: 1-70<br>8 - *默认* |
| passwd\_check\_rules | integer | 密码检查规则.<br><br>可选位图值:<br>0 - 检查密码长度;<br>1 - 检查密码是否使用大小写拉丁字母;<br>2 - 检查密码是否使用数字;<br>4 - 检查密码是否使用特殊字符;<br>8 - *(默认)* 检查密码是否不在常用密码列表中且不包含"Zabbix"或其变体或用户姓名/用户名.<br><br>此为位掩码字段;可接受任何位图值的组合(例如15表示检查所有规则). |
#### Authentication
To access any data in Zabbix, you need to either:
- use an existing [API token](/manual/web_interface/frontend_sections/administration/general#api-tokens) (created in Zabbix frontend or using the [Token API](/manual/api/reference/token));
- use an authentication token obtained with the [user.login](/manual/api/reference/user/login) method.
For example, if you wanted to obtain a new authentication token by logging in as a standard *Admin* user, then a JSON request would look like this:
```json
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1,
"auth": null
}
```
Let's take a closer look at the request object. It has the following
properties:
- `jsonrpc` - the version of the JSON-RPC protocol used by the API;
the Zabbix API implements JSON-RPC version 2.0;
- `method` - the API method being called;
- `params` - parameters that will be passed to the API method;
- `id` - an arbitrary identifier of the request;
if omitted, the API treats the request as a [notification](https://www.jsonrpc.org/specification#notification);
- `auth` - a user authentication token; since we don't have one yet,
it's set to `null`.
If you provided the credentials correctly, the response returned by the
API will contain the user authentication token:
```json
{
"jsonrpc": "2.0",
"result": "0424bd59b807674191e7d77572075f33",
"id": 1
}
```
The response object in turn contains the following properties:
- `jsonrpc` - again, the version of the JSON-RPC protocol;
- `result` - the data returned by the method;
- `id` - identifier of the corresponding request.
#### 认证
要访问Zabbix中的任何数据，您需要：
- 使用现有的[api-令牌](/manual/web_interface/frontend_sections/administration/general#api-令牌)（在Zabbix前端创建或使用[Token API](/manual/api/reference/token)）；
- 使用通过[user.login](/manual/api/reference/user/login)方法获取的身份验证令牌。
例如，如果您想以标准*Admin*用户身份登录获取新的身份验证令牌，JSON请求将如下所示：
```json
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1,
"auth": null
}
```
让我们仔细看看请求object。它具有以下属性：
- `jsonrpc` - API使用的JSON-RPC协议的version；
Zabbix API实现了JSON-RPC version 2.0；
- `method` - 调用的API方法；
- `params` - 传递给API方法的参数；
- `id` - 请求的任意标识符；
如果省略，API会将请求视为[notification](https://www.jsonrpc.org/specification#notification)；
- `auth` - 用户身份验证令牌；由于我们还没有，
it's set to `null`.
`null`。
如果您提供了正确的凭据，API返回的响应将包含用户身份验证令牌：
```json
{
"jsonrpc": "2.0",
"result": "0424bd59b807674191e7d77572075f33",
"id": 1
}
```
响应object包含以下属性：
- `jsonrpc` - 再次是JSON-RPC协议的version；
- `result` - 方法返回的数据；
- `id` - 对应请求的标识符。
# authentication.update
# authentication.update
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## 作者
Alexei Vladishev <[[\[email protected\]]{.__cf_email__
cfemail="254449405d655f4447474c5d0b464a48"}](/cdn-cgi/l/email-protection#eb8a878e93ab918a89898293c5888486)>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## 作者
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## 作者
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## 作者
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
## 作者
Alexei Vladishev <<alex@zabbix.com>>
------------------------------------------------------------------------
[ ]{#index}
##### Authorization
|Parameter|Description|
|--|--------|
|*Login attempts*|Number of unsuccessful login attempts before the possibility to log in gets blocked.|
|*Login blocking interval*|Period of time for which logging in will be prohibited when *Login attempts* limit is exceeded.|
##### 授权
| 参数 | 描述 |
|--|--------|
| *Login attempts* | 登录被阻止前允许的login失败尝试次数。 |
| *Login blocking interval* | 当超过*登录尝试*限制时，禁止登录的时间段。 |
## AUTHOR
Zabbix LLC
------------------------------------------------------------------------
[ ]{#index}
## 作者
Zabbix 有限责任公司
------------------------------------------------------------------------
[ ]{#index}
## AUTHOR
Zabbix LLC
------------------------------------------------------------------------
[ ]{#index}
## 作者
Zabbix 有限责任公司
------------------------------------------------------------------------
[ ]{#index}
#### Automated type selection
Item configuration form now automatically suggests the matching type of information, if selected item key returns data
only of the specific type (for example, **log\[\]** item requires *Type of information: Log*).
*Type of information* parameter is now located under the *Key* parameter on the primary *Item* tab and is duplicated on
the *Preprocessing* tab if at least one preprocessing step is specified. If Zabbix detects a possible mismatch of the
selected type of information and key, a warning icon will be displayed next to the *Type of information* field.
#### 自动类型选择
监控项配置表单现在会自动建议匹配的信息类型，如果选定的监控项键返回的数据仅属于特定类型（例如**log\[\]**监控项需要*信息类型：日志*）。
*信息类型*参数现在位于主*监控项*标签页的*键*参数下方，并在*预处理*标签页上重复显示（如果至少指定了一个预处理步骤）。当Zabbix检测到所选信息类型与键可能存在不匹配时，会在*信息类型*字段旁显示警告图标。
##### Automatic mode
A host's inventory can also be populated automatically. For that to work,
when configuring the host's inventory mode in the *Inventory* tab,
it must be set to *Automatic*.
Then you can [configure host items](/manual/config/items/item) to
populate any host inventory field with their value, indicating the
destination field with the respective attribute (called *Item will
populate host inventory field*) in item configuration.
Items that are especially useful for automated inventory data
collection:
- system.hw.chassis\[full|type|vendor|model|serial\] - default is
\[full\], root permissions needed
- system.hw.cpu\[all|cpunum,full|maxfreq|vendor|model|curfreq\] -
default is \[all,full\]
- system.hw.devices\[pci|usb\] - default is \[pci\]
- system.hw.macaddr\[interface,short|full\] - default is \[all,full\],
interface is regexp
- system.sw.arch
- system.sw.os\[name|short|full\] - default is \[name\]
- system.sw.packages\[regexp,manager,short|full\] - default is
\[all,all,full\]
##### 自动模式
一个主机的资产清单也可以自动填充。要实现此功能，
在*资产清单*标签页中配置主机的资产清单模式时，
必须将其设置为*自动*。
然后您可以[configure host items](/manual/config/items/item)来
用其值填充任何主机资产清单字段，在监控项配置中
通过相应属性（称为*监控项将填充主机资产清单字段*）
指示目标字段。
特别适用于自动化资产数据收集的监控项：
- system.hw.chassis\[full|type|vendor|model|serial\] - 默认为
\[full\]，需要root权限
- system.hw.cpu\[all|cpunum,full|maxfreq|vendor|model|curfreq\] -
默认为 \[all,full\]
- system.hw.devices\[pci|usb\] - 默认为 \[pci\]
- system.hw.macaddr\[interface,short|full\] - 默认为 \[all,full\]，
interface是正则表达式
- system.sw.arch
- system.sw.os\[name|short|full\] - 默认为 \[name\]
- system.sw.packages\[regexp,manager,short|full\] - 默认为
\[all,all,full\]
#### Autoregistration actions
The following conditions can be set for actions based on active agent
autoregistration:
|Condition type|Supported operators|Description|
|--------------|-------------------|-----------|
|*Host metadata*|contains<br>does not contain<br>matches<br>does not match|Specify host metadata or host metadata to exclude.<br>**contains** - host metadata contains the string.<br>**does not contain** - host metadata does not contain the string.<br>Host metadata can be specified in an [agent configuration file](/manual/appendix/config/zabbix_agentd).<br>**matches** - host metadata matches regular expression.<br>**does not match** - host metadata does not match regular expression.|
|*Host name*|contains<br>does not contain<br>matches<br>does not match|Specify a host name or a host name to exclude.<br>**contains** - host name contains the string.<br>**does not contain** - host name does not contain the string.<br>**matches** - host name matches regular expression.<br>**does not match** - host name does not match regular expression.|
|*Proxy*|equals<br>does not equal|Specify a proxy or a proxy to exclude.<br>**equals** - using this proxy.<br>**does not equal** - using any other proxy except this one.|
#### 自动注册动作
可以为基于主动式agent自动注册的动作设置以下条件:
|条件类型|支持的操作符|说明|
|--------------|-------------------|-----------|
|*Host metadata*|contains<br>does not contain<br>matches<br>does not match|主机元数据或要排除的主机元数据<br>**contains** - 主机元数据包含该字符串<br>**does not contain** - 主机元数据不包含该字符串<br>关于主机元数据请参见 [agent configuration file](/manual/appendix/config/zabbix_agentd).<br>**matches** - 主机元数据匹配该正则表达式<br>**does not match** - 主机元数据不匹配该正则表达式|
|*Host name*|contains<br>does not contain<br>matches<br>does not match|主机名或要排除的主机名<br>**contains** - 主机名包含该字符串<br>**does not contain** - 主机名不包含该字符串<br>**matches** - 主机名匹配该正则表达式<br>**does not match** - 主机名不匹配该正则表达式|
|*Proxy*|equals<br>does not equal|使用的Zabbix代理或要排除的Zabbix代理<br>**equals** - 使用该代理<br>**does not equal** - 使用此代理以外的其它代理|
#### Autoregistration actions
The following conditions can be used in actions based on active agent
autoregistration:
|Condition type|Supported operators|Description|
|--|--|------|
|*Host metadata*|contains<br>does not contain<br>matches<br>does not match|Specify host metadata or host metadata to exclude.<br>**contains** - host metadata contains the string.<br>**does not contain** - host metadata does not contain the string.<br>Host metadata can be specified in an [agent configuration file](/manual/appendix/config/zabbix_agentd).<br>**matches** - host metadata matches regular expression.<br>**does not match** - host metadata does not match regular expression.|
|*Host name*|contains<br>does not contain<br>matches<br>does not match|Specify a host name or a host name to exclude.<br>**contains** - host name contains the string.<br>**does not contain** - host name does not contain the string.<br>**matches** - host name matches regular expression.<br>**does not match** - host name does not match regular expression.|
|*Proxy*|equals<br>does not equal|Specify a proxy or a proxy to exclude.<br>**equals** - using this proxy.<br>**does not equal** - using any other proxy except this one.|
#### 自动注册动作
以下条件可用于基于活动agent的操作
自动注册:
| 条件类型 | 支持的运算符 | 描述 |
|--|--|------|
| *Host metadata* | contains<br>does not contain<br>matches<br>does not match | 指定要包含的主机元数据或要排除的主机元数据。<br>**包含** - 主机元数据包含string。<br>**不包含** - 主机元数据不包含string。<br>主机元数据可在[agent configuration file](/manual/appendix/config/zabbix_agentd)中指定。<br>**匹配** - 主机元数据符合正则表达式。<br>**不匹配** - 主机元数据不符合正则表达式。 |
| *Host name* | contains<br>does not contain<br>matches<br>does not match | 指定要包含的一个主机名称或要排除的一个主机名称.<br>**contains** - 主机名包含string.<br>**does not contain** - 主机名不包含string.<br>**matches** - 主机名匹配正则表达式.<br>**does not match** - 主机名不匹配正则表达式. |
| *Proxy* | equals<br>does not equal | 指定要包含或排除的proxy。<br>**等于** - 使用此proxy。<br>**不等于** - 使用除此proxy外的其他proxy。 |
# autoregistration.get
# autoregistration.get
#### Autoregistration table cleared from orphaned records
Previously the `autoreg_host` table was never cleared. Now orphaned records that reference neither an autoregistration event nor an existing host will be removed by the Housekeeper.
#### 自动注册表已清除孤立记录
此前`autoreg_host`表从未被清理。现在，那些既不引用自动注册事件也不引用现有主机的孤立记录将由Housekeeper移除。
### Autoregistration
The autoregistration object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|tls\_accept|integer|Type of allowed incoming connections for autoregistration.<br><br>Possible values:<br>1 - allow unencrypted connections;<br>2 - allow TLS with PSK.<br>3 - allow both unencrypted and TLS with PSK connections.|
|tls\_psk\_identity|string|*(write-only)* PSK identity; must be paired with only one PSK (across [autoregistration](/manual/api/reference/autoregistration/object), [hosts](/manual/api/reference/host/object), and [proxies](/manual/api/reference/proxy/object)).<br>Do not include sensitive information in the PSK identity, as it is sent unencrypted over the network to inform the receiver which PSK to use.|
|tls\_psk|string|*(write-only)* Pre-shared key (PSK); must be at least 32 hex digits.|
### 自动注册
自动注册object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| tls\_accept | integer | 自动注册允许的传入连接类型。<br><br>可能的值：<br>1 - 允许未加密连接；<br>2 - 允许带PSK的TLS连接；<br>3 - 同时允许未加密和带PSK的TLS连接。 |
| tls\_psk\_identity | string | *(仅写入)* PSK标识；必须与唯一的PSK配对（跨[autoregistration](/manual/api/reference/autoregistration/object)、[hosts](/manual/api/reference/host/object)和[proxies](/manual/api/reference/proxy/object)）。<br>不要在PSK标识中包含敏感信息，因为它会以未加密形式通过网络发送，告知接收方使用哪个PSK。 |
| tls\_psk | string | *(仅写入)* 预共享密钥（PSK）；必须至少为32位十六进制数字。 |
# autoregistration.update
# autoregistration.update
##### Average request count to Nginx server
View the average request count per second per day to the Nginx server:
- add the request count per second item to the data set
- select the aggregate function `avg` and specify interval `1d`
- a bar graph is displayed, where each bar represents the average
number of requests per second per day
##### 对 nginx 服务器的平均请求数
查看每天对nginx服务器的每秒平均请求数：
- 将每秒请求数监控项添加到数据集
- 选择聚合函数`avg`并指定间隔`1d`
- 显示柱状图，其中每个柱子代表每天的每秒平均请求数
#### Axes
The following parameters are supported for configuring *Axes*.
|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|*Left Y*|0|lefty|0 - Disabled;<br>1 - *(default)* Enabled.<br><br>Parameter available if *Y-axis* (in *Data set* configuration) is set to "Left".|
|*Right Y*|0|righty|0 - *(default)* Disabled;<br>1 - Enabled.<br><br>Parameter available if *Y-axis* (in *Data set* configuration) is set to "Right".|
|*Min*|1|lefty_min|Any numeric value.<br><br>Default: `""` (empty).|
|^|^|righty_min|^|
|*Max*|1|lefty_max|Any numeric value.<br><br>Default: `""` (empty).|
|^|^|righty_max|^|
|*Units* (type)|0|lefty_units|0 - *(default)* Auto;<br>1 - Static.|
|^|^|righty_units|^|
|*Units* (value)|1|lefty_static_units|Any string value.<br><br>Default: `""` (empty).|
|^|^|righty_static_units|^|
|*X-Axis*|0|xaxis|0 - Disabled;<br>1 - *(default)* Enabled.|
#### 坐标轴
以下参数可用于配置*坐标轴*。
| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| *Left Y* | 0 | lefty | 0 - 禁用;<br>1 - *(默认)* 启用.<br><br>该参数在*数据集*配置中将*Y轴*设为"左侧"时可用。 |
| *Right Y* | 0 | righty | 0 - *(默认)* 禁用;<br>1 - 启用.<br><br>该参数在*数据集*配置中将*Y轴*设为"右侧"时可用。 |
| *Min* | 1 | lefty_min | 任意数值.<br><br>默认: `""` (空). |
| ^ | ^ | righty_min | ^ |
| *Max* | 1 | lefty_max | 任意数值.<br><br>默认: `""` (空). |
| ^ | ^ | righty_max | ^ |
| *Units* (type) | 0 | lefty_units | 0 - *(默认)* 自动;<br>1 - 静态. |
| ^ | ^ | righty_units | ^ |
| *Units* (value) | 1 | lefty_static_units | 任意string值.<br><br>默认: `""` (空). |
| ^ | ^ | righty_static_units | ^ |
| *X-Axis* | 0 | xaxis | 0 - 禁用;<br>1 - *(默认)* 启用. |
### Backward incompatible changes
### 向后不兼容变更
#### Baseline monitoring
Set of available baseline monitoring options has been extended with the two new functions **baselinedev** and
**baselinewma**.
- **baselinedev** - compares the last data period with the same data periods in preceding seasons and returns the
number of deviations;
- **baselinewma** - calculates the baseline by averaging data from the same timeframe in multiple equal time periods
('seasons') using the weighted moving average algorithm.
In context of these functions, the term 'season' refers to a configurable timeframe, which could be hours, days, weeks,
months or years. The length of a season and the number of seasons to analyse is set in function parameters.
See [history functions](/manual/appendix/functions/history) for more info.
#### 基线监控
可用的基线监控选项集已扩展为包含两个新函数**baselinedev**和**baselinewma**。
- **baselinedev** - 将最近数据周期与先前季节中相同数据周期进行比较，并返回偏差次数；
- **baselinewma** - 使用加权移动平均算法，通过平均多个相等时间段（'季节'）中相同时段的数据来计算基线。
在这些函数的上下文中，术语'季节'指可配置的时间段，可以是小时、天、周、月或年。季节长度和待分析季节数量通过函数参数设置。
更多信息请参阅[history functions](/manual/appendix/functions/history)。
#### Batch migration of history tables
* Prepare directories for Data Pump.
Data Pump must have read and write permissions to these directories.
Example:
``` {.bash}
mkdir -pv /export/history
chown -R oracle:oracle /export
```
* Create a directory object and grant read and write permissions to this object to the user used for Zabbix authentication ('zabbix' in the example below). Under *sysdba* role, run:
``` {.sql}
create directory history as '/export/history';
grant read,write on directory history to zabbix;
```
* Export tables. Replace N with the desired thread count.
``` {.bash}
expdp zabbix/password@oracle_host/service \
DIRECTORY=history \
TABLES=history_old,history_uint_old,history_str_old,history_log_old,history_text_old \
PARALLEL=N
```
* Import tables. Replace N with the desired thread count.
``` {.bash}
impdp zabbix/password@oracle_host/service \
DIRECTORY=history \
TABLES=history_uint_old \
REMAP_TABLE=history_old:history,history_uint_old:history_uint,history_str_old:history_str,history_log_old:history_log,history_text_old:history_text \
data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
```
* Follow [post-migration instructions](#post-migration) to drop the old tables.
#### 历史表的批量迁移
* 为Data Pump准备目录
Data Pump必须对这些目录具有读写权限
示例:
```{.bash}
mkdir -pv /export/history
chown -R oracle:oracle /export
```
* 创建目录object并授予Zabbix认证用户(下例中的'zabbix')对该object的读写权限。在*sysdba*角色下，run:
```{.sql}
create directory history as '/export/history';
grant read,write on directory history to zabbix;
```
* 导出表。将N替换为所需的线程数
```{.bash}
expdp zabbix/password@oracle_host/service \
DIRECTORY=history \
TABLES=history_old,history_uint_old,history_str_old,history_log_old,history_text_old \
PARALLEL=N
```
* 导入表。将N替换为所需的线程数
```{.bash}
impdp zabbix/password@oracle_host/service \
DIRECTORY=history \
TABLES=history_uint_old \
REMAP_TABLE=history_old:history,history_uint_old:history_uint,history_str_old:history_str,history_log_old:history_log,history_text_old:history_text \
data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
```
* 按照[迁移后说明](#post-migration)删除旧表
#### Behavior depending on availability
The following table illustrates how each function behaves in cases of limited availability of host/item and history data.
|Function|Disabled host|Unavailable host with data|Unavailable host without data|Disabled item|Unsupported item|Data retrieval error (SQL)|
|--|--|--|--|--|--|--|
|*avg_foreach*|ignore|return avg|ignore|ignore|ignore|ignore|
|*bucket_rate_foreach*|ignore|return bucket rate|ignore|ignore|ignore|ignore|
|*count_foreach*|ignore|return count|0|ignore|ignore|ignore|
|*exists_foreach*|ignore|1|1|ignore|1|n/a|
|*last_foreach*|ignore|return last|ignore|ignore|ignore|ignore|
|*max_foreach*|ignore|return max|ignore|ignore|ignore|ignore|
|*min_foreach*|ignore|return min|ignore|ignore|ignore|ignore|
|*sum_foreach*|ignore|return sum|ignore|ignore|ignore|ignore|
If the item is *ignored*, nothing is added to the aggregation.
#### 根据可用性的行为表现
下表展示了当主机/监控项和历史数据可用性受限时，各函数的行为表现。
| 函数 | 禁用主机 | 数据不可用的主机 | 无数据的主机 | 禁用监控项 | 不支持的监控项 | 数据检索错误(SQL) |
|--|--|--|--|--|--|--|
| *avg_foreach* | 忽略 | 返回平均值 | 忽略 | 忽略 | 忽略 | 忽略 |
| *bucket_rate_foreach* | 忽略 | 返回分桶率 | 忽略 | 忽略 | 忽略 | 忽略 |
| *count_foreach* | 忽略 | 返回计数 | 0 | 忽略 | 忽略 | 忽略 |
| *exists_foreach* | 忽略 | 1 | 1 | 忽略 | 1 | 不适用 |
| *last_foreach* | 忽略 | 返回最后值 | 忽略 | 忽略 | 忽略 | 忽略 |
| *max_foreach* | 忽略 | 返回最大值 | 忽略 | 忽略 | 忽略 | 忽略 |
| *min_foreach* | 忽略 | 返回最小值 | 忽略 | 忽略 | 忽略 | 忽略 |
| *sum_foreach* | 忽略 | 返回总和 | 忽略 | 忽略 | 忽略 | 忽略 |
若监控项被*忽略*，则不会向聚合结果添加任何内容。
# Best practices for secure Zabbix setup
# 安全设置 Zabbix 的最佳方式
#### Better navigation between item configuration and latest data
A new context menu for items has been introduced in
*[Latest data](/manual/web_interface/frontend_sections/monitoring/latest_data)* allowing to access the item
configuration and available graphs:
Conversely, a new context menu has been introduced in the
[item list](/manual/web_interface/frontend_sections/configuration/hosts/items) in configuration menu allowing to access
the latest data for the item and other useful options:
This menu replaces the wizard option in previous versions. A similar menu has
also been introduced for [template items](/manual/web_interface/frontend_sections/configuration/templates/items)
and [item prototypes](/manual/discovery/low_level_discovery/item_prototypes).
#### 在 监控项 配置与最新数据间实现更优导航
在*[Latest data](/manual/web_interface/frontend_sections/monitoring/latest_data)*中新增了监控项的上下文菜单
可访问监控项配置和可用图表:
相应地 在配置菜单的[item list](/manual/web_interface/frontend_sections/configuration/hosts/items)中
新增了上下文菜单 可访问监控项的最新数据
及其他实用选项:
该菜单取代了旧版本中的向导选项 类似的菜单也已
在[template items](/manual/web_interface/frontend_sections/configuration/templates/items)和[item prototypes](/manual/discovery/low_level_discovery/item_prototypes)中实现
## Breaking changes
## 重大变更
## Breaking changes
## 重大变更
## Breaking changes
## 重大变更
## Breaking changes
## 重大变更
## Breaking changes
## 重大变更
## Breaking changes
## 重大变更
### Breaking changes
#### Loadable plugin versioning
[Loadable plugins](/manual/config/items/plugins#loadable) for Zabbix agent 2 now use the same versioning system as Zabbix itself.
The following version changes have been made:
- MongoDB 1.2.0 -> MongoDB 6.0.13
- PostgreSQL 1.2.1 -> PostgreSQL 6.0.13
These plugins are supported for any minor version of Zabbix 6.0.
Note that source code repository for each plugin now contains a dedicated *release/6.0* branch (previously, there was only *master* branch).
### 重大变更
#### 可加载插件版本控制
[可加载](/manual/config/items/plugins#可加载) 现在为 Zabbix agent 2 采用了与Zabbix自身相同的版本控制系统.
以下 version 变更已实施:
- MongoDB 1.2.0 -> MongoDB 6.0.13
- PostgreSQL 1.2.1 -> PostgreSQL 6.0.13
这些插件支持Zabbix 6.0的任何次要 version 版本.
请注意每个插件的源代码仓库现在包含专用的*release/6.0*分支(之前仅有*master*分支).
### Breaking changes
#### Loadable plugin versioning
[Loadable plugins](/manual/config/items/plugins#loadable) for Zabbix agent 2 now use the same versioning system as Zabbix itself. The following version changes have been made:
- MongoDB 1.2.0 -> MongoDB 6.0.13
- PostgreSQL 1.2.1 -> PostgreSQL 6.0.13
These plugins are supported for any minor version of Zabbix 6.0.
Note that source code repository for each plugin now contains a dedicated *release/6.0* branch (previously, there was only *master* branch).
### 重大变更
#### 可加载插件版本控制
[可加载](/manual/config/items/plugins#可加载) 现在与 Zabbix agent 2 采用与 Zabbix 自身相同的版本控制系统。以下 version 变更已实施：
- MongoDB 1.2.0 -> MongoDB 6.0.13
- PostgreSQL 1.2.1 -> PostgreSQL 6.0.13
这些插件支持Zabbix 6.0的任何次要version版本。
请注意，每个插件的源代码仓库现在都包含一个专用的*release/6.0*分支（之前仅有*master*分支）。
##### BSD systems
If `watch` command is not installed, a similar effect can be achieved
with
while [ 1 ]; do ps x; sleep 0.2; clear; done
##### BSD 系统
如果没有安装`watch` 命令 ，可以达到类似的效果
while [ 1 ]; do ps x; sleep 0.2; clear; done
##### Build 32bit PCRE
1\. Run:
mingw32-make clean
2\. Delete *CMakeCache.txt*:
del CMakeCache.txt
rmdir /q /s CMakeFiles
3\. Run cmake:
cmake -G "MinGW Makefiles" -DCMAKE_C_COMPILER=gcc -DCMAKE_C_FLAGS="-m32 -O2 -g" -DCMAKE_CXX_FLAGS="-m32 -O2 -g" -DCMAKE_EXE_LINKER_FLAGS="-Wl,-mi386pe" -DCMAKE_INSTALL_PREFIX=c:\dev\pcre32
4\. Next, run:
mingw32-make install
##### 构建32位PCRE
1\. 运行:
mingw32-make clean
2\. 删除 *CMakeCache.txt*:
del CMakeCache.txt
rmdir /q /s CMakeFiles
3\. 运行 cmake:
cmake -G "MinGW Makefiles" -DCMAKE_C_COMPILER=gcc -DCMAKE_C_FLAGS="-m32 -O2 -g" -DCMAKE_CXX_FLAGS="-m32 -O2 -g" -DCMAKE_EXE_LINKER_FLAGS="-Wl,-mi386pe" -DCMAKE_INSTALL_PREFIX=c:\dev\pcre32
4\. 接下来, run:
mingw32-make install
##### Build 64bit PCRE
1\. Delete old configuration/cache if exists:
del CMakeCache.txt
rmdir /q /s CMakeFiles
2\. Run cmake (CMake can be installed from
<https://cmake.org/download/>):
cmake -G "MinGW Makefiles" -DCMAKE_C_COMPILER=gcc -DCMAKE_C_FLAGS="-O2 -g" -DCMAKE_CXX_FLAGS="-O2 -g" -DCMAKE_INSTALL_PREFIX=c:\dev\pcre
3\. Next, run:
mingw32-make clean
mingw32-make install
##### 构建64位PCRE
1\. 如果存在旧配置/缓存则删除:
del CMakeCache.txt
rmdir /q /s CMakeFiles
2\. 运行cmake (CMake可从
<https://cmake.org/download/>下载):
cmake -G "MinGW Makefiles" -DCMAKE_C_COMPILER=gcc -DCMAKE_C_FLAGS="-O2 -g" -DCMAKE_CXX_FLAGS="-O2 -g" -DCMAKE_INSTALL_PREFIX=c:\dev\pcre
3\. 接下来, run:
mingw32-make clean
mingw32-make install
#### Building agent binaries with shared libraries
Install PCRE2 (replace *pcre2* with *pcre* in the commands below, if needed):
brew install pcre2
When building with TLS, install OpenSSL and/or GnuTLS:
brew install openssl
brew install gnutls
Download Zabbix source:
git clone https://git.zabbix.com/scm/zbx/zabbix.git
Build agent without TLS:
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6
make
make install
Build agent with OpenSSL:
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-openssl=/usr/local/opt/openssl
make
make install
Build agent with GnuTLS:
cd zabbix-source/
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-gnutls=/usr/local/opt/gnutls
make
make install
#### 使用共享库构建agent二进制文件
安装PCRE2（如需使用PCRE，请将以下命令中的*pcre2*替换为*pcre*）：
brew install pcre2
如需支持TLS编译，请安装OpenSSL和/或GnuTLS：
brew install openssl
brew install gnutls
下载Zabbix源码：
git clone https://git.zabbix.com/scm/zbx/zabbix.git
编译agent（不启用TLS）：
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6
make
make install
编译agent（启用OpenSSL）：
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-openssl=/usr/local/opt/openssl
make
make install
编译agent（启用GnuTLS）：
cd zabbix-source/
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-gnutls=/usr/local/opt/gnutls
make
make install
#### Building agent binaries with static libraries with GnuTLS
GnuTLS depends on the Nettle crypto backend and GMP arithmetic library.
Instead of using full GMP library, this guide will use mini-gmp which is
included in Nettle.
When building GnuTLS and Nettle, it's recommended to run `make check`
after successful building. Even if building was successful, tests
sometimes fail. If this is the case, problems should be researched and
resolved before continuing.
Let's assume that PCRE, Nettle and GnuTLS static libraries will be
installed in `$HOME/static-libs`. We will use PCRE2 10.39, Nettle 3.4.1
and GnuTLS 3.6.5.
PCRE_PREFIX="$HOME/static-libs/pcre2-10.39"
NETTLE_PREFIX="$HOME/static-libs/nettle-3.4.1"
GNUTLS_PREFIX="$HOME/static-libs/gnutls-3.6.5"
Let's build static libraries in `static-libs-source`:
mkdir static-libs-source
cd static-libs-source
Download and build Nettle:
curl --remote-name https://ftp.gnu.org/gnu/nettle/nettle-3.4.1.tar.gz
tar xf nettle-3.4.1.tar.gz
cd nettle-3.4.1
./configure --prefix="$NETTLE_PREFIX" --enable-static --disable-shared --disable-documentation --disable-assembler --enable-x86-aesni --enable-mini-gmp
make
make check
make install
cd ..
Download and build GnuTLS:
curl --remote-name https://www.gnupg.org/ftp/gcrypt/gnutls/v3.6/gnutls-3.6.5.tar.xz
tar xf gnutls-3.6.5.tar.xz
cd gnutls-3.6.5
PKG_CONFIG_PATH="$NETTLE_PREFIX/lib/pkgconfig" ./configure --prefix="$GNUTLS_PREFIX" --enable-static --disable-shared --disable-guile --disable-doc --disable-tools --disable-libdane --without-idn --without-p11-kit --without-tpm --with-included-libtasn1 --with-included-unistring --with-nettle-mini
make
make check
make install
cd ..
Download Zabbix source and build agent:
git clone https://git.zabbix.com/scm/zbx/zabbix.git
cd zabbix
./bootstrap.sh
CFLAGS="-Wno-unused-command-line-argument -framework Foundation -framework Security" \
> LIBS="-lgnutls -lhogweed -lnettle" \
> LDFLAGS="-L$GNUTLS_PREFIX/lib -L$NETTLE_PREFIX/lib" \
> ./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-libpcre2="$PCRE_PREFIX" --with-gnutls="$GNUTLS_PREFIX"
make
make install
#### 使用GnuTLS的静态库构建agent二进制文件
GnuTLS依赖于Nettle加密后端和GMP算术库。
本指南将使用Nettle内置的mini-gmp而非完整的GMP库。
构建GnuTLS和Nettle时，建议在成功构建后run`make check`。即使构建成功，测试有时也会失败。若出现此情况，应在继续前研究并解决问题。
假设PCRE、Nettle和GnuTLS静态库将安装在`$HOME/static-libs`。我们将使用PCRE2 10.39、Nettle 3.4.1和GnuTLS 3.6.5。
PCRE_PREFIX="$HOME/static-libs/pcre2-10.39"
NETTLE_PREFIX="$HOME/static-libs/nettle-3.4.1"
GNUTLS_PREFIX="$HOME/static-libs/gnutls-3.6.5"
在`static-libs-source`中构建静态库：
mkdir static-libs-source
cd static-libs-source
下载并构建Nettle：
curl --remote-name https://ftp.gnu.org/gnu/nettle/nettle-3.4.1.tar.gz
tar xf nettle-3.4.1.tar.gz
cd nettle-3.4.1
./configure --prefix="$NETTLE_PREFIX" --enable-static --disable-shared --disable-documentation --disable-assembler --enable-x86-aesni --enable-mini-gmp
make
make check
make install
cd ..
下载并构建GnuTLS：
curl --remote-name https://www.gnupg.org/ftp/gcrypt/gnutls/v3.6/gnutls-3.6.5.tar.xz
tar xf gnutls-3.6.5.tar.xz
cd gnutls-3.6.5
PKG_CONFIG_PATH="$NETTLE_PREFIX/lib/pkgconfig" ./configure --prefix="$GNUTLS_PREFIX" --enable-static --disable-shared --disable-guile --disable-doc --disable-tools --disable-libdane --without-idn --without-p11-kit --without-tpm --with-included-libtasn1 --with-included-unistring --with-nettle-mini
make
make check
make install
cd ..
下载Zabbix源码并构建agent：
git clone https://git.zabbix.com/scm/zbx/zabbix.git
cd zabbix
./bootstrap.sh
CFLAGS="-Wno-unused-command-line-argument -framework Foundation -framework Security" \
> LIBS="-lgnutls -lhogweed -lnettle" \
> LDFLAGS="-L$GNUTLS_PREFIX/lib -L$NETTLE_PREFIX/lib" \
> ./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-libpcre2="$PCRE_PREFIX" --with-gnutls="$GNUTLS_PREFIX"
make
make install
#### Building agent binaries with static libraries with OpenSSL
When building OpenSSL, it's recommended to run `make test` after
successful building. Even if building was successful, tests sometimes
fail. If this is the case, problems should be researched and resolved
before continuing.
Let's assume that PCRE and OpenSSL static libraries will be installed in
`$HOME/static-libs`. We will use PCRE2 10.39 and OpenSSL 1.1.1a.
PCRE_PREFIX="$HOME/static-libs/pcre2-10.39"
OPENSSL_PREFIX="$HOME/static-libs/openssl-1.1.1a"
Let's build static libraries in `static-libs-source`:
mkdir static-libs-source
cd static-libs-source
Download and build PCRE with Unicode properties support:
curl --remote-name https://github.com/PhilipHazel/pcre2/releases/download/pcre2-10.39/pcre2-10.39.tar.gz
tar xf pcre2-10.39.tar.gz
cd pcre2-10.39
./configure --prefix="$PCRE_PREFIX" --disable-shared --enable-static --enable-unicode-properties
make
make check
make install
cd ..
Download and build OpenSSL:
curl --remote-name https://www.openssl.org/source/openssl-1.1.1a.tar.gz
tar xf openssl-1.1.1a.tar.gz
cd openssl-1.1.1a
./Configure --prefix="$OPENSSL_PREFIX" --openssldir="$OPENSSL_PREFIX" --api=1.1.0 no-shared no-capieng no-srp no-gost no-dgram no-dtls1-method no-dtls1_2-method darwin64-x86_64-cc
make
make test
make install_sw
cd ..
Download Zabbix source and build agent:
git clone https://git.zabbix.com/scm/zbx/zabbix.git
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-libpcre2="$PCRE_PREFIX" --with-openssl="$OPENSSL_PREFIX"
make
make install
#### 使用OpenSSL的静态库构建agent二进制文件
构建OpenSSL时，建议在成功构建后执行run `make test`。即使构建成功，测试有时也会失败。如果出现这种情况，应在继续之前研究并解决问题。
假设PCRE和OpenSSL静态库将安装在`$HOME/static-libs`中。我们将使用PCRE2 10.39和OpenSSL 1.1.1a。
PCRE_PREFIX="$HOME/static-libs/pcre2-10.39"
OPENSSL_PREFIX="$HOME/static-libs/openssl-1.1.1a"
让我们在`static-libs-source`中构建静态库：
mkdir static-libs-source
cd static-libs-source
下载并构建支持Unicode属性的PCRE：
curl --remote-name https://github.com/PhilipHazel/pcre2/releases/download/pcre2-10.39/pcre2-10.39.tar.gz
tar xf pcre2-10.39.tar.gz
cd pcre2-10.39
./configure --prefix="$PCRE_PREFIX" --disable-shared --enable-static --enable-unicode-properties
make
make check
make install
cd ..
下载并构建OpenSSL：
curl --remote-name https://www.openssl.org/source/openssl-1.1.1a.tar.gz
tar xf openssl-1.1.1a.tar.gz
cd openssl-1.1.1a
./Configure --prefix="$OPENSSL_PREFIX" --openssldir="$OPENSSL_PREFIX" --api=1.1.0 no-shared no-capieng no-srp no-gost no-dgram no-dtls1-method no-dtls1_2-method darwin64-x86_64-cc
make
make test
make install_sw
cd ..
下载Zabbix源码并构建agent：
git clone https://git.zabbix.com/scm/zbx/zabbix.git
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-libpcre2="$PCRE_PREFIX" --with-openssl="$OPENSSL_PREFIX"
make
make install
#### Building agent binaries with static libraries without TLS
Let's assume that PCRE static libraries will be installed in
`$HOME/static-libs`. We will use PCRE2 10.39.
PCRE_PREFIX="$HOME/static-libs/pcre2-10.39"
Download and build PCRE with Unicode properties support:
mkdir static-libs-source
cd static-libs-source
curl --remote-name https://github.com/PhilipHazel/pcre2/releases/download/pcre2-10.39/pcre2-10.39.tar.gz
tar xf pcre2-10.39.tar.gz
cd pcre2-10.39
./configure --prefix="$PCRE_PREFIX" --disable-shared --enable-static --enable-unicode-properties
make
make check
make install
Download Zabbix source and build agent:
git clone https://git.zabbix.com/scm/zbx/zabbix.git
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-libpcre2="$PCRE_PREFIX"
make
make install
#### 不使用TLS的静态库构建agent二进制文件
假设PCRE静态库将被安装到
`$HOME/static-libs`目录。我们将使用PCRE2 10.39版本。
PCRE_PREFIX="$HOME/static-libs/pcre2-10.39"
下载并构建支持Unicode属性的PCRE库：
mkdir static-libs-source
cd static-libs-source
curl --remote-name https://github.com/PhilipHazel/pcre2/releases/download/pcre2-10.39/pcre2-10.39.tar.gz
tar xf pcre2-10.39.tar.gz
cd pcre2-10.39
./configure --prefix="$PCRE_PREFIX" --disable-shared --enable-static --enable-unicode-properties
make
make check
make install
下载Zabbix源码并构建agent：
git clone https://git.zabbix.com/scm/zbx/zabbix.git
cd zabbix
./bootstrap.sh
./configure --sysconfdir=/usr/local/etc/zabbix --enable-agent --enable-ipv6 --with-libpcre2="$PCRE_PREFIX"
make
make install
#### Building inventory
#### 构建资产清单
### Built-in objects
### 内置对象
#### Built-in
The following plugins for Zabbix agent 2 are available out-of-the-box. Click on the plugin name to go to the plugin repository with additional information.
|Plugin name|Description|[Supported item keys](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2)|Comments|
|--|--|--|----|
|Agent|Metrics of the Zabbix agent being used.|agent.hostname, agent.ping, agent.version|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[Ceph](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/ceph/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Ceph monitoring.|ceph.df.details, ceph.osd.stats, ceph.osd.discovery, ceph.osd.dump,<br>ceph.ping, ceph.pool.discovery, ceph.status| |
|[CPU](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/cpu?at=refs%2Fheads%2Frelease%2F6.0)|System CPU monitoring (number of CPUs/CPU cores, discovered CPUs, utilization percentage).|system.cpu.discovery, system.cpu.num, system.cpu.util|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[Docker](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/docker/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Monitoring of Docker containers.|docker.container\_info, docker.container\_stats, docker.containers, docker.containers.discovery,<br>docker.data\_usage, docker.images, docker.images.discovery, docker.info, docker.ping|See also:<br>[Configuration parameters](/manual/appendix/config/zabbix_agent2_plugins/d_plugin)|
|File|File metrics collection.|vfs.file.cksum, vfs.file.contents, vfs.file.exists, vfs.file.md5sum,<br>vfs.file.regexp, vfs.file.regmatch, vfs.file.size, vfs.file.time|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[Kernel](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/kernel?at=refs%2Fheads%2Frelease%2F6.0)|Kernel monitoring.|kernel.maxfiles, kernel.maxproc|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[Log](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/log?at=refs%2Fheads%2Frelease%2F6.0)|Log file monitoring.|log, log.count, logrt, logrt.count|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).<br><br>See also:<br>Plugin configuration parameters ([Unix](/manual/appendix/config/zabbix_agent2)/[Windows](/manual/appendix/config/zabbix_agent2_win))|
|[Memcached](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/memcached/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Memcached server monitoring.|memcached.ping, memcached.stats| |
|[Modbus](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/modbus/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Reads Modbus data.|modbus.get|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[MQTT](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/mqtt/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Receives published values of MQTT topics.|mqtt.get|To configure encrypted connection to the MQTT broker, specify the TLS parameters in the agent configuration file as [named session](#named_sessions) or [default](#default-values) parameters. Currently, TLS parameters cannot be passed as item key parameters. |
|[MySQL](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/mysql/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Monitoring of MySQL and its forks.|mysql.custom.query, mysql.db.discovery, mysql.db.size, mysql.get\_status\_variables,<br>mysql.ping, mysql.replication.discovery, mysql.replication.get\_slave\_status, mysql.version|To configure encrypted connection to the database, specify the TLS parameters in the agent configuration file as [named session](#named_sessions) or [default](#default-values) parameters. Currently, TLS parameters cannot be passed as item key parameters.<br><br>`mysql.custom.query` item key is supported since Zabbix 6.0.21.|
|[NetIf](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/net/netif?at=refs%2Fheads%2Frelease%2F6.0)|Monitoring of network interfaces.|net.if.collisions, net.if.discovery, net.if.in, net.if.out, net.if.total|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[Oracle](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/oracle/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Oracle Database monitoring.|oracle.diskgroups.stats, oracle.diskgroups.discovery, oracle.archive.info, oracle.archive.discovery,<br>oracle.cdb.info, oracle.custom.query, oracle.datafiles.stats, oracle.db.discovery,<br>oracle.fra.stats, oracle.instance.info, oracle.pdb.info, oracle.pdb.discovery,<br>oracle.pga.stats, oracle.ping, oracle.proc.stats, oracle.redolog.info,<br>oracle.sga.stats, oracle.sessions.stats, oracle.sys.metrics, oracle.sys.params,<br>oracle.ts.stats, oracle.ts.discovery, oracle.user.info, oracle.version|Install the [Oracle Instant Client](https://www.oracle.com/database/technologies/instant-client/downloads.html) before using the plugin.|
|[Proc](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/proc?at=refs%2Fheads%2Frelease%2F6.0)|Process CPU utilization percentage.|proc.cpu.util|Supported key has the same parameters as Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent).|
|[Redis](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/redis/README.md?at=refs%2Fheads%2Frelease%2F6.0)|Redis server monitoring.|redis.config, redis.info, redis.ping, redis.slowlog.count| |
|[Smart](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/smart?at=refs%2Fheads%2Frelease%2F6.0)|S.M.A.R.T. monitoring.|smart.attribute.discovery, smart.disk.discovery, smart.disk.get|The minimum required smartctl version is 7.1. <br> Sudo/root access rights to smartctl are required for the user executing Zabbix agent 2. The plugin uses only the following commands: <br> ``/usr/sbin/smartctl -a *``<br> ``/usr/sbin/smartctl --scan *`` <br> ``/usr/sbin/smartctl -j -V``<br><br>Supported [keys](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2) can be used with Zabbix agent 2 only on Linux/Windows, both as a passive and active check.<br>See also:<br>[Configuration parameters](/manual/appendix/config/zabbix_agent2_plugins/smart_plugin)|
|[Swap](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/swap?at=refs%2Fheads%2Frelease%2F6.0)|Swap space size in bytes/percentage.|system.swap.size|Supported key has the same parameters as Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent).|
|SystemRun|Runs specified command.|system.run|Supported key has the same parameters as Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent).<br><br>See also:<br>Plugin configuration parameters ([Unix](/manual/appendix/config/zabbix_agent2)/[Windows](/manual/appendix/config/zabbix_agent2_win))|
|Systemd|Monitoring of systemd services.|systemd.unit.discovery, systemd.unit.get, systemd.unit.info| |
|[TCP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/net/tcp?at=refs%2Fheads%2Frelease%2F6.0)|TCP connection availability check.|net.tcp.port|Supported key has the same parameters as Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent).|
|[UDP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/net/udp?at=refs%2Fheads%2Frelease%2F6.0)|Monitoring of the UDP services availability and performance.|net.udp.service, net.udp.service.perf|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[Uname](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/uname?at=refs%2Fheads%2Frelease%2F6.0)|Retrieval of information about the system.|system.hostname, system.sw.arch, system.uname|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[Uptime](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/uptime?at=refs%2Fheads%2Frelease%2F6.0)|System uptime metrics collection.|system.uptime|Supported key has the same parameters as Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent).|
|[VFSDev](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/vfs/dev?at=refs%2Fheads%2Frelease%2F6.0)|VFS metrics collection.|vfs.dev.discovery, vfs.dev.read, vfs.dev.write|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[WebCertificate](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/web/certificate?at=refs%2Fheads%2Frelease%2F6.0)|Monitoring of TLS/SSL website certificates.|web.certificate.get| |
|[WebPage](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/web/page?at=refs%2Fheads%2Frelease%2F6.0)|Web page monitoring.|web.page.get, web.page.perf, web.page.regexp|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[ZabbixAsync](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/zabbix/async?at=refs%2Fheads%2Frelease%2F6.0)|Asynchronous metrics collection.|net.tcp.listen, net.udp.listen, sensor, system.boottime, system.cpu.intr, system.cpu.load,<br>system.cpu.switches, system.hw.cpu, system.hw.macaddr, system.localtime, system.sw.os,<br>system.swap.in, system.swap.out, vfs.fs.discovery|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[ZabbixStats](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/zabbix/stats?at=refs%2Fheads%2Frelease%2F6.0)|Zabbix server/proxy internal metrics or number of delayed items in a queue.|zabbix.stats|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
|[ZabbixSync](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/zabbix/sync?at=refs%2Fheads%2Frelease%2F6.0)|Synchronous metrics collection.|net.dns, net.dns.record, net.tcp.service, net.tcp.service.perf, proc.mem,<br>proc.num, system.hw.chassis, system.hw.devices, system.sw.packages,<br>system.users.num, vfs.dir.count, vfs.dir.size, vfs.fs.get, vfs.fs.inode,<br>vfs.fs.size, vm.memory.size.|Supported keys have the same parameters as Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent).|
#### 内置
以下插件为Zabbix agent 2提供开箱即用的支持。点击插件名称可跳转至插件仓库获取更多信息。
| 插件名称 | 描述 | [Supported item keys](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2) | 备注 |
|--|--|--|----|
| Agent | 被使用的Zabbix agent指标。 | agent.hostname, agent.ping, agent.version | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Ceph](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/ceph/README.md?at=refs%2Fheads%2Frelease%2F6.0) | Ceph监控。 | ceph.df.details, ceph.osd.stats, ceph.osd.discovery, ceph.osd.dump,<br>ceph.ping, ceph.pool.discovery, ceph.status | |
| [CPU](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/cpu?at=refs%2Fheads%2Frelease%2F6.0) | 系统CPU监控（CPU数量/核心数、发现的CPU、利用率百分比）。 | system.cpu.discovery, system.cpu.num, system.cpu.util | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Docker](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/docker/README.md?at=refs%2Fheads%2Frelease%2F6.0) | Docker容器监控。 | docker.container\_info, docker.container\_stats, docker.containers, docker.containers.discovery,<br>docker.data\_usage, docker.images, docker.images.discovery, docker.info, docker.ping | 另见：<br>[Configuration parameters](/manual/appendix/config/zabbix_agent2_plugins/d_plugin) |
| File | 文件指标收集。 | vfs.file.cksum, vfs.file.contents, vfs.file.exists, vfs.file.md5sum,<br>vfs.file.regexp, vfs.file.regmatch, vfs.file.size, vfs.file.time | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Kernel](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/kernel?at=refs%2Fheads%2Frelease%2F6.0) | 内核监控。 | kernel.maxfiles, kernel.maxproc | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Log](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/log?at=refs%2Fheads%2Frelease%2F6.0) | 日志file监控。 | log, log.count, logrt, logrt.count | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。<br><br>另见：<br>插件配置参数 ([Unix](/manual/appendix/config/zabbix_agent2)/[Windows](/manual/appendix/config/zabbix_agent2_win)) |
| [Memcached](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/memcached/README.md?at=refs%2Fheads%2Frelease%2F6.0) | Memcached服务器监控。 | memcached.ping, memcached.stats | |
| [Modbus](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/modbus/README.md?at=refs%2Fheads%2Frelease%2F6.0) | 读取Modbus数据。 | modbus.get | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [MQTT](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/mqtt/README.md?at=refs%2Fheads%2Frelease%2F6.0) | 接收MQTT主题的发布值。 | mqtt.get | 要配置与MQTT代理的加密连接，请在agent配置file中指定TLS参数作为[命名会话](#named_sessions)或[默认](#default-values)参数。目前，TLS参数不能作为监控项键参数传递。 |
| [MySQL](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/mysql/README.md?at=refs%2Fheads%2Frelease%2F6.0) | MySQL及其分支的监控。 | mysql.custom.query, mysql.db.discovery, mysql.db.size, mysql.get\_status\_variables,<br>mysql.ping, mysql.replication.discovery, mysql.replication.get\_slave\_status, mysql.version | 要配置与数据库的加密连接，请在agent配置file中指定TLS参数作为[命名会话](#named_sessions)或[默认](#default-values)参数。目前，TLS参数不能作为监控项键参数传递。<br><br>`mysql.custom.query` 监控项键自Zabbix 6.0.21起支持。 |
| [NetIf](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/net/netif?at=refs%2Fheads%2Frelease%2F6.0) | 网络接口监控。 | net.if.collisions, net.if.discovery, net.if.in, net.if.out, net.if.total | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Oracle](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/oracle/README.md?at=refs%2Fheads%2Frelease%2F6.0) | Oracle数据库监控。 | oracle.diskgroups.stats, oracle.diskgroups.discovery, oracle.archive.info, oracle.archive.discovery,<br>oracle.cdb.info, oracle.custom.query, oracle.datafiles.stats, oracle.db.discovery,<br>oracle.fra.stats, oracle.instance.info, oracle.pdb.info, oracle.pdb.discovery,<br>oracle.pga.stats, oracle.ping, oracle.proc.stats, oracle.redolog.info,<br>oracle.sga.stats, oracle.sessions.stats, oracle.sys.metrics, oracle.sys.params,<br>oracle.ts.stats, oracle.ts.discovery, oracle.user.info, oracle.version | 使用插件前请安装[Oracle Instant Client](https://www.oracle.com/database/technologies/instant-client/downloads.html)。 |
| [Proc](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/proc?at=refs%2Fheads%2Frelease%2F6.0) | 进程CPU利用率百分比。 | proc.cpu.util | 支持的键值与Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Redis](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/redis/README.md?at=refs%2Fheads%2Frelease%2F6.0) | Redis服务器监控。 | redis.config, redis.info, redis.ping, redis.slowlog.count | |
| [Smart](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/smart?at=refs%2Fheads%2Frelease%2F6.0) | S.M.A.R.T.监控。 | smart.attribute.discovery, smart.disk.discovery, smart.disk.get | 最低要求的smartctl version为7.1。<br>执行Zabbix agent 2的用户需要sudo/root权限访问smartctl。插件仅使用以下命令：<br>``/usr/sbin/smartctl -a *``<br>``/usr/sbin/smartctl --scan *``<br>``/usr/sbin/smartctl -j -V``<br><br>支持的[keys](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2)仅在Linux/Windows上可与Zabbix agent 2一起使用，作为被动或主动检查。<br>另见：<br>[Configuration parameters](/manual/appendix/config/zabbix_agent2_plugins/smart_plugin) |
| [Swap](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/swap?at=refs%2Fheads%2Frelease%2F6.0) | 交换空间大小（字节/百分比）。 | system.swap.size | 支持的键值与Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| SystemRun | 运行指定命令。 | system.run | 支持的键值与Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。<br><br>另见：<br>插件配置参数 ([Unix](/manual/appendix/config/zabbix_agent2)/[Windows](/manual/appendix/config/zabbix_agent2_win)) |
| Systemd | systemd服务监控。 | systemd.unit.discovery, systemd.unit.get, systemd.unit.info | |
| [TCP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/net/tcp?at=refs%2Fheads%2Frelease%2F6.0) | TCP连接可用性检查。 | net.tcp.port | 支持的键值与Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [UDP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/net/udp?at=refs%2Fheads%2Frelease%2F6.0) | UDP服务可用性和性能监控。 | net.udp.service, net.udp.service.perf | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Uname](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/uname?at=refs%2Fheads%2Frelease%2F6.0) | 系统信息检索。 | system.hostname, system.sw.arch, system.uname | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [Uptime](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/system/uptime?at=refs%2Fheads%2Frelease%2F6.0) | 系统运行时间指标收集。 | system.uptime | 支持的键值与Zabbix agent [key](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [VFSDev](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/vfs/dev?at=refs%2Fheads%2Frelease%2F6.0) | VFS指标收集。 | vfs.dev.discovery, vfs.dev.read, vfs.dev.write | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [WebCertificate](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/web/certificate?at=refs%2Fheads%2Frelease%2F6.0) | TLS/SSL网站证书监控。 | web.certificate.get | |
| [WebPage](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/web/page?at=refs%2Fheads%2Frelease%2F6.0) | 网页监控。 | web.page.get, web.page.perf, web.page.regexp | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [ZabbixAsync](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/zabbix/async?at=refs%2Fheads%2Frelease%2F6.0) | 异步指标收集。 | net.tcp.listen, net.udp.listen, sensor, system.boottime, system.cpu.intr, system.cpu.load,<br>system.cpu.switches, system.hw.cpu, system.hw.macaddr, system.localtime, system.sw.os,<br>system.swap.in, system.swap.out, vfs.fs.discovery | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [ZabbixStats](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/zabbix/stats?at=refs%2Fheads%2Frelease%2F6.0) | Zabbix server/proxy内部指标或队列中延迟监控项的数量。 | zabbix.stats | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
| [ZabbixSync](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/src/go/plugins/zabbix/sync?at=refs%2Fheads%2Frelease%2F6.0) | 同步指标收集。 | net.dns, net.dns.record, net.tcp.service, net.tcp.service.perf, proc.mem,<br>proc.num, system.hw.chassis, system.hw.devices, system.sw.packages,<br>system.users.num, vfs.dir.count, vfs.dir.size, vfs.fs.get, vfs.fs.inode,<br>vfs.fs.size, vm.memory.size. | 支持的键值与Zabbix agent [keys](/manual/config/items/itemtypes/zabbix_agent)具有相同参数。 |
##### Bulk processing
Bulk processing is supported for dependent items. To enable caching and indexing,
the *Prometheus pattern* preprocessing must be the **first** preprocessing step.
When *Prometheus pattern* is first preprocessing step then the parsed Prometheus
data is cached and indexed by the first `<label>==<value>` condition in the
*Prometheus pattern* preprocessing step. This cache is reused when processing
other dependent items in this batch. For optimal performance, the first label
should be the one with most different values.
If there is other preprocessing to be done before the first step, it should be
moved either to the master item or to a new dependent item which would be used as
the master item for the dependent items.
##### 批量处理
批量处理支持依赖监控项. 要启用缓存和索引功能,
*Prometheus模式*预处理必须作为**第一个**预处理步骤.
当*Prometheus模式*作为首个预处理步骤时, 解析后的Prometheus
数据会被缓存并通过*Prometheus模式*预处理步骤中的第一个`<label>==<value>`条件
建立索引. 在处理同一批次中其他依赖监控项时会复用此缓存.
为实现最佳性能, 第一个标签应选择具有最多不同值的那个.
若在首个步骤前还需进行其他预处理, 应将其移至主监控项,
或新建一个依赖监控项作为这些依赖监控项的主监控项.
##### Bulk processing for Prometheus metrics
As bulk processing of dependent items has been introduced in the preprocessing
queue for Prometheus metrics, dependent items will no longer be processed in
parallel and that may have an affect on how fast they are processed.
##### Prometheus 指标批量处理
由于Prometheus指标的预处理队列中引入了依赖监控项的批量处理机制，依赖监控项将不再并行处理，这可能会影响其处理速度。
#### Bulk processing for Prometheus metrics
Bulk processing of dependent items has been introduced in the preprocessing
queue to improve the performance of retrieving Prometheus metrics.
See [Prometheus checks](/manual/config/items/itemtypes/prometheus#bulk-processing) for more details.
#### Prometheus 指标批量处理
预处理队列中引入了对依赖监控项的批量处理机制，以提升Prometheus指标获取的性能。
详见[批量处理](/manual/config/items/itemtypes/prometheus#批量处理)获取更多细节。
##### Buttons
| | |
|---|---|
||Clone the service.<br>When a service is cloned, its parent links are preserved, while the child links are not.|
##### 按钮
| · | · |
|---|---|
||克隆服务。<br>克隆服务时，将保留其父链接，但不保留子链接。|
##### Buttons
Buttons to the right offer the following options:
| | |
|--|--------|
||Go to map constructor to edit the map content.|
||Add map to the favorites widget in the [Dashboard](dashboard).|
||The map is in the favorites widget in the [Dashboard](dashboard). Click to remove map from the favorites widget.|
View mode buttons being common for all sections are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
右侧按钮提供以下选项：
| | |
|--|--------|
|  | 进入地图编辑器修改地图内容。 |
|  | 将地图添加至[Dashboard](dashboard)的收藏部件中。 |
|  | 该地图已在[Dashboard](dashboard)的收藏部件中。点击可从收藏部件移除地图。 |
所有版块通用的视图模式按钮说明详见
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面。
##### Buttons
*Create host* allows to create a [new host](/manual/config/hosts/host).
This button is available for Admin and Super Admin users only.
View mode buttons being common for all sections are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
*创建主机* 允许create一个[new host](/manual/config/hosts/host).
该按钮仅对管理员和超级管理员用户可见.
所有模块通用的视图模式按钮说明请参阅
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面.
##### Buttons
The button to the right offers the following option:
| | |
|--|--------|
||Export content from all pages to a CSV file.|
View mode buttons, being common for all sections, are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
右侧按钮提供以下选项：
| | |
|--|--------|
|  | 将所有页面内容导出为CSV file。 |
视图模式按钮作为所有章节的通用功能，其说明详见
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面。
##### Buttons
View mode buttons being common for all sections are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
在 [监测](/manual/web_interface/frontend_sections/monitoring#查看模式按钮) 页面中描述了所有节的常见视图模式按钮。
##### Buttons
View mode buttons being common for all sections are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
所有章节通用的视图模式按钮说明详见
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面。
##### Buttons
View mode buttons being common for all sections are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
所有章节通用的视图模式按钮说明请参阅
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面。
##### Buttons
View mode buttons being common for all sections are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
所有章节通用的视图模式按钮说明请参阅
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面。
##### Buttons
View mode buttons being common for all sections are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
所有章节通用的视图模式按钮说明请参阅
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面。
##### Buttons
View mode buttons, being common for all sections, are described on the
[Monitoring](/manual/web_interface/frontend_sections/monitoring#view_mode_buttons)
page.
##### 按钮
视图模式按钮作为所有章节的通用功能，其说明详见
[视图模式按钮](/manual/web_interface/frontend_sections/monitoring#视图模式按钮)
页面。
By default, the widget displays all enabled hosts with valid geographical coordinates defined in the host configuration. It is
possible to configure host filtering in the widget parameters.
The valid host coordinates are:
- Latitude: from -90 to 90 (can be integer or float number)
- Longitude: from -180 to 180 (can be integer or float number)
默认情况下，该部件会显示所有已启用且在地图配置主机中定义了有效地理坐标的主机。
可以在小部件参数中配置主机过滤。
有效的主机坐标为:
- 纬度: 从 -90 到 90 (可以是 integer 或 float 数字)
- 经度: 从-180到180 (可以是integer或float数字)
#### Cache mode parameter for PostgreSQL plugin
New parameters for controlling the cache mode by default or on session name level have been added to the PostgreSQL plugin [configuration](/manual/appendix/config/zabbix_agent2_plugins/postgresql_plugin#parameters):
- `Plugins.PostgreSQL.Default.CacheMode`
- `Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode`
The cache mode parameter may have one of two allowed values: *prepare* (default) or *describe*. Note that "describe" is primarily useful when the environment does not allow prepared statements such as when running a connection pooler like PgBouncer.
#### PostgreSQL 插件的缓存模式参数
PostgreSQL插件[参数](/manual/appendix/config/zabbix_agent2_plugins/postgresql_plugin#参数)新增了用于默认或会话名称级别控制缓存模式的参数:
- `Plugins.PostgreSQL.Default.CacheMode`
- `Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode`
缓存模式参数可接受两个允许值之一: *prepare*(默认)或*describe*. 需注意"describe"主要用于不允许预编译语句的环境，例如运行PgBouncer等连接池时。
#### Calculated items
Calculated items now support not only numeric, but also **text**, **log**, and **character** types of information.
#### 计算型 监控项
计算型监控项现在不仅支持数值类型，还支持**文本**、**日志**和**字符**类型的信息。
#### Calculation time
A trigger is recalculated every time Zabbix server receives a new value
that is part of the expression. When a new value is received, each
function that is included in the expression is recalculated (not just
the one that received the new value).
Additionally, a trigger is recalculated each time when a new value is
received **and** every 30 seconds if [date and time](/manual/appendix/functions/time) and/or
nodata() functions are used in the expression.
[Date and time](/manual/appendix/functions/time) and/or nodata()
functions are recalculated every 30
seconds by the Zabbix history syncer process.
Triggers that reference trend functions **only** are evaluated once per
the smallest time period in the expression. See also [trend functions](/manual/appendix/functions/trends).
#### 计算时间
每次当Zabbix server接收到表达式组成部分的新值时，触发器都会重新计算。当接收到新值时，表达式中包含的每个函数都会重新计算（不仅仅是接收到新值的那个函数）。
此外，触发器在每次接收到新值时都会重新计算，**并且**如果表达式中使用了[date and time](/manual/appendix/functions/time)和/或nodata()函数，则每30秒也会重新计算一次。
[Date and time](/manual/appendix/functions/time)和/或nodata()函数由Zabbix历史同步器进程每30秒重新计算一次。
仅引用趋势函数的触发器会根据表达式中的最小时间周期进行一次评估。另请参阅[trend functions](/manual/appendix/functions/trends)。
#### Calculation time
A trigger is recalculated every time Zabbix server receives a new value
that is part of the expression. When a new value is received, each
function that is included in the expression is recalculated (not just
the one that received the new value).
Additionally, a trigger is recalculated each time when a new value is
received **and** every 30 seconds if time-based functions are used in
the expression.
Time-based functions are **nodata()**, **date()**, **dayofmonth()**,
**dayofweek()**, **time()**, **now()**); they are recalculated every 30
seconds by the Zabbix history syncer process.
Triggers that reference trend functions **only** are evaluated once per
the smallest time period in the expression. See also [trend functions](/manual/appendix/functions/trends).
#### 计算时间
每次 Zabbix server接收到新值时，都会重新计算一次触发器 这是表达式的一部分。当接收到一个新值时，每个表达式中的函数都会重新计算（不仅仅是收到新值的那个）。
此外，每次出现新值时都会重新计算触发器，以及每30秒重新计算，如果使用了基于时间的函数。
如果在表达式中使用基于时间的函数(**nodata()**, **date()**, **dayofmonth()**,
**dayofweek()**, **time()**, **now()**)，触发器就会由Zabbix history syncer进程每30秒重新计算一次。
如果触发器包含趋势数据函数，则根据表达式中最小时间间隔进行评估。 参考 [trend functions](/manual/appendix/functions/trends).
#### Certificate configuration parameters
The following configuration parameters are supported for setting up certificates on Zabbix components.
|Parameter|Mandatory|Description|
|--|-|--------|
|*TLSCAFile*|yes|Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification.<br>If using a certificate chain with multiple members, order the certificates with lower level CA(s) certificates first, followed by higher level CA(s) certificates.<br>Certificates from multiple CAs can be included in a single file.|
|*TLSCRLFile*|no|Full pathname of a file containing [Certificate Revocation Lists (CRL)](#certificate-revocation-lists-crl).|
|*TLSCertFile*|yes|Full pathname of a file containing the certificate.<br>If using a certificate chain with multiple members, order the certificates with the server, proxy, or agent certificate first, followed by lower level CA(s) certificates, and concluded by higher level CA(s) certificates.|
|*TLSKeyFile*|yes|Full pathname of a file containing the private key.<br>Ensure that this file is readable only by the [Zabbix user](/manual/installation/install#create-user-account) by setting appropriate access rights.|
|*TLSServerCertIssuer*|no|Allowed server certificate issuer.|
|*TLSServerCertSubject*|no|Allowed server certificate subject.|
#### 证书配置参数
以下配置参数支持在Zabbix组件上设置证书。
| 参数 | 必选 | 描述 |
|--|-|--------|
| *TLSCAFile* | yes | 包含用于对等证书验证的Top级CA证书的file完整路径名。<br>若使用多级证书链，请按从低级CA证书到高级CA证书的顺序排列。<br>多个CA的证书可包含在单个file中。 |
| *TLSCRLFile* | no | 包含[证书吊销列表(CRL)](#certificate-revocation-lists-crl)的file完整路径名。 |
| *TLSCertFile* | yes | 包含证书的file完整路径名.<br>若使用含多级成员的证书链, 应按照服务器证书、proxy或agent证书优先的顺序排列, 随后是较低级别CA证书, 最后是较高级别CA证书. |
| *TLSKeyFile* | yes | 包含私钥的file的完整路径名.<br>通过设置适当的访问权限，确保该file只能由[Zabbix用户](/manual/installation/install#create-user-account)读取. |
| *TLSServerCertIssuer* | no | 允许的服务器证书颁发者。 |
| *TLSServerCertSubject* | no | 允许的服务器证书主题。 |
#### Certificate Revocation Lists (CRL)
If a certificate is compromised, the Certificate Authority (CA) can revoke it by including the certificate in a Certificate Revocation List (CRL).
CRLs are managed through configuration files and can be specified using the `TLSCRLFile` parameter in server, proxy, and agent configuration files.
For example:
```ini
TLSCRLFile=/home/zabbix/zabbix_crl_file.crt
```
In this case, `zabbix_crl_file.crt` may contain CRLs from multiple CAs, and could look like this:
```ini
-----BEGIN X509 CRL-----
MIIB/DCB5QIBATANBgkqhkiG9w0BAQUFADCBgTETMBEGCgmSJomT8ixkARkWA2Nv
...
treZeUPjb7LSmZ3K2hpbZN7SoOZcAoHQ3GWd9npuctg=
-----END X509 CRL-----
-----BEGIN X509 CRL-----
MIIB+TCB4gIBATANBgkqhkiG9w0BAQUFADB/MRMwEQYKCZImiZPyLGQBGRYDY29t
...
CAEebS2CND3ShBedZ8YSil59O6JvaDP61lR5lNs=
-----END X509 CRL-----
```
The CRL file is loaded only when Zabbix starts.
To update the CRL, restart Zabbix.
::: noteimportant
If Zabbix components are compiled with OpenSSL and CRLs are used, ensure that each top-level and intermediate CA in the certificate chains has a corresponding CRL (even if it is empty) included in the `TLSCRLFile`.
:::
#### 证书撤销列表(CRL)
如果证书遭到泄露，证书颁发机构（CA）可通过将该证书列入证书吊销列表（CRL）来撤销它。
CRL通过配置文件进行管理，可在服务器、proxy和agent配置文件中使用`TLSCRLFile`参数指定。
例如：
```ini
TLSCRLFile=/home/zabbix/zabbix_crl_file.crt
```
在此情况下，`zabbix_crl_file.crt`可能包含来自多个CA的CRL，其内容可能如下所示：
```ini
-----BEGIN X509 CRL-----
MIIB/DCB5QIBATANBgkqhkiG9w0BAQUFADCBgTETMBEGCgmSJomT8ixkARkWA2Nv
...
treZeUPjb7LSmZ3K2hpbZN7SoOZcAoHQ3GWd9npuctg=
-----END X509 CRL-----
-----BEGIN X509 CRL-----
MIIB+TCB4gIBATANBgkqhkiG9w0BAQUFADB/MRMwEQYKCZImiZPyLGQBGRYDY29t
...
CAEebS2CND3ShBedZ8YSil59O6JvaDP61lR5lNs=
-----END X509 CRL-----
```
CRL file仅在Zabbix启动时加载。
要update CRL，需重启Zabbix。
::: noteimportant
如果Zabbix组件使用OpenSSL编译且启用了CRL，请确保证书链中每个Top级和中间CA都在`TLSCRLFile`中包含对应的CRL（即使该CRL为空）。
:::
#### Change count
A new [history function](/manual/appendix/functions/history) **changecount()** has been added allowing to count the
number of changes between adjacent values. The function supports three different modes for counting all changes, only
decreases, or only increases. As an example, it can be used to track changes in the number of users or the number of
system uptime decreases.
#### 变更计数
新增了一个[history function](/manual/appendix/functions/history) **changecount()** 函数，用于计算相邻值之间的变更次数。该函数支持三种不同模式：统计所有变更、仅统计减少次数或仅统计增加次数。例如，可用于追踪用户数量变化或系统运行时间减少次数。
#### Change dashboard owner
Available only for admins and super admins.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 2
}
```
#### 更改仪表盘所有者
仅限管理员和超级管理员使用。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.update",
"params": {
"dashboardid": "2",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 2
}
```
#### Change hosts monitored by a proxy
Update the proxy to monitor the two given hosts.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"hosts": [
"10294",
"10295"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10293"
]
},
"id": 1
}
```
#### Change hosts monitored by a proxy 改变一个主机的代理
Update the proxy to monitor the two given hosts.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"hosts": [
"10294",
"10295"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10293"
]
},
"id": 1
}
```
#### Change hosts monitored by a proxy
Update the proxy to monitor the two given hosts.
Request:
```json
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"hosts": [
{
"hostid": "10294"
},
{
"hostid": "10295"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10293"
]
},
"id": 1
}
```
#### 更改由 proxy 监控的主机
更新proxy以监控给定的两个主机.
请求:
```json
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"hosts": [
{
"hostid": "10294"
},
{
"hostid": "10295"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10293"
]
},
"id": 1
}
```
##### Change indicator
The following parameters are supported if *Advanced configuration* is set to "Enabled", and *Show* is set to "Change indicator".
|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|*Change indicator ↑ color*|1|up_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: `""` (empty).|
|*Change indicator ↓ color*|1|down_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: `""` (empty).|
|*Change indicator ↕ color*|1|updown_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: `""` (empty).|
##### 变化指示器
若*高级配置*设为"启用"且*显示*设为"变更指示器"，则支持以下参数。
| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| *Change indicator ↑ color* | 1 | up_color | 十六进制颜色代码（例如`FF0000`）。<br><br>默认值：`""`（空）。 |
| *Change indicator ↓ color* | 1 | down_color | 十六进制颜色代码（例如`FF0000`）。<br><br>默认值：`""`（空）。 |
| *Change indicator ↕ color* | 1 | updown_color | 十六进制颜色代码（例如`FF0000`）。<br><br>默认值：`""`（空）。 |
#### Change map owner
Available only for admins and super admins.
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.update",
"params": {
"sysmapid": "9",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 2
}
```
#### 更改地图所有者
仅限管理员和超级管理员使用。
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.update",
"params": {
"sysmapid": "9",
"userid": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 2
}
```
#### Change proxy status
Change the proxy to an active proxy and rename it to "Active proxy".
Request:
```json
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"host": "Active proxy",
"status": "5"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10293"
]
},
"id": 1
}
```
#### 更改 proxy 状态
将proxy更改为活动proxy并将其重命名为"活动proxy".
请求:
```json
{
"jsonrpc": "2.0",
"method": "proxy.update",
"params": {
"proxyid": "10293",
"host": "Active proxy",
"status": "5"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10293"
]
},
"id": 1
}
```
#### Change script command
Change the command of the script to "/bin/ping -c 10 {HOST.CONN}
2>&1".
Request:
```json
{
"jsonrpc": "2.0",
"method": "script.update",
"params": {
"scriptid": "1",
"command": "/bin/ping -c 10 {HOST.CONN} 2>&1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"1"
]
},
"id": 1
}
```
#### 更改脚本命令
将脚本命令修改为 "/bin/ping -c 10 {HOST.CONN}
2>&1".
请求:
```json
{
"jsonrpc": "2.0",
"method": "script.update",
"params": {
"scriptid": "1",
"command": "/bin/ping -c 10 {HOST.CONN} 2>&1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"1"
]
},
"id": 1
}
```
#### CHANGES IN 6.0.0
#### 6.0.0 版本变更
#### CHANGES IN 6.0.13
New templates are available:
- AWS EC2 by HTTP
- AWS by HTTP
- AWS RDS instance by HTTP
- AWS S3 bucket by HTTP
- Azure by HTTP
- Control-M server by HTTP
- Control-M enterprise manager by HTTP
- Veeam Backup Enterprise Manager by HTTP
- Veeam Backup and Replication by HTTP
See setup instructions for [HTTP templates](/manual/config/templates_out_of_the_box/http).
#### 6.0.13 版本变更
新模板已上线:
- 基于HTTP的AWS EC2监控
- 基于HTTP的AWS监控
- 基于HTTP的AWS RDS实例监控
- 基于HTTP的AWS S3存储桶监控
- 基于HTTP的Azure监控
- 基于HTTP的Control-M服务器监控
- 基于HTTP的Control-M企业管理器监控
- 基于HTTP的Veeam备份企业管理器监控
- 基于HTTP的Veeam备份与复制监控
查看[HTTP templates](/manual/config/templates_out_of_the_box/http)的设置说明.
#### CHANGES IN 6.0.18
#### 6.0.18 版本变更
#### CHANGES IN 6.0.20
New templates are available:
- [AWS ECS Cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_ecs_http?at=refs%2Fheads%2Frelease%2F6.0) (along with its [Serverless Cluster version](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_ecs_serverless_http?at=refs%2Fheads%2Frelease%2F6.0))
- [Cisco SD-WAN by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/cisco/cisco_sdwan_http?at=refs%2Fheads%2Frelease%2F6.0)
- [OpenStack by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/openstack?at=refs%2Fheads%2Frelease%2F6.0), which includes *OpenStack Nova by HTTP* template for monitoring OpenStack Nova service
- [PostgreSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/postgresql_odbc?at=refs%2Fheads%2Frelease%2F6.0)
#### 6.0.20 版本变更
新模板已发布:
- [AWS ECS Cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_ecs_http?at=refs%2Fheads%2Frelease%2F6.0) (及其[Serverless Cluster version](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_ecs_serverless_http?at=refs%2Fheads%2Frelease%2F6.0))
- [Cisco SD-WAN by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/cisco/cisco_sdwan_http?at=refs%2Fheads%2Frelease%2F6.0)
- [OpenStack by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/openstack?at=refs%2Fheads%2Frelease%2F6.0), 包含用于监控OpenStack Nova服务的*OpenStack Nova by HTTP*模板
- [PostgreSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/postgresql_odbc?at=refs%2Fheads%2Frelease%2F6.0)
#### CHANGES IN 6.0.21
New template is available:
- [AWS Cost Explorer by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_cost_http?at=release%2F6.0)
#### 6.0.21 版本变更
新模板可用:
- [AWS Cost Explorer by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_cost_http?at=release%2F6.0)
#### CHANGES IN 6.0.22
New templates are available:
- [Acronis Cyber Protect Cloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/acronis?at=refs%2Fheads%2Frelease%2F6.0)
- [HashiCorp Nomad by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nomad?at=refs%2Fheads%2Frelease%2F6.0)
- [MantisBT by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/mantisbt?at=refs%2Fheads%2Frelease%2F6.0)
#### 6.0.22 版本变更
新模板已上线:
- [Acronis Cyber Protect Cloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/acronis?at=refs%2Fheads%2Frelease%2F6.0)
- [HashiCorp Nomad by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nomad?at=refs%2Fheads%2Frelease%2F6.0)
- [MantisBT by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/mantisbt?at=refs%2Fheads%2Frelease%2F6.0)
#### CHANGES IN 6.0.23
**New templates**
New templates are available:
- [FortiGate by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/fortinet/fortigate_http?at=refs%2Fheads%2Frelease%2F6.0)
- [FortiGate by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/fortinet/fortigate_snmp?at=refs%2Fheads%2Frelease%2F6.0)
- [Nextcloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nextcloud?at=refs%2Fheads%2Frelease%2F6.0)
#### 6.0.23 版本变更
**新模板**
可用的新模板:
- [FortiGate by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/fortinet/fortigate_http?at=refs%2Fheads%2Frelease%2F6.0)
- [FortiGate by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/fortinet/fortigate_snmp?at=refs%2Fheads%2Frelease%2F6.0)
- [Nextcloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nextcloud?at=refs%2Fheads%2Frelease%2F6.0)
#### CHANGES IN 6.0.24
**New templates**
New template is available:
- [HPE iLO by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/hpe_ilo_http?at=refs%2Fheads%2Frelease%2F6.0)
**Updated templates**
Integration with OpenShift has been added to [Kubernetes cluster state by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_state_http?at=refs%2Fheads%2Frelease%2F6.0) template.
#### 6.0.24 版本变更
**新模板**
新模板可用:
- [HPE iLO by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/hpe_ilo_http?at=refs%2Fheads%2Frelease%2F6.0)
**更新模板**
OpenShift集成已添加到[Kubernetes cluster state by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_state_http?at=refs%2Fheads%2Frelease%2F6.0)模板中。
#### CHANGES IN 6.0.26
**New templates**
The set of [Azure by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http?at=refs%2Fheads%2Frelease%2F6.0) templates has been supplemented with the Azure Cost Management by HTTP template.
**Updated templates**
[MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0) template has been updated for working with AlwaysOn features such as Failover Cluster Instances (FCI) and Availability Groups (AG). It is now possible to use the template for monitoring a host in cluster, standalone host and host by cluster name. A macro for instance name is no longer used; when the master is switched, it is not required to change any macros:
- new LLD rules and metrics for quorum and quorum members have been added;
- the type of the LLD rules has been changed from “Database monitor” to “Dependent item”;
- items with `db.odbc.discovery` key have been turned into items dependent on the `db.odbc.get` item
- new item has been added - MSSQL DB '{#DBNAME}': Recovery model, which returns the database recovery model under the database discovery;
- new macros, namely, {$MSSQL.BACKUP_FULL.USED}, {$MSSQL.BACKUP_DIFF.USED}, {$MSSQL.BACKUP_LOG.USED}, have been added - those can be used for disabling backup age triggers for a certain database.
#### 6.0.26 版本变更
**新增模板**
[Azure by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http?at=refs%2Fheads%2Frelease%2F6.0)模板集新增了通过HTTP实现的Azure成本管理模板.
**更新模板**
[MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0)模板已更新以支持AlwaysOn功能，例如故障转移集群实例(FCI)和可用性组(AG). 该模板现在可用于监控集群中的一个主机、独立主机以及通过集群名称监控主机. 不再使用实例名称宏；当主节点切换时，无需更改任何宏:
- 新增了仲裁和仲裁成员的LLD规则及指标;
- 将LLD规则类型从"数据库监控器"更改为"依赖监控项";
- 具有`db.odbc.discovery`键的监控项已转换为依赖`db.odbc.get` 监控项的监控项;
- 新增监控项 - MSSQL数据库'{#DBNAME}': 恢复模型，该模型在数据库发现下返回数据库恢复模型;
- 新增宏变量，包括{$MSSQL.BACKUP_FULL.USED}、{$MSSQL.BACKUP_DIFF.USED}、{$MSSQL.BACKUP_LOG.USED}，这些宏可用于禁用特定数据库的备份年龄触发器.
#### CHANGES IN 6.0.27
**New templates**
A new template is available:
- [YugabyteDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/yugabytedb_http?at=refs%2Fheads%2Frelease%2F6.0), which includes the *YugabyteDB Cluster by HTTP* template for monitoring each YugabyteDB cluster.
#### 6.0.27 版本变更
**新模板**
提供新模板:
- [YugabyteDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/yugabytedb_http?at=refs%2Fheads%2Frelease%2F6.0), 包含用于监控每个YugabyteDB集群的*YugabyteDB Cluster by HTTP*模板.
#### CHANGES IN 6.0.28
**New templates**
New templates are available:
- [AWS ELB Application Load Balancer by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_elb_http?at=refs%2Fheads%2Frelease%2F6.0)
- [Check Point Next Generation Firewall by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/checkpoint/quantum_ngfw_snmp?at=refs%2Fheads%2Frelease%2F6.0)
- [MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0)
#### 6.0.28 版本变更
**新模板**
可用的新模板:
- [AWS ELB Application Load Balancer by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_elb_http?at=refs%2Fheads%2Frelease%2F6.0)
- [Check Point Next Generation Firewall by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/checkpoint/quantum_ngfw_snmp?at=refs%2Fheads%2Frelease%2F6.0)
- [MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0)
#### CHANGES IN 6.0.29
**New templates**
A new template is available:
- [Oracle Cloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/oracle_cloud?at=refs%2Fheads%2Frelease%2F6.0), a master template that discovers various Oracle Cloud Infrastructure (OCI) services and resources.
**Updated templates**
- [FortiGate by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/fortinet/fortigate_snmp?at=refs%2Fheads%2Frelease%2F6.0) template has been supplemented with metrics regarding VPN, high availability (HA), wireless termination points (WTPs), SD-WAN health checks, and HW sensors.
- [MySQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mysql_odbc/README.md?at=refs%2Fheads%2Frelease%2F6.0) template has been supplemented with the items "MySQL: Get database" and "MySQL: Get replication". The LLD rules "Database discovery" and "Replication discovery" have been changed to the "Dependent item" type.
- [Oracle by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/oracle_odbc/README.md?at=refs%2Fheads%2Frelease%2F6.0) template has been supplemented with the items "Oracle: Get archive log", "Oracle: Get ASM disk groups", "Oracle: Get database", "Oracle: Get PDB", and "Oracle: Get tablespace". The LLD rules "Archive log discovery", "ASM disk groups discovery", "Database discovery", "PDB discovery", and "Tablespace discovery" have been changed to the "Dependent item" type.
- The VMware Hypervisor template within the [VMware](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware?at=refs%2Fheads%2Frelease%2F6.0) and [VMware FQDN](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware_fqdn?at=release%2F6.0) template sets has been supplemented with a new LLD rule, "Sensor discovery".
#### 6.0.29 版本变更
**新增模板**
新增以下模板：
- [Oracle Cloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/oracle_cloud?at=refs%2Fheads%2Frelease%2F6.0)，一个主模板，用于发现各种Oracle云基础设施(OCI)服务和资源。
**更新模板**
- [FortiGate by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/fortinet/fortigate_snmp?at=refs%2Fheads%2Frelease%2F6.0)模板新增了关于VPN、高可用性(HA)、无线终端点(WTPs)、SD-WAN健康检查和硬件传感器的指标。
- [MySQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mysql_odbc/README.md?at=refs%2Fheads%2Frelease%2F6.0)模板新增了监控项"MySQL: 获取数据库"和"MySQL: 获取复制"。LLD规则"数据库发现"和"复制发现"已更改为"依赖监控项"类型。
- [Oracle by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/oracle_odbc/README.md?at=refs%2Fheads%2Frelease%2F6.0)模板新增了监控项"Oracle: 获取归档日志"、"Oracle: 获取ASM磁盘组"、"Oracle: 获取数据库"、"Oracle: 获取PDB"和"Oracle: 获取表空间"。LLD规则"归档日志发现"、"ASM磁盘组发现"、"数据库发现"、"PDB发现"和"表空间发现"已更改为"依赖监控项"类型。
- [VMware](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware?at=refs%2Fheads%2Frelease%2F6.0)和[VMware FQDN](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware_fqdn?at=release%2F6.0)模板集中的VMware Hypervisor模板新增了一个新的LLD规则"传感器发现"。
#### CHANGES IN 6.0.2
The template *Generic Java JMX* now contains two discovery rules:
- Garbage collector discovery
- Memory pool discovery
#### 6.0.2 版本变更
模板*Generic Java JMX*现在包含两条发现规则:
- 垃圾收集器发现
- 内存池发现
#### CHANGES IN 6.0.30
**New templates**
The AWS ELB template set has been supplemented with the template [AWS ELB Network Load Balancer by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_elb_http?at=refs%2Fheads%2Frelease%2F6.0).
**Updated templates**
The [OS templates](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/os?at=refs%2Fheads%2Frelease%2F6.0) (agent, SNMP, and Prometheus-based) have been given a mounted filesystem update. In mounted filesystem discovery, the "Space is low" and "Space is critically low" triggers no longer have the absolute threshold and burst condition.
#### 6.0.30 版本变更
**新增模板**
AWS ELB模板集已补充模板[AWS ELB Network Load Balancer by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_elb_http?at=refs%2Fheads%2Frelease%2F6.0).
**更新模板**
[OS templates](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/os?at=refs%2Fheads%2Frelease%2F6.0) (agent, SNMP和基于Prometheus的版本) 已添加挂载文件系统update功能. 在挂载文件系统发现中,"空间不足"和"空间严重不足"触发器不再包含绝对阈值和突发条件.
#### CHANGES IN 6.0.31
**New templates**
A new template is available:
- [Jira Data Center by JMX](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/jira_datacenter_jmx?at=refs%2Fheads%2Frelease%2F6.0), a template for monitoring Jira Data Center health.
#### 6.0.31 版本变更
**新模板**
新增可用模板:
- [Jira Data Center by JMX](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/jira_datacenter_jmx?at=refs%2Fheads%2Frelease%2F6.0), 用于监控Jira Data Center运行状态的模板.
#### CHANGES IN 6.0.32
**New templates**
A new template is available:
The set of [Azure by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http?at=refs%2Fheads%2Frelease%2F6.0) templates has been supplemented with the Azure VM Scale Set by HTTP template.
**Updated templates**
The templates [Zabbix server health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_server?at=refs%2Fheads%2Frelease%2F6.0), [Remote Zabbix server health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_server_remote?at=refs%2Fheads%2Frelease%2F6.0), [Zabbix proxy health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_proxy?at=refs%2Fheads%2Frelease%2F6.0), and [Remote Zabbix proxy health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_proxy_remote?at=refs%2Fheads%2Frelease%2F6.0) have been updated for improved data visualization in item graphs by regrouping the displayed metrics.
#### 6.0.32 版本变更
**新模板**
新增可用模板:
[Azure by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http?at=refs%2Fheads%2Frelease%2F6.0) 模板系列新增了通过HTTP监控的Azure虚拟机规模集模板.
**更新模板**
[Zabbix server health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_server?at=refs%2Fheads%2Frelease%2F6.0), [Remote Zabbix server health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_server_remote?at=refs%2Fheads%2Frelease%2F6.0), [Zabbix proxy health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_proxy?at=refs%2Fheads%2Frelease%2F6.0)和[Remote Zabbix proxy health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_proxy_remote?at=refs%2Fheads%2Frelease%2F6.0)模板已更新, 通过重新分组显示指标来优化监控项图表的数据可视化效果.
#### CHANGES IN 6.0.33
**New templates**
A new template is available:
- [AWS Lambda by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_function_lambda_http?at=refs%2Fheads%2Frelease%2F6.0), a template for monitoring AWS Lambda metrics.
#### 6.0.33 版本变更
**新模板**
提供以下新模板:
- [AWS Lambda by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_function_lambda_http?at=refs%2Fheads%2Frelease%2F6.0), 用于监控AWS Lambda指标的模板.
#### CHANGES IN 6.0.34
**New templates**
New templates are available:
- [GitHub repository by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/github_http?at=refs%2Fheads%2Frelease%2F6.0), a template for monitoring GitHub repositories.
- [Microsoft 365 reports by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/ms365_http?at=refs%2Fheads%2Frelease%2F6.0), a template for monitoring Microsoft 365 services.
#### 6.0.34 版本变更
**新模板**
可用的新模板:
- [GitHub repository by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/github_http?at=refs%2Fheads%2Frelease%2F6.0), 用于监控GitHub仓库的模板
- [Microsoft 365 reports by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/ms365_http?at=refs%2Fheads%2Frelease%2F6.0), 用于监控Microsoft 365服务的模板
#### CHANGES IN 6.0.35
**New templates**
A new template is available:
- [Huawei OceanStor V6 by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/huawei_oceanstor_v6_snmp/README.md?at=release%2F6.0), a template for monitoring SAN Huawei OceanStor V6.
**Updated templates**
- In all [APC templates](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/power/apc?at=refs%2Fheads%2Frelease%2F6.0), the discovery rule for external defective battery packs has been supplemented with a filter to avoid creating unsupported items.
- In the templates [MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0) and [MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0), a timeout has been added and certain item keys have been adjusted to increase monitoring stability.
#### 6.0.35 版本变更
**新增模板**
新增可用模板:
- [Huawei OceanStor V6 by SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/huawei_oceanstor_v6_snmp/README.md?at=release%2F6.0), 用于监控SAN存储设备华为 OceanStor V6的模板.
**更新模板**
- 在所有[APC templates](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/power/apc?at=refs%2Fheads%2Frelease%2F6.0)中, 外部故障电池组的发现规则已补充过滤器, 以避免创建不受支持的监控项.
- 在模板[MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0)和[MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0)中, 增加了超时设置并调整了部分监控项键值以提高监控稳定性.
#### CHANGES IN 6.0.36
**New templates**
A new template is available:
- [Nutanix Prism Element by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nutanix_http/README.md?at=release%2F6.0), a template set that also includes the templates *Nutanix Cluster Prism Element by HTTP* and *Nutanix Host Prism Element by HTTP*.
**Updated templates**
- The template *VMware Hypervisor* within the [VMware](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware/README.md?at=release%2F6.0) and [VMware FQDN](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware_fqdn/README.md?at=release%2F6.0) template sets has been updated with the option to be used as a standalone template.
- [Proxmox VE by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refs%2Fheads%2Frelease%2F6.0) has been updated with new items and trigger prototypes for disk space usage in LXC containers.
- In the template [MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0), the performance counter query has been updated to improve data retrieval. Both *MSSQL by ODBC* and [MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0) template documentation has been reviewed and updated.
#### 6.0.36 版本变更
**新增模板**
现提供以下新模板：
- [Nutanix Prism Element by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nutanix_http/README.md?at=release%2F6.0)，该模板集同时包含*通过HTTP监控Nutanix集群Prism Element*和*通过HTTP监控Nutanix 主机 Prism Element*模板。
**更新模板**
- [VMware](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware/README.md?at=release%2F6.0)和[VMware FQDN](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vmware_fqdn/README.md?at=release%2F6.0)模板集中的*VMware Hypervisor*模板已更新，新增了作为独立模板使用的选项。
- [Proxmox VE by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refs%2Fheads%2Frelease%2F6.0)已更新，新增了针对LXC容器磁盘空间使用情况的监控项和触发器原型。
- 在[MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0)模板中，性能计数器query已更新以优化数据采集。同时修订更新了*MSSQL by ODBC*和[MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0)模板的文档说明。
#### CHANGES IN 6.0.39
**New templates**
A new template is available:
- The [Azure by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http?at=refs%2Fheads%2Frelease%2F6.0) template set has been supplemented with the template *Azure SQL Managed Instance by HTTP*.
**Updated templates**
- All [Dell HTTP and SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell?at=refs%2Fheads%2Frelease%2F6.0) templates have been updated with improvements, including fixes for items, macros, and scripts.
- The templates [MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0) and [MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0) have been updated with filters to include or exclude discovered quorum members by name as well as a service filter that allows filtering by cluster name to exclude empty clusters. Please see [Breaking changes](/manual/installation/upgrade_notes_6039#mssql-zabbix-agent-2-plugin-update) for additional information on *MSSQL by Zabbix agent 2*.
#### 6.0.39 版本变更
**新增模板**
新增可用模板:
- [Azure by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http?at=refs%2Fheads%2Frelease%2F6.0) 模板集已补充 *Azure SQL Managed Instance by HTTP* 模板.
**更新模板**
- 所有 [Dell HTTP and SNMP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell?at=refs%2Fheads%2Frelease%2F6.0) 模板已更新优化，包含对 监控项、宏和脚本的修复.
- 模板 [MSSQL by ODBC](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_odbc?at=refs%2Fheads%2Frelease%2F6.0) 和 [MSSQL by Zabbix agent 2](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/mssql_agent2?at=refs%2Fheads%2Frelease%2F6.0) 已更新过滤器功能，支持按名称包含/排除发现的仲裁成员，以及通过集群名称过滤空集群的服务过滤器. 关于 *MSSQL by Zabbix agent 2* 的更多信息请参阅[重大变更](/manual/installation/upgrade_notes_6039#mssql-zabbix-agent-2-plugin-update).
#### CHANGES IN 6.0.3
A new template *OpenWeatherMap by HTTP* is available.
The following changes have been made in the existing templates:
- In the templates *Windows services by Zabbix agent*, *Windows services by Zabbix agent active*, *Windows by Zabbix agent*, *Windows by Zabbix agent active* {$SERVICE.NAME.NOT_MATCHES} macro value has been updated to filter out an extended list of services.
- The template *PostgreSQL by Zabbix agent 2* now will check the number of slow queries and generate a problem if the amount exceeds a threshold.
#### 6.0.3 版本变更
新增了*通过HTTP获取OpenWeatherMap数据*模板。
现有模板已进行以下变更：
- 在模板*通过Zabbix agent监控Windows服务*、*通过Zabbix agent主动监控Windows服务*、*通过Zabbix agent监控Windows*、*通过Zabbix agent主动监控Windows*中，{$SERVICE.NAME.NOT_MATCHES}宏的值已更新，可过滤更多服务列表。
- *通过Zabbix agent 2监控PostgreSQL*模板现在会检查慢速queries的数量，当超过阈值时generate问题。
#### CHANGES IN 6.0.40
**New templates**
A new template is available:
- The template set [Zabbix server health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_server?at=refs%2Fheads%2Frelease%2F6.0) has been supplemented with the templates *Zabbix server health by Zabbix agent*, *Zabbix server health by Zabbix agent active*, and [Zabbix proxy health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_proxy?at=refs%2Fheads%2Frelease%2F6.0) - with *Zabbix proxy health by Zabbix agent* and *Zabbix proxy health by Zabbix agent active*, enabling the monitoring of internal Zabbix metrics via Zabbix agent.
#### 6.0.40 版本变更
**新增模板**
现提供以下新模板：
- 模板集[Zabbix server health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_server?at=refs%2Fheads%2Frelease%2F6.0)新增了*Zabbix server运行状态（通过Zabbix agent监控）*、*Zabbix server运行状态（通过Zabbix agent主动式监控）*模板
- 模板集[Zabbix proxy health](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zabbix_proxy?at=refs%2Fheads%2Frelease%2F6.0)新增了*Zabbix proxy运行状态（通过Zabbix agent监控）*和*Zabbix proxy运行状态（通过Zabbix agent主动式监控）*模板，支持通过Zabbix agent监控Zabbix内部指标
#### CHANGES IN 6.0.4
New templates are available:
- *TrueNAS SNMP* - monitoring of TrueNAS storage OS by SNMP
- *Proxmox VE by HTTP* - see setup instructions for [HTTP templates](/manual/config/templates_out_of_the_box/http)
The templates *SMART by Zabbix agent 2* and *SMART by Zabbix agent 2 (active)* have been updated:
- the *Attribute discovery* LLD rule has been deleted, whereas the *Disk discovery* LLD rule will now discover disks based on the pre-defined vendor-specific set of attributes;
- **smart.disk.get** item can now return information about a specific disk only, instead of all disks.
New macros allowing to define warning and critical thresholds of the filesystem utilization for virtual file system monitoring have been added to the templates
*HOST-RESOURCES-MIB storage SNMP*,
*Linux by Prom*,
*Linux filesystems SNMP*,
*Linux filesystems by Zabbix agent active*,
*Linux filesystems by Zabbix agent*,
*Mellanox SNMP*,
*PFSense SNMP*,
*Windows filesystems by Zabbix agent active*,
*Windows filesystems by Zabbix agent*.
Filesystem utilization triggers have been updated to use these macros.
#### 6.0.4 版本变更
新增可用模板:
- *TrueNAS SNMP* - 通过SNMP监控TrueNAS存储操作系统
- *Proxmox VE by HTTP* - 查看[HTTP templates](/manual/config/templates_out_of_the_box/http)的设置说明
模板*SMART by Zabbix agent 2*和*SMART by Zabbix agent 2 (active)*已更新:
- 删除了*Attribute discovery* LLD规则，而*Disk discovery* LLD规则现在将基于预定义的供应商特定属性集发现磁盘;
- **smart.disk.get** 监控项现在可以仅返回特定磁盘的信息，而不是所有磁盘.
新增宏定义允许为虚拟file系统监控设置文件系统使用率的警告和严重阈值，这些宏已添加到以下模板:
*主机-RESOURCES-MIB storage SNMP*,
*Linux by Prom*,
*Linux filesystems SNMP*,
*Linux filesystems by Zabbix agent active*,
*Linux filesystems by Zabbix agent*,
*Mellanox SNMP*,
*PFSense SNMP*,
*Windows filesystems by Zabbix agent active*,
*Windows filesystems by Zabbix agent*.
文件系统使用率触发器已更新为使用这些宏.
#### CHANGES IN 6.0.5
New templates are available:
- CockroachDB by HTTP
- Envoy Proxy by HTTP
- HashiCorp Consul Cluster by HTTP
- HashiCorp Consul Node by HTTP
See setup instructions for [HTTP templates](/manual/config/templates_out_of_the_box/http).
#### 6.0.5 版本变更
新模板已发布:
- 基于HTTP的CockroachDB监控模板
- 基于HTTP的Envoy Proxy监控模板
- 基于HTTP的HashiCorp Consul集群监控模板
- 基于HTTP的HashiCorp Consul节点监控模板
查看[HTTP templates](/manual/config/templates_out_of_the_box/http)的配置说明.
#### CHANGES IN 6.0.6
New templates are available:
- HPE MSA 2040 Storage by HTTP
- HPE MSA 2060 Storage by HTTP
- HPE Primera by HTTP
See setup instructions for [HTTP templates](/manual/config/templates_out_of_the_box/http).
#### 6.0.6 版本变更
新模板已发布:
- 基于HTTP的HPE MSA 2040存储
- 基于HTTP的HPE MSA 2060存储
- 基于HTTP的HPE Primera
查看配置说明请访问[HTTP templates](/manual/config/templates_out_of_the_box/http).
#### CHANGES IN 6.0.7
A new [template](/manual/config/templates_out_of_the_box/http) *HPE Synergy by HTTP* is available.
The templates *HashiCorp Consul Node by HTTP* and *HashiCorp Consul Cluster by HTTP* now support Consul namespaces.
#### 6.0.7 版本变更
新增 [template](/manual/config/templates_out_of_the_box/http) *HPE Synergy by HTTP* 模板可用.
模板 *HashiCorp Consul Node by HTTP* 和 *HashiCorp Consul Cluster by HTTP* 现已支持 Consul 命名空间.
#### CHANGES IN 6.0.8
A new [template](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/opnsense_snmp?at=refs%2Fheads%2Frelease%2F6.0) *OPNsense by SNMP* is available.
#### 6.0.8 版本变更
新的[template](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/opnsense_snmp?at=refs%2Fheads%2Frelease%2F6.0) *OPNsense通过SNMP* 模板现已可用.
##### Changes in templates
- The {\#FSLABEL} macro has been added to the corresponding item names
and descriptions in *Windows by Zabbix agent* and *Windows by Zabbix
agent active* templates
- The vfs.file.cksum\[/etc/passwd\] agent item has been changed to
vfs.file.cksum\[/etc/passwd,sha256\]
- A new check zabbix\[process,odbc poller,avg,busy\] has been added to *Zabbix server*, *Zabbix proxy*, *Remote Zabbix server* and *Remote Zabbix proxy* templates. The metric is used for monitoring the average time for which ODBC processes have been busy during the last minute (in percentage).
##### 模板变更
- 在*Windows通过Zabbix agent*和*Windows通过Zabbix agent主动*模板中，已将{\#FSLABEL}宏添加到相应的监控项名称和描述中
- vfs.file.cksum\[/etc/passwd\] agent 监控项已更改为vfs.file.cksum\[/etc/passwd,sha256\]
- 在*Zabbix server*、*Zabbix proxy*、*远程Zabbix server*和*远程Zabbix proxy*模板中新增了zabbix\[process,odbc poller,avg,busy\]检查项。该指标用于监控ODBC进程在过去一分钟内的平均繁忙时间（百分比）
#### Change the IP range of a discovery rule
Change the IP range of a discovery rule to "192.168.2.1-255".
Request:
```json
{
"jsonrpc": "2.0",
"method": "drule.update",
"params": {
"druleid": "6",
"iprange": "192.168.2.1-255"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"druleids": [
"6"
]
},
"id": 1
}
```
#### 修改发现规则的IP范围
将发现规则的IP范围修改为"192.168.2.1-255".
请求:
```json
{
"jsonrpc": "2.0",
"method": "drule.update",
"params": {
"druleid": "6",
"iprange": "192.168.2.1-255"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"druleids": [
"6"
]
},
"id": 1
}
```
#### Changing a host interface port
Change the port of a host interface.
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.update",
"params": {
"interfaceid": "30048",
"port": "30050"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30048"
]
},
"id": 1
}
```
#### 更改主机接口端口
更改一个主机接口的端口.
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.update",
"params": {
"interfaceid": "30048",
"port": "30050"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30048"
]
},
"id": 1
}
```
##### Changing dependency for inherited triggers disabled
The possibility to change dependencies for triggers inherited from a template is now disabled.
The reason is that upon updating the dependencies of a template trigger, the dependencies of
inherited triggers are overwritten. Thus it is more reliable always to set trigger dependencies
only on the root template level.
##### 禁用继承触发器的依赖关系变更
现在已禁用修改从模板继承的触发器依赖关系的功能。
原因是当更新模板触发器的依赖关系时，继承触发器的依赖关系会被覆盖。
因此更可靠的做法是始终仅在根模板层级设置触发器依赖关系。
#### Changing event's severity
Change severity for multiple events and leave a message.
Request:
```json
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": ["20427", "20428"],
"action": 12,
"message": "Maintenance required to fix it.",
"severity": 4
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"eventids": [
"20427",
"20428"
]
},
"id": 1
}
```
#### 更改事件严重性
批量修改事件严重性并留下备注信息
请求:
```json
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": ["20427", "20428"],
"action": 12,
"message": "Maintenance required to fix it.",
"severity": 4
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"eventids": [
"20427",
"20428"
]
},
"id": 1
}
```
#### Changing mappings for one value map.
Request:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.update",
"params": {
"valuemapid": "2",
"mappings": [
{
"type": "0",
"value": "0",
"newvalue": "Online"
},
{
"type": "0",
"value": "1",
"newvalue": "Offline"
}
]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"2"
]
},
"id": 1
}
```
#### 修改单个值映射表的映射关系
请求:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.update",
"params": {
"valuemapid": "2",
"mappings": [
{
"type": "0",
"value": "0",
"newvalue": "Online"
},
{
"type": "0",
"value": "1",
"newvalue": "Offline"
}
]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"2"
]
},
"id": 1
}
```
#### Changing proxy setting
The hosts discovered by different proxies are always treated as
different hosts. While this allows to perform discovery on matching IP
ranges used by different subnets, changing proxy for an already
monitored subnet is complicated because the proxy changes must be also
applied to all discovered hosts.
For example the steps to replace proxy in a discovery rule:
1. disable discovery rule
2. sync proxy configuration
3. replace the proxy in the discovery rule
4. replace the proxy for all hosts discovered by this rule
5. enable discovery rule
#### 修改 proxy 设置
由不同proxies发现的主机始终被视为不同的主机. 虽然这允许对不同子网使用的匹配IP范围执行发现, 但为已监控子网更改proxy会很复杂, 因为proxy变更必须同时应用于所有已发现的主机.
例如替换发现规则中proxy的步骤:
1. 禁用发现规则
2. 同步proxy配置
3. 替换发现规则中的proxy
4. 替换该规则发现的所有主机的proxy
5. 启用发现规则
#### Changing the excluded downtimes for an SLA
Add a planned 4 hour long RAM upgrade downtime on the 6th of April, 2022,
while keeping (needs to be defined anew) a previously existing software upgrade planned on the 4th of July
for the SLA with ID "5".
Request:
```json
{
"jsonrpc": "2.0",
"method": "service.update",
"params": {
"slaid": "5",
"excluded_downtimes": [
{
"name": "Software version upgrade rollout",
"period_from": "1648760400",
"period_to": "1648764900"
},
{
"name": "RAM upgrade",
"period_from": "1649192400",
"period_to": "1649206800"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"slaids": [
"5"
]
},
"id": 1
}
```
#### 更改SLA的排除停机时间
添加一个计划于2022年4月6日进行的4小时RAM升级停机时间，
同时保留（需要重新定义）先前存在的7月4日软件升级计划
针对ID为"5"的SLA。
请求:
```json
{
"jsonrpc": "2.0",
"method": "service.update",
"params": {
"slaid": "5",
"excluded_downtimes": [
{
"name": "Software version upgrade rollout",
"period_from": "1648760400",
"period_to": "1648764900"
},
{
"name": "RAM upgrade",
"period_from": "1649192400",
"period_to": "1649206800"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"slaids": [
"5"
]
},
"id": 1
}
```
#### Changing the interface of an item prototype
Change the host interface that will be used by discovered items.
Request:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.update",
"params": {
"itemid": "27428",
"interfaceid": "132"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27428"
]
},
"id": 1
}
```
#### 修改 监控项 原型的接口
更改将被发现的监控项所使用的主机接口。
请求:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.update",
"params": {
"itemid": "27428",
"interfaceid": "132"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27428"
]
},
"id": 1
}
```
#### Changing the schedule of an SLA
Switch the SLA with ID "5" to a 24x7 schedule.
Request:
```json
{
"jsonrpc": "2.0",
"method": "service.update",
"params": {
"slaid": "5",
"schedule": []
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"slaids": [
"5"
]
},
"id": 1
}
```
#### 更改SLA的计划
将ID为"5"的SLA切换至24x7全天候排程
请求:
```json
{
"jsonrpc": "2.0",
"method": "service.update",
"params": {
"slaid": "5",
"schedule": []
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"slaids": [
"5"
]
},
"id": 1
}
```
#### Changing the size of a graph prototype
Change the size of a graph prototype to 1100 to 400 pixels.
Request:
```json
{
"jsonrpc": "2.0",
"method": "graphprototype.update",
"params": {
"graphid": "439",
"width": 1100,
"height": 400
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"439"
]
},
"id": 1
}
```
#### 修改图形原型大小
将图形原型尺寸修改为1100×400像素
请求:
```json
{
"jsonrpc": "2.0",
"method": "graphprototype.update",
"params": {
"graphid": "439",
"width": 1100,
"height": 400
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"439"
]
},
"id": 1
}
```
#### Changing the standard template properties
Change the technical name of the template to "Linux by Zabbix agent Custom", the visible name to "My template", and update the template description.
Request:
```json
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"host": "Linux by Zabbix agent Custom",
"name": "My template",
"description": "This is a custom Linux template."
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10086"
]
},
"id": 1
}
```
#### 更改标准模板属性
将模板的技术名称更改为"Linux by Zabbix agent Custom"，可见名称改为"My template"，并update模板描述。
请求：
```json
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"host": "Linux by Zabbix agent Custom",
"name": "My template",
"description": "This is a custom Linux template."
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10086"
]
},
"id": 1
}
```
#### Changing the value of a global macro
Change the value of a global macro to "public".
Request:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.updateglobal",
"params": {
"globalmacroid": "1",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"globalmacroids": [
"1"
]
},
"id": 1
}
```
#### 修改全局宏的值
将全局宏的值更改为"public"。
请求:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.updateglobal",
"params": {
"globalmacroid": "1",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"globalmacroids": [
"1"
]
},
"id": 1
}
```
#### Changing the value of a host macro
Change the value of a host macro to "public".
Request:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.update",
"params": {
"hostmacroid": "1",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostmacroids": [
"1"
]
},
"id": 1
}
```
#### 修改主机宏的值
将宏一个主机的值修改为"public".
请求:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.update",
"params": {
"hostmacroid": "1",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostmacroids": [
"1"
]
},
"id": 1
}
```
#### Changing user role
Change a role of a user.
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "12",
"roleid": "6"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"userids": [
"12"
]
},
"id": 1
}
```
#### 更改用户角色
更改用户的角色。
请求:
```json
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "12",
"roleid": "6"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"userids": [
"12"
]
},
"id": 1
}
```
#### Changing value map name
Change value map name to "Device status".
Request:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.update",
"params": {
"valuemapid": "2",
"name": "Device status"
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"2"
]
},
"id": 1
}
```
#### 修改值映射名称
将值映射名称更改为"Device status".
请求:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.update",
"params": {
"valuemapid": "2",
"name": "Device status"
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"2"
]
},
"id": 1
}
```
#### Checking for not supported value
This example uses the [Check for not supported value](/manual/config/items/preprocessing#configuration) preprocessing step to check if the item value could not be retrieved.
When a Zabbix server/proxy poller process attempts to collect an item value, it may:
- Return a valid result.
- Return a result that initially seems valid but may become unsupported later (e.g., due to a value type mismatch after preprocessing).
- Return an error of collecting the value, causing the item to become unsupported. Common causes include:
- Unknown item key (for Zabbix agent, Simple check, or Zabbix internal items)
- Unknown OID (SNMP agent), unknown sensor (IPMI agent), or no JMX metric (JMX agent)
- Cannot read trap file (SNMP trap)
- Script not found (External check)
- No such URL (HTTP agent)
- Login failed (SSH agent, TELNET agent)
- Invalid formula syntax (Calculated), JavaScript syntax error (Script), or invalid SQL (Database monitor)
To detect and handle errors of collecting item values, you can use the "Check for not supported value" preprocessing step.
Note that this step is always executed first and only detects errors that occur before preprocessing begins.
In the *Preprocessing* tab of an item, select the "Check for not supported value" preprocessing step.
Then, use the *Custom on fail* option to discard the value (in this case, the error), set a custom value, or return a custom error message.
Please note that [discarded](/manual/config/items/preprocessing#discardunchanged) values are not stored in the database; as a result, triggers are not evaluated and trend data is not generated.
#### 检查不支持的值
此示例使用[配置](/manual/config/items/preprocessing#配置)预处理步骤来检查监控项值是否无法获取。
当Zabbix server/proxy轮询器进程尝试收集监控项值时，可能会：
- 返回有效结果
- 返回最初看似有效但后续可能变为不支持的结果（例如由于预处理后的值类型不匹配）
- 返回收集值时的错误，导致监控项变为不支持状态。常见原因包括：
- Unknown item key (for Zabbix agent, Simple check, or Zabbix internal items)
- Unknown OID (SNMP agent), unknown sensor (IPMI agent), or no JMX metric (JMX agent)
- Cannot read trap file (SNMP trap)
- Script not found (External check)
- No such URL (HTTP agent)
- Login failed (SSH agent, TELNET agent)
- Invalid formula syntax (Calculated), JavaScript syntax error (Script), or invalid SQL (Database monitor)
要检测和处理监控项值收集错误，可以使用"检查不支持的值"预处理步骤。
请注意该步骤始终最先执行，且仅检测预处理开始前发生的错误。
在监控项的*预处理*标签页中，选择"检查不支持的值"预处理步骤。
然后使用*失败时自定义*选项来丢弃该值（此处指错误）、设置自定义值或返回自定义错误消息。
请注意[2-监控项值预处理](/manual/config/items/preprocessing#2-监控项值预处理)值不会存入数据库，因此不会评估触发器且不会生成趋势数据。
#### Checking retrieved value type
This example uses the [Custom multiplier](/manual/config/items/preprocessing#configuration) preprocessing step to check if the retrieved item value type is numeric.
In the *Preprocessing* tab of an item, select the "Custom multiplier" preprocessing step and set the following parameter:
```bash
# Multiplies the retrieved value by 1:
number: 1
```
::: noteimportant
If preprocessing fails (e.g., input is not numeric), then the item becomes unsupported with a corresponding error message.
To avoid this, mark the "Custom on fail" checkbox and select an option such as discarding the value or setting a custom one.
Please note that [discarded](/manual/config/items/preprocessing#configuration) values are not stored in the database; as a result, triggers are not evaluated and trend data is not generated.
:::
#### 检查获取值类型
此示例使用[配置](/manual/config/items/preprocessing#配置)预处理步骤来检查获取的监控项值类型是否为数值型.
在监控项的*预处理*选项卡中，选择"自定义乘数"预处理步骤并设置以下参数:
```bash
# Multiplies the retrieved value by 1:
number: 1
```
::: noteimportant
如果预处理失败(例如输入非数值)，则该监控项将变为不受支持状态并显示相应错误信息.
为避免这种情况，请勾选"失败时自定义操作"复选框并选择相应选项，如丢弃该值或设置自定义值.
请注意[配置](/manual/config/items/preprocessing#配置)值不会存入数据库，因此不会触发告警评估且不会生成趋势数据.
:::
### 'Check now' request object
The 'Check now' task request object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|itemid|string|ID of item and low-level discovery rules.|
### 立即检查请求 object
'立即检查'任务请求object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| itemid | string | 监控项和低级发现规则的ID. |
#### Check of pre-requisites
Make sure that all software prerequisites are met.
{width="550"}
|Pre-requisite|Minimum value|Description|
|--|--|------|
|*PHP version*|7.2.5| |
|*PHP memory\_limit option*|128MB|In php.ini:<br>memory\_limit = 128M|
|*PHP post\_max\_size option*|16MB|In php.ini:<br>post\_max\_size = 16M|
|*PHP upload\_max\_filesize option*|2MB|In php.ini:<br>upload\_max\_filesize = 2M|
|*PHP max\_execution\_time option*|300 seconds (values 0 and -1 are allowed)|In php.ini:<br>max\_execution\_time = 300|
|*PHP max\_input\_time option*|300 seconds (values 0 and -1 are allowed)|In php.ini:<br>max\_input\_time = 300|
|*PHP session.auto\_start option*|must be disabled|In php.ini:<br>session.auto\_start = 0|
|*Database support*|One of: MySQL, Oracle, PostgreSQL.|One of the following modules must be installed:<br>mysql, oci8, pgsql|
|*bcmath*| |php-bcmath|
|*mbstring*| |php-mbstring|
|*PHP mbstring.func\_overload option*|must be disabled|In php.ini:<br>mbstring.func\_overload = 0|
|*sockets*| |php-net-socket. Required for user script support.|
|*gd*|2.0.28|php-gd. PHP GD extension must support PNG images (*--with-png-dir*), JPEG (*--with-jpeg-dir*) images and FreeType 2 (*--with-freetype-dir*).|
|*libxml*|2.6.15|php-xml|
|*xmlwriter*| |php-xmlwriter|
|*xmlreader*| |php-xmlreader|
|*ctype*| |php-ctype|
|*session*| |php-session|
|*gettext*| |php-gettext<br>Since Zabbix 2.2.1, the PHP gettext extension is not a mandatory requirement for installing Zabbix. If gettext is not installed, the frontend will work as usual, however, the translations will not be available.|
Optional pre-requisites may also be present in the list. A failed
optional prerequisite is displayed in orange and has a *Warning* status.
With a failed optional pre-requisite, the setup may continue.
::: noteimportant
If there is a need to change the Apache user or
user group, permissions to the session folder must be verified.
Otherwise Zabbix setup may be unable to continue.
:::
#### 先决条件检查
确保满足所有软件先决条件。
{width="550"}
| 先决条件 | 最低要求值 | 描述 |
|--|--|------|
| *PHP version* | 7.2.5 | |
| *PHP memory\_limit option*|128MB|In php.ini:<br>memory\_limit = 128M|
|*PHP post\_max\_size option*|16MB|In php.ini:<br>post\_max\_size = 16M|
|*PHP upload\_max\_filesize option*|2MB|In php.ini:<br>upload\_max\_filesize = 2M|
|*PHP max\_execution\_time option*|300 seconds (values 0 and -1 are allowed)|In php.ini:<br>max\_execution\_time = 300|
|*PHP max\_input\_time option*|300 seconds (values 0 and -1 are allowed)|In php.ini:<br>max\_input\_time = 300|
|*PHP session.auto\_start option*|must be disabled|In php.ini:<br>session.auto\_start = 0|
|*Database support*|One of: MySQL, Oracle, PostgreSQL.|One of the following modules must be installed:<br>mysql, oci8, pgsql|
|*bcmath*| |php-bcmath|
|*mbstring*| |php-mbstring|
|*PHP mbstring.func\_overload option*|must be disabled|In php.ini:<br>mbstring.func\_overload = 0 |
| *sockets* | | php-net-socket。用户脚本支持所需。 |
| *gd* | 2.0.28 | php-gd。PHP GD扩展必须支持PNG图像(*--with-png-dir*)、JPEG(*--with-jpeg-dir*)图像和FreeType 2(*--with-freetype-dir*)。 |
| *libxml* | 2.6.15 | php-xml |
| *xmlwriter* | | php-xmlwriter |
| *xmlreader* | | php-xmlreader |
| *ctype* | | php-ctype |
| *session* | | php-session |
| *gettext* | | php-gettext<br>从Zabbix 2.2.1开始，PHP gettext扩展不再是安装Zabbix的强制要求。如果未安装gettext，前端将正常工作，但翻译功能不可用。 |
列表中可能还包含可选先决条件。未满足的可选先决条件会以橙色显示并标记为*警告*状态。
即使存在未满足的可选先决条件，安装程序仍可继续。
::: noteimportant
如需更改Apache用户或用户组，必须验证会话文件夹的权限。
否则Zabbix安装程序可能无法继续。
:::
#### Check status of nodes at specific IP addresses
Request:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["name", "status"],
"filter": {
"address": ["192.168.1.7", "192.168.1.13"]
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"name": "node3",
"status": "0"
},
{
"name": "node-active",
"status": "3"
}
],
"id": 1
}
```
#### 检查特定IP地址节点的状态
请求:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["name", "status"],
"filter": {
"address": ["192.168.1.7", "192.168.1.13"]
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"name": "node3",
"status": "0"
},
{
"name": "node-active",
"status": "3"
}
],
"id": 1
}
```
#### Chromium for Zabbix web service on Ubuntu 20
Though in most cases, Zabbix web service can run with Chromium, on
Ubuntu 20.04 using Chromium causes the following error:
Cannot fetch data: chrome failed to start:cmd_run.go:994:
WARNING: cannot create user data directory: cannot create
"/var/lib/zabbix/snap/chromium/1564": mkdir /var/lib/zabbix: permission denied
Sorry, home directories outside of /home are not currently supported. See https://forum.snapcraft.io/t/11209 for details.
This error occurs because `/var/lib/zabbix` is used as a home directory
of user 'zabbix'.
#### Ubuntu 20 上用于 Zabbix web 服务的 Chromium
虽然在大多数情况下，Zabbix web服务可以run与Chromium配合使用，
但在Ubuntu 20.04上使用Chromium会导致以下错误：
Cannot fetch data: chrome failed to start:cmd_run.go:994:
WARNING: cannot create user data directory: cannot create
"/var/lib/zabbix/snap/chromium/1564": mkdir /var/lib/zabbix: permission denied
Sorry, home directories outside of /home are not currently supported. See https://forum.snapcraft.io/t/11209 for details.
此错误发生是因为`/var/lib/zabbix`被用作用户'zabbix'的主目录。
#### Ciphersuites
Ciphersuites by default are configured internally during Zabbix startup
and, before Zabbix 4.0.19, 4.4.7, are not user-configurable.
Since Zabbix 4.0.19, 4.4.7 also user-configured ciphersuites are
supported for GnuTLS and OpenSSL. Users may
[configure](#user-configured_ciphersuites) ciphersuites according to
their security policies. Using this feature is optional (built-in
default ciphersuites still work).
For crypto libraries compiled with default settings Zabbix built-in
rules typically result in the following ciphersuites (in order from
higher to lower priority):
|Library|Certificate ciphersuites|PSK ciphersuites|
|-------|-------------------|-------------------|
|*GnuTLS 3.1.18*|TLS\_ECDHE\_RSA\_AES\_128\_GCM\_SHA256<br>TLS\_ECDHE\_RSA\_AES\_128\_CBC\_SHA256<br>TLS\_ECDHE\_RSA\_AES\_128\_CBC\_SHA1<br>TLS\_RSA\_AES\_128\_GCM\_SHA256<br>TLS\_RSA\_AES\_128\_CBC\_SHA256<br>TLS\_RSA\_AES\_128\_CBC\_SHA1|TLS\_ECDHE\_PSK\_AES\_128\_CBC\_SHA256<br>TLS\_ECDHE\_PSK\_AES\_128\_CBC\_SHA1<br>TLS\_PSK\_AES\_128\_GCM\_SHA256<br>TLS\_PSK\_AES\_128\_CBC\_SHA256<br>TLS\_PSK\_AES\_128\_CBC\_SHA1|
|*OpenSSL 1.0.2c*|ECDHE-RSA-AES128-GCM-SHA256<br>ECDHE-RSA-AES128-SHA256<br>ECDHE-RSA-AES128-SHA<br>AES128-GCM-SHA256<br>AES128-SHA256<br>AES128-SHA|PSK-AES128-CBC-SHA|
|*OpenSSL 1.1.0*|ECDHE-RSA-AES128-GCM-SHA256<br>ECDHE-RSA-AES128-SHA256<br>ECDHE-RSA-AES128-SHA<br>AES128-GCM-SHA256<br>AES128-CCM8<br>AES128-CCM<br>AES128-SHA256<br>AES128-SHA<br>|ECDHE-PSK-AES128-CBC-SHA256<br>ECDHE-PSK-AES128-CBC-SHA<br>PSK-AES128-GCM-SHA256<br>PSK-AES128-CCM8<br>PSK-AES128-CCM<br>PSK-AES128-CBC-SHA256<br>PSK-AES128-CBC-SHA|
|*OpenSSL 1.1.1d*|TLS\_AES\_256\_GCM\_SHA384<br>TLS\_CHACHA20\_POLY1305\_SHA256<br>TLS\_AES\_128\_GCM\_SHA256<br>ECDHE-RSA-AES128-GCM-SHA256<br>ECDHE-RSA-AES128-SHA256<br>ECDHE-RSA-AES128-SHA<br>AES128-GCM-SHA256<br>AES128-CCM8<br>AES128-CCM<br>AES128-SHA256<br>AES128-SHA|TLS\_CHACHA20\_POLY1305\_SHA256<br>TLS\_AES\_128\_GCM\_SHA256<br>ECDHE-PSK-AES128-CBC-SHA256<br>ECDHE-PSK-AES128-CBC-SHA<br>PSK-AES128-GCM-SHA256<br>PSK-AES128-CCM8<br>PSK-AES128-CCM<br>PSK-AES128-CBC-SHA256<br>PSK-AES128-CBC-SHA|
#### 密码套件
默认情况下，密码套件在Zabbix启动时内部配置完成
在Zabbix 4.0.19和4.4.7版本之前，这些配置不可由用户自定义。
自Zabbix 4.0.19和4.4.7版本起，GnuTLS和OpenSSL开始支持
用户自定义密码套件。用户可根据自身安全策略
[配置](#user-configured_ciphersuites)密码套件。此功能为可选使用
（内置默认密码套件仍可正常工作）。
对于采用默认设置编译的加密库，Zabbix内置规则
通常会产生以下密码套件（按优先级从高到低排序）：
| 加密库 | 证书密码套件 | PSK密码套件 |
|-------|-------------------|-------------------|
| *GnuTLS 3.1.18* | TLS\_ECDHE\_RSA\_AES\_128\_GCM\_SHA256<br>TLS\_ECDHE\_RSA\_AES\_128\_CBC\_SHA256<br>TLS\_ECDHE\_RSA\_AES\_128\_CBC\_SHA1<br>TLS\_RSA\_AES\_128\_GCM\_SHA256<br>TLS\_RSA\_AES\_128\_CBC\_SHA256<br>TLS\_RSA\_AES\_128\_CBC\_SHA1 | TLS\_ECDHE\_PSK\_AES\_128\_CBC\_SHA256<br>TLS\_ECDHE\_PSK\_AES\_128\_CBC\_SHA1<br>TLS\_PSK\_AES\_128\_GCM\_SHA256<br>TLS\_PSK\_AES\_128\_CBC\_SHA256<br>TLS\_PSK\_AES\_128\_CBC\_SHA1 |
| *OpenSSL 1.0.2c* | ECDHE-RSA-AES128-GCM-SHA256<br>ECDHE-RSA-AES128-SHA256<br>ECDHE-RSA-AES128-SHA<br>AES128-GCM-SHA256<br>AES128-SHA256<br>AES128-SHA | PSK-AES128-CBC-SHA |
| *OpenSSL 1.1.0* | ECDHE-RSA-AES128-GCM-SHA256<br>ECDHE-RSA-AES128-SHA256<br>ECDHE-RSA-AES128-SHA<br>AES128-GCM-SHA256<br>AES128-CCM8<br>AES128-CCM<br>AES128-SHA256<br>AES128-SHA<br> | ECDHE-PSK-AES128-CBC-SHA256<br>ECDHE-PSK-AES128-CBC-SHA<br>PSK-AES128-GCM-SHA256<br>PSK-AES128-CCM8<br>PSK-AES128-CCM<br>PSK-AES128-CBC-SHA256<br>PSK-AES128-CBC-SHA |
| *OpenSSL 1.1.1d* | TLS\_AES\_256\_GCM\_SHA384<br>TLS\_CHACHA20\_POLY1305\_SHA256<br>TLS\_AES\_128\_GCM\_SHA256<br>ECDHE-RSA-AES128-GCM-SHA256<br>ECDHE-RSA-AES128-SHA256<br>ECDHE-RSA-AES128-SHA<br>AES128-GCM-SHA256<br>AES128-CCM8<br>AES128-CCM<br>AES128-SHA256<br>AES128-SHA | TLS\_CHACHA20\_POLY1305\_SHA256<br>TLS\_AES\_128\_GCM\_SHA256<br>ECDHE-PSK-AES128-CBC-SHA256<br>ECDHE-PSK-AES128-CBC-SHA<br>PSK-AES128-GCM-SHA256<br>PSK-AES128-CCM8<br>PSK-AES128-CCM<br>PSK-AES128-CBC-SHA256<br>PSK-AES128-CBC-SHA |
### Cleaner configuration export
YAML files generated during Zabbix entity configuration export no longer contain empty lines between entities in an array, which makes such files shorter and more convenient to work with. See [Configuration export/import](/manual/xml_export_import) section for updated export examples.
### Cleaner configuration export
Zabbix实体配置过程中生成的YAML文件export不再在array的实体之间包含空行，这使得此类文件更短且更便于处理。有关更新的export示例，请参阅[Configuration export/import](/manual/xml_export_import)部分。
#### Clear history
Request:
```json
{
"jsonrpc": "2.0",
"method": "history.clear",
"params": [
"10325",
"13205"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"10325",
"13205"
]
},
"id": 1
}
```
#### 清除历史记录
请求:
```json
{
"jsonrpc": "2.0",
"method": "history.clear",
"params": [
"10325",
"13205"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"10325",
"13205"
]
},
"id": 1
}
```
#### Clearing template linked templates
Unlink and clear the given template from a specific linked template.
Request:
```json
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"templates_clear": [
{
"templateid": "10087"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10086"
]
},
"id": 1
}
```
#### 清除模板链接模板
解除关联并从特定关联模板中clear给定模板。
请求:
```json
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"templates_clear": [
{
"templateid": "10087"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10086"
]
},
"id": 1
}
```
##### Cloning a report
To quickly clone an existing report, click the *Clone* button at the bottom of an existing report configuration form. When cloning a report created by another user, the current user becomes the owner of the new report.
Report settings will be copied to the new report configuration form with respect to user permissions:
- If the user who clones a report has no permissions to a dashboard, the *Dashboard* field will be cleared.
- If the user who clones a report has no permissions to some users or user groups in the *Subscriptions* list, inaccessible recipients will not be cloned.
- *Generate report by* settings will be updated to display the current user (unless *Generate report by* is set to the recipient).
Change the required settings and the report name, then click *Add*.
##### 克隆报告
要快速克隆现有报告，请点击现有报告配置表单底部的*克隆*按钮。当克隆由其他用户创建的报告时，当前用户将成为新报告的所有者。
报告设置将被复制到新的报告配置表单中，同时考虑用户权限：
- 如果克隆报告的用户对仪表板没有权限，*仪表板*字段将被清空。
- 如果克隆报告的用户对*订阅*列表中的某些用户或用户组没有权限，无法访问的收件人将不会被克隆。
- *生成报告者*设置将更新为显示当前用户（除非*生成报告者*设置为收件人）。
更改所需的设置和报告名称，然后点击*添加*。
### Code
|Type|Size|Comments|
|-----|-----|----------|
|Byte| 4 |Payload type, currently only JSON is supported.|
### 代码
| 类型 | 大小 | 说明 |
|-----|-----|----------|
| Byte | 4 | 负载类型，目前仅支持JSON格式。 |
##### Collapsed menu
When the menu is collapsed to icons only, a full menu reappears as soon
as the mouse cursor is placed upon it. Note that it reappears over page
content; to move page content to the right you have to click on the
expand button. If the mouse cursor again is placed outside the full
menu, the menu will collapse again after two seconds.
You can also make a collapsed menu reappear fully by hitting the Tab
key. Hitting the Tab key repeatedly will allow to focus on the next menu
element.
##### 折叠菜单
当菜单被折叠为仅显示图标时，只要将鼠标光标悬停其上，完整菜单便会重新出现。请注意，它会覆盖在页面内容上方；若要将页面内容向右移动，需点击展开按钮。若鼠标光标再次移出完整菜单区域，菜单将在两秒后重新折叠。
您也可以通过按Tab键使折叠的菜单完全重现。重复按Tab键可依次聚焦下一个菜单元素。
##### Column configuration
{width="600"}
##### 列配置
{width="600"}
#### Columns
Columns have common parameters and additional parameters depending on the configuration of the parameter *Data*.
::: noteclassic
For all parameters related to columns the number in the property name (e.g. columns.name.0) references a column for which the parameter is configured.
:::
#### 列
列具有通用参数以及根据*数据*参数配置而定的附加参数。
::: noteclassic
所有与列相关的参数中，属性名称中的数字（例如columns.name.0）指向该参数所配置的对应列。
:::
#### Command-line based installation
#### 基于命令行的安装
#### Command result
The return value of the command is a standard output together with a standard error produced by the command.
::: noteimportant
An item that returns text (character, log, or text type of information) will not become unsupported in case of a standard error output.
:::
The return value is limited to 16MB (including trailing whitespace that is truncated); [database limits](/manual/config/items/item#text_data_limits) also apply.
User parameters that return text (character, log, or text type of information) can also return a whitespace.
In case of an invalid result, the item will become unsupported.
#### 命令结果
命令的返回值包括该命令产生的标准输出及标准错误输出。
::: noteimportant
返回文本类型数据（字符型、日志型或文本型信息）的监控项不会因标准错误输出而变为不受支持状态。
:::
返回值限制为16MB（包含被截断的尾部空白字符）；[文本数据限制](/manual/config/items/item#文本数据限制)同样适用。
返回文本类型数据（字符型、日志型或文本型信息）的用户参数也可以返回空白字符。
若返回无效结果，该监控项将变为不受支持状态。
[comment]: # attributes: noaside
# 11 Recipes for monitoring
# 11 监控方法
[comment]: # (tags: proxy)
# 4 Proxy
[comment]: # (标签: proxy)
# 4 Proxy
#### Common agent items supported on Windows
|Item key|User group|<|
|--------|----------|-|
| |Recommended|Minimum technically acceptable (functionality is limited)|
|agent.hostname|Guests|Guests|
|agent.ping|Guests|Guests|
|agent.variant|Guests|Guests|
|agent.version|Guests|Guests|
|log|Administrators|Guests|
|log.count|Administrators|Guests|
|logrt|Administrators|Guests|
|logrt.count|Administrators|Guests|
|net.dns|Guests|Guests|
|net.dns.record|Guests|Guests|
|net.if.discovery|Guests|Guests|
|net.if.in|Guests|Guests|
|net.if.out|Guests|Guests|
|net.if.total|Guests|Guests|
|net.tcp.listen|Guests|Guests|
|net.tcp.port|Guests|Guests|
|net.tcp.service|Guests|Guests|
|net.tcp.service.perf|Guests|Guests|
|net.udp.service|Guests|Guests|
|net.udp.service.perf|Guests|Guests|
|proc.num|Administrators|Guests|
|system.cpu.discovery|Performance Monitor Users|Performance Monitor Users|
|system.cpu.load|Performance Monitor Users|Performance Monitor Users|
|system.cpu.num|Guests|Guests|
|system.cpu.util|Performance Monitor Users|Performance Monitor Users|
|system.hostname|Guests|Guests|
|system.localtime|Guests|Guests|
|system.run|Administrators|Guests|
|system.sw.arch|Guests|Guests|
|system.swap.size|Guests|Guests|
|system.uname|Guests|Guests|
|system.uptime|Performance Monitor Users|Performance Monitor Users|
|vfs.dir.count|Administrators|Guests|
|vfs.dir.get|Administrators|Guests|
|vfs.dir.size|Administrators|Guests|
|vfs.file.cksum|Administrators|Guests|
|vfs.file.contents|Administrators|Guests|
|vfs.file.exists|Administrators|Guests|
|vfs.file.md5sum|Administrators|Guests|
|vfs.file.regexp|Administrators|Guests|
|vfs.file.regmatch|Administrators|Guests|
|vfs.file.size|Administrators|Guests|
|vfs.file.time|Administrators|Guests|
|vfs.fs.discovery|Administrators|Guests|
|vfs.fs.get|Administrators|Guests|
|vfs.fs.size|Administrators|Guests|
|vm.memory.size|Guests|Guests|
|web.page.get|Guests|Guests|
|web.page.perf|Guests|Guests|
|web.page.regexp|Guests|Guests|
|zabbix.stats|Guests|Guests|
#### Windows支持的通用Agent监控项
| 监控项 键值 | 用户组 | < |
|--------|----------|-|
| | 推荐值 | 最低技术可接受值（功能受限） |
| agent.hostname | 访客 | 访客 |
| agent.ping | 访客 | 访客 |
| agent.variant | 访客 | 访客 |
| agent.version | 访客 | 访客 |
| log | 管理员 | 访客 |
| log.count | 管理员 | 访客 |
| logrt | 管理员 | 访客 |
| logrt.count | 管理员 | 访客 |
| net.dns | 访客 | 访客 |
| net.dns.record | 访客 | 访客 |
| net.if.discovery | 访客 | 访客 |
| net.if.in | 访客 | 访客 |
| net.if.out | 访客 | 访客 |
| net.if.total | 访客 | 访客 |
| net.tcp.listen | 访客 | 访客 |
| net.tcp.port | 访客 | 访客 |
| net.tcp.service | 访客 | 访客 |
| net.tcp.service.perf | 访客 | 访客 |
| net.udp.service | 访客 | 访客 |
| net.udp.service.perf | 访客 | 访客 |
| proc.num | 管理员 | 访客 |
| system.cpu.discovery | 性能监控用户 | 性能监控用户 |
| system.cpu.load | 性能监控用户 | 性能监控用户 |
| system.cpu.num | 访客 | 访客 |
| system.cpu.util | 性能监控用户 | 性能监控用户 |
| system.hostname | 访客 | 访客 |
| system.localtime | 访客 | 访客 |
| system.run | 管理员 | 访客 |
| system.sw.arch | 访客 | 访客 |
| system.swap.size | 访客 | 访客 |
| system.uname | 访客 | 访客 |
| system.uptime | 性能监控用户 | 性能监控用户 |
| vfs.dir.count | 管理员 | 访客 |
| vfs.dir.get | 管理员 | 访客 |
| vfs.dir.size | 管理员 | 访客 |
| vfs.file.cksum | 管理员 | 访客 |
| vfs.file.contents | 管理员 | 访客 |
| vfs.file.exists | 管理员 | 访客 |
| vfs.file.md5sum | 管理员 | 访客 |
| vfs.file.regexp | 管理员 | 访客 |
| vfs.file.regmatch | 管理员 | 访客 |
| vfs.file.size | 管理员 | 访客 |
| vfs.file.time | 管理员 | 访客 |
| vfs.fs.discovery | 管理员 | 访客 |
| vfs.fs.get | 管理员 | 访客 |
| vfs.fs.size | 管理员 | 访客 |
| vm.memory.size | 访客 | 访客 |
| web.page.get | 访客 | 访客 |
| web.page.perf | 访客 | 访客 |
| web.page.regexp | 访客 | 访客 |
| zabbix.stats | 访客 | 访客 |
Common column parameters:
| | |
|--|--------|
|*Name*|Name of the column.|
|*Data*|Data type to display in the column:<br>**Item value** - value of the specified item<br>**Host name** - host name of the item specified in the *Item value* column<br>**Text** - static text string|
|*Base color*|Background color of the column; fill color if *Item value* data is displayed as bar/indicators.<br>For *Item value* data the default color can be overridden by custom color, if the item value is over one of the specified "Thresholds".|
通用列参数:
| | |
|--|--------|
| *名称* | 列的名称. |
| *数据* | 列中显示的数据类型:<br>**监控项值** - 指定监控项的值<br>**主机名** - 在*监控项值*列中指定的监控项的主机名<br>**文本** - 静态文本string |
| *基础颜色* | 列的背景色; 如果*监控项值*数据显示为条形/指示器则为填充颜色.<br>对于*监控项值*数据, 如果监控项值超过指定的"阈值"之一, 默认颜色可以被自定义颜色覆盖. |
### Common "get" method parameters
The following parameters are supported by all `get` methods:
|Parameter|[Type](#data_types)|Description|
|-|-|------|
|countOutput|boolean|Return the number of records in the result instead of the actual data.|
|editable|boolean|If set to `true`, return only objects that the user has write permissions to.<br><br>Default: `false`.|
|excludeSearch|boolean|Return results that do not match the criteria given in the `search` parameter.|
|filter|object|Return only those results that exactly match the given filter.<br><br>Accepts an object, where the keys are property names (e.g., Host object properties in `host.get`, Item object properties in `item.get`, etc.), and the values are either a single value or an array of values to match against.<br><br>Does not support properties of `text` [data type](#data-types).<br><br>Note that some methods have specific functionality for this parameter, which is described on the method page (e.g., the `filter` parameter in [host.get](/manual/api/reference/host/get) also supports Host interface properties).|
|limit|integer|Limit the number of records returned.|
|output|query|Object properties to be returned.<br><br>Default: `extend`.|
|preservekeys|boolean|Use IDs as keys in the resulting array.|
|search|object|Return results that match the given pattern (case-insensitive).<br><br>Accepts an object, where the keys are property names (e.g., Host object properties in `host.get`, Item object properties in `item.get`, etc.), and the values are strings to search for. If no additional options are given, this will perform a `LIKE "%…%"` search.<br><br>Supports only properties of `string` and `text` [data type](#data-types).<br><br>Note that some methods have specific functionality for this parameter, which is described on the method page (e.g., the `search` parameter in [host.get](/manual/api/reference/host/get) also supports Host interface properties).|
|searchByAny|boolean|If set to `true`, return results that match any of the criteria given in the `filter` or `search` parameter instead of all of them.<br><br>Default: `false`.|
|searchWildcardsEnabled|boolean|If set to `true`, enables the use of "\*" as a wildcard character in the `search` parameter.<br><br>Default: `false`.|
|sortfield|string/array|Sort the result by the given properties. Refer to a specific API get method description for a list of properties that can be used for sorting. Macros are not expanded before sorting.<br><br>If no value is specified, data will be returned unsorted.|
|sortorder|string/array|Order of sorting. If an array is passed, each value will be matched to the corresponding property given in the `sortfield` parameter.<br><br>Possible values are:<br>`ASC` - *(default)* ascending;<br>`DESC` - descending.|
|startSearch|boolean|The `search` parameter will compare the beginning of fields, that is, perform a `LIKE "…%"` search instead.<br><br>Ignored if `searchWildcardsEnabled` is set to `true`.|
### 通用"get"方法参数
所有`get`方法均支持以下参数:
| 参数 | [类型](#数据类型) | 描述 |
|-|-|------|
| countOutput | boolean | 返回结果中的记录数而非实际数据。 |
| editable | boolean | 如果设置为`true`，则仅返回用户具有写入权限的objects。<br><br>默认值：`false`。 |
| excludeSearch | boolean | 返回不符合`search`参数中给定条件的结果. |
| filter | object | 仅返回与给定筛选条件完全匹配的结果。<br><br>接受一个object，其中键为属性名称（例如`host.get`中的主机 object属性、`item.get`中的监控项 object属性等），值为单个值或用于匹配的array值集合。<br><br>不支持`text`[数据类型](#data-types)的属性。<br><br>注意某些方法对此参数有特定功能，详见方法页面说明（例如[host.get](/manual/api/reference/host/get)中的`filter`参数还支持主机接口属性）。 |
| limit | integer | 限制返回的记录数量。 |
| output | query | 要返回的object属性。<br><br>默认值: `extend`. |
| preservekeys | boolean | 在生成的array中使用ID作为键。 |
| search | object | 返回与给定模式匹配的结果（不区分大小写）。<br><br>接受一个object，其中键为属性名称（例如`host.get`中的主机 object属性、`item.get`中的监控项 object属性等），值为要搜索的字符串。若未提供额外选项，将执行`LIKE "%…%"`搜索。<br><br>仅支持`string`和`text`[数据类型](#data-types)的属性。<br><br>注意：部分方法对此参数有特定功能，详见方法页面说明（例如[host.get](/manual/api/reference/host/get)中的`search`参数还支持主机接口属性）。 |
| searchByAny | boolean | 若设置为`true`，则返回符合`filter`或`search`参数中任意条件的匹配结果，而非全部条件。<br><br>默认值：`false`。 |
| searchWildcardsEnabled | boolean | 若设置为`true`，则允许在`search`参数中使用"\*"作为通配符。<br><br>默认值: `false`. |
| sortfield | string/array | 按给定属性对结果进行排序。具体可用的排序属性列表请参考特定的API get方法说明。宏在排序前不会被展开。<br><br>若未指定值，数据将按未排序状态返回。 |
| sortorder | string/array | 排序顺序。如果传入array，每个值将与`sortfield`参数中给定的对应属性进行匹配。<br><br>可能的值为：<br>`ASC` - *(默认)* 升序；<br>`DESC` - 降序。 |
| startSearch | boolean | `search`参数将比较字段的开头部分，即执行`LIKE "…%"`搜索而非完全匹配。<br><br>若`searchWildcardsEnabled`设为`true`则此参数将被忽略。 |
##### Common parameters
- `/host/key` is a common mandatory first parameter for the functions
referencing the host item history
- `(sec|#num)<:time shift>` is a common second parameter for the
functions referencing the host item history, where:
- **sec** - maximum [evaluation
period](/manual/config/triggers#evaluation_period) in seconds
(time [suffixes](/manual/appendix/suffixes) can be used), or
- **\#num** - maximum [evaluation
range](/manual/config/triggers#evaluation_period) in latest
collected values (if preceded by a hash mark)
- **time shift** (optional) allows to move the evaluation point
back in time. See [more
details](/manual/config/triggers/expression#time_shift) on
specifying time shift.
##### 通用参数
- `/host/key` 是引用主机监控项历史的函数中常见的必选第一个参数
- `(sec|#num)<:time shift>` 是引用主机监控项历史的函数中常见的第二个参数，其中：
- **sec** - 最大[评估周期](/manual/config/triggers#评估周期)（以秒为单位，可使用[suffixes](/manual/appendix/suffixes)），或
- **\#num** - 最新采集值中的最大[评估周期](/manual/config/triggers#评估周期)（如果前面带有井号标记）
- **time shift**（可选）允许将评估点回溯到过去时间。关于指定时间偏移，请参阅[时间偏移](/manual/config/triggers/expression#时间偏移)
##### Common parameters
- `/host/key` is a common mandatory first parameter for the functions
referencing the host item history
- `(sec|#num)<:time shift>` is a common second parameter for the
functions referencing the host item history, where:
- **sec** - maximum [evaluation
period](/manual/config/triggers#evaluation_period) in seconds
(time [suffixes](/manual/appendix/suffixes) can be used), or
- **\#num** - maximum [evaluation
range](/manual/config/triggers#evaluation_period) in latest
collected values (if preceded by a hash mark)
- **time shift** (optional) allows to move the evaluation point
back in time. See [more
details](/manual/config/triggers/expression#time_shift) on
specifying time shift.
##### 通用参数
- `/host/key` 是引用主机监控项历史的函数中常见的必需第一个参数
- `(sec|#num)<:time shift>` 是引用主机监控项历史的函数中常见的第二个参数，其中：
- **sec** - 最大[评估周期](/manual/config/triggers#评估周期)（以秒为单位，可使用[suffixes](/manual/appendix/suffixes)），或
- **\#num** - 最新采集值中的最大[评估周期](/manual/config/triggers#评估周期)（如果前面带有井号标记）
- **时间偏移**（可选）允许将评估点回溯到过去时间。有关指定时间偏移的详细信息，请参阅[时间偏移](/manual/config/triggers/expression#时间偏移)
##### Common parameters
- `/host/key` is a common mandatory first parameter for the functions
referencing the host item history
- `(sec|#num)<:time shift>` is a common second parameter for the
functions referencing the host item history, where:
- **sec** - maximum [evaluation
period](/manual/config/triggers#evaluation_period) in seconds
(time [suffixes](/manual/appendix/suffixes) can be used), or
- **\#num** - maximum [evaluation
range](/manual/config/triggers#evaluation_period) in latest
collected values (if preceded by a hash mark)
- **time shift** (optional) allows to move the evaluation point
back in time. See [more
details](/manual/config/triggers/expression#time_shift) on
specifying time shift.
##### 通用参数
- `/host/key` 是引用主机监控项历史数据的函数中常见的必需第一个参数
- `(sec|#num)<:time shift>` 是引用主机监控项历史数据的函数中常见的第二个参数，其中：
- **sec** - 最大[评估周期](/manual/config/triggers#评估周期)（以秒为单位，可使用[suffixes](/manual/appendix/suffixes)），或
- **\#num** - 最新采集值中的最大[评估周期](/manual/config/triggers#评估周期)（如果前面带有井号标记）
- **时间偏移**（可选）允许将评估点回溯到过去时间。关于指定时间偏移的详细信息，请参阅[时间偏移](/manual/config/triggers/expression#时间偏移)
##### Common parameters
- `/host/key` is a common mandatory first parameter
- `time period:time shift` is a common second parameter, where:
- **time period** - the time period (minimum '1h'), defined as \<N>\<time unit> where `N` - the number of time units, `time unit` - h (hour), d (day), w (week), M (month) or y (year).
- **time shift** - the time period offset (see function examples)
##### 通用参数
- `/host/key` 是一个常见的必选首参数
- `time period:time shift` 是常见的第二个参数，其中：
- **time period** - 时间周期（最小为'1h'），定义为\<N>\<time unit>，其中 `N` - 时间单位数量，`time unit` - h（小时）、d（天）、w（周）、M（月）或 y（年）。
- **time shift** - 时间周期偏移量（参见函数示例）
#### Common parameters
Some parameters are common for all media types.
In the **Media type** tab the common general attributes are:
|Parameter|Description|
|--|--------|
|*Name*|Name of the media type.|
|*Type*|Select the type of media.|
|*Description*|Enter a description.|
|*Enabled*|Mark the checkbox to enable the media type.|
See the individual pages of media types for media-specific parameters.
The **Message templates** tab allows to set default notification
messages for all or some of the following event types:
- Problem
- Problem recovery
- Problem update
- Service
- Service recovery
- Service update
- Discovery
- Autoregistration
- Internal problem
- Internal problem recovery
To customize message templates:
- In the *Message templates* tab click on
: a *Message
template* popup window will open.
- Select required *Message type* and edit *Subject* and *Message*
texts.
- Click on *Add* to save the message template
Message template parameters:
|Parameter|Description|
|--|-----------|
|*Message type*|Type of an event for which the default message should be used.<br>Only one default message can be defined for each event type.<br>|
|*Subject*|Subject of the default message. The subject may contain macros. It is limited to 255 characters.<br>Subject is not available for SMS media type.|
|*Message*|The default message. It is limited to certain amount of characters depending on the database type (see [Sending messages](/manual/config/notifications/action/operation/message/) for more information).<br>The message may contain supported [macros](/manual/appendix/macros/supported_by_location).<br>In problem and problem update messages, expression macros are supported (for example, `{?avg(/host/key,1h)}`).|
To make changes to an existing message template: In the *Actions* column
click on  to edit
the template or click on
 to delete the
message template.
It is possible to define a custom message template for a specific action
(see [action
operations](/manual/config/notifications/action/operation#operation_details)
for details). Custom messages defined in the action configuration will
override default media type message template.
::: notewarning
Defining message templates is mandatory for all
media types, including webhooks or custom alert scripts that do not use
default messages for notifications. For example, an action "Send message
to Pushover webhook" will fail to send problem notifications, if the
Problem message for the Pushover webhook is not defined.
:::
The **Options** tab contains alert processing settings. The same set of
options is configurable for each media type.
All media types are processed in parallel. While the maximum number of
concurrent sessions is configurable per media type, the total number of
alerter processes on the server can only be limited by the StartAlerters
[parameter](/manual/appendix/config/zabbix_server). Alerts generated by
one trigger are processed sequentially. So multiple notifications may be
processed simultaneously only if they are generated by multiple
triggers.
|Parameter|Description|
|--|--------|
|*Concurrent sessions*|Select the number of parallel alerter sessions for the media type:<br>**One** - one session<br>**Unlimited** - unlimited number of sessions<br>**Custom** - select a custom number of sessions<br>Unlimited/high values mean more parallel sessions and increased capacity for sending notifications. Unlimited/high values should be used in large environments where lots of notifications may need to be sent simultaneously.<br>If more notifications need to be sent than there are concurrent sessions, the remaining notifications will be queued; they will not be lost.|
|*Attempts*|Number of attempts for trying to send a notification. Up to 100 attempts can be specified; the default value is '3'. If '1' is specified Zabbix will send the notification only once and will not retry if the sending fails.|
|*Attempt interval*|Frequency of trying to resend a notification in case the sending failed, in seconds (0-3600). If '0' is specified, Zabbix will retry immediately.<br>Time suffixes are supported, e.g. 5s, 3m, 1h.|
#### 通用参数
某些参数对所有媒介类型都是通用的。
在**媒介类型**标签页中，常见的通用属性包括：
| 参数 | 描述 |
|--|--------|
| *Name* | 媒体类型的名称。 |
| *Type* | 选择媒介类型。 |
| *Description* | 输入描述。 |
| *Enabled* | 勾选复选框以启用该媒介类型。 |
请参阅各媒介类型页面以获取特定媒介的参数。
**消息模板**选项卡允许设置默认通知
以下部分或全部事件类型的消息：
- 问题
- 问题恢复
- 问题 update
- 服务
- 服务恢复
- 服务 update
- 发现
- 自动注册
- 内部问题
- 内部问题恢复
要自定义消息模板：
- 在*消息模板*标签页中点击
: 一条*消息
模板*弹出窗口将打开。
- 选择所需的*消息类型*并编辑*主题*和*消息*
文本
- 点击 *添加* 保存消息模板
消息模板参数:
| 参数 | 描述 |
|--|-----------|
| *Message type* | 应使用默认消息的事件类型。<br>每种事件类型只能定义一个默认消息。<br> |
| *Subject* | 默认消息的主题。主题可包含宏变量，长度限制为255个字符。<br>短信媒介类型不支持主题设置。 |
| *Message* | 默认消息. 其字符长度受限于数据库类型(详见[Sending messages](/manual/config/notifications/action/operation/message/)获取更多信息).<br>该消息可包含支持的[macros](/manual/appendix/macros/supported_by_location).<br>在问题及问题update消息中,支持表达式宏(例如`{?avg(/host/key,1h)}`). |
要对现有消息模板进行修改：在*Actions*列中
点击  进行编辑
该模板或点击
 到 delete 该
消息模板
可以为特定操作定义自定义消息模板
(参见[操作详情](/manual/config/notifications/action/operation#操作详情)
有关详细信息）。在操作配置中定义的自定义消息将
覆盖默认媒介类型消息模板。
::: notewarning
定义消息模板对所有情况都是强制性的
媒体类型，包括不使用webhook或自定义告警脚本
通知的默认消息。例如，一个动作"发送消息"
若未配置"Pushover webhook"，将无法发送问题通知
Pushover webhook的问题消息未定义。
:::
**选项**选项卡包含告警处理设置。同一组
每种媒体类型均可配置选项。
所有媒体类型均并行处理。当最大数量达到时
每种媒体类型均可配置并发会话数，总数量为
服务器上的alerter进程只能通过StartAlerters参数进行限制
[parameter](/manual/appendix/config/zabbix_server). 由以下情况生成的告警
一个触发器会按顺序处理。因此可能会产生多个通知
仅当它们由多个来源同时生成时才会被并行处理
触发器。
| 参数 | 描述 |
|--|--------|
| *Concurrent sessions* | 选择该媒介类型的并行告警会话数量:<br>**One** - 单个会话<br>**Unlimited** - 无限制会话数量<br>**Custom** - 自定义会话数量<br>无限制/高数值意味着更多并行会话及更高的通知发送能力。无限制/高数值应在大规模环境中使用，这些环境可能需要同时发送大量通知。<br>若需发送的通知数量超过并发会话数，剩余通知将进入队列而不会丢失。 |
| *Attempts* | 尝试发送通知的尝试次数. 最多可指定100次尝试, 默认值为'3'. 如果指定'1', Zabbix将仅发送通知一次, 如果发送失败则不会重试. |
| *Attempt interval* | 通知发送失败时重试发送的频率，单位为秒（0-3600）。若指定为'0'，Zabbix将立即重试。<br>支持时间后缀，例如5s、3m、1h。 |
##### Common use cases of global and host macros
- use a global macro in several locations; then change the macro value
and apply configuration changes to all locations with one click
- take advantage of templates with host-specific attributes:
passwords, port numbers, file names, regular expressions, etc.
##### 全局宏与主机宏的常见应用场景
- 在多个位置使用全局宏；然后更改宏值并通过一次点击将配置更改应用到所有位置
- 利用具有主机特定属性的模板：
密码、端口号、file名称、正则表达式等
##### Communication with Zabbix server
|Parameter|Description|
|--|--------|
|*Network timeout*|How many seconds to wait before closing an idle socket (if a connection to Zabbix server has been established earlier, but frontend can not finish read/send data operation during this time, the connection will be dropped). Allowed range: 1 - 300s (default: 3s).|
|*Connection timeout*|How many seconds to wait before stopping an attempt to connect to Zabbix server. Allowed range: 1 - 30s (default: 3s).|
|*Network timeout for media type test*|How many seconds to wait for a response when testing a media type. Allowed range: 1 - 300s (default: 65s).|
|*Network timeout for script execution*|How many seconds to wait for a response when executing a script. Allowed range: 1 - 300s (default: 60s).|
|*Network timeout for item test*|How many seconds to wait for returned data when testing an item. Allowed range: 1 - 300s (default: 60s).|
|*Network timeout for scheduled report test*|How many seconds to wait for returned data when testing a scheduled report. Allowed range: 1 - 300s (default: 60s).|
##### 与 Zabbix server 的通信
| 参数 | 描述 |
|--|--------|
| *Network timeout* | 关闭空闲套接字前的等待秒数（若之前已建立与Zabbix server的连接，但前端在此时间内无法完成读/发送数据操作，连接将被丢弃）。允许范围：1-300秒（默认：3秒）。 |
| *Connection timeout* | 停止尝试连接Zabbix server前的等待秒数。允许范围：1-30秒（默认：3秒）。 |
| *Network timeout for media type test* | 测试媒体类型时等待响应的秒数。允许范围：1-300秒（默认：65秒）。 |
| *Network timeout for script execution* | 执行脚本时等待响应的秒数。允许范围：1-300秒（默认：60秒）。 |
| *Network timeout for item test* | 测试监控项时等待返回数据的秒数。允许范围：1-300秒（默认：60秒）。 |
| *Network timeout for scheduled report test* | 测试计划报告时等待返回数据的秒数。允许范围：1-300秒（默认：60秒）。 |
#### Comparing the import of a template
Compare the template contained in the XML string to the current system elements,
and show what will be changed if this template will be imported.
Request:
```json
{
"jsonrpc": "2.0",
"method": "configuration.importcompare",
"params": {
"format": "xml",
"rules": {
"discoveryRules": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"graphs": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"groups": {
"createMissing": true,
"updateExisting": true
},
"httptests": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"items": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"templateLinkage": {
"createMissing": true,
"deleteMissing": true
},
"templates": {
"createMissing": true,
"updateExisting": true
},
"templateDashboards": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"triggers": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"valueMaps": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
}
},
"source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:30:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key><delay>3m</delay></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter><dt>Server uptime: (.*)</dt></parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>648006da5971424ead0c47ddbbf1ea2e</uuid><name>CPU utilization</name><key>system.cpu.util</key><value_type>FLOAT</value_type><units>%</units><triggers><trigger><uuid>736225012c534ec480c2a66a91322ce0</uuid><expression>avg(/New template/system.cpu.util,3m)>70</expression><name>CPU utilization too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"templates": {
"updated": [
{
"before": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template"
},
"after": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template"
},
"items": {
"added": [
{
"after": {
"uuid": "648006da5971424ead0c47ddbbf1ea2e",
"name": "CPU utilization",
"key": "system.cpu.util",
"value_type": "FLOAT",
"units": "%"
},
"triggers": {
"added": [
{
"after": {
"uuid": "736225012c534ec480c2a66a91322ce0",
"expression": "avg(/New template/system.cpu.util,3m)>70",
"name": "CPU utilization too high on 'New host' for 3 minutes",
"priority": "WARNING"
}
}
]
}
}
],
"removed": [
{
"before": {
"uuid": "6805d4c39a624a8bab2cc8ab63df1ab3",
"name": "CPU load",
"key": "system.cpu.load",
"value_type": "FLOAT"
},
"triggers": {
"removed": [
{
"before": {
"uuid": "ab4c2526c2bc42e48a633082255ebcb3",
"expression": "avg(/New template/system.cpu.load,3m)>2",
"name": "CPU load too high on 'New host' for 3 minutes",
"priority": "WARNING"
}
}
]
}
}
],
"updated": [
{
"before": {
"uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
"name": "Zabbix agent ping",
"key": "agent.ping"
},
"after": {
"uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
"name": "Zabbix agent ping",
"key": "agent.ping",
"delay": "3m"
}
}
]
}
}
]
}
},
"id": 1
}
```
#### 比较模板导入
将XML string中包含的模板与当前系统元素进行比较，
并显示如果导入此模板将会发生哪些变更。
请求:
```json
{
"jsonrpc": "2.0",
"method": "configuration.importcompare",
"params": {
"format": "xml",
"rules": {
"discoveryRules": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"graphs": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"groups": {
"createMissing": true,
"updateExisting": true
},
"httptests": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"items": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"templateLinkage": {
"createMissing": true,
"deleteMissing": true
},
"templates": {
"createMissing": true,
"updateExisting": true
},
"templateDashboards": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"triggers": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"valueMaps": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
}
},
"source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:30:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key><delay>3m</delay></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter><dt>Server uptime: (.*)</dt></parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>648006da5971424ead0c47ddbbf1ea2e</uuid><name>CPU utilization</name><key>system.cpu.util</key><value_type>FLOAT</value_type><units>%</units><triggers><trigger><uuid>736225012c534ec480c2a66a91322ce0</uuid><expression>avg(/New template/system.cpu.util,3m)>70</expression><name>CPU utilization too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"templates": {
"updated": [
{
"before": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template"
},
"after": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template"
},
"items": {
"added": [
{
"after": {
"uuid": "648006da5971424ead0c47ddbbf1ea2e",
"name": "CPU utilization",
"key": "system.cpu.util",
"value_type": "FLOAT",
"units": "%"
},
"triggers": {
"added": [
{
"after": {
"uuid": "736225012c534ec480c2a66a91322ce0",
"expression": "avg(/New template/system.cpu.util,3m)>70",
"name": "CPU utilization too high on 'New host' for 3 minutes",
"priority": "WARNING"
}
}
]
}
}
],
"removed": [
{
"before": {
"uuid": "6805d4c39a624a8bab2cc8ab63df1ab3",
"name": "CPU load",
"key": "system.cpu.load",
"value_type": "FLOAT"
},
"triggers": {
"removed": [
{
"before": {
"uuid": "ab4c2526c2bc42e48a633082255ebcb3",
"expression": "avg(/New template/system.cpu.load,3m)>2",
"name": "CPU load too high on 'New host' for 3 minutes",
"priority": "WARNING"
}
}
]
}
}
],
"updated": [
{
"before": {
"uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
"name": "Zabbix agent ping",
"key": "agent.ping"
},
"after": {
"uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
"name": "Zabbix agent ping",
"key": "agent.ping",
"delay": "3m"
}
}
]
}
}
]
}
},
"id": 1
}
```
#### Compiling OpenSSL
The following steps will help you to compile OpenSSL from sources on MS
Windows 10 (64-bit).
1. For compiling OpenSSL you will need on Windows machine:
1. C compiler (e.g. VS 2017 RC),
2. NASM (<https://www.nasm.us/>),
3. Perl (e.g. Strawberry Perl from <http://strawberryperl.com/>),
4. Perl module Text::Template (cpan Text::Template).
2. Get OpenSSL sources from <https://www.openssl.org/>. OpenSSL 1.1.1
is used here.
3. Unpack OpenSSL sources, for example, in E:\\openssl-1.1.1.
4. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 RC.
5. Go to the OpenSSL source directory, e.g. E:\\openssl-1.1.1.
1. Verify that NASM can be found:`e:\openssl-1.1.1> nasm --version
NASM version 2.13.01 compiled on May 1 2017
`
6. Configure OpenSSL, for
example:`e:\openssl-1.1.1> perl E:\openssl-1.1.1\Configure VC-WIN64A no-shared no-capieng no-srp no-gost no-dgram no-dtls1-method no-dtls1_2-method --api=1.1.0 --prefix=C:\OpenSSL-Win64-111-static --openssldir=C:\OpenSSL-Win64-111-static
`
::: noteimportant
Make sure to revoke write access from non-administrator users to the
OpenSSL install directory (`C:\OpenSSL-Win64-111-static`). Otherwise,
Zabbix agent will load SSL settings from a path that can be modified
by unprivileged users, resulting in a potential security vulnerability.
:::
- Note the option 'no-shared': if 'no-shared' is used then the
OpenSSL static libraries libcrypto.lib and libssl.lib will be
'self-sufficient' and resulting Zabbix binaries will include
OpenSSL in themselves, no need for external OpenSSL DLLs.
Advantage: Zabbix binaries can be copied to other Windows
machines without OpenSSL libraries. Disadvantage: when a new
OpenSSL bugfix version is released, Zabbix agent needs to
recompiled and reinstalled.
- If 'no-shared' is not used, then the static libraries
libcrypto.lib and libssl.lib will be using OpenSSL DLLs at
runtime. Advantage: when a new OpenSSL bugfix version is
released, probably you can upgrade only OpenSSL DLLs, without
recompiling Zabbix agent. Disadvantage: copying Zabbix agent to
another machine requires copying OpenSSL DLLs, too.
7. Compile OpenSSL, run tests, install:`e:\openssl-1.1.1> nmake
e:\openssl-1.1.1> nmake test
...
All tests successful.
Files=152, Tests=1152, 501 wallclock secs ( 0.67 usr + 0.61 sys = 1.28 CPU)
Result: PASS
e:\openssl-1.1.1> nmake install_sw
`'install\_sw' installs only software components (i.e. libraries,
header files, but no documentation). If you want everything, use
"nmake install".
#### 编译OpenSSL
以下步骤将帮助您在MS Windows 10（64位）系统上从源码编译OpenSSL。
1. 在Windows机器上编译OpenSSL需要准备:
1. C编译器（例如VS 2017 RC）,
2. NASM（<https://www.nasm.us/>）,
3. Perl（例如从<http://strawberryperl.com/>获取Strawberry Perl）,
4. Perl模块Text::Template（通过cpan Text::Template安装）.
2. 从<https://www.openssl.org/>获取OpenSSL源码。本文使用OpenSSL 1.1.1版本。
3. 解压OpenSSL源码，例如解压到E:\\openssl-1.1.1目录。
4. 打开命令行窗口，例如VS 2017 RC的x64 Native Tools Command Prompt。
5. 进入OpenSSL源码目录，例如E:\\openssl-1.1.1。
1. 验证NASM是否可用:`e:\openssl-1.1.1> nasm --version
NASM version 2.13.01 compiled on May 1 2017
`
6. 配置OpenSSL，用于
example:`e:\openssl-1.1.1> perl E:\openssl-1.1.1\Configure VC-WIN64A no-shared no-capieng no-srp no-gost no-dgram no-dtls1-method no-dtls1_2-method --api=1.1.0 --prefix=C:\OpenSSL-Win64-111-static --openssldir=C:\OpenSSL-Win64-111-static
`
::: noteimportant
请确保撤销非管理员用户对OpenSSL安装目录（`C:\OpenSSL-Win64-111-static`）的写入权限。否则，Zabbix agent会从可能被非特权用户修改的路径加载SSL设置，导致潜在的安全漏洞。
:::
- 注意'no-shared'选项：如果使用'no-shared'，则OpenSSL静态库libcrypto.lib和libssl.lib将具备'自包含性'，生成的Zabbix二进制文件将内置OpenSSL，无需外部OpenSSL DLL。优点：Zabbix二进制文件可以复制到没有OpenSSL库的其他Windows机器上。缺点：当新的OpenSSL修复version发布时，需要重新编译和重新安装Zabbix agent。
- 如果不使用'no-shared'，则静态库libcrypto.lib和libssl.lib将在运行时使用OpenSSL DLL。优点：当新的OpenSSL修复version发布时，可能只需升级OpenSSL DLL而无需重新编译Zabbix agent。缺点：将Zabbix agent复制到其他机器时也需要复制OpenSSL DLL。
7. 编译OpenSSL，run测试，安装:`e:\openssl-1.1.1> nmake
e:\openssl-1.1.1> nmake test
...
All tests successful.
Files=152, Tests=1152, 501 wallclock secs ( 0.67 usr + 0.61 sys = 1.28 CPU)
Result: PASS
e:\openssl-1.1.1> nmake install_sw
`'install\_sw'仅安装软件组件（即库文件和头文件，不包括文档）。如需完整安装，请使用"nmake install"。
#### Compiling PCRE
1. Download the PCRE or PCRE2 (supported since Zabbix 6.0) library (<https://pcre.org/>).
2. Extract to directory *E:\\pcre2-10.39*.
3. Install CMake from <https://cmake.org/download/>, during install
select: and ensure that cmake\\bin is on your path (tested version
3.9.4).
4. Create a new, empty build directory, preferably a subdirectory of
the source dir. For example, *E:\\pcre2-10.39\\build*.
5. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 and from that shell environment run cmake-gui. Do not
try to start Cmake from the Windows Start menu, as this can lead to
errors.
6. Enter *E:\\pcre2-10.39* and *E:\\pcre2-10.39\\build* for the source and
build directories, respectively.
7. Hit the "Configure" button.
8. When specifying the generator for this project select "NMake
Makefiles".
9. Create a new, empty install directory. For example,
*E:\\pcre2-10.39-install*.
10. The GUI will then list several configuration options. Make sure the
following options are selected:
- **PCRE\_SUPPORT\_UNICODE\_PROPERTIES** ON
- **PCRE\_SUPPORT\_UTF** ON
- **CMAKE\_INSTALL\_PREFIX** *E:\\pcre2-10.39-install*
11. Hit "Configure" again. The adjacent "Generate" button should now be
active.
12. Hit "Generate".
13. In the event that errors occur, it is recommended that you delete
the CMake cache before attempting to repeat the CMake build process.
In the CMake GUI, the cache can be deleted by selecting "File >
Delete Cache".
14. The build directory should now contain a usable build system -
*Makefile*.
15. Open a commandline window e.g. the x64 Native Tools Command Prompt
for VS 2017 and navigate to the *Makefile* mentioned above.
16. Run NMake command: `E:\pcre2-10.39\build> nmake install
`
#### 编译PCRE
1. 下载PCRE或PCRE2（Zabbix 6.0起支持）库（<https://pcre.org/>）。
2. 解压到目录*E:\\pcre2-10.39*。
3. 从<https://cmake.org/download/>安装CMake，安装过程中选择：并确保cmake\\bin在您的路径中（测试版本version 3.9.4）。
4. 创建一个新的空构建目录，最好是源代码目录的子目录。例如，*E:\\pcre2-10.39\\build*。
5. 打开命令行窗口，例如VS 2017的x64 Native Tools Command Prompt，并从该shell环境run cmake-gui。不要尝试从Windows开始菜单启动Cmake，这可能导致错误。
6. 分别输入*E:\\pcre2-10.39*和*E:\\pcre2-10.39\\build*作为源代码和构建目录。
7. 点击"Configure"按钮。
8. 在指定此项目的生成器时选择"NMake Makefiles"。
9. 创建一个新的空安装目录。例如，*E:\\pcre2-10.39-install*。
10. GUI将列出多个配置选项。确保选择以下选项：
- **PCRE\_SUPPORT\_UNICODE\_PROPERTIES** ON
- **PCRE\_SUPPORT\_UTF** ON
- **CMAKE\_INSTALL\_PREFIX** *E:\\pcre2-10.39-install*
11. 再次点击"Configure"。相邻的"Generate"按钮现在应该处于活动状态。
12. 点击"Generate"。
13. 如果出现错误，建议在尝试重复CMake构建过程之前delete CMake缓存。在CMake GUI中，可以通过选择"File > Delete Cache"来删除缓存。
14. 构建目录现在应包含一个可用的构建系统 - *Makefile*。
15. 打开命令行窗口，例如VS 2017的x64 Native Tools Command Prompt，并导航到上述*Makefile*。
16. 运行NMake命令：`E:\pcre2-10.39\build> nmake install
`
#### Compiling PCRE development libraries
The following instructions will compile and install 64-bit PCRE
libraries in *c:\\dev\\pcre* and 32-bit libraries in *c:\\dev\\pcre32*:
1\. Download the PCRE or PCRE2 (supported since Zabbix 6.0) library (<https://pcre.org/>) and extract\
2\. Open *cmd* and navigate to the extracted sources
#### 编译 PCRE 开发库
以下说明将在*c:\\dev\\pcre*中编译安装64位PCRE库，并在*c:\\dev\\pcre32*中安装32位库：
1\. 下载PCRE或PCRE2（Zabbix 6.0起支持）库(<https://pcre.org/>)并解压\
2\. 打开*cmd*并导航至解压后的源码目录
#### Compiling Zabbix agent 2
#### 编译Zabbix agent 2
#### Compiling Zabbix agent on HP-UX
If you install the PCRE library from a popular HP-UX package site
<http://hpux.connect.org.uk>, for example from file
`pcre-8.42-ia64_64-11.31.depot`, you get only the 64-bit version of the
library installed in the /usr/local/lib/hpux64 directory.
In this case, for successful agent compilation customized options need
to be used for the "configure" script, e.g.:
CFLAGS="+DD64" ./configure --enable-agent --with-libpcre-include=/usr/local/include --with-libpcre-lib=/usr/local/lib/hpux64
#### 在 HP-UX 上编译 Zabbix agent
如果从常规的 HP-UX 软件包站点 http://hpux.connect.org.uk 安装 PCRE 库（例如 `pcre-8.42-ia64_64-11.31.depot` 文件），你将仅获得安装在 /usr/local/lib/hpux64 路径下的 64 位版本的库。
在这种情况下，为了成功编译 agent，需要为“配置”脚本使用自定义选项，例如：
CFLAGS="+DD64" ./configure --enable-agent --with-libpcre-include=/usr/local/include --with-libpcre-lib=/usr/local/lib/hpux64
#### Compiling Zabbix agent on HP-UX
If you install the PCRE library from the popular HP-UX package site
<http://hpux.connect.org.uk> (for example, from file `pcre-8.42-ia64_64-11.31.depot`), only the 64-bit version of the library will be installed in the `/usr/local/lib/hpux64` directory.
In this case, for successful agent compilation, a customized option is needed for the `configure` script, for example:
CFLAGS="+DD64" ./configure --enable-agent --with-libpcre-include=/usr/local/include --with-libpcre-lib=/usr/local/lib/hpux64
#### 在 HP-UX 上编译 Zabbix agent
如果从流行的HP-UX软件包站点<http://hpux.connect.org.uk>安装PCRE库（例如通过file `pcre-8.42-ia64_64-11.31.depot`），则仅会安装该库的64位version版本到`/usr/local/lib/hpux64`目录。
这种情况下，为了成功进行agent编译，需要对`configure`脚本使用定制化选项，例如：
CFLAGS="+DD64" ./configure --enable-agent --with-libpcre-include=/usr/local/include --with-libpcre-lib=/usr/local/lib/hpux64
#### Compiling Zabbix
The following steps will help you to compile Zabbix from sources on MS
Windows 10 (64-bit). When compiling Zabbix with/without TLS support the
only significant difference is in step 4.
1. On a Linux machine check out the source from
git:`` $ git clone https://git.zabbix.com/scm/zbx/zabbix.git
$ cd zabbix
$ ./bootstrap.sh
$ ./configure --enable-agent --enable-ipv6 --prefix=`pwd`
$ make dbschema
$ make dist
``
2. Copy and unpack the archive, e.g. zabbix-4.4.0.tar.gz, on a Windows
machine.
3. Let's assume that sources are in e:\\zabbix-4.4.0. Open a
commandline window e.g. the x64 Native Tools Command Prompt for VS
2017 RC. Go to E:\\zabbix-4.4.0\\build\\win32\\project.
4. Compile zabbix\_get, zabbix\_sender and zabbix\_agent.
- without TLS:
`E:\zabbix-4.4.0\build\win32\project> nmake /K PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
`
- with TLS:
`E:\zabbix-4.4.0\build\win32\project> nmake /K -f Makefile_get TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
E:\zabbix-4.4.0\build\win32\project> nmake /K -f Makefile_sender TLS=openssl TLSINCDIR="C:\OpenSSL-Win64-111-static\include TLSLIBDIR="C:\OpenSSL-Win64-111-static\lib" PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
E:\zabbix-4.4.0\build\win32\project> nmake /K -f Makefile_agent TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
`
5. New binaries are located in e:\\zabbix-4.4.0\\bin\\win64. Since
OpenSSL was compiled with 'no-shared' option, Zabbix binaries
contain OpenSSL within themselves and can be copied to other
machines that do not have OpenSSL.
#### 编译Zabbix
以下步骤将帮助您在MS Windows 10（64位）系统上从源代码编译Zabbix。无论是否启用TLS支持，编译Zabbix的主要区别仅体现在第4步。
1. 在Linux机器上检出源代码：
`` $ git clone https://git.zabbix.com/scm/zbx/zabbix.git
$ cd zabbix
$ ./bootstrap.sh
$ ./configure --enable-agent --enable-ipv6 --prefix=`pwd`
$ make dbschema
$ make dist
``
2. 将生成的压缩包（例如zabbix-4.4.0.tar.gz）复制到Windows机器并解压。
3. 假设源代码位于e:\\zabbix-4.4.0目录。打开命令行窗口（例如VS 2017 RC的x64 Native Tools Command Prompt），进入E:\\zabbix-4.4.0\\build\\win32\\project目录。
4. 编译zabbix\_get、zabbix\_sender和zabbix\_agent：
- 不启用TLS：
`E:\zabbix-4.4.0\build\win32\project> nmake /K PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
`
- 启用TLS：
`E:\zabbix-4.4.0\build\win32\project> nmake /K -f Makefile_get TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
E:\zabbix-4.4.0\build\win32\project> nmake /K -f Makefile_sender TLS=openssl TLSINCDIR="C:\OpenSSL-Win64-111-static\include TLSLIBDIR="C:\OpenSSL-Win64-111-static\lib" PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
E:\zabbix-4.4.0\build\win32\project> nmake /K -f Makefile_agent TLS=openssl TLSINCDIR=C:\OpenSSL-Win64-111-static\include TLSLIBDIR=C:\OpenSSL-Win64-111-static\lib PCREINCDIR=E:\pcre2-10.39-install\include PCRELIBDIR=E:\pcre2-10.39-install\lib
`
5. 新生成的二进制文件位于e:\\zabbix-4.4.0\\bin\\win64目录。由于OpenSSL是以'no-shared'选项编译的，Zabbix二进制文件已内置OpenSSL，可复制到未安装OpenSSL的其他机器上运行。
#### Compiling Zabbix with encryption support
To support encryption Zabbix must be compiled and linked with one of the
supported crypto libraries:
- GnuTLS - from version 3.1.18
- OpenSSL - versions 1.0.1, 1.0.2, 1.1.0, 1.1.1, 3.0.x. Note that 3.0.x is supported since Zabbix 6.0.4.
- LibreSSL - tested with versions 2.7.4, 2.8.2:
- LibreSSL 2.6.x is not supported
- LibreSSL is supported as a compatible replacement of OpenSSL;
the new `tls_*()` LibreSSL-specific API functions are not used.
Zabbix components compiled with LibreSSL will not be able to use
PSK, only certificates can be used.
:::notetip
You can find out more about setting up SSL for Zabbix frontend by referring to these [best practices](/manual/installation/requirements/best_practices).
:::
The library is selected by specifying the respective option to
"configure" script:
- `--with-gnutls[=DIR]`
- `--with-openssl[=DIR]` (also used for LibreSSL)
For example, to configure the sources for server and agent with
*OpenSSL* you may use something like:
./configure --enable-server --enable-agent --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-libxml2 --with-openssl
Different Zabbix components may be compiled with different crypto
libraries (e.g. a server with *OpenSSL*, an agent with *GnuTLS*).
::: noteimportant
If you plan to use pre-shared keys (PSK),
consider using *GnuTLS* or *OpenSSL 1.1.0* (or newer) libraries in
Zabbix components using PSKs. *GnuTLS* and *OpenSSL 1.1.0* libraries
support PSK ciphersuites with [Perfect Forward
Secrecy](https://en.wikipedia.org/wiki/Forward_secrecy#Perfect_forward_secrecy_.28PFS.29).
Older versions of the *OpenSSL* library (1.0.1, 1.0.2c) also support
PSKs, but available PSK ciphersuites do not provide Perfect Forward
Secrecy.
:::
#### 编译带加密支持的Zabbix
要支持加密功能，Zabbix必须使用以下任一加密库进行编译和链接：
- GnuTLS - 从version 3.1.18版本开始支持
- OpenSSL - 支持1.0.1、1.0.2、1.1.0、1.1.1、3.0.x版本。注意3.0.x版本从Zabbix 6.0.4开始支持
- LibreSSL - 测试通过的版本包括2.7.4、2.8.2：
- LibreSSL 2.6.x is not supported
- LibreSSL is supported as a compatible replacement of OpenSSL;
the new `tls_*()` LibreSSL-specific API functions are not used.
Zabbix components compiled with LibreSSL will not be able to use
PSK, only certificates can be used.
`tls_*()` 未使用LibreSSL特有的API功能
使用LibreSSL编译的Zabbix组件将无法使用PSK，仅能使用证书
:::notetip
您可以通过这些[best practices](/manual/installation/requirements/best_practices)了解更多关于为Zabbix前端设置SSL的信息。
:::
通过向"configure"脚本指定相应选项来选择加密库：
- `--with-gnutls[=DIR]`
- `--with-openssl[=DIR]` (也适用于LibreSSL)
例如，要为server 和 agent配置*OpenSSL*源代码，可以使用类似以下命令：
./configure --enable-server --enable-agent --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-libxml2 --with-openssl
不同的Zabbix组件可以使用不同的加密库编译
（例如服务器使用*OpenSSL*，agent使用*GnuTLS*）。
::: noteimportant
如果您计划使用预共享密钥(PSK)，
建议在使用PSK的Zabbix组件中使用*GnuTLS*或*OpenSSL 1.1.0*（或更新版本）库。
*GnuTLS*和*OpenSSL 1.1.0*库支持具有[完美前向保密性](https://en.wikipedia.org/wiki/Forward_secrecy#Perfect_forward_secrecy_.28PFS.29)的PSK密码套件。
较旧版本的*OpenSSL*库（1.0.1、1.0.2c）也支持PSK，但可用的PSK密码套件不提供完美前向保密性。
:::
#### Compiling Zabbix with LibreSSL
The process is similar to compiling with OpenSSL, but you need to make
small changes in files located in the `build\win32\project` directory:
- In Makefile_tls delete `/DHAVE_OPENSSL_WITH_PSK`, i.e. find:
```
CFLAGS = $(CFLAGS) /DHAVE_OPENSSL /DHAVE_OPENSSL_WITH_PSK
```
and replace it with
```
CFLAGS = $(CFLAGS) /DHAVE_OPENSSL
```
- In Makefile_common.inc add `/NODEFAULTLIB:LIBCMT` i.e. find:
```
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb
```
and replace it with
```
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb /NODEFAULTLIB:LIBCMT
```
#### 使用LibreSSL编译Zabbix
该过程与使用OpenSSL编译类似，但需要对位于`build\win32\project`目录中的文件进行小幅修改：
- 在Makefile_tls delete `/DHAVE_OPENSSL_WITH_PSK`中，即查找：
```CFLAGS = $(CFLAGS) /DHAVE_OPENSSL /DHAVE_OPENSSL_WITH_PSK
```
and replace it with
```
CFLAGS = $(CFLAGS) /DHAVE_OPENSSL
```- 在Makefile_common.inc中添加`/NODEFAULTLIB:LIBCMT`，即查找：
```
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb
```并将其替换为
```
/MANIFESTUAC:"level='asInvoker' uiAccess='false'" /DYNAMICBASE:NO /PDB:$(TARGETDIR)\$(TARGETNAME).pdb /NODEFAULTLIB:LIBCMT
```
#### Compiling Zabbix with ODBC support
To enable ODBC support, Zabbix should be compiled with the following
flag:
--with-unixodbc[=ARG] # Use ODBC driver against unixODBC package.
::: noteclassic
See more about Zabbix installation from the [source
code](/manual/installation/install#from_the_sources).
:::
#### 编译支持 ODBC 的 Zabbix
要启用ODBC支持，Zabbix需要使用以下flag进行编译：
--with-unixodbc[=ARG] # Use ODBC driver against unixODBC package.
::: noteclassic
有关从[3-从源代码安装](/manual/installation/install#3-从源代码安装)安装Zabbix的更多信息。
:::
#### Compressed content in web monitoring
The ability to handle compressed content has been added to Zabbix web
monitoring. All encoding formats supported by **libcurl** are supported.
#### Web 监控中的压缩内容
Zabbix网页监控已新增对压缩内容的处理能力。支持**libcurl**支持的所有编码格式。
### Conditions
The following conditions can be used in service actions:
|Condition type|Supported operators|Description|
|--|--|------|
|*Service*|equals<br>does not equal|Specify a service or a service to exclude.<br>**equals** - event belongs to this service.<br>**does not equal** - event does not belong to this service.<br>Specifying a parent service implicitly selects all child services. To specify the parent service only, all nested services have to be additionally set with the **does not equal** operator.|
|*Service name*|contains<br>does not contain|Specify a string in the service name or a string to exclude.<br>**contains** - event is generated by a service, containing this string in the name.<br>**does not contain** - this string cannot be found in the service name.|
|*Service tag name*|equals<br>does not equal<br>contains<br>does not contain|Specify an event tag or an event tag to exclude. Service event tags can be defined in the service configuration section *Tags*.<br>**equals** - event has this tag<br>**does not equal** - event does not have this tag<br>**contains** - event has a tag containing this string<br>**does not contain** - event does not have a tag containing this string.|
|*Service tag value*|equals<br>does not equal<br>contains<br>does not contain|Specify an event tag and value combination or a tag and value combination to exclude. Service event tags can be defined in the service configuration section *Tags*.<br>**equals** - event has this tag and value<br>**does not equal** - event does not have this tag and value<br>**contains** - event has a tag and value containing these strings<br>**does not contain** - event does not have a tag and value containing these strings.|
:::noteimportant
Make sure to define [message templates](/manual/config/notifications/media#overview) for Service actions in the *Administration->Media types* menu. Otherwise, the notifications will not be sent.
:::
### 条件
以下条件可用于服务操作:
| 条件类型 | 支持的运算符 | 描述 |
|--|--|------|
| *Service* | equals<br>does not equal | 指定要排除的服务或服务项。<br>**equals** - 事件属于该服务。<br>**does not equal** - 事件不属于该服务。<br>指定父服务会隐式选择所有子服务。若仅指定父服务，必须使用**does not equal**运算符额外设置所有嵌套服务。 |
| *Service name* | contains<br>does not contain | 在服务名称中指定一个string或要排除的string.<br>**contains** - 事件由名称中包含此string的服务生成.<br>**does not contain** - 在服务名称中找不到此string. |
| *Service tag name* | equals<br>does not equal<br>contains<br>does not contain | 指定一个事件标签或要排除的事件标签。服务事件标签可在服务配置部分的*Tags*中定义。<br>**equals** - 事件具有此标签<br>**does not equal** - 事件不具有此标签<br>**contains** - 事件具有包含此string的标签<br>**does not contain** - 事件不具有包含此string的标签。 |
| *Service tag value* | equals<br>does not equal<br>contains<br>does not contain | 指定要包含或排除的事件标签与值组合。服务事件标签可在服务配置的*标签*部分定义。<br>**equals** - 事件包含此标签及值<br>**does not equal** - 事件不包含此标签及值<br>**contains** - 事件包含匹配此字符串的标签及值<br>**does not contain** - 事件不包含匹配此字符串的标签及值。 |
::: noteimportant
请确保在*管理->媒介类型*菜单中为服务操作定义[概述](/manual/config/notifications/media#概述)。否则，通知将无法发送。
:::
#### Configurable fields
The **key** is a unique item identifier (per host). You can create any
key name using supported symbols.
Calculation definition should be entered in the **Formula** field. There
is virtually no connection between the formula and the key. The key
parameters are not used in the formula in any way.
The syntax of a simple formula is:
function(/host/key,<parameter1>,<parameter2>,...)
where:
| | |
|--|--------|
|*function*|One of the [supported functions](/manual/appendix/functions): last, min, max, avg, count, etc|
|*host*|Host of the item that is used for calculation.<br>The current host can be omitted (i.e. as in `function(//key,parameter,...)`).|
|*key*|Key of the item that is used for calculation.|
|*parameter(s)*|Parameters of the function, if required.|
::: noteimportant
[User macros](/manual/config/macros/user_macros)
in the formula will be expanded if used to reference a function
parameter, item filter parameter, or a constant. User macros will NOT be expanded if referencing
a function, host name, item key, item key parameter or
operator.
:::
A more complex formula may use a combination of functions, operators and
brackets. You can use all functions and
[operators](/manual/config/triggers/expression#operators) supported in
trigger expressions. The logic and operator precedence are exactly the
same.
Unlike trigger expressions, Zabbix processes calculated items according
to the item update interval, not upon receiving a new value.
All items that are referenced by history functions in the calculated
item formula must exist and be collecting data. Also, if you change the
item key of a referenced item, you have to manually update any formulas
using that key.
A calculated item may become unsupported in several cases:
- referenced item(s)
- is not found
- is disabled
- belongs to a disabled host
- is not supported (except with nodata() function and
[operators](/manual/config/triggers/expression#operators) with
unknown values)
- no data to calculate a function
- division by zero
- incorrect syntax used
#### 可配置字段
**键**是唯一的监控项标识符（每个主机）。您可以使用支持的符号create任何键名。
计算定义应输入在**公式**字段中。公式与键之间实际上没有关联。键参数不会以任何方式在公式中使用。
简单公式的语法如下：
function(/host/key,<parameter1>,<parameter2>,...)
其中：
| | |
|--|--------|
| *函数* | [supported functions](/manual/appendix/functions)之一：last、min、max、avg、count等 |
| *主机* | 用于计算的监控项的主机。<br>当前主机可以省略（例如`function(//key,parameter,...)`中所示）。 |
| *键* | 用于计算的监控项的键。 |
| *参数* | 函数所需的参数（如有）。 |
::: noteimportant
[User macros](/manual/config/macros/user_macros)
在公式中如果用于引用函数参数、监控项过滤器参数或常量时会被展开。用户宏在引用函数、主机名、监控项键、监控项键参数或运算符时不会被展开。
:::
更复杂的公式可以使用函数、运算符和括号的组合。您可以使用触发器表达式中支持的所有函数和[运算符](/manual/config/triggers/expression#运算符)。逻辑和运算符优先级完全相同。
与触发器表达式不同，Zabbix根据监控项的update间隔处理计算型监控项，而不是在接收到新值时处理。
计算型监控项公式中历史函数引用的所有监控项必须存在并正在收集数据。此外，如果更改被引用监控项的监控项键，必须手动update使用该键的所有公式。
计算型监控项在以下情况下可能变为不支持状态：
- 被引用的监控项
- 未找到
- 已禁用
- 属于已禁用的主机
- 不受支持（nodata()函数和[运算符](/manual/config/triggers/expression#运算符)处理未知值的情况除外）
- 无数据可用于计算函数
- 除以零
- 使用了错误的语法
### Configurable TLS and connection parameters in MQTT plugin
The [MQTT plugin](/manual/appendix/config/zabbix_agent2_plugins/mqtt_plugin) for Zabbix agent 2 now provides additional configuration options, which can be defined in the plugin configuration file as [named session](/manual/config/items/plugins#named-sessions) or [default](/manual/config/items/plugins#default-values) parameters:
- Connection-related parameters: broker URL, topic, username, and password;
- TLS encryption parameters: location of the top-level CA(s) certificate, MQTT certificate or certificate chain, private key.
All of the new parameters are optional.
### MQTT 插件中可配置的 TLS 及连接参数
[MQTT plugin](/manual/appendix/config/zabbix_agent2_plugins/mqtt_plugin) 现在为 Zabbix agent 2 提供了额外的配置选项，这些选项可在插件配置 file 中定义为 [命名会话](/manual/config/items/plugins#命名会话) 或 [默认值](/manual/config/items/plugins#默认值) 参数：
- 连接相关参数：代理URL、主题、用户名和密码；
- TLS加密参数：Top级CA证书的位置、MQTT证书或证书链、私钥。
所有新参数均为可选。
### Configuration
### 配置
#### Configuration
#### 配置
#### Configuration
#### 配置
#### Configuration
#### 配置
#### Configuration
#### 配置
#### Configuration
#### 配置
#### Configuration
#### 配置
#### Configuration
#### 配置
### Configuration
1. Create disabled Script item on the main VMware host (where the **eventlog[]** item is present) with the following parameters:
- *Name*: VMware metrics
- *Type*: Script
- *Key*: vmware.metrics
- *Type of information*: Text
- *Script*: copy and paste the [script](#script) provided below
- *Timeout*: 10
- *History storage period*: Do not keep history
- *Enabled*: unmarked
#### Script
try {
Zabbix.log(4, 'vmware metrics script');
var result, resp,
req = new HttpRequest();
req.addHeader('Content-Type: application/xml');
req.addHeader('SOAPAction: "urn:vim25/6.0"');
login = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25">\
<soapenv:Header/>\
<soapenv:Body>\
<urn:Login>\
<urn:_this type="SessionManager">SessionManager</urn:_this>\
<urn:userName>{$VMWARE.USERNAME}</urn:userName>\
<urn:password>{$VMWARE.PASSWORD}</urn:password>\
</urn:Login>\
</soapenv:Body>\
</soapenv:Envelope>'
resp = req.post("{$VMWARE.URL}", login);
if (req.getStatus() != 200) {
throw 'Response code: '+req.getStatus();
}
query = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25">\
<soapenv:Header/>\
<soapenv:Body>\
<urn:RetrieveProperties>\
<urn:_this type="PropertyCollector">propertyCollector</urn:_this>\
<urn:specSet>\
<urn:propSet>\
<urn:type>PerformanceManager</urn:type>\
<urn:pathSet>perfCounter</urn:pathSet>\
</urn:propSet>\
<urn:objectSet>\
<urn:obj type="PerformanceManager">PerfMgr</urn:obj>\
</urn:objectSet>\
</urn:specSet>\
</urn:RetrieveProperties>\
</soapenv:Body>\
</soapenv:Envelope>'
resp = req.post("{$VMWARE.URL}", query);
if (req.getStatus() != 200) {
throw 'Response code: '+req.getStatus();
}
Zabbix.log(4, 'vmware metrics=' + resp);
result = resp;
logout = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25">\
<soapenv:Header/>\
<soapenv:Body>\
<urn:Logout>\
<urn:_this type="SessionManager">SessionManager</urn:_this>\
</urn:Logout>\
</soapenv:Body>\
</soapenv:Envelope>'
resp = req.post("{$VMWARE.URL}",logout);
if (req.getStatus() != 200) {
throw 'Response code: '+req.getStatus();
}
} catch (error) {
Zabbix.log(4, 'vmware call failed : '+error);
result = {};
}
return result;
Once the item is configured, press *Test* button, then press *Get value*.
{width=600}
Copy received XML to any XML formatter and find the desired metric.
An example of XML for one metric:
<PerfCounterInfo xsi:type="PerfCounterInfo">
<key>6</key>
<nameInfo>
<label>Usage in MHz</label>
<summary>CPU usage in megahertz during the interval</summary>
<key>usagemhz</key>
</nameInfo>
<groupInfo>
<label>CPU</label>
<summary>CPU</summary>
<key>cpu</key>
</groupInfo>
<unitInfo>
<label>MHz</label>
<summary>Megahertz</summary>
<key>megaHertz</key>
</unitInfo>
<rollupType>average</rollupType>
<statsType>rate</statsType>
<level>1</level>
<perDeviceLevel>3</perDeviceLevel>
</PerfCounterInfo>
Use XPath to extract the counter path from received XML. For the example above, the XPath will be:
|field |xPath | value |
|--|--|--|
|group | //groupInfo[../key=6]/key | cpu |
|counter |//nameInfo[../key=6]/key |usagemhz |
|rollup |//rollupType[../key=6] |average |
Resulting performance counter path in this case is: `cpu/usagemhz[average]`
### 配置
1. 在主VMware 主机上创建一个禁用的脚本 监控项（存在 **eventlog[]** 监控项的地方），并设置以下参数：
- *名称*: VMware指标
- *类型*: 脚本
- *键*: vmware.metrics
- *信息类型*: 文本
- *脚本*: copy 并粘贴下方提供的[脚本](#script)
- *超时*: 10
- *历史数据存储周期*: 不保留历史记录
- *Enabled*: 未标记
#### 脚本
try {
Zabbix.log(4, 'vmware metrics script');
var result, resp,
req = new HttpRequest();
req.addHeader('Content-Type: application/xml');
req.addHeader('SOAPAction: "urn:vim25/6.0"');
login = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25">\
<soapenv:Header/>\
<soapenv:Body>\
<urn:Login>\
<urn:_this type="SessionManager">SessionManager</urn:_this>\
<urn:userName>{$VMWARE.USERNAME}</urn:userName>\
<urn:password>{$VMWARE.PASSWORD}</urn:password>\
</urn:Login>\
</soapenv:Body>\
</soapenv:Envelope>'
resp = req.post("{$VMWARE.URL}", login);
if (req.getStatus() != 200) {
throw 'Response code: '+req.getStatus();
}
query = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25">\
<soapenv:Header/>\
<soapenv:Body>\
<urn:RetrieveProperties>\
<urn:_this type="PropertyCollector">propertyCollector</urn:_this>\
<urn:specSet>\
<urn:propSet>\
<urn:type>PerformanceManager</urn:type>\
<urn:pathSet>perfCounter</urn:pathSet>\
</urn:propSet>\
<urn:objectSet>\
<urn:obj type="PerformanceManager">PerfMgr</urn:obj>\
</urn:objectSet>\
</urn:specSet>\
</urn:RetrieveProperties>\
</soapenv:Body>\
</soapenv:Envelope>'
resp = req.post("{$VMWARE.URL}", query);
if (req.getStatus() != 200) {
throw 'Response code: '+req.getStatus();
}
Zabbix.log(4, 'vmware metrics=' + resp);
result = resp;
logout = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:vim25">\
<soapenv:Header/>\
<soapenv:Body>\
<urn:Logout>\
<urn:_this type="SessionManager">SessionManager</urn:_this>\
</urn:Logout>\
</soapenv:Body>\
</soapenv:Envelope>'
resp = req.post("{$VMWARE.URL}",logout);
if (req.getStatus() != 200) {
throw 'Response code: '+req.getStatus();
}
} catch (error) {
Zabbix.log(4, 'vmware call failed : '+error);
result = {};
}
返回结果;
一旦配置好监控项，点击*Test*按钮，然后点击*Get value*。
{width=600}
将接收到的XML复制到任意XML格式化工具中并查找所需的指标。
一个指标的XML示例:
<PerfCounterInfo xsi:type="PerfCounterInfo">
<key>6</key>
<nameInfo>
<label>Usage in MHz</label>
<summary>CPU usage in megahertz during the interval</summary>
<key>usagemhz</key>
</nameInfo>
<groupInfo>
<label>CPU</label>
<summary>CPU</summary>
<key>cpu</key>
</groupInfo>
<unitInfo>
<label>MHz</label>
<summary>Megahertz</summary>
<key>megaHertz</key>
</unitInfo>
<rollupType>average</rollupType>
<statsType>rate</statsType>
<level>1</level>
<perDeviceLevel>3</perDeviceLevel>
</PerfCounterInfo>
使用XPath从接收到的XML中提取计数器路径。对于上述示例，XPath表达式为：
| 字段 | xPath | 值 |
|--|--|--|
| group | //groupInfo[../key=6]/key | cpu |
| counter | //nameInfo[../key=6]/key | usagemhz |
| rollup | //rollupType[../key=6] | 平均值 |
在此情况下的性能计数器路径为：`cpu/usagemhz[average]`
#### Configuration
::: noteclassic
In cases when a user does not have permission to access certain widget elements, that element's name will appear as *Inaccessible* during the widget's configuration.
This results in *Inaccessible Item, Inaccessible Host, Inaccessible Group, Inaccessible Map, and Inaccessible Graph* appearing instead of the "real" name of the element.
:::
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters) for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Host groups*|Enter host groups to display in the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Host data from these host groups will be displayed in the widget. If no host groups are entered, all host groups will be displayed.|
|*Exclude host groups*|Enter host groups to hide from the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Host data from these host groups will not be displayed in the widget. For example, hosts 001, 002, 003 may be in Group A and hosts 002, 003 in Group B as well. If we select to *show* Group A and *exclude* Group B at the same time, only data from host 001 will be displayed in the Dashboard.|
|*Hosts*|Enter hosts to display in the widget. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts.<br>If no hosts are entered, all hosts will be displayed.|
|*Tags*|Specify tags to limit the number of web scenarios displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Show hosts in maintenance*|Include hosts that are in maintenance in the statistics.|
#### 配置
::: noteclassic
当用户无权访问某些小部件元素时，该元素的名称在小部件配置过程中将显示为*Inaccessible*。
这将导致显示*不可访问的监控项、不可访问的主机、不可访问的组、不可访问的映射和不可访问的图形*，而非元素的"真实"名称。
:::
除了适用于所有小部件的[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *主机 组* | 输入要显示在小部件中的主机组。此字段支持自动补全，开始输入组名时将显示匹配组的下拉列表。<br>指定父级主机组会隐式选择所有嵌套的主机组。<br>来自这些主机组的主机数据将显示在小部件中。如果未输入任何主机组，则将显示所有主机组。 |
| *排除主机组* | 输入需要在小部件中隐藏的主机组。该字段支持自动补全功能，输入组名时会显示匹配组的下拉列表。<br>指定父级主机组将隐式选择所有嵌套的主机组。<br>来自这些主机组的主机数据不会在小部件中显示。例如，主机 001、002、003可能在A组中，而主机 002、003也在B组中。如果我们同时选择*显示*A组和*排除*B组，则仪表板中仅会显示来自主机 001的数据。 |
| *主机* | 输入 主机 以在小部件中显示。该字段支持自动补全，因此开始输入 一个主机 名称时将显示匹配 主机 的下拉列表。<br>如果未输入任何 主机，则将显示所有 主机。 |
| *标签* | 指定标签以限制部件中显示的Web场景数量。可以包含或排除特定标签及其值。可设置多个条件。标签名称匹配始终区分大小写。<br>每个条件支持以下运算符：<br>**存在** - 包含指定标签名称<br>**等于** - 包含指定标签名称及值（区分大小写）<br>**包含** - 包含标签值含有输入string的指定标签名称（子串匹配，不区分大小写）<br>**不存在** - 排除指定标签名称<br>**不等于** - 排除指定标签名称及值（区分大小写）<br>**不包含** - 排除标签值含有输入string的指定标签名称（子串匹配，不区分大小写）<br>条件计算类型有两种：<br>**与/或** - 必须满足所有条件，相同标签名的条件将通过或条件分组<br>**或** - 只需满足一个条件 |
| *显示维护中的主机* | 在统计中包含处于维护状态的主机。 |
#### Configuration
Debug mode can be activated for individual users who belong to a user
group:
- when configuring a [user
group](/manual/config/users_and_usergroups/usergroup#configuration);
- when viewing configured [user
groups](//manual/web_interface/frontend_sections/administration/user_groups).
When *Debug mode* is enabled for a user group, its users will see a
*Debug* button in the lower right corner of the browser window:
Clicking on the *Debug* button opens a new window below the page
contents which contains the SQL statistics of the page, along with a
list of API calls and individual SQL statements:
{width="600"}
In case of performance problems with the page, this window may be used
to search for the root cause of the problem.
::: notewarning
Enabled *Debug mode* negatively affects frontend
performance.
:::
#### 配置
调试模式可针对属于用户组的单个用户激活：
- 配置[配置](/manual/config/users_and_usergroups/usergroup#配置)时；
- 查看已配置的[user
groups](//manual/web_interface/frontend_sections/administration/user_groups).
When *Debug mode* is enabled for a user group, its users will see a
*Debug* button in the lower right corner of the browser window:
时
点击*调试*按钮将在页面内容下方打开一个新窗口，其中包含该页面的SQL统计信息，以及API调用列表和单独的SQL语句：
{width="600"}
若页面出现性能问题，可使用此窗口查找问题的根本原因。
::: notewarning
启用*调试模式*会对前端性能产生负面影响。
:::
#### Configuration examples
After setting up the necessary certificates, configure Zabbix components to use certificate-based encryption.
Below are detailed steps for configuring:
- [Zabbix server](#zabbix-server)
- [Zabbix proxy](#zabbix-proxy)
- [Zabbix agent](#zabbix-agent)
#### 配置示例
在设置好必要的证书后，配置Zabbix组件以使用基于证书的加密。
以下是详细的配置步骤：
- [Zabbix server](#zabbix-server)
- [Zabbix proxy](#zabbix-proxy)
- [Zabbix agent](#zabbix-agent)
# configuration.export
# configuration.export
#### Configuration file
For details on configuring Zabbix agent see the configuration file
options for [zabbix\_agentd](/manual/appendix/config/zabbix_agentd) or
[Windows agent](/manual/appendix/config/zabbix_agentd_win).
#### 配置文件
有关配置Zabbix agent的详细信息，请参阅[zabbix\_agentd](/manual/appendix/config/zabbix_agentd)或
[Windows agent](/manual/appendix/config/zabbix_agentd_win)的配置file选项。
##### Configuration file
See the [configuration file](/manual/appendix/config/zabbix_proxy)
options for details on configuring zabbix\_proxy.
##### 配置文件
有关配置zabbix_proxy的详细信息，请参阅[configuration file](/manual/appendix/config/zabbix_proxy)选项。
##### Configuration file
See the [configuration file](/manual/appendix/config/zabbix_server)
options for details on configuring zabbix\_server.
##### 配置文件
有关配置zabbix_server的详细信息，请参阅[configuration file](/manual/appendix/config/zabbix_server)选项。
#### Configuration file
The configuration parameters of agent 2 are mostly compatible with
Zabbix agent with some exceptions.
|New parameters|Description|
|--|--------|
|*ControlSocket*|The runtime control socket path. Agent 2 uses a control socket for [runtime commands](#runtime_control).|
|*EnablePersistentBuffer*,<br>*PersistentBufferFile*,<br>*PersistentBufferPeriod*|These parameters are used to configure persistent storage on agent 2 for active items.|
|*ForceActiveChecksOnStart*|Determines whether the agent should perform active checks immediately after restart or spread evenly over time. Supported since Zabbix 6.0.2.|
|*Plugins*|Plugins may have their own parameters, in the format `Plugins.<Plugin name>.<Parameter>=<value>`. A common plugin parameter is *System.Capacity*, setting the limit of checks that can be executed at the same time.|
|*StatusPort*|The port agent 2 will be listening on for HTTP status request and display of a list of configured plugins and some internal parameters|
|**Dropped parameters**|**Description**|
|*AllowRoot*, *User*|Not supported because daemonization is not supported.|
|*LoadModule*, *LoadModulePath*|Loadable modules are not supported.|
|*StartAgents*|This parameter was used in Zabbix agent to increase passive check concurrency or disable them. In Agent 2, the concurrency is configured at a plugin level and can be limited by a capacity setting. Whereas disabling passive checks is not currently supported.|
|*HostInterface*, *HostInterfaceItem*|Not yet supported.|
For more details see the configuration file options for
[zabbix\_agent2](/manual/appendix/config/zabbix_agent2).
#### 配置文件
agent 2的配置参数大多与Zabbix agent兼容，但存在部分例外情况。
| 新增参数 | 描述 |
|--|--------|
| *ControlSocket* | 运行时控制套接字路径。Agent 2使用控制套接字实现[运行时命令](#runtime_control)功能。 |
| *EnablePersistentBuffer*,<br>*PersistentBufferFile*,<br>*PersistentBufferPeriod* | 这些参数用于为主动式监控项配置agent 2的持久化存储。 |
| *ForceActiveChecksOnStart* | 控制agent在重启后立即执行主动检查还是均匀分布执行。Zabbix 6.0.2版本开始支持。 |
| *Plugins* | 插件可拥有`Plugins.<Plugin name>.<Parameter>=<value>`格式的专属参数。通用插件参数*System.Capacity*用于设置并行检查的数量上限。 |
| *StatusPort* | agent 2监听HTTP状态请求的端口，用于显示已配置插件列表及部分内部参数 |
| **废弃参数** | **描述** |
| *AllowRoot*, *User* | 因不支持守护进程化而被移除。 |
| *LoadModule*, *LoadModulePath* | 不支持可加载模块功能。 |
| *StartAgents* | 该参数在Zabbix agent中用于提升被动检查并发度或禁用检查。Agent 2改为在插件层级配置并发度，并通过容量设置进行限制。当前版本不支持禁用被动检查。 |
| *HostInterface*, *HostInterfaceItem* | 暂未支持。 |
更多细节请参阅[zabbix\_agent2](/manual/appendix/config/zabbix_agent2)的配置file选项。
#### Configuration
Global notifications can be enabled per user in the *Messaging* tab of
[profile configuration](/manual/web_interface/user_profile).
|Parameter|Description|
|--|--------|
|*Frontend messaging*|Mark the checkbox to enable global notifications.|
|*Message timeout*|You can set for how long the message will be displayed. By default, messages will stay on screen for 60 seconds.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 30s, 5m, 2h, 1d.|
|*Play sound*|You can set how long the sound will be played.<br>**Once** - sound is played once and fully.<br>**10 seconds** - sound is repeated for 10 seconds.<br>**Message timeout** - sound is repeated while the message is visible.|
|*Trigger severity*|You can set the trigger severities that global notifications and sounds will be activated for. You can also select the sounds appropriate for various severities.<br>If no severity is marked then no messages will be displayed at all.<br>Also, recovery messages will only be displayed for those severities that are marked. So if you mark *Recovery* and *Disaster*, global notifications will be displayed for the problems and the recoveries of disaster severity triggers.|
|*Show suppressed problems*|Mark the checkbox to display notifications for problems which would otherwise be suppressed (not shown) because of host maintenance.|
#### 配置
全局通知可在用户*消息*选项卡中按用户启用
[profile configuration](/manual/web_interface/user_profile).
| 参数 | 描述 |
|--|--------|
| *Frontend messaging* | 勾选复选框以启用全局通知. |
| *Message timeout* | 可设置消息显示时长. 默认消息会在屏幕上停留60秒.<br>支持[Time suffixes](/manual/appendix/suffixes)格式, 例如30s, 5m, 2h, 1d. |
| *Play sound* | 可设置声音播放时长.<br>**Once** - 声音播放一次且完整播放.<br>**10 seconds** - 声音重复播放10秒.<br>**Message timeout** - 消息可见期间重复播放声音. |
| *Trigger severity* | 可设置触发全局通知和声音的触发器严重级别. 还可为不同严重级别选择相应声音.<br>若未选择任何严重级别则不会显示任何消息.<br>此外, 恢复消息仅会针对已标记的严重级别显示. 例如若标记*Recovery*和*Disaster*, 则全局通知会显示灾难级别触发器的问题和恢复消息. |
| *Show suppressed problems* | 勾选复选框以显示因主机维护而被抑制(不显示)的问题通知. |
# configuration.import
# configuration.import
# configuration.importcompare
# configuration.importcompare
### Configuration import
Previously, the import process would fail on a UUID mismatch of an importable entity (host group, item, graph, etc). For example, it was not possible to import a host group if a host group with the same name already existed on the host.
In the new version the import will not fail because of a UUID mismatch; instead the entity will be matched by the uniqueness criteria such as entity ID (name). The entity will be imported, and the UUID will be updated to the UUID of the imported entity.
In another improvement, when removing template linkage (the *Delete missing* option for template linkage) through the imported template or host, the inherited entities of the unlinked template are no longer removed (template gets unlinked, not unlinked and cleared), unless these entities are missing in the import file **and** the *Delete missing* option for the specific entity is marked.
Due to this change, the warning message when marking the *Delete missing* option for template linkage will no longer be displayed.
### 配置导入
先前，当可导入实体（主机组、监控项、图表等）的UUID不匹配时，import进程会失败。例如，如果主机上已存在同名一个主机组，则无法import一个主机组。
在新的version中，import不会因UUID不匹配而失败；相反，实体将通过唯一性标准（如实体ID/名称）进行匹配。实体将被导入，且UUID将更新为导入实体的UUID。
另一项改进是：当通过导入的模板或主机移除模板关联（模板关联的*删除缺失项*选项）时，未关联模板的继承实体不再被移除（模板仅解除关联，而非解除关联并清除），除非这些实体在importfile中缺失**且**该实体的*删除缺失项*选项被标记。
由于此变更，标记模板关联的*删除缺失项*选项时将不再显示警告消息。
### Configuration import
See changes in the [configuration import](/manual/introduction/whatsnew6013#configuration-import) process.
### 配置导入
查看[配置import](/manual/introduction/whatsnew6013#configuration-import)流程中的变更。
#### Configuration
In order to enable maintenance mode, the `maintenance.inc.php` file
(located in `/conf` of Zabbix HTML document directory on the
web server) must be modified to uncomment the following lines:
// Maintenance mode.
define('ZBX_DENY_GUI_ACCESS', 1);
// Array of IP addresses, which are allowed to connect to frontend (optional).
$ZBX_GUI_ACCESS_IP_RANGE = array('127.0.0.1');
// Message shown on warning screen (optional).
$ZBX_GUI_ACCESS_MESSAGE = 'We are upgrading MySQL database till 15:00. Stay tuned...';
#### 配置
要启用维护模式，必须修改位于Web服务器上Zabbix HTML文档目录中的`/conf`文件内的`maintenance.inc.php` file，取消以下行的注释：
// Maintenance mode.
define('ZBX_DENY_GUI_ACCESS', 1);
// 允许连接前端的IP地址array（可选）。
$ZBX_GUI_ACCESS_IP_RANGE = array('127.0.0.1');
// 警告屏幕上显示的消息（可选）。
$ZBX_GUI_ACCESS_MESSAGE = '我们正在升级MySQL数据库至15:00。请保持关注...';
#### Configuration
In the *Type* field of [item configuration
form](/manual/config/items/item) select Script then fill out required
fields.
All mandatory input fields are marked with a red asterisk.
The fields that require specific information for Script items are:
|Field|Description|
|-----|-----------|
|Key|Enter a unique key that will be used to identify the item.|
|Parameters|Specify the variables to be passed to the script as the attribute and value pairs.<br>[Built-in macros](/manual/config/macros) {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.IP}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG} and [user macros](/manual/config/macros/user_macros) are supported.|
|Script|Enter JavaScript code in the block that appears when clicking in the parameter field (or on the view/edit button next to it). This code must provide the logic for returning the metric value.<br>The code has access to all parameters, it may perform HTTP GET, POST, PUT and DELETE requests and has control over HTTP headers and request body.<br>See also: [Additional JavaScript objects](/manual/config/items/preprocessing/javascript/javascript_objects), [JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide).|
|Timeout|JavaScript execution timeout (1-60s, default 3s).<br>Time suffixes are supported, e.g. 30s, 1m.|
#### 配置
在[监控项配置表单](/manual/config/items/item)的*类型*字段选择脚本，然后填写必要字段。
所有标有红色星号的为必填字段。
需要的脚本监控项特定信息的字段是：
|字段|描述|
|-----|-----------|
|Key|输入用于识别监控项唯一性的键。|
|Parameters|指定传输给脚本的属性与值的配对。<br>支持的宏: [内建宏](/manual/config/macros) {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.IP}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG} 与[用户自定义宏](/manual/config/macros/user_macros)。|
|Script|在点击参数字段的空白所弹出的输入框中输入JavaScript代码（或在查看/编辑按钮后进入该输入框。代码必须提供返回指标数值的逻辑。<br>代码可以访问所有的参数，可以执行HTTP GET、POST、PUT、DELETE请求，并且可以控制HTTP标头和请求体<br>查看更多: [更多JavaScript对象](/manual/config/items/preprocessing/javascript/javascript_objects), [JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide)。|
|Timeout|JavaScript执行超时时间(1-60s, 默认3s)。<br>支持时间后缀，如：30s, 1m。|
### Configuration
In the *Type* field of [item configuration
form](/manual/config/items/item) select Script then fill out required
fields.
All mandatory input fields are marked with a red asterisk.
The fields that require specific information for Script items are:
|Field|Description|
|--|--------|
|Key|Enter a unique key that will be used to identify the item.|
|Parameters|Specify the variables to be passed to the script as the attribute and value pairs.<br>[Built-in macros](/manual/config/macros) {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.IP}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG} and [user macros](/manual/config/macros/user_macros) are supported.|
|Script|Enter JavaScript code in the block that appears when clicking in the parameter field (or on the view/edit button next to it). This code must provide the logic for returning the metric value.<br>The code has access to all parameters, it may perform HTTP GET, POST, PUT and DELETE requests and has control over HTTP headers and request body.<br>See also: [Additional JavaScript objects](/manual/config/items/preprocessing/javascript/javascript_objects), [JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide).|
|Timeout|JavaScript execution timeout (1-60s, default 3s); exceeding it will return error.<br>Time suffixes are supported, e.g. 30s, 1m.<br>Depending on the script it might take longer for the timeout to trigger. |
### 配置
在[item configuration
form](/manual/config/items/item)的*类型*字段中选择脚本，然后填写必填字段。
所有必填输入字段均标有红色星号。
脚本监控项需要填写特定信息的字段包括：
| 字段 | 描述 |
|--|--------|
| Key | 输入用于标识监控项的唯一键值。 |
| Parameters | 指定要传递给脚本的变量作为属性和值对。<br>支持[Built-in macros](/manual/config/macros) {HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.IP}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}和[user macros](/manual/config/macros/user_macros)。 |
| Script | 在点击参数字段（或旁边的查看/编辑按钮）时出现的代码块中输入JavaScript代码。该代码必须提供返回指标值的逻辑。<br>代码可以访问所有参数，可以执行HTTP GET、POST、PUT和DELETE请求，并可以控制HTTP头部和请求体。<br>另请参阅：[Additional JavaScript objects](/manual/config/items/preprocessing/javascript/javascript_objects)、[JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide)。 |
| Timeout | JavaScript执行超时时间（1-60秒，默认为3秒）；超过此时间将返回错误。<br>支持时间后缀，例如30s、1m。<br>根据脚本的不同，触发超时可能需要更长时间。 |
#### Configuration
::: noteimportant
Only Super admin users can create host groups.
:::
There are two options of creating a host group in Zabbix frontend.
**Option one**:
- Go to: *Configuration* → *Host groups*
- Click on *Create Group* in the upper right corner of the screen
- Enter the group name in the form
**Option two**: when [configuring a host](/manual/config/hosts/host#configuration), enter a non-existing group name in the *Groups* input field.
Once the host group is created, you can click on the group name in the list under *Configuration* → *Host groups* to edit the group name, clone the group, or delete the group.
Deleting a host group only deletes the logical group, not the hosts in the group. It is not possible to delete a host group that is the only group for any existing host.
#### 配置
::: noteimportant
仅超级管理员用户可以create 主机组。
:::
在Zabbix前端创建一个主机组有两种方式。
**方式一**:
- 前往：*配置* → *主机组*
- 点击屏幕右上角的*创建组*
- 在表单中输入组名称
**方式二**：当[配置](/manual/config/hosts/host#配置)时，在*组*输入框中输入不存在的组名称。
当主机组创建后，您可以通过*配置* → *主机组*列表点击组名称来编辑组名、克隆组或delete该组。
删除一个主机组仅会删除逻辑组，不会删除组内的主机。若某主机仅属于该一个主机组，则无法delete该组。
#### Configuration
ODBC configuration is done by editing **odbcinst.ini** and **odbc.ini**
files. These configuration files can be found in */etc* folder. The file
**odbcinst.ini** may be missing and in this case it is necessary to
create it manually.
**odbcinst.ini**
[mysql]
Description = General ODBC for MySQL
Driver = /usr/lib64/libmyodbc5.so
Setup = /usr/lib64/libodbcmyS.so
FileUsage = 1
Please consider the following examples of **odbc.ini** configuration
parameters.
- An example with a connection through an IP:
```{=html}
<!-- -->
```
[TEST_MYSQL]
Description = MySQL database 1
Driver = mysql
Port = 3306
Server = 127.0.0.1
- An example with a connection through an IP and with the use of
credentials. A Zabbix database is used by default:
```{=html}
<!-- -->
```
[TEST_MYSQL_FILLED_CRED]
Description = MySQL database 2
Driver = mysql
User = root
Port = 3306
Password = zabbix
Database = zabbix
Server = 127.0.0.1
- An example with a connection through a socket and with the use of
credentials. A Zabbix database is used by default:
```{=html}
<!-- -->
```
[TEST_MYSQL_FILLED_CRED_SOCK]
Description = MySQL database 3
Driver = mysql
User = root
Password = zabbix
Socket = /var/run/mysqld/mysqld.sock
Database = zabbix
All other possible configuration parameter options can be found in
[MySQL official
documentation](https://dev.mysql.com/doc/connector-odbc/en/connector-odbc-configuration-connection-parameters.html)
web page.
#### 配置
ODBC配置通过编辑**odbcinst.ini**和**odbc.ini**完成
这些配置文件可以在*/etc*文件夹中找到。file
**odbcinst.ini** 可能缺失，在这种情况下需要
create 手动执行
**odbcinst.ini**
[mysql]
Description = General ODBC for MySQL
Driver = /usr/lib64/libmyodbc5.so
Setup = /usr/lib64/libodbcmyS.so
FileUsage = 1
请参考以下**odbc.ini**配置示例
参数。
- 通过IP连接的示例:
```{=html}
<!-- -->
```
[TEST_MYSQL]
Description = MySQL数据库1
Driver = mysql
Port = 3306
Server = 127.0.0.1
- 一个通过IP连接并使用示例
credentials. A Zabbix database is used by default:
```{=html}
<!-- -->
```
[TEST_MYSQL_FILLED_CRED]
Description = MySQL数据库2
Driver = mysql
User = root
Port = 3306
Password = zabbix
Database = zabbix
Server = 127.0.0.1
- 一个通过套接字连接并使用功能的示例
credentials. A Zabbix database is used by default:
```{=html}
<!-- -->
```
[TEST_MYSQL_FILLED_CRED_SOCK]
Description = MySQL数据库3
Driver = mysql
User = root
Password = zabbix
Socket = /var/run/mysqld/mysqld.sock
Database = zabbix
数据库 = zabbix
所有其他可能的配置参数选项可在以下位置找到
[MySQL official
documentation](https://dev.mysql.com/doc/connector-odbc/en/connector-odbc-configuration-connection-parameters.html)
网页
#### Configuration
ODBC configuration is done by editing the **odbcinst.ini** and
**odbc.ini** files. These configuration files can be found in */etc*
folder. The file **odbcinst.ini** may be missing and in this case it is
necessary to create it manually.
Please consider the following examples:
**odbcinst.ini**
[postgresql]
Description = General ODBC for PostgreSQL
Driver = /usr/lib64/libodbcpsql.so
Setup = /usr/lib64/libodbcpsqlS.so
FileUsage = 1
# Since 1.6 if the driver manager was built with thread support you may add another entry to each driver entry.
# This entry alters the default thread serialization level.
Threading = 2
**odbc.ini**
[TEST_PSQL]
Description = PostgreSQL database 1
Driver = postgresql
#CommLog = /tmp/sql.log
Username = zbx_test
Password = zabbix
# Name of Server. IP or DNS
Servername = 127.0.0.1
# Database name
Database = zabbix
# Postmaster listening port
Port = 5432
# Database is read only
# Whether the datasource will allow updates.
ReadOnly = No
# PostgreSQL backend protocol
# Note that when using SSL connections this setting is ignored.
# 7.4+: Use the 7.4(V3) protocol. This is only compatible with 7.4 and higher backends.
Protocol = 7.4+
# Includes the OID in SQLColumns
ShowOidColumn = No
# Fakes a unique index on OID
FakeOidIndex = No
# Row Versioning
# Allows applications to detect whether data has been modified by other users
# while you are attempting to update a row.
# It also speeds the update process since every single column does not need to be specified in the where clause to update a row.
RowVersioning = No
# Show SystemTables
# The driver will treat system tables as regular tables in SQLTables. This is good for Access so you can see system tables.
ShowSystemTables = No
# If true, the driver automatically uses declare cursor/fetch to handle SELECT statements and keeps 100 rows in a cache.
Fetch = Yes
# Bools as Char
# Bools are mapped to SQL_CHAR, otherwise to SQL_BIT.
BoolsAsChar = Yes
# SSL mode
SSLmode = Require
# Send to backend on connection
ConnSettings =
#### 配置
ODBC配置通过编辑**odbcinst.ini**和
**odbc.ini**文件完成。这些配置文件可在*/etc*
目录中找到。file **odbcinst.ini**文件可能缺失，此时需要
create手动创建。
请参考以下示例：
**odbcinst.ini**
[postgresql]
Description = General ODBC for PostgreSQL
Driver = /usr/lib64/libodbcpsql.so
Setup = /usr/lib64/libodbcpsqlS.so
FileUsage = 1
# Since 1.6 if the driver manager was built with thread support you may add another entry to each driver entry.
# This entry alters the default thread serialization level.
Threading = 2
**odbc.ini**
[TEST_PSQL]
Description = PostgreSQL数据库1
Driver = postgresql
#CommLog = /tmp/sql.log
Username = zbx_test
Password = zabbix
# 服务器名称。IP或DNS
Servername = 127.0.0.1
# 数据库名称
Database = zabbix
# Postmaster监听端口
Port = 5432
# 数据库为只读
# 数据源是否允许更新。
ReadOnly = No
# PostgreSQL后端协议
# 注意：使用SSL连接时此设置将被忽略。
# 7.4+: 使用7.4(V3)协议。仅与7.4及更高版本的后端兼容。
Protocol = 7.4+
# 在SQLColumns中包含OID
ShowOidColumn = No
# 在OID上模拟唯一索引
FakeOidIndex = No
# 行版本控制
# 允许应用程序检测数据是否被其他用户修改
# 当您尝试update一行时。
# 它还加速了update过程，因为不需要在where子句中指定每一列来update一行。
RowVersioning = No
# 显示系统表
# 驱动程序将在SQLTables中将系统表视为常规表。这对Access很有用，因此您可以看到系统表。
ShowSystemTables = No
# 如果为true，驱动程序自动使用declare cursor/fetch处理SELECT语句，并在缓存中保留100行。
Fetch = Yes
# 布尔值作为字符
# 布尔值映射到SQL_CHAR，否则映射到SQL_BIT。
BoolsAsChar = Yes
# SSL模式
SSLmode = Require
# 连接时发送到后端
ConnSettings =
#### Configuration
ODBC configuration is done by editing the **odbcinst.ini** and
**odbc.ini** files. These configuration files can be found in */etc*
folder. The file **odbcinst.ini** may be missing and in this case it is
necessary to create it manually.
Please consider the following examples:
**odbcinst.ini**
vi /etc/odbcinst.ini
[FreeTDS]
Driver = /usr/lib64/libtdsodbc.so.0
**odbc.ini**
vi /etc/odbc.ini
[sql1]
Driver = FreeTDS
Server = <SQL server 1 IP>
PORT = 1433
TDS_Version = 8.0
#### 配置
ODBC配置通过编辑**odbcinst.ini**和
**odbc.ini**文件完成。这些配置文件位于*/etc*
目录下。file **odbcinst.ini**文件可能缺失，此时需要create
手动创建。
请参考以下示例:
**odbcinst.ini**
vi /etc/odbcinst.ini
[FreeTDS]
Driver = /usr/lib64/libtdsodbc.so.0
**odbc.ini**
vi /etc/odbc.ini
[sql1]
Driver = FreeTDS
Server = <SQL server 1 IP>
PORT = 1433
TDS_Version = 8.0
### Configuration
Once you have [installed](/manual/installation/install) and
[configured](/manual/appendix/config/zabbix_proxy) a proxy, it is time
to configure it in the Zabbix frontend.
### 配置
当您完成[installed](/manual/installation/install)并[configured](/manual/appendix/config/zabbix_proxy)一个proxy后
就可以在Zabbix前端进行配置了
#### Configuration
Overall, the process of setting up the notification should feel familiar
to those who have set up alerts in Zabbix before.
#### 配置
总体而言 对于之前设置过Zabbix告警的用户来说 配置通知的过程会感到熟悉
#### Configuration parameters
For Zabbix server/proxy new configuration parameters have been added for
Vault authentication and retrieving database credentials:
- VaultToken - Vault authentication token (see Zabbix
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
configuration file for details)
- VaultURL - Vault server HTTP\[S\] URL
- VaultDBPath - Vault path from where credentials for database will be
retrieved by keys 'password' and 'username' (for example:
secret/zabbix/database)
Zabbix server and Zabbix proxy read the Vault-related configuration
parameters from zabbix\_server.conf and zabbix\_proxy.conf upon startup.
Zabbix server and Zabbix proxy will additionally read "VAULT\_TOKEN"
environment variable once during startup and unset it so that it would
not be available through forked scripts; it is an error if both
VaultToken and VAULT\_TOKEN contain value.
::: noteclassic
Forward slash and colon are reserved symbols. Forward slash
can only be used to separate mount point from path (e.g. secret/zabbix
where mount point is "secret" and "zabbix" is path) and, in case of
Vault macros, colon can only be used to separate path from key. It is
possible to URL-encode "/" and ":" if there is need to create mount
point with name that is separated by forward slash (e.g. foo/bar/zabbix
where mount point is "foo/bar" and path is "zabbix" as
"foo%2Fbar/zabbix") and if mount point name or path needs to contain
colon.
:::
#### 配置参数
针对Zabbix server/proxy新增了以下Vault认证及数据库凭据获取的配置参数:
- VaultToken - Vault认证令牌(详见Zabbix
[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)
配置中的file函数说明)
- VaultURL - Vault服务器的HTTP[S]地址
- VaultDBPath - 用于获取数据库凭据的Vault路径
retrieved by keys 'password' and 'username' (for example:
secret/zabbix/database)
Zabbix server和Zabbix proxy在启动时会从zabbix\_server.conf和zabbix\_proxy.conf读取Vault相关配置参数。
Zabbix server和Zabbix proxy在启动时会额外读取一次"VAULT\_TOKEN"环境变量并立即清除该变量，以防止其通过fork脚本泄露；若同时设置了VaultToken和VAULT\_TOKEN将会报错。
::: noteclassic
斜杠(/)和冒号(:)是保留字符。斜杠仅可用于分隔挂载点与路径(例如secret/zabbix中"secret"是挂载点，"zabbix"是路径)；在Vault宏中，冒号仅可用于分隔路径与键名。如需create包含斜杠的挂载点名称(例如foo/bar/zabbix中挂载点为"foo/bar"，路径为"zabbix"，应表示为"foo%2Fbar/zabbix")，或当挂载点名称/路径需要包含冒号时，可对"/"和":"进行URL编码。
:::
#### Configuration
Providing you have the HTTP master item configured, you need to create a
[dependent item](/manual/config/items/itemtypes/dependent_items) that
uses a Prometheus preprocessing step:
- Enter general dependent item parameters in the configuration form
- Go to the Preprocessing tab
- Select a Prometheus preprocessing option (*Prometheus pattern* or
*Prometheus to JSON*)
The following parameters are specific to the *Prometheus pattern* preprocessing option:
|Parameter|Description|Examples|
|--|------|------|
|*Pattern*|To define the required data pattern you may use a query language that is similar to Prometheus query language (see [comparison table](#query-language-comparison)), e.g.:<br><metric name> - select by metric name<br>{\_\_name\_\_="<metric name>"} - select by metric name<br>{\_\_name\_\_=\~"<regex>"} - select by metric name matching a regular expression<br>{<label name>="<label value>",...} - select by label name<br>{<label name>=\~"<regex>",...} - select by label name matching a regular expression<br>{\_\_name\_\_=\~".\*"}==<value> - select by metric value<br>Or a combination of the above:<br><metric name>{<label1 name>="<label1 value>",<label2 name>=\~"<regex>",...}==<value><br><br>Label value can be any sequence of UTF-8 characters, but the backslash, double-quote and line feed characters have to be escaped as `\\`, `\"` and `\n` respectively; other characters shall not be escaped.|*wmi\_os\_physical\_memory\_free\_bytes*<br>*cpu\_usage\_system{cpu="cpu-total"}*<br>*cpu\_usage\_system{cpu=\~".\*"}*<br>*cpu\_usage\_system{cpu="cpu-total",host=\~".\*"}*<br>*wmi\_service\_state{name="dhcp"}==1*<br>*wmi\_os\_timezone{timezone=\~".\*"}==1*|
|*Result processing*|Specify whether to return the value, the label or apply the appropriate function (if the pattern matches several lines and the result needs to be aggregated):<br>**value** - return metric value (error if multiple lines matched)<br>**label** - return value of the label specified in the *Label* field (error if multiple metrics are matched)<br>**sum** - return the sum of values<br>**min** - return the minimum value<br>**max** - return the maximum value<br>**avg** - return the average value<br>**count** - return the count of values<br>This field is only available for the *Prometheus pattern* option. |See also examples of using parameters below.|
|*Output*|Define label name (optional). In this case the value corresponding to the label name is returned.<br>This field is only available for the *Prometheus pattern* option, if 'Label' is selected in the *Result processing* field.| |
**Examples of using parameters**
1. The most common use case is to return the **value**. To return
the value of `/var/db` from:
> `node_disk_usage_bytes{path="/var/cache"} 2.1766144e+09`<br>
> `node_disk_usage_bytes{path="/var/db"} 20480`<br>
> `node_disk_usage_bytes{path="/var/dpkg"} 8192`<br>
> `node_disk_usage_bytes{path="/var/empty"} 4096`
use the following parameters:
* *Pattern* - `node_disk_usage_bytes{path="/var/db"}`
* *Result processing* - select 'value'
2. You may also be interested in the **average** value of all
`node_disk_usage_bytes` parameters:
* *Pattern* - `node_disk_usage_bytes`
* *Result processing* - select 'avg'
3. While Prometheus supports only numerical data, it is popular to use a
workaround that allows to return the relevant textual description as well.
This can be accomplished with a filter and specifying the label. So, to
return the value of the 'color' label from
> `elasticsearch_cluster_health_status{cluster="elasticsearch",color="green"} 1`<br>
> `elasticsearch_cluster_health_status{cluster="elasticsearch",color="red"} 0`<br>
> `elasticsearch_cluster_health_status{cluster="elasticsearch",color="yellow"} 0`
use the following parameters:
* *Pattern* - `elasticsearch_cluster_health_status {cluster="elasticsearch"} == 1`
* *Result processing* - select 'label'
* *Label* - specify 'color'
The filter (based on the numeric value '1') will match the appropriate row, while the label will
return the health status description (currently 'green'; but potentially also 'red' or 'yellow').
#### 配置
若已配置HTTP主监控项，您需要create一个
[dependent item](/manual/config/items/itemtypes/dependent_items)，该
链接使用Prometheus预处理步骤：
- 在配置表单中输入通用依赖监控项参数
- 转到预处理选项卡
- 选择Prometheus预处理选项（*Prometheus模式*或
*Prometheus to JSON*)
以下参数特定于*Prometheus模式*预处理选项：
| 参数 | 描述 | 示例 |
|--|------|------|
| *Pattern* | 要定义所需的数据模式，您可以使用与Prometheus query语言相似的query语言（参见[比较表](#query-language-comparison)），例如：<br><metric name> - 按指标名称选择<br>{\_\_name\_\_="<metric name>"} - 按指标名称选择<br>{\_\_name\_\_=\~"<regex>"} - 按匹配正则表达式的指标名称选择<br>{<label name>="<label value>",...} - 按标签名称选择<br>{<label name>=\~"<regex>",...} - 按匹配正则表达式的标签名称选择<br>{\_\_name\_\_=\~".\*"}==<value> - 按指标值选择<br>或上述组合：<br><metric name>{<label1 name>="<label1 value>",<label2 name>=\~"<regex>",...}==<value><br><br>标签值可以是任何UTF-8字符序列，但反斜杠、双引号和换行符必须分别转义为`\\`、`\"`和`\n`；其他字符不应转义。 | *wmi\_os\_physical\_memory\_free\_bytes*<br>*cpu\_usage\_system{cpu="cpu-total"}*<br>*cpu\_usage\_system{cpu=\~".\*"}*<br>*cpu\_usage\_system{cpu="cpu-total",host=\~".\*"}*<br>*wmi\_service\_state{name="dhcp"}==1*<br>*wmi\_os\_timezone{timezone=\~".\*"}==1* |
| *Result processing* | 指定是返回值、标签还是应用适当的函数（如果模式匹配多行且需要聚合结果）：<br>**value** - 返回指标值（如果匹配多行则报错）<br>**label** - 返回*Label*字段中指定标签的值（如果匹配多个指标则报错）<br>**sum** - 返回值的总和<br>**min** - 返回最小值<br>**max** - 返回最大值<br>**avg** - 返回平均值<br>**count** - 返回值的计数<br>此字段仅适用于*Prometheus模式*选项。 | 参见下方参数使用示例。 |
| *Output* | 定义标签名称（可选）。在这种情况下，返回与标签名称对应的值。<br>此字段仅适用于*Prometheus模式*选项，如果在*Result processing*字段中选择'Label'。 | |
**参数使用示例**
1. 最常见的用例是返回**value**。要从以下内容返回`/var/db`的值：
> `node_disk_usage_bytes{path="/var/cache"} 2.1766144e+09`<br>
> `node_disk_usage_bytes{path="/var/db"} 20480`<br>
> `node_disk_usage_bytes{path="/var/dpkg"} 8192`<br>
> `node_disk_usage_bytes{path="/var/empty"} 4096`
使用以下参数：
* *Pattern* - `node_disk_usage_bytes{path="/var/db"}`
* *Result processing* - 选择'value'
2. 您可能还对所有`node_disk_usage_bytes`参数的**average**值感兴趣：
* *Pattern* - `node_disk_usage_bytes`
* *Result processing* - 选择'avg'
3. 虽然Prometheus仅支持数值数据，但流行使用一种变通方法，允许返回相关的文本描述。
这可以通过过滤器和指定标签来实现。因此，要从以下内容返回'color'标签的值：
> `elasticsearch_cluster_health_status{cluster="elasticsearch",color="green"} 1`<br>
> `elasticsearch_cluster_health_status{cluster="elasticsearch",color="red"} 0`<br>
> `elasticsearch_cluster_health_status{cluster="elasticsearch",color="yellow"} 0`
使用以下参数：
* *Pattern* - `elasticsearch_cluster_health_status {cluster="elasticsearch"} == 1`
* *Result processing* - 选择'label'
* *Label* - 指定'color'
基于数值'1'的过滤器将匹配适当的行，而标签将返回健康状态描述（当前为'green'；但也可能是'red'或'yellow'）。
#### Configuration
Real-time export of trigger events, item values and trends is configured
by specifying a directory for the export files - see the `ExportDir`
parameter in server
[configuration](/manual/appendix/config/zabbix_server).
Two other parameters are available:
- `ExportFileSize` may be used to set the maximum allowed size of an
individual export file. When a process needs to write to a file it
checks the size of the file first. If it exceeds the configured size
limit, the file is renamed by appending .old to its name and a new
file with the original name is created.
::: noteimportant
A file will be created per each process that will
write data (i.e. approximately 4-30 files). As the default size per
export file is 1G, keeping large export files may drain the disk space
fast.
:::
- `ExportType` allows to specify which entity types (events, history,
trends) will be exported.
#### 配置
触发器事件、监控项值和趋势数据的实时export功能
通过指定export文件目录进行配置 - 请参阅服务器配置中的
`ExportDir`参数
[configuration](/manual/appendix/config/zabbix_server).
另有两个可用参数:
- `ExportFileSize`可用于设置单个
individual export file. When a process needs to write to a file it
checks the size of the file first. If it exceeds the configured size
limit, the file is renamed by appending .old to its name and a new
file with the original name is created.
文件
允许的最大尺寸
::: noteimportant
每个写入数据进程都会创建一个file文件
(即大约4-30个文件)。由于默认每个exportfile文件
大小为1G，保留大型export文件可能快速耗尽磁盘空间。
:::
- `ExportType`允许指定导出哪些实体类型(事件、历史数据、
趋势数据)。
#### Configuration
Some of the operands (installation options) require additional resources
to be created before. The following section describes these
prerequisites. All possible configuration options are available during
operand deployment. For example, **Zabbix proxy (MySQL)**:
{width="600"}
The YAML section provides all available options with default values:
{width="600"}
#### 配置
部分操作数（安装选项）需要预先创建额外资源。以下章节描述了这些先决条件。所有可能的配置选项在操作数部署期间均可用。例如：**Zabbix proxy (MySQL)**:
{width="600"}
YAML部分提供了所有可用选项及其默认值：
{width="600"}
##### Configuration syncer
Performance of the configuration syncer has been improved.
It is recommended to increase the CacheSize on server/proxy
if there is a large amount of templates. It is also recommended
to remove unused templates.
Note that the default CacheSize on server/proxy has been increased
to 32M.
##### 配置同步器
配置同步器的性能得到了改进。如果有大量模板，建议增加 server/proxy 上的 CacheSize。同时建议删除未使用的模板。
请注意，server/proxy 上的默认 CacheSize 已增加到 32M。
#### Configuration sync optimization for Oracle
For Zabbix installations with Oracle, it is now possible to manually change item and item preprocessing database field types from *nclob* to *nvarchar2* by applying a database patch.
Patch application may increase the speed of configuration sync in environments with large number of items and item preprocessing steps,
but will reduce the maximum field size limit from 65535 bytes to 4000 bytes for some item parameters.
See [Known issues](/manual/installation/known_issues#slow-configuration-sync-with-oracle) for details.
#### Oracle 配置同步优化
对于使用Oracle数据库的Zabbix安装，现在可以通过应用数据库补丁手动将监控项和监控项预处理数据库字段类型从*nclob*更改为*nvarchar2*。
应用此补丁可提升具有大量监控项和监控项预处理步骤环境中的配置同步速度，
但会将部分监控项参数的最大字段大小限制从65535字节降低至4000字节。
详情请参阅[oracle-配置同步缓慢](/manual/installation/known_issues#oracle-配置同步缓慢)。
#### Configuration
Tags can be entered in a dedicated tab, for example, in trigger
configuration:
#### 配置
标签可以在专用选项卡中输入，例如在触发器配置中：
#### Configuration
The global time zone:
- can be set manually when [installing](/manual/installation/frontend)
the frontend
- can be modified in *Administration* → *General* →
*[GUI](/manual/web_interface/frontend_sections/administration/general#gui)*
User-level time zone:
- can be set when
[configuring/updating](/manual/config/users_and_usergroups/user#general_attributes)
a user
- can be set by each user in their [user
profile](/manual/web_interface/user_profile#user-profile)
**See also:** Aligning time zones when using [scheduling intervals](/manual/config/items/item/custom_intervals#aligning-time-zones-for-proxies-and-agent-2).
#### 配置
全局时区:
- 可在[installing](/manual/installation/frontend)
前端界面
时手动设置
- 可通过*管理* → *常规* → 修改
*[GUI](/manual/web_interface/frontend_sections/administration/general#gui)*
用户级时区:
- 可在
[通用属性](/manual/config/users_and_usergroups/user#通用属性)
创建用户
时设置
- 可由各用户在其[user
profile](/manual/web_interface/user_profile#user-profile)
**See also:** Aligning time zones when using [scheduling intervals](/manual/config/items/item/custom_intervals#aligning-time-zones-for-proxies-and-agent-2)中自行设置
#### Configuration
The **Host** tab contains general host attributes:
All mandatory input fields are marked with a red asterisk.
|Parameter|<|Description|
|-|----------|----------------------------------------|
|*Host name*|<|Enter a unique host name. Alphanumerics, spaces, dots, dashes and underscores are allowed. However, leading and trailing spaces are disallowed.<br>*Note:* With Zabbix agent running on the host you are configuring, the agent [configuration file](/manual/appendix/config/zabbix_agentd) parameter *Hostname* must have the same value as the host name entered here. The name in the parameter is needed in the processing of [active checks](/manual/appendix/items/activepassive).|
|*Visible name*|<|Enter a unique visible name for the host. If you set this name, it will be the one visible in lists, maps, etc instead of the technical host name. This attribute has UTF-8 support.|
|*Templates*|<|Link [templates](/manual/config/templates) to the host. All entities (items, triggers, graphs, etc) will be inherited from the template.<br>To link a new template, start typing the template name in the *Templates* field. A list of matching templates will appear; scroll down to select. Alternatively, you may click on *Select* next to the *Templates* field; then, first select the host group by clicking on *Select* next to the *Host groups* field; mark the checkbox in front of one or multiple templates from the list displayed below; click on *Select*. The template(s) that are selected in the *Templates* field will be linked to the host when the host configuration form is saved or updated.<br>To unlink a template, use one of the two options in the *Templates* block:<br>*Unlink* - unlink the template, but preserve its items, triggers and graphs<br>*Unlink and clear* - unlink the template and remove all its items, triggers and graphs<br>Listed template names are clickable links leading to the template configuration form.|
|*Groups*|<|Select [host groups](/manual/config/hosts/host_groups) the host belongs to. A host must belong to at least one host group. A new group can be created and linked to a host by typing in a non-existing group name; the new name will be displayed in a dropdown list as "new" in the brackets; clicking on it, will add it to the selection field.|
|*Interfaces*|<|Several host interface types are supported for a host: *Agent*, *SNMP*, *JMX* and *IPMI*.<br>No interfaces are defined by default. To add a new interface, click on *Add* in the *Interfaces* block, select the interface type and enter *IP/DNS*, *Connect to* and *Port* info.<br>*Note:* Interfaces that are used in any items cannot be removed and link *Remove* is grayed out for them.<br>The "IP" or "DNS" from an SNMP interface is also used for [SNMP traps](/manual/config/items/itemtypes/snmptrap).<br>During matching, only the selected "IP" or "DNS" in the host interface is used.<br>See [Configuring SNMP monitoring](/manual/config/items/itemtypes/snmp#configuring_snmp_monitoring) for additional details on configuring an SNMP interface (v1, v2 and v3).|
| |*IP address*|Host IP address (optional).|
|^|*DNS name*|Host DNS name (optional).|
|^|*Connect to*|Clicking the respective button will tell Zabbix server what to use to retrieve data from agents:<br>**IP** - Connect to the host IP address (recommended)<br>**DNS** - Connect to the host DNS name|
|^|*Port*|TCP/UDP port number. Default values are: 10050 for Zabbix agent, 161 for SNMP agent, 12345 for JMX and 623 for IPMI.|
|^|*Default*|Check the radio button to set the default interface.|
|*Description*|<|Enter the host description.|
|*Monitored by proxy*|<|The host can be monitored either by Zabbix server or one of Zabbix proxies:<br>**(no proxy)** - host is monitored by Zabbix server<br>**Proxy name** - host is monitored by Zabbix proxy "Proxy name"|
|*Enabled*|<|When the checkbox is checked, the host is enabled - ready for monitoring.<br><br>When the checkbox is unchecked, the host is disabled - not monitored:<br>For passive data requests initiated by Zabbix server/proxy (for example, [Zabbix agent](/manual/appendix/items/activepassive#passive-checks), [SNMP agent](/manual/config/items/itemtypes/snmp), [simple checks](/manual/config/items/itemtypes/simple_checks)), monitoring is disabled after configuration synchronization. Triggers and actions linked to the host are also disabled only after the configuration is reloaded.<br>For Zabbix agent [active checks](/manual/appendix/items/activepassive#active-checks), monitoring stops within the time frame (under 2 minutes) that Zabbix agent receives information about the host having been disabled. During this brief interval, the host will continue to locally collect data for the active checks and try sending it to the server/proxy; however, since the host is marked as *Disabled*, the server/proxy will reject the data.|
The **IPMI** tab contains IPMI management attributes.
|Parameter|Description|
|--|--------|
|*Authentication algorithm*|Select the authentication algorithm.|
|*Privilege level*|Select the privilege level.|
|*Username*|User name for authentication. User macros may be used.|
|*Password*|Password for authentication. User macros may be used.|
The **Tags** tab allows you to define host-level
[tags](/manual/config/tagging). All problems of this host will be tagged
with the values entered here.
User macros, {INVENTORY.\*} macros, {HOST.HOST}, {HOST.NAME},
{HOST.CONN}, {HOST.DNS}, {HOST.IP}, {HOST.PORT} and {HOST.ID} macros are
supported in tags.
The **Macros** tab allows you to define host-level [user
macros](/manual/config/macros/user_macros) as a name-value pairs. Note
that macro values can be kept as plain text, secret text or Vault
secret. Adding a description is also supported.
You may also view here template-level and global user macros if you
select the *Inherited and host macros* option. That is where all defined
user macros for the host are displayed with the value they resolve to as
well as their origin.
{width="600"}
For convenience, links to respective templates and global macro
configuration are provided. It is also possible to edit a
template/global macro on the host level, effectively creating a copy of
the macro on the host.
The **Host inventory** tab allows you to manually enter
[inventory](inventory) information for the host. You can also select to
enable *Automatic* inventory population, or disable inventory population
for this host.
If inventory is enabled (manual or automatic), a green dot is displayed
with the tab name.
#### 配置
该**主机**选项卡包含通用主机属性:
所有必填字段均以红色星号标记。
| 参数 | < | 描述 |
|-|----------|----------------------------------------|
| *Host name* | < | 输入唯一主机名。允许使用字母数字、空格、点、短横线和下划线。但禁止使用前导和尾随空格。<br>*注意:* 当Zabbix agent运行在您配置的主机上时，agent的[configuration file](/manual/appendix/config/zabbix_agentd)参数*主机名*必须与此处输入的主机名称相同。该参数中的名称在处理[active checks](/manual/appendix/items/activepassive)时需要。 |
| *Visible name* | < | 为主机输入唯一的可见名称。设置此名称后，它将在列表、地图等位置显示，替代技术性主机名。此属性支持UTF-8编码。 |
| *Templates* | < | 将[templates](/manual/config/templates)链接至主机。所有实体(监控项、触发器、图形等)将从模板继承。<br>要链接新模板，开始在*模板*字段输入模板名称。匹配模板列表将出现；滚动选择。或者，您可以点击*模板*字段旁的*选择*；然后，首先通过点击*主机组*字段旁的*选择*来选择主机组；从下方显示的列表中标记一个或多个模板前的复选框；点击*选择*。当主机配置表单保存或更新时，*模板*字段中选择的模板将被链接到主机。<br>要取消链接模板，使用*模板*块中的两个选项之一:<br>*取消链接* - 取消链接模板，但保留其监控项、触发器和图形<br>*取消链接并clear* - 取消链接模板并移除其所有监控项、触发器和图形<br>列出的模板名称是可点击的链接，指向模板配置表单。 |
| *Groups* | < | 选择主机所属的[host groups](/manual/config/hosts/host_groups)。一个主机必须至少属于一个主机组。可以通过输入不存在的组名创建新组并链接到一个主机；新名称将在下拉列表中显示为括号中的"new"；点击它将添加到选择字段。 |
| *Interfaces* | < | 一个主机支持多种主机接口类型：*Agent*、*SNMP*、*JMX*和*IPMI*。<br>默认未定义接口。要添加新接口，点击*接口*块中的*添加*，选择接口类型并输入*IP/DNS*、*连接到*和*端口*信息。<br>*注意:* 在任何监控项中使用的接口不能被移除，其*移除*链接将显示为灰色。<br>SNMP接口中的"IP"或"DNS"也用于[SNMP traps](/manual/config/items/itemtypes/snmptrap)。<br>在匹配过程中，仅使用主机接口中选择的"IP"或"DNS"。<br>有关配置SNMP接口(v1、v2和v3)的更多详情，请参阅[配置-snmp-监控](/manual/config/items/itemtypes/snmp#配置-snmp-监控)。 |
| | *IP地址* | 主机IP地址（可选）。 |
| ^ | *DNS名称* | 主机DNS名称（可选）。 |
| ^ | *连接到* | 点击相应按钮将告知Zabbix server使用什么从agents检索数据:<br>**IP** - 连接到主机 IP地址（推荐）<br>**DNS** - 连接到主机 DNS名称 |
| ^ | *端口* | TCP/UDP端口号。默认值为：Zabbix agent为10050，SNMP agent为161，JMX为12345，IPMI为623。 |
| ^ | *默认* | 选中单选按钮以设置默认接口。 |
| *Description* | < | 输入主机描述。 |
| *Monitored by proxy* | < | 主机可由Zabbix server或Zabbix proxies之一监控:<br>**(无proxy)** - 主机由Zabbix server监控<br>**Proxy名称** - 主机由Zabbix proxy"Proxy名称"监控 |
| *Enabled* | < | 勾选复选框时，主机启用 - 准备监控。<br><br>未勾选复选框时，主机禁用 - 不监控:<br>对于由Zabbix server/proxy发起的被动数据请求（例如[被动检查](/manual/appendix/items/activepassive#被动检查)、[SNMP agent](/manual/config/items/itemtypes/snmp)、[simple checks](/manual/config/items/itemtypes/simple_checks)），监控在配置同步后禁用。链接到主机的触发器和动作也仅在配置重新加载后禁用。<br>对于Zabbix agent [主动检查](/manual/appendix/items/activepassive#主动检查)，监控在Zabbix agent接收到主机已被禁用信息的时间范围内（2分钟内）停止。在此短暂间隔内，主机将继续为主动检查本地收集数据并尝试发送至server/proxy；但由于主机标记为*禁用*，server/proxy将拒绝数据。 |
**IPMI**选项卡包含IPMI管理属性。
| 参数 | 描述 |
|--|--------|
| *Authentication algorithm* | 选择认证算法。 |
| *Privilege level* | 选择权限级别。 |
| *Username* | 认证用户名。可使用用户宏。 |
| *Password* | 认证密码。可使用用户宏。 |
**标签**选项卡允许您定义[tags](/manual/config/tagging)的主机级别。此主机的所有问题都将被标记为在此输入的值。
支持用户宏、{INVENTORY.\*}宏、{HOST.HOST}、{HOST.NAME}、{HOST.CONN}、{HOST.DNS}、{HOST.IP}、{HOST.PORT}和{HOST.ID}宏在标签中使用。
**宏**选项卡允许您将[user
macros](/manual/config/macros/user_macros)的主机级别定义为名称-值对。注意宏值可以保存为纯文本、秘密文本或Vault秘密。还支持添加描述。
如果您选择*继承和主机宏*选项，您也可以在此查看模板级和全局用户宏。这里显示为主机定义的所有用户宏及其解析值以及来源。
{width="600"}
为方便起见，提供了指向相应模板和全局宏配置的链接。也可以在主机级别编辑模板/全局宏，从而在主机上创建宏的copy。
**主机资产**选项卡允许您手动输入主机的[inventory](inventory)信息。您还可以选择启用*自动*资产清单填充，或为此主机禁用资产清单填充。
如果资产清单启用（手动或自动），选项卡名称旁将显示绿色圆点。
#### Configuration
The **Item** tab contains general item attributes.
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|---------|-----------|
|*Name*|Item name.|
|*Type*|Item type. See individual [item type](itemtypes) sections.|
|*Key*|Item key (up to 2048 characters).<br>The supported [item keys](itemtypes) can be found in individual item type sections.<br>The key must be unique within a single host.<br>If key type is 'Zabbix agent', 'Zabbix agent (active)' or 'Simple check', the key value must be supported by Zabbix agent or Zabbix server.<br>See also: the correct [key format](/manual/config/items/item/key).|
|*Type of information*|Type of data as stored in the database after performing conversions, if any.<br>**Numeric (unsigned)** - 64bit unsigned integer<br>**Numeric (float)** - 64bit floating point number<br>This type will allow precision of approximately 15 digits and range from approximately -1.79E+308 to 1.79E+308 (with exception of [PostgreSQL 11 and earlier versions](/manual/installation/known_issues#floating_point_values)).<br>Receiving values in scientific notation is also supported. E.g. 1.23E+7, 1e308, 1.1E-4.<br>**Character** - short text data<br>**Log** - long text data with optional log related properties (timestamp, source, severity, logeventid)<br>**Text** - long text data. See also [text data limits](#text-data-limits).<br>For item keys that return data only in one specific format, matching type of information is selected automatically.|
|*Host interface*|Select the host interface. This field is available when editing an item on the host level.|
|*Units*|If a unit symbol is set, Zabbix will add post processing to the received value and display it with the set unit postfix.<br>By default, if the raw value exceeds 1000, it is divided by 1000 and displayed accordingly. For example, if you set *bps* and receive a value of 881764, it will be displayed as 881.76 Kbps.<br>The [JEDEC](https://en.wikipedia.org/wiki/JEDEC_memory_standards) memory standard is used for processing **B** (byte), **Bps** (bytes per second) units, which are divided by 1024. Thus, if units are set to **B** or **Bps** Zabbix will display:<br>1 as 1B/1Bps<br>1024 as 1KB/1KBps<br>1536 as 1.5KB/1.5KBps<br>Special processing is used if the following time-related units are used:<br>**unixtime** - translated to "yyyy.mm.dd hh:mm:ss". To translate correctly, the received value must be a *Numeric (unsigned)* type of information.<br>**uptime** - translated to "hh:mm:ss" or "N days, hh:mm:ss"<br>For example, if you receive the value as 881764 (seconds), it will be displayed as "10 days, 04:56:04"<br>**s** - translated to "yyy mmm ddd hhh mmm sss ms"; parameter is treated as number of seconds.<br>For example, if you receive the value as 881764 (seconds), it will be displayed as "10d 4h 56m"<br>Only 3 upper major units are shown, like "1m 15d 5h" or "2h 4m 46s". If there are no days to display, only two levels are displayed - "1m 5h" (no minutes, seconds or milliseconds are shown). Will be translated to "< 1 ms" if the value is less than 0.001.<br>*Note* that if a unit is prefixed with `!`, then no unit prefixes/processing is applied to item values. See [unit conversion](#unit_conversion).|
|*Update interval*|Retrieve a new value for this item every N seconds. Maximum allowed update interval is 86400 seconds (1 day).<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 30s, 1m, 2h, 1d.<br>[User macros](/manual/config/macros/user_macros) are supported.<br>A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.<br>*Note*: The update interval can only be set to '0' if custom intervals exist with a non-zero value. If set to '0', and a custom interval (flexible or scheduled) exists with a non-zero value, the item will be polled during the custom interval duration.<br>*Note* that the first item poll after the item became active or after update interval change might occur earlier than the configured value.<br>An existing passive item can be polled for value immediately by pushing the *Execute now* [button](#form_buttons).|
|*Custom intervals*|You can create custom rules for checking the item:<br>**Flexible** - create an exception to the *Update interval* (interval with different frequency)<br>**Scheduling** - create a custom polling schedule.<br>For detailed information see [Custom intervals](/manual/config/items/item/custom_intervals).<br>[Time suffixes](/manual/appendix/suffixes) are supported in the *Interval* field, e.g. 30s, 1m, 2h, 1d.<br>[User macros](/manual/config/macros/user_macros) are supported.<br>A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.<br>Scheduling is supported since Zabbix 3.0.0.<br>*Note*: Not available for Zabbix agent active items.|
|*History storage period*|Select either:<br>**Do not keep history** - item history is not stored. Useful for master items if only dependent items need to keep history.<br>This setting cannot be overridden by global housekeeper [settings](/manual/web_interface/frontend_sections/administration/general#housekeeper).<br>**Storage period** - specify the duration of keeping detailed history in the database (1 hour to 25 years). Older data will be removed by the housekeeper. Stored in seconds.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 2h, 1d. [User macros](/manual/config/macros/user_macros) are supported.<br>The *Storage period* value can be overridden globally in *Administration → General → [Housekeeper](/manual/web_interface/frontend_sections/administration/general#housekeeper)*.<br>If a global overriding setting exists, a green  info icon is displayed. If you position your mouse on it, a warning message is displayed, e.g. *Overridden by global housekeeper settings (1d)*.<br>It is recommended to keep the recorded values for the smallest possible time to reduce the size of value history in the database. Instead of keeping a long history of values, you can keep longer data of trends.<br>See also [History and trends](/manual/config/items/history_and_trends).|
|*Trend storage period*|Select either:<br>**Do not keep trends** - trends are not stored.<br>This setting cannot be overridden by global housekeeper [settings](/manual/web_interface/frontend_sections/administration/general#housekeeper).<br>**Storage period** - specify the duration of keeping aggregated (hourly min, max, avg, count) history in the database (1 day to 25 years). Older data will be removed by the housekeeper. Stored in seconds.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 24h, 1d. [User macros](/manual/config/macros/user_macros) are supported.<br>The *Storage period* value can be overridden globally in *Administration → General → [Housekeeper](/manual/web_interface/frontend_sections/administration/general#housekeeper)*.<br>If a global overriding setting exists, a green  info icon is displayed. If you position your mouse on it, a warning message is displayed, e.g. *Overridden by global housekeeper settings (7d)*.<br>*Note:* Keeping trends is not available for non-numeric data - character, log and text.<br>See also [History and trends](/manual/config/items/history_and_trends).|
|*Value mapping*|Apply value mapping to this item. [Value mapping](/manual/config/items/mapping) does not change received values, it is for displaying data only.<br>It works with *Numeric(unsigned)*, *Numeric(float)* and *Character* items.<br>For example, "Windows service states".|
|*Log time format*|Available for items of type **Log** only. Supported placeholders:<br>\* **y**: *Year (1970-2038)*<br>\* **M**: *Month (01-12)*<br>\* **d**: *Day (01-31)*<br>\* **h**: *Hour (00-23)*<br>\* **m**: *Minute (00-59)*<br>\* **s**: *Second (00-59)*<br>If left blank the timestamp will not be parsed.<br>For example, consider the following line from the Zabbix agent log file:<br>" 23480:20100328:154718.045 Zabbix agent started. Zabbix 1.8.2 (revision 11211)."<br>It begins with six character positions for PID, followed by date, time, and the rest of the line.<br>Log time format for this line would be "pppppp:yyyyMMdd:hhmmss".<br>Note that "p" and ":" chars are just placeholders and can be anything but "yMdhms".|
|*Populates host inventory field*|You can select a host inventory field that the value of item will populate. This will work if automatic [inventory](/manual/config/hosts/inventory) population is enabled for the host.<br>This field is not available if *Type of information* is set to 'Log'.|
|*Description*|Enter an item description.|
|*Enabled*|Mark the checkbox to enable the item so it will be processed.|
::: noteclassic
Item type specific fields are described on [corresponding
pages](itemtypes).
:::
::: noteclassic
When editing an existing
[template](/manual/config/templates) level item on a host level, a
number of fields are read-only. You can use the link in the form header
and go to the template level and edit them there, keeping in mind that
the changes on a template level will change the item for all hosts that
the template is linked to.
:::
The **Tags** tab allows to define item-level
[tags](/manual/config/tagging).
#### 配置
**监控项** 选项卡包含了常规监控项属性：
{width="600"}
所有必填输入字段都标有红色星号。
| 参数 | 描述 |
|---|---|
|*名称* |监控项名称。<br>可以使用以下宏：<br>**$1, $2...$9** - 指的是监控项的第1、2...9个参数<br>例如：$1上的可用磁盘空间<br>如果监控项的key是 "vfs.fs.size\[/,free\]", 说明将自动更改为 "Free disk space on /"|
|*类型* |监控项类型。参考单个 [监控项类型](itemtypes) 章节.|
|*键值* |监控项键值.<br>可支持的[监控项键值](itemtypes) 能够在各个监控项类型中找到。<br>这个键值在单个主机中必须是唯一的。<br>如果键值的类型是'Zabbix 客户端'、'Zabbix客户端(主动式)', '简单检查' 或者 'Zabbix整合', 则此key必须被 Zabbix 客户端 或者 Zabbix 服务端 支持。<br>也可以查看: 正确的 [键值的格式](/zh/manual/config/items/item/key).|
|*信息类型* |转换后存储在数据库中的数据类型（如果有）。<br>**数字(无正负)** - 64位无符号整数<br>**数字(浮点)** - 64位浮点数<br>允许大约15位的精度，范围从-1.79E+308到1.79E+308(with exception of [PostgreSQL 11和更早版本](/manual/installation/known_issues#floating_point_values)除外)<br>也支持科学计数值。例如:1.23E+7, 1e308, 1.1E-4。<br>**字符** - 短文本数据<br>**日志** - 具有可选日志相关属性的长文本数据(timestamp（时间戳）, source（源）, severity（严重性）, logeventid（日志事件id）)<br>**文本** - 长文本数据。可参见 [文本数据限制](#Text_data_limits)。<br>针对返回的数据是指定格式的监控项键值，匹配的信息类型会自动选择。|
|*主机接口* |主机接口。编辑主机级别的监控项时，此字段可用。|
|*单位* |如果设置了单位符号，Zabbix将在收到数据后再加工处理，并使用设置单位后缀进行显示。<br>默认情况下，如果原始值超过1000，则除以1000，并相应显示。 例如，如果设置 *bps* 并接收到值为881764，则将显示为881.76 Kbps。<br> [JEDEC](https://en.wikipedia.org/wiki/JEDEC_memory_standards) 存储器标准用于处理B（字节），Bps（每秒字节数）单位，除以1024。因此，如果单位设置为B或Bps，Zabbix将显示：<br>1 为 1B/1Bps<br>1024 为 1KB/1KBps<br>1536 为 1.5KB/1.5KBps<br>如果使用以下与时间相关的单位，则使用特殊处理：<br>**unixtime** - 转换成“yyyy.mm.dd hh：mm：ss”。 要正确转换，接收的值必须是数字（无符号）类型的信息。<br>**uptime** - 转换为 "hh:mm:ss" 或者 "N days, hh:mm:ss"<br>例如，如果你收到的值为881764（秒），则显示为“10天，04:56:04”<br>**s** - 转换成“yyy mmm ddd hhh mmm sss ms”; 参数被视为秒数。<br>例如，如果您收到的值为881764（秒），则显示为“10d 4h 56m”<br>只显示3个主要单位，如“1m 15d 5h”或“2h 4m 46s”。 如果没有显示天数，则仅显示两个级别 - “1m 5h”（不显示分钟，秒或毫秒）。 如果该值小于0.001，将被转换成“<1 ms”。<br>注意，如果单位带有前缀“!”，单元前缀/处理不会应用到监控项的值，请参阅 [单位黑名单](#unit_blacklist).|
|*更新间隔* |每N秒检索一次这个项目的新值。允许的最大更新间隔为86400秒（1天）。<br>支持[时间后缀](/zh/manual/appendix/suffixes)，例如 30s，1m，2h，1d。<br>支持[用户宏](/zh/manual/config/macros/usermacros)。<br>单个宏必须填充整个字段。不支持字段中的多个宏或文本混合的宏。<br>*注意*：仅当自定义间隔存在非零值时，更新间隔才能设置为“ 0”。如果设置为“ 0”，并且存在自定义间隔（灵活的或计划的）且具有非零值，则将在自定义间隔持续时间内轮询该项目。<br>*注意* 项目成为活动后或更新间隔更改后的第一个项目轮询可能发生在配置值之前。<br>可以通过按*立即检查*[按钮](#form_buttons)立即轮询现有被动监控项的值。|
|*自定义时间间隔* |你可以创建用于检查监控项的自定义规则：<br>**Flexible**（灵活） - 为 *更新间隔* (不同频率的间隔)创建一个特例。<br>**Scheduling**（调度）- 创建自定义轮询时间表。<br>详细信息请查看 [自定义间隔](/zh/manual/config/items/item/custom_intervals)。<br>*间隔* 字段支持[时间后缀](/zh/manual/appendix/suffixes) , 例如 30s, 1m, 2h, 1d.<br>支持[用户宏](/zh/manual/config/macros/usermacros)。<br>从Zabix 3.0.0开始支持时间表。<br>*注意*: 不适用于Zabbix Agent的活动监控项。|
|*历史数据保留时长*|以下可供选择：<br>**不存储历史数据** - 不存储监控项历史数据。如果只有依赖项需要保留历史记录，则对主监控项很有用。<br>此设置不能被全局管家 [设置](/zh/manual/web_interface/frontend_sections/administration/general#housekeeper)覆盖。<br>**存储时长** - 指定将详细历史数据保留在数据库中的时长(1小时至25年)。 过期数据将被housekeeper管家删除。按秒存储。<br>支持[时间后缀](/zh/manual/appendix/suffixes)，例如2h，1d。支持[用户宏](/zh/manual/config/macros/user_macros)<br> *存储时长* 可以被 *Administration（管理） → General（通用） → [管家](/zh/manual/web_interface/frontend_sections/administration/general#housekeeper)*中的值覆盖。<br>如果存在全局设置，则显示绿色告警信息，。当鼠标移到上面时会提示告警信息，例如*被全局管家设置(1d)覆盖*.<br>建议保留最小可能天数的历史数据，以减轻数据库存储压力。可以保留更长的趋势数据来替代历史数据。<br>更多内容请参考[历史与趋势](/zh/manual/config/items/history_and_trends)。|
|*趋势存储时间*|以下可供选择：<br>**不存储趋势数据** - 将不会存储趋势数据。<br>此设置不能被全局管家[设置](/manual/web_interface/frontend_sections/administration/general#housekeeper)覆盖。<br>**存储时长** - 指定在数据库中保存聚合（每小时，最大，平均，计数）历史数据的时长（1天至25年）。管家将删除较旧的数据。按秒存储。<br>支持[时间后缀](/zh/manual/appendix/suffixes)，例如2h，1d。支持[用户宏](/zh/manual/config/macros/user_macros)<br>*存储时长*可以在*Administration（管理） → General（通用） → [管家](/zh/manual/web_interface/frontend_sections/administration/general#housekeeper)*中的值覆盖。<br>如果存在全局设置，将显示一条绿色的警告消息。当鼠标移到上面时会提示告警信息，例如：*被全局管家设置(7d)覆盖*.<br>*注意:* 保持趋势不适用于非数字数据 - 字符、日志和文本。<br>更多信息请参考 [历史与趋势](/zh/manual/config/items/history_and_trends).|
|*值映射*|将值映射应用于此监控项。[值映射](/zh/manual/config/items/mapping) 不会改变收到的值，仅用于显示数据。<br>适用于 *数值型(无符号)*, *数值型(浮点型)* 和 *字符型* 监控项。<br>例如："Windows service states".|
|*日志时间格式* 仅适用于*|日志**类型的监控项。 支持的占位符:<br>\* **y**: *年 (1970-2038)*<br>\* **M**: *月 (01-12)*<br>\* **d**: *日 (01-31)*<br>\* **h**: *小时 (00-23)*<br>\* **m**: *分钟 (00-59)*<br>\* **s**: *秒 (00-59)*<br>如果留空，则不会解析时间戳。<br>例如，从Zabbix Agent日志文件中考虑以下几行：“23480：20100328：154718.045 Zabbix代理启动。 Zabbix 1.8.2（修订11211）。“<br>它以PID的六个字符位置开始，后跟日期，时间和行的其余部分。<br>该行的日志时间格式为“pppppp：yyyyMMdd：hhmmss”。<br>注意，“p”和“:”字符只是占位符，只能是“yMdhms”。|
|*主机资产纪录字段* |你可以选择项目的值填充的主机资产字段，如果你为主机启用了自动发现模式 [资产管理](/zh/manual/config/hosts/inventory)。<br>该字段在*信息类型*字段设置为'日志'时不可用。|
|*描述* |输入监控项描述。|
|*已启用* |选中复选框以启用该监控项，以便对其进行处理。|
::: noteclassic
监控项类型的特定字段在[对应页面](监控项类型)会有描述。
:::
:::
noteclassic
当编辑主机级别上的现有[模板](/zh/manual/config/templates)级别的监控项时，多个字段是只读的。你可以使用表单标题中的链接并转到模板级别并在其中进行编辑，但请记住，模板级别上的更改将更改模板链接到的所有主机的项目。
:::
**标签** 允许定义监控项级别的[标签](/zh/manual/config/tagging).
#### Configuration
The **Item** tab contains general item attributes.
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Name*|Item name.|
|*Type*|Item type. See individual [item type](itemtypes) sections.|
|*Key*|Item key (up to 2048 characters).<br>The supported [item keys](itemtypes) can be found in individual item type sections.<br>The key must be unique within a single host.<br>If key type is 'Zabbix agent', 'Zabbix agent (active)' or 'Simple check', the key value must be supported by Zabbix agent or Zabbix server.<br>See also: the correct [key format](/manual/config/items/item/key).|
|*Type of information*|Type of data as stored in the database after performing conversions, if any.<br>**Numeric (unsigned)** - 64-bit unsigned integer<br>**Numeric (float)** - 64-bit floating point number<br>This type will allow precision of approximately 15 digits and range from approximately -1.79E+308 to 1.79E+308 (with exception of [PostgreSQL 11 and earlier versions](/manual/installation/known_issues#numeric-float-data-type-range-with-postgresql-11-and-earlier)).<br>Receiving values in scientific notation is also supported. E.g., 1.23E+7, 1e308, 1.1E-4.<br>**Character** - short text data<br>**Log** - long text data with optional log related properties (timestamp, source, severity, logeventid)<br>**Text** - long text data. See also [text data limits](#text-data-limits).<br>For item keys that return data only in one specific format, matching type of information is selected automatically.|
|*Host interface*|Select the host interface. This field is available when editing an item on the host level.|
|*Units*|If a unit symbol is set, Zabbix will add postprocessing to the received value and display it with the set unit postfix.<br>By default, if the raw value exceeds 1000, it is divided by 1000 and displayed accordingly. For example, if you set *bps* and receive a value of 881764, it will be displayed as 881.76 Kbps.<br>Special processing is applied to the following units: **B**, **Bps**, **unixtime**, **uptime**, **s**.<br>The [JEDEC](https://en.wikipedia.org/wiki/JEDEC_memory_standards) memory standard is used for processing **B** (byte), **Bps** (bytes per second) units, which are divided by 1024. Thus, if units are set to **B** or **Bps** Zabbix will display:<br>1 as 1B/1Bps<br>1024 as 1KB/1KBps<br>1536 as 1.5KB/1.5KBps<br>Special processing is used if the following time-related units are used:<br>**unixtime** - translated to "yyyy.mm.dd hh:mm:ss". To translate correctly, the received value must be a *Numeric (unsigned)* type of information.<br>**uptime** - translated to "hh:mm:ss" or "N days, hh:mm:ss"<br>For example, if you receive the value as 881764 (seconds), it will be displayed as "10 days, 04:56:04"<br>**s** - translated to "yyy mmm ddd hhh mmm sss ms"; parameter is treated as number of seconds.<br>For example, if you receive the value as 881764 (seconds), it will be displayed as "10d 4h 56m"<br>Only 3 upper major units are shown, like "1m 15d 5h" or "2h 4m 46s". If there are no days to display, only two levels are displayed - "1m 5h" (no minutes, seconds or milliseconds are shown). Will be translated to "< 1 ms" if the value is less than 0.001.<br>*Note* that if a unit is prefixed with `!`, then no unit prefixes/processing is applied to item values. See [preventing unit conversion](/manual/appendix/suffixes#preventing-unit-conversion).|
|*Update interval*|Retrieve a new value for this item every N seconds. Maximum allowed update interval is 86400 seconds (1 day).<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g., 30s, 1m, 2h, 1d.<br>[User macros](/manual/config/macros/user_macros) are supported.<br>A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.<br>*Note*: The update interval can only be set to '0' if custom intervals exist with a non-zero value. If set to '0', and a custom interval (flexible or scheduled) exists with a non-zero value, the item will be polled during the custom interval duration.<br>*Note* that the first item poll after the item became active or after update interval change might occur earlier than the configured value.<br>An existing passive item can be polled for value immediately by pushing the *Execute now* [button](#form_buttons).|
|*Custom intervals*|You can create custom rules for checking the item:<br>**Flexible** - create an exception to the *Update interval* (interval with different frequency)<br>**Scheduling** - create a custom polling schedule.<br>For detailed information see [Custom intervals](/manual/config/items/item/custom_intervals).<br>[Time suffixes](/manual/appendix/suffixes) are supported in the *Interval* field, e.g., 30s, 1m, 2h, 1d.<br>[User macros](/manual/config/macros/user_macros) are supported.<br>A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.<br>Scheduling is supported since Zabbix 3.0.0.<br>*Note*: custom intervals for active checks are supported by Zabbix agent 2 only.|
|*History storage period*|Select either:<br>**Do not keep history** - item history is not stored. Useful for master items if only dependent items need to keep history.<br>This setting cannot be overridden by global housekeeper [settings](/manual/web_interface/frontend_sections/administration/general#housekeeper).<br>**Storage period** - specify the duration of keeping detailed history in the database (1 hour to 25 years). Older data will be removed by the housekeeper. Stored in seconds.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g., 2h, 1d. [User macros](/manual/config/macros/user_macros) are supported.<br>The *Storage period* value can be overridden globally in *Administration → General → [Housekeeper](/manual/web_interface/frontend_sections/administration/general#housekeeper)*.<br>If a global overriding setting exists, an orange  info icon is displayed. If you position your mouse on it, a warning message is displayed, e.g., *Overridden by global housekeeper settings (1d)*.<br>It is recommended to keep the recorded values for the smallest possible time to reduce the size of value history in the database. Instead of keeping a long history of values, you can keep longer data of trends.<br>See also [History and trends](/manual/config/items/history_and_trends).|
|*Trend storage period*|Select either:<br>**Do not keep trends** - trends are not stored.<br>This setting cannot be overridden by global housekeeper [settings](/manual/web_interface/frontend_sections/administration/general#housekeeper).<br>**Storage period** - specify the duration of keeping aggregated (hourly min, max, avg, count) history in the database (1 day to 25 years). Older data will be removed by the housekeeper. Stored in seconds.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g., 24h, 1d. [User macros](/manual/config/macros/user_macros) are supported.<br>The *Storage period* value can be overridden globally in *Administration → General → [Housekeeper](/manual/web_interface/frontend_sections/administration/general#housekeeper)*.<br>If a global overriding setting exists, an orange  info icon is displayed. If you position your mouse on it, a warning message is displayed, e.g., *Overridden by global housekeeper settings (7d)*.<br>*Note:* Keeping trends is not available for non-numeric data - character, log and text.<br>See also [History and trends](/manual/config/items/history_and_trends).|
|*Value mapping*|Apply value mapping to this item. [Value mapping](/manual/config/items/mapping) does not change received values, it is for displaying data only.<br>It works with *Numeric(unsigned)*, *Numeric(float)* and *Character* items.<br>For example, "Windows service states".|
|*Log time format*|Available for items of type **Log** only. Supported placeholders:<br>\* **y**: *Year (1970-2038)*<br>\* **M**: *Month (01-12)*<br>\* **d**: *Day (01-31)*<br>\* **h**: *Hour (00-23)*<br>\* **m**: *Minute (00-59)*<br>\* **s**: *Second (00-59)*<br>If left blank, the timestamp will be set to 0 in Unix time, representing January 1, 1970.<br>For example, consider the following line from the Zabbix agent log file:<br>" 23480:20100328:154718.045 Zabbix agent started. Zabbix 1.8.2 (revision 11211)."<br>It begins with six character positions for PID, followed by date, time, and the rest of the message.<br>The log time format for this line would be "pppppp:yyyyMMdd:hhmmss".<br>Note that "p" and ":" characters are placeholders and can be any characters except "yMdhms".|
|*Populates host inventory field*|You can select a host inventory field that the value of item will populate. This will work if automatic [inventory](/manual/config/hosts/inventory) population is enabled for the host.<br>This field is not available if *Type of information* is set to 'Log'.|
|*Description*|Enter an item description. [User macros](/manual/config/macros/user_macros) are supported.|
|*Enabled*|Mark the checkbox to enable the item so it will be processed.|
|*Latest data*|Click on the link to view the latest data for the item.<br>This link is only available when editing an already existing item.|
::: noteclassic
Item type specific fields are described on [corresponding
pages](itemtypes).
:::
::: noteclassic
When editing an existing
[template](/manual/config/templates) level item on a host level, a
number of fields are read-only. You can use the link in the form header
and go to the template level and edit them there, keeping in mind that
the changes on a template level will change the item for all hosts that
the template is linked to.
:::
The **Tags** tab allows to define item-level
[tags](/manual/config/tagging).
#### 配置
**监控项** 选项卡包含通用的 监控项 属性。
所有必填字段均以红色星号标记。
| 参数 | 描述 |
|--|--------|
| *Name* | 监控项 名称. |
| *Type* | 监控项 类型。参见各 [item type](itemtypes) 章节。 |
| *Key* | 监控项 键（最多2048个字符）。<br>支持的[item keys](itemtypes)可在各监控项类型章节中找到。<br>该键在单个主机内必须唯一。<br>若键类型为'Zabbix agent'、'Zabbix agent（主动式）'或'简单检查'，则键值必须被Zabbix agent或Zabbix server支持。<br>另请参阅：正确的[key format](/manual/config/items/item/key)。 |
| *Type of information* | 数据库中存储的数据类型（经过必要转换后）。<br>**数值（无符号）** - 64位无符号integer<br>**数值（float）** - 64位浮点数<br>该类型支持约15位精度，数值范围约-1.79E+308至1.79E+308（[postgresql-11及更早版本的数值浮点数据类型范围](/manual/installation/known_issues#postgresql-11及更早版本的数值浮点数据类型范围)除外）。<br>同时支持接收科学计数法表示的值，例如：1.23E+7、1e308、1.1E-4。<br>**字符型** - 短文本数据<br>**日志型** - 带可选日志属性（时间戳、来源、严重程度、日志事件ID）的长文本数据<br>**文本型** - 长文本数据（参见[文本数据限制](#text-data-limits)）<br>对于仅返回特定格式数据的监控项监控项，系统会自动选择匹配的信息类型。 |
| *Host interface* | 选择 主机 界面。当在 主机 级别编辑 监控项 时，此字段可用。 |
| *Units* | 若设置了单位符号，Zabbix会对接收值进行后处理并显示带有所设单位后缀的值。<br>默认情况下，若原始值超过1000，则除以1000后显示。例如，若设置*bps*并收到值881764，将显示为881.76 Kbps。<br>以下单位会进行特殊处理：**B**、**Bps**、**unixtime**、**uptime**、**s**。<br>[JEDEC](https://en.wikipedia.org/wiki/JEDEC_memory_standards) memory标准用于处理**B**（字节）、**Bps**（字节/秒）单位，这些值会除以1024。因此，若单位设为**B**或**Bps**，Zabbix将显示：<br>1为1B/1Bps<br>1024为1KB/1KBps<br>1536为1.5KB/1.5KBps<br>若使用以下时间相关单位会进行特殊处理：<br>**unixtime** - 转换为"yyyy.mm.dd hh:mm:ss"。要正确转换，接收值必须是*Numeric (unsigned)*信息类型。<br>**uptime** - 转换为"hh:mm:ss"或"N天, hh:mm:ss"<br>例如，若收到值881764（秒），将显示为"10天, 04:56:04"<br>**s** - 转换为"yyy年 mmm月 ddd天 hhh时 mmm分 sss秒 ms毫秒"；参数被视为秒数。<br>例如，若收到值881764（秒），将显示为"10天 4时 56分"<br>仅显示3个主要单位层级，如"1月 15天 5时"或"2时 4分 46秒"。若无天数可显示，则仅显示两个层级 - "1月 5时"（不显示分钟、秒或毫秒）。若值小于0.001，将转换为"< 1毫秒"。<br>*注意*：若单位前缀为`!`，则不会对监控项值应用单位前缀/处理。参见[防止单位转换](/manual/appendix/suffixes#防止单位转换)。 |
| *Update interval* | 每N秒为此监控项获取新值。允许的最大update间隔为86400秒（1天）。<br>支持[Time suffixes](/manual/appendix/suffixes)，例如30s、1m、2h、1d。<br>支持[User macros](/manual/config/macros/user_macros)。<br>单个宏必须填满整个字段。不支持字段中包含多个宏或宏与文本混合的情况。<br>*注意*：仅当存在非零值的自定义间隔时，update间隔才能设置为'0'。如果设置为'0'且存在非零值的自定义间隔（灵活或计划），则会在自定义间隔期间轮询监控项。<br>*注意*：监控项激活后或update间隔更改后的首次监控项轮询可能早于配置值发生。<br>可通过点击*立即执行*[按钮](#form_buttons)立即轮询现有被动监控项的值。 |
| *Custom intervals* | 您可以create自定义规则来检查监控项:<br>**灵活** - 为*更新间隔*（不同频率的间隔）create一个例外<br>**调度** - create自定义轮询计划.<br>详细信息请参阅[Custom intervals](/manual/config/items/item/custom_intervals).<br>*间隔*字段支持[Time suffixes](/manual/appendix/suffixes)，例如30s、1m、2h、1d.<br>支持[User macros](/manual/config/macros/user_macros).<br>单个宏必须填满整个字段。不支持在字段中使用多个宏或将宏与文本混合.<br>调度功能自Zabbix 3.0.0起支持.<br>*注意*: 主动检查的自定义间隔仅由Zabbix agent 2支持. |
| *History storage period* | 选择以下任一选项：<br>**不保留历史记录** - 监控项 历史数据将不被存储。适用于主 监控项 仅需依赖 监控项 保留历史记录的场景。<br>此设置不受全局管家 [管家服务](/manual/web_interface/frontend_sections/administration/general#管家服务) 覆盖。<br>**存储周期** - 指定详细历史数据在数据库中保留的时长（1小时至25年）。更早的数据将被管家清理。以秒为单位存储。<br>支持 [Time suffixes](/manual/appendix/suffixes) 格式，例如 2h, 1d。支持 [User macros](/manual/config/macros/user_macros) 格式。<br>*存储周期* 值可在 *管理 → 常规 → [管家服务](/manual/web_interface/frontend_sections/administration/general#管家服务)* 中进行全局覆盖。<br>若存在全局覆盖设置，将显示橙色  信息图标。鼠标悬停时将显示警告信息，例如 *已被全局管家设置覆盖（1d）*。<br>建议尽可能缩短记录值的保留时间以减少数据库中历史值的大小。相较于长期保留详细历史值，可改为保留更长时间的趋势数据。<br>另见 [History and trends](/manual/config/items/history_and_trends)。 |
| *Trend storage period* | 选择以下任一选项：<br>**不保留趋势数据** - 不存储趋势数据。<br>此设置无法被全局管家[管家服务](/manual/web_interface/frontend_sections/administration/general#管家服务)覆盖。<br>**存储周期** - 指定在数据库中保留聚合（每小时最小值、最大值、平均值、计数）历史数据的时长（1天至25年）。更旧的数据将由管家删除。以秒为单位存储。<br>支持[Time suffixes](/manual/appendix/suffixes)格式，例如24h、1d。支持[User macros](/manual/config/macros/user_macros)格式。<br>*存储周期*值可在*管理 → 常规 → [管家服务](/manual/web_interface/frontend_sections/administration/general#管家服务)*中全局覆盖。<br>若存在全局覆盖设置，将显示橙色信息图标。将鼠标悬停其上时，会显示警告消息，例如*被全局管家设置覆盖（7d）*。<br>*注意：* 趋势保留不适用于非数值数据——字符型、日志型和文本型。<br>另见[History and trends](/manual/config/items/history_and_trends)。 |
| *Value mapping* | 对此监控项应用值映射。[Value mapping](/manual/config/items/mapping)不会改变接收到的值，仅用于数据显示。<br>它适用于*无符号数值*、*数值(float)*和*字符*监控项。<br>例如"Windows服务状态"。 |
| *Log time format* | 仅适用于类型为**Log**的监控项. 支持的占位符:<br>\* **y**: *年(1970-2038)*<br>\* **M**: *月(01-12)*<br>\* **d**: *日(01-31)*<br>\* **h**: *时(00-23)*<br>\* **m**: *分(00-59)*<br>\* **s**: *秒(00-59)*<br>如果留空, 时间戳将被设置为Unix时间的0, 即1970年1月1日.<br>例如, 考虑file中Zabbix agent日志的以下行:<br>" 23480:20100328:154718.045 Zabbix agent started. Zabbix 1.8.2 (revision 11211)."<br>它以六个字符位置的PID开头, 后跟日期、时间和消息的其余部分.<br>此行的日志时间格式应为"pppppp:yyyyMMdd:hhmmss".<br>请注意"p"和":"字符是占位符, 可以是除"yMdhms"之外的任何字符. |
| *Populates host inventory field* | 您可以选择 一个主机 资产字段，监控项 的值将填充该字段。当 主机 启用了自动 [inventory](/manual/config/hosts/inventory) 填充功能时此设置生效。<br>若*信息类型*设置为 '日志' 则该字段不可用。 |
| *Description* | 输入 监控项 描述。支持 [User macros](/manual/config/macros/user_macros)。 |
| *Enabled* | 勾选复选框以启用监控项，使其能够被处理。 |
| *Latest data* | 点击链接查看监控项的最新数据。<br>此链接仅在编辑已存在的监控项时可用。 |
::: noteclassic
监控项类型的特定字段描述见[corresponding
pages](itemtypes)。
:::
::: noteclassic
编辑现有
[template](/manual/config/templates) 级别 监控项 在 一个主机 级别上
表单中的部分字段为只读。您可以使用表单标题中的链接
并前往模板层级并在该处编辑它们，需谨记
模板级别的更改将改变所有监控项的主机
该模板所关联的。
:::
**Tags**标签页允许定义监控项级别的
[tags](/manual/config/tagging).
#### Configuration
The low-level discovery rule should be created as a [dependent
item](/manual/config/items/itemtypes/dependent_items) to the HTTP master
item that collects Prometheus data.
#### 配置
低级发现规则应创建为指向收集Prometheus数据的HTTP主监控项的[dependent
item](/manual/config/items/itemtypes/dependent_items)
#### Configuration
The options for aggregation are available in data set settings when
configuring a [graph
widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#graph).
You may pick the aggregation function and the time interval. As the data
set may comprise several items, there is also another option allowing to
show aggregated data for each item separately or for all data set items
as one aggregated value.
#### 配置
在配置[图表](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#图表)时，数据集设置中提供了聚合选项。
您可以选择聚合函数和时间间隔。由于数据集可能包含多个监控项，还有另一个选项允许分别显示每个监控项的聚合数据，或将数据集所有监控项作为一个聚合值显示。
#### Configuration
The *Scheduled reports* tab contains general report attributes.
{width="600"}
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Owner*|User that creates a report. *Super admin* level users are allowed to change the owner. For *Admin* level users, this field is read-only.|
|*Name*|Name of the report; must be unique.|
|*Dashboard*|Dashboard on which the report is based; only one dashboard can be selected at a time. To select a dashboard, start typing the name - a list of matching dashboards will appear; scroll down to select. Alternatively, you may click *Select* next to the field and select a dashboard from the displayed list.<br>If a dashboard contains multiple pages, only the first page will be sent as a report.|
|*Period*|Period for which the report will be prepared. Select the previous day, week, month, or year.|
|*Cycle*|Report generation frequency. The reports can be sent daily, weekly, monthly, or yearly. "Weekly" mode allows to select days of the week when the report will be sent.|
|*Start time*|Time of the day in the format hh:mm when the report will be prepared. Note that Zabbix server time zone will be used.|
|*Repeat on*|Days of the week when the report will be sent. This field is available only if *Cycle* is set to "Weekly".|
|*Start date*|Date when regular report generation should be started.|
|*End date*|Date when regular report generation should be stopped.|
|*Subject*|Subject of the report email. Supports {TIME} macro.|
|*Message*|Body of the report email. Supports {TIME} macro.|
|*Subscriptions*|List of report recipients. By default, includes only the report owner. Any Zabbix user with configured email media may be specified as a report recipient.<br>Click *Add user* or *Add user group* to add more recipients.<br>Click the username to edit settings:<br>*Generate report by* - whether the report data should be generated based on the dashboard permissions of the current user or the recipient.<br>*Status* - select "Include" to send the report to the user or "Exclude" to prevent sending the report to this user. At least one user must have the "Include" status. The "Exclude" status can be used to exclude specific users from a user group that is included.<br><br>Note that users with insufficient permissions (that is, users with a role based on the *Admin* user type who are not members of the same user group as the recipient or report owner) will see "Inaccessible user" or "Inaccessible user group" instead of the actual names in the fields *Recipient* and *Generate report by*; the fields *Status* and *Action* will be displayed as read-only.|
|*Enabled*|Report status. Clearing this checkbox will disable the report.|
|*Description*|An optional description of the report. This description is for internal use and will not be sent to report recipients.|
#### 配置
*计划报告*选项卡包含报告的一般属性。
{width="600"}
所有必填输入字段均标有红色星号。
| 参数 | 描述 |
|--|--------|
| *Owner* | 创建报告的用户。*超级管理员*级别用户可更改所有者，*管理员*级别用户此字段为只读。 |
| *Name* | 报告名称，必须唯一。 |
| *Dashboard* | 报告基于的仪表板；一次只能选择一个仪表板。输入名称可筛选匹配仪表板列表，滚动选择；或点击字段旁的*选择*按钮从列表中选择。<br>若仪表板含多页面，仅第一页会作为报告发送。 |
| *Period* | 报告覆盖的时间段。可选择前一天、周、月或年。 |
| *Cycle* | 报告生成频率。可设置为每日、每周、每月或每年。"每周"模式可指定发送的具体星期几。 |
| *Start time* | 报告生成时间（hh:mm格式）。注意将使用Zabbix server时区。 |
| *Repeat on* | 报告发送的星期几。仅当*周期*设为"每周"时显示此字段。 |
| *Start date* | 开始定期生成报告的日期。 |
| *End date* | 停止定期生成报告的日期。 |
| *Subject* | 报告邮件的主题。支持{TIME}宏。 |
| *Message* | 报告邮件的正文。支持{TIME}宏。 |
| *Subscriptions* | 报告收件人列表。默认仅包含报告所有者。可添加任何配置了邮件媒介的Zabbix用户。<br>点击*添加用户*或*添加用户组*增加收件人。<br>点击用户名可编辑设置：<br>*生成报告依据* - 选择基于当前用户或收件人的仪表板权限生成报告数据。<br>*状态* - 选择"包含"发送报告，或"排除"禁止发送。至少需有一个"包含"状态的用户。"排除"状态可用于从已包含的用户组中排除特定用户。<br><br>注意权限不足的用户（即基于*管理员*用户类型的角色，且非收件人或报告所有者同组成员）将在*收件人*和*生成报告依据*字段中看到"不可访问用户/用户组"；*状态*和*操作*字段将显示为只读。 |
| *Enabled* | 报告状态。取消勾选将禁用报告。 |
| *Description* | 可选的报告描述。该描述仅供内部使用，不会发送给收件人。 |
### Configuration
The Zabbix API allows you to manage the configuration of your monitoring
system.
### 配置
Zabbix API允许您管理监控系统的配置。
#### Configuration
Those remote commands that are executed on Zabbix agent (custom scripts)
must be first enabled in the agent
[configuration](/manual/appendix/config/zabbix_agentd).
Make sure that the AllowKey=system.run[<command>,\*] parameter is added for each allowed command in agent configuration to allow specific command with nowait mode. Restart agent daemon if changing this parameter.
::: noteimportant
Remote commands do not work with active Zabbix
agents.
:::
Then, when configuring a new action in *Configuration → Actions*:
- Define the appropriate conditions. In this example, set that the
action is activated upon any disaster problems with one of Apache
applications:
- In the
*[Operations](/manual/config/notifications/action/operation#configuring_an_operation)*
tab, click on Add in the Operations/Recovery operations/Update
operations block
- From the Operation dropdown field select one of the predefined
scripts
- Select the target list for the script
#### 配置
在Zabbix agent上执行的远程命令（自定义脚本）
必须先在agent中启用
[configuration](/manual/appendix/config/zabbix_agentd).
确保在agent配置中为每个允许的命令添加AllowKey=system.run[<command>,\*]参数，以允许特定命令使用nowait模式。如果更改此参数，请重启agent守护进程。
::: noteimportant
远程命令不适用于活动的Zabbix
agents.
:::
然后，在*配置 → 动作*中配置新动作时：
- 定义适当的条件。在此示例中，设置
action is activated upon any disaster problems with one of Apache
applications:
- 在
*[配置操作](/manual/config/notifications/action/operation#配置操作)*
选项卡中，点击操作/恢复操作/更新操作块中的添加
- 从操作下拉字段中选择一个预定义的
scripts
- 为脚本选择目标列表
#### Configuration
To add the widget, select *Geomap* as type.
#### 配置
要添加该部件，请选择*地理地图*作为类型。
#### Configuration
To add the widget, select *Geomap* as type.
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|---|---|
|*Host groups*|Select host groups to be displayed on the map. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on 'x' to remove the selected.|
|*Hosts*|Select hosts to be displayed all the map. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts. Scroll down to select. Click on 'x' to remove the selected.|
|*Tags*|Specify tags to limit the number of hosts displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Initial view*|Comma separated center coordinates and an optional zoom level to display when the widget is initially loaded in the format `<latitude>,<longitude>,<zoom>`<br>If initial zoom is specified, the Geomap widget is loaded at the given zoom level. Otherwise, initial zoom is calculated as half of the [max zoom](/manual/web_interface/frontend_sections/administration/general#geographical_maps) for the particular tile provider.<br>The initial view is ignored if the default view is set (see below).<br>Examples:<br>=> 40.6892494,-74.0466891,14<br>=> 40.6892494,-122.0466891|
Host markers displayed on the map have the color of the host's most
serious problem and green color if a host has no problems. Clicking on
the host marker allows viewing the host's visible name and the number of
unresolved problems grouped by severity. Clicking on the visible name
will open [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu).
Hosts displayed on the map can be filtered by problem severity. Press on
the filter icon in the widget's upper right corner and mark the required
severities.
It is possible to zoom in and out the map by using the plus and minus
buttons in the widget's upper left corner or by using the mouse scroll
wheel or touchpad. To set the current view as default, right-click
anywhere on the map and select *Set this view as default*. This setting
will override *Initial view* widget parameter for the current user. To
undo this action, right-click anywhere on the map again and select
*Reset the initial view*.
When *Initial view* or *Default view* is set, you can return to this
view at any time by pressing on the home icon on the left.
#### Configuration
To add the widget, select *Geomap* as type.
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|---|---|
|*Host groups*|Select host groups to be displayed on the map. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on 'x' to remove the selected.|
|*Hosts*|Select hosts to be displayed all the map. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts. Scroll down to select. Click on 'x' to remove the selected.|
|*Tags*|Specify tags to limit the number of hosts displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Initial view*|Comma separated center coordinates and an optional zoom level to display when the widget is initially loaded in the format `<latitude>,<longitude>,<zoom>`<br>If initial zoom is specified, the Geomap widget is loaded at the given zoom level. Otherwise, initial zoom is calculated as half of the [max zoom](/manual/web_interface/frontend_sections/administration/general#geographical_maps) for the particular tile provider.<br>The initial view is ignored if the default view is set (see below).<br>Examples:<br>=> 40.6892494,-74.0466891,14<br>=> 40.6892494,-122.0466891|
Host markers displayed on the map have the color of the host's most
serious problem and green color if a host has no problems. Clicking on
the host marker allows viewing the host's visible name and the number of
unresolved problems grouped by severity. Clicking on the visible name
will open [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu).
Hosts displayed on the map can be filtered by problem severity. Press on
the filter icon in the widget's upper right corner and mark the required
severities.
It is possible to zoom in and out the map by using the plus and minus
buttons in the widget's upper left corner or by using the mouse scroll
wheel or touchpad. To set the current view as default, right-click
anywhere on the map and select *Set this view as default*. This setting
will override *Initial view* widget parameter for the current user. To
undo this action, right-click anywhere on the map again and select
*Reset the initial view*.
When *Initial view* or *Default view* is set, you can return to this
view at any time by pressing on the home icon on the left.
#### Configuration
To assign triggers as link indicators, do the following:
- select a map element
- click on *Edit* in the *Links* section for the appropriate link
- click on *Add* in the *Link indicators* block and select one or more
triggers
{width="600"}
All mandatory input fields are marked with a red asterisk.
Added triggers can be seen in the *Link indicators* list.
You can set the link type and color for each trigger directly from the
list. When done, click on *Apply*, close the form and click on *Update*
to save the map changes.
#### 配置
要将触发器设置为链接指示器，请执行以下操作：
- 选择地图元素
- 在相应链接的*Links*部分点击*Edit*
- 在*Link indicators*区块中点击*Add*并选择一个或多个触发器
triggers
{width="600"}
所有必填字段均以红色星号标记。
已添加的触发器可在*Link indicators*列表中查看。
您可以直接从列表中为每个触发器设置链接类型和颜色。完成后点击*Apply*，关闭表单并点击*Update*以保存地图更改。
#### Configuration
To be able to send and receive notifications from Zabbix you have to:
- [define the media](/manual/config/notifications/media) to send a
message to
If the operation takes place outside of the [When active](/manual/config/notifications/media#user-media) time period
defined for the selected media in the user configuration, the message will not be sent.
The default trigger severity ('Not classified')
**must be** checked in user media
[configuration](/manual/config/notifications/media/email#user_media) if
you want to receive notifications for non-trigger events such as
discovery, active agent autoregistration or internal events.
- [configure an action
operation](/manual/config/notifications/action/operation) that sends
a message to one of the defined media
::: noteimportant
Zabbix sends notifications only to those users
that have at least 'read' permissions to the host that generated the
event. At least one host of a trigger expression must be
accessible.
:::
You can configure custom scenarios for sending messages using
[escalations](/manual/config/notifications/action/escalations).
To successfully receive and read e-mails from Zabbix, e-mail
servers/clients must support standard 'SMTP/MIME e-mail' format since
Zabbix sends UTF-8 data (If the subject contains ASCII characters only,
it is not UTF-8 encoded.). The subject and the body of the message are
base64-encoded to follow 'SMTP/MIME e-mail' format standard.
Message limit after all macros expansion is the same as message limit
for [Remote
commands](/manual/config/notifications/action/operation/remote_command).
#### 配置
要能够从Zabbix发送和接收通知，您必须：
- [define the media](/manual/config/notifications/media) 以发送
message to
如果操作发生在用户配置中为所选媒介定义的[用户媒介](/manual/config/notifications/media#用户媒介)时间段之外，则消息将不会被发送。
默认触发器严重性（'未分类'）
**必须**在用户媒介[用户媒介](/manual/config/notifications/media/email#用户媒介)中被勾选，
如果您希望接收非触发器事件的通知，例如
发现、主动agent自动注册或内部事件。
- [configure an action
operation](/manual/config/notifications/action/operation) that sends
a message to one of the defined media
::: noteimportant
Zabbix sends notifications only to those users
that have at least 'read' permissions to the host that generated the
event. At least one host of a trigger expression must be
accessible.
:::
You can configure custom scenarios for sending messages using
[escalations](/manual/config/notifications/action/escalations).
要成功接收和阅读来自Zabbix的电子邮件，电子邮件
服务器/客户端必须支持标准的'SMTP/MIME电子邮件'格式，因为
Zabbix发送的是UTF-8数据（如果主题仅包含ASCII字符，
则不会进行UTF-8编码。）。消息的主题和正文是
经过base64编码以遵循'SMTP/MIME电子邮件'格式标准。
所有宏扩展后的消息限制与[Remote
commands](/manual/config/notifications/action/operation/remote_command)的消息限制相同。
#### Configuration
To configure a CSV to JSON preprocessing step:
- Go to the Preprocessing tab in
[item](/manual/config/items/preprocessing)/[discovery
rule](/manual/discovery/low_level_discovery#preprocessing)
configuration
- Click on *Add*
- Select the *CSV to JSON* option
{width="600"}
The first parameter allows to set a custom delimiter. Note that if the
first line of CSV input starts with "Sep=" and is followed by a single
UTF-8 character then that character will be used as the delimiter in
case the first parameter is not set. If the first parameter is not set
and a delimiter is not retrieved from the "Sep=" line, then a comma is
used as a separator.
The second optional parameter allows to set a quotation symbol.
If the *With header row* checkbox is marked, the header line values will
be interpreted as column names (see [Header
processing](#csv_header_processing) for more information).
If the *Custom on fail* checkbox is marked, the item will not become
unsupported in case of a failed preprocessing step. Additionally custom
error handling options may be set: discard the value, set a specified
value or set a specified error message.
#### 配置
配置CSV转JSON预处理步骤：
- 前往[item](/manual/config/items/preprocessing)/[预处理](/manual/discovery/low_level_discovery#预处理)配置中的预处理选项卡
- 点击*添加*
- 选择*CSV转JSON*选项
{width="600"}
第一个参数允许设置自定义分隔符。请注意，如果CSV输入的首行以"Sep="开头且后接单个UTF-8字符，当第一个参数未设置时该字符将作为分隔符。若第一个参数未设置且未从"Sep="行获取分隔符，则默认使用逗号作为分隔符。
第二个可选参数允许设置引号符号。
若勾选*包含标题行*复选框，标题行数值将被解析为列名（详见[标题行处理](#csv_header_processing)）。
若勾选*自定义失败处理*复选框，当预处理步骤失败时监控项不会变为不受支持状态。还可设置自定义错误处理选项：丢弃数值、设置指定值或设置指定错误消息。
#### Configuration
To configure a maintenance period:
- Go to: *Configuration → Maintenance*
- Click on *Create maintenance period* (or on the name of an existing
maintenance period)
- Enter maintenance parameters in the form
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Name*|Name of the maintenance period.|
|*Maintenance type*|Two types of maintenance can be set:<br>**With data collection** - data will be collected by the server during maintenance, triggers will be processed<br>**No data collection** - data will not be collected by the server during maintenance|
|*Active since*|The date and time when executing maintenance periods becomes active.<br>*Note*: Setting this time alone does not activate a maintenance period; maintenance periods must be configured in *Periods* (see below).|
|*Active till*|The date and time when executing maintenance periods stops being active.|
|*Periods*|This block allows you to define the exact days and hours when the maintenance takes place. Clicking on  opens a popup window with a flexible *Maintenance period* form where you can define maintenance schedule. See [Maintenance periods](#maintenance_periods) for a detailed description.|
|*Host groups*|Select host groups that the maintenance will be activated for. The maintenance will be activated for all hosts from the specified host group(s). This field is auto-complete, so starting to type in it will display a dropdown of all available host groups.<br>Specifying a parent host group implicitly selects all nested host groups. Thus the maintenance will also be activated on hosts from nested groups.|
|*Hosts*|Select hosts that the maintenance will be activated for. This field is auto-complete, so starting to type in it will display a dropdown of all available hosts.<br>|
|*Tags*|If maintenance tags are specified, maintenance for the selected hosts will be activated, but only problems with matching tags will be suppressed (i.e. no actions will be taken).<br>In case of multiple tags, they are calculated as follows:<br>**And/Or** - all tags must correspond; however tags with the same tag name are calculated by the Or condition<br>**Or** - enough if one tag corresponds<br>There are two ways of matching the tag value:<br>**Contains** - case-sensitive substring match (tag value contains the entered string)<br>**Equals** - case-sensitive string match (tag value equals the entered string) <br> Tags can be specified only if *With data collection* mode is selected.|
|*Description*|Description of maintenance period.|
#### 配置
配置维护周期:
- 前往: *配置 → 维护*
- 点击 *创建维护周期* (或现有维护周期名称)
- 在表单中输入维护参数
所有必填字段均以红色星号标记。
| 参数 | 描述 |
|--|--------|
| *Name* | 维护周期名称。 |
| *Maintenance type* | 可设置两种维护类型:<br>**带数据收集** - 服务器在维护期间会收集数据，触发器会被处理<br>**无数据收集** - 服务器在维护期间不会收集数据 |
| *Active since* | 维护周期开始生效的日期和时间。<br>*注意*: 仅设置此时间不会激活维护周期；必须在*周期*中配置维护周期(见下文)。 |
| *Active till* | 维护周期停止生效的日期和时间。 |
| *Periods* | 此区块允许定义维护发生的具体日期和时间。点击会打开一个灵活的*维护周期*表单弹窗，可在此定义维护计划。详见[维护周期](#maintenance_periods)的详细说明。 |
| *Host groups* | 选择维护将激活的主机组。维护将对指定主机组(s)中的所有主机激活。此字段支持自动补全，输入时会显示所有可用主机组的下拉列表。<br>指定父主机组会隐式选择所有嵌套的主机组。因此维护也会对嵌套组中的主机激活。 |
| *Hosts* | 选择维护将激活的主机。此字段支持自动补全，输入时会显示所有可用主机的下拉列表。<br> |
| *Tags* | 如果指定了维护标签，对所选主机的维护将被激活，但仅会抑制匹配标签的问题(即不会采取任何操作)。<br>多个标签的计算方式如下:<br>**与/或** - 所有标签必须对应；但相同标签名的标签按或条件计算<br>**或** - 只需一个标签对应即可<br>有两种匹配标签值的方式:<br>**包含** - 区分大小写的子串匹配(标签值包含输入的string)<br>**等于** - 区分大小写的string匹配(标签值等于输入的string) <br> 只有在选择*带数据收集*模式时才能指定标签。 |
| *Description* | 维护周期描述。 |
#### Configuration
To configure a user group:
- Go to *Administration → User groups*
- Click on *Create user group* (or on the group name to edit an
existing group)
- Edit group attributes in the form
The **User group** tab contains general group attributes:
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Group name*|Unique group name.|
|*Users*|To add users to the group start typing the name of an existing user. When the dropdown with matching user names appears, scroll down to select.<br>Alternatively you may click the *Select* button to select users in a popup.|
|*Frontend access*|How the users of the group are authenticated.<br>**System default** - use default authentication method (set [globally](/manual/web_interface/frontend_sections/administration/authentication))<br>**Internal** - use Zabbix internal authentication (even if LDAP authentication is used globally).<br>Ignored if HTTP authentication is the global default.<br>**LDAP** - use LDAP authentication (even if internal authentication is used globally).<br>Ignored if HTTP authentication is the global default.<br>**Disabled** - access to Zabbix frontend is forbidden for this group|
|*Enabled*|Status of user group and group members.<br>*Checked* - user group and users are enabled<br>*Unchecked* - user group and users are disabled|
|*Debug mode*|Mark this checkbox to activate [debug mode](/manual/web_interface/debug_mode) for the users.|
The **Permissions** tab allows you to specify user group access to host
group (and thereby host) data:
{width="600"}
Current permissions to host groups are displayed in the *Permissions* block.
If current permissions of the host group are inherited by all nested host groups, this is indicated after the host group name ("*including subgroups*").
Note that a *Super admin* user can enforce nested host groups to have the same level of permissions as the parent host group; this can be done in the host group [configuration](/manual/config/hosts/host#creating_a_host_group) form.
You may change the level of access to a host group:
- **Read-write** - read-write access to a host group;
- **Read** - read-only access to a host group;
- **Deny** - access to a host group denied;
- **None** - no permissions are set.
Use the selection field below to select host groups and the level of access to them.
This field is auto-complete so starting to type the name of a host group will offer a dropdown of matching host groups.
If you wish to see all host groups, click on *Select*.
If you wish to include nested host groups, mark the *Include subgroups* checkbox.
Click on  to add the selected host groups to the list of host group permissions.
:::noteimportant
Adding a parent host group with the *Include subgroups* checkbox marked will override (and remove from the list) previously configured permissions of all related nested host groups.
Adding a host group with *None* as the level of access selected will remove the host group from the list if the host group is already in the list.
:::
The **Tag filter** tab allows you to set tag-based permissions for user
groups to see problems filtered by tag name and its value:
To select a host group to apply a tag filter for, click *Select* to get
the complete list of existing host groups or start to type the name of a
host group to get a dropdown of matching groups. If you want to apply
tag filters to nested host groups, mark the *Include subgroups*
checkbox.
Tag filter allows to separate the access to host group from the
possibility to see problems.
For example, if a database administrator needs to see only "MySQL"
database problems, it is required to create a user group for database
administrators first, then specify "Service" tag name and "MySQL" value.
If "Service" tag name is specified and value field is left blank,
corresponding user group will see all problems for selected host group
with tag name "Service". If both tag name and value fields are left
blank but host group selected, corresponding user group will see all
problems for selected host group. Make sure a tag name and tag value are
correctly specified otherwise a corresponding user group will not see
any problems.
Let's review an example when a user is a member of several user groups
selected. Filtering in this case will use OR condition for tags.
| | | | | | | |
|---|---|---|---|---|---|---|
|**User group A**|<|<|**User group B**|<|<|**Visible result for a user (member) of both groups**|
|*Tag filter*|<|<|<|<|<|^|
|*Host group*|*Tag name*|*Tag value*|*Host group*|*Tag name*|*Tag value*|^|
|Templates/Databases|Service|MySQL|Templates/Databases|Service|Oracle|Service: MySQL or Oracle problems visible|
|Templates/Databases|*blank*|*blank*|Templates/Databases|Service|Oracle|All problems visible|
|*not selected*|*blank*|*blank*|Templates/Databases|Service|Oracle|<Service:Oracle> problems visible|
::: noteimportant
Adding a filter (for example, all tags in a
certain host group "Templates/Databases") results in not being able to
see the problems of other host groups.
:::
#### 配置
要配置用户组:
- 前往 *管理 → 用户组*
- 点击*创建用户组*（或点击组名称以编辑现有组）
现有群组)
- 在表单中编辑群组属性
**用户组**标签页包含以下通用组属性:
所有必填字段均以红色星号标记。
| 参数 | 描述 |
|--|--------|
| *Group name* | 唯一组名称. |
| *Users* | 要将用户添加至该组，请开始输入现有用户的名称。当匹配用户名的下拉列表出现时，滚动选择。<br>或者点击*选择*按钮，通过弹出窗口选择用户。 |
| *Frontend access* | 该用户组的认证方式。<br>**系统默认** - 使用默认认证方法（设置[globally](/manual/web_interface/frontend_sections/administration/authentication)）<br>**内部认证** - 使用Zabbix内部认证（即使全局使用LDAP认证）。<br>若HTTP认证为全局默认则忽略此设置。<br>**LDAP** - 使用LDAP认证（即使全局使用内部认证）。<br>若HTTP认证为全局默认则忽略此设置。<br>**禁用** - 禁止该用户组访问Zabbix前端 |
| *Enabled* | 用户组及组成员状态.<br>*Checked* - 用户组及用户已启用<br>*Unchecked* - 用户组及用户已禁用 |
| *Debug mode* | 勾选此复选框以激活用户的[debug mode](/manual/web_interface/debug_mode)。 |
**权限**选项卡允许您指定用户组对主机的访问权限
组（以及相应的主机）数据：
{width="600"}
当前对主机组的权限显示在*Permissions*区块中。
如果主机组的当前权限被所有嵌套的主机组继承，这将在主机组名称后标明（"*包括子组*"）。
请注意，*超级管理员*用户可强制嵌套的主机组继承父主机组的相同权限级别，此操作可通过主机组的[创建主机组](/manual/config/hosts/host#创建主机组)表单实现。
您可以更改对一个主机组的访问级别:
- **读写** - 对一个主机组具有读写访问权限;
- **读取** - 对一个主机组的只读访问权限;
- **拒绝** - 访问 一个主机 组被拒绝;
- **无** - 未设置任何权限。
使用下方的选择字段来选择主机组及其访问权限级别。
此字段支持自动补全功能，因此开始输入一个主机组名称时，将显示匹配的主机组下拉列表。
如果您希望查看所有主机组，请点击*Select*。
如果您希望包含嵌套的主机组，请勾选*包含子组*复选框。
点击将选定的主机组添加到主机组权限列表中
::: noteimportant
添加一个勾选了*包含子组*复选框的父主机组，将覆盖（并从列表中移除）之前配置的所有相关嵌套主机组的权限。
选择访问级别为*None*的情况下添加一个主机组，如果主机组已在列表中，将会从列表中移除主机组。
:::
**标签过滤器**选项卡允许您为用户设置基于标签的权限
按标签名称及其值筛选问题查看的组：
要选择应用标签过滤的一个主机组，点击*Select*以get
现有主机组的完整列表或开始输入组名称
主机组 到 get 一个匹配组的下拉列表。如果您想应用
将标签过滤器应用于嵌套的主机组时，勾选*包含子组*
复选框
标签过滤器允许将主机组的访问权限分离
查看问题的可能性
例如，如果数据库管理员只需要查看"MySQL"
数据库问题，需要create一个用户组用于数据库
管理员优先，然后指定"Service"标签名称和"MySQL"值
如果指定了"Service"标签名称且值字段留空
相应用户组将看到所选主机组的所有问题
带有标签名称"Service"。如果标签名称和值字段均留空
空白但主机组已选择，相应用户组将看到所有
所选主机组的问题。确保标签名称和标签值
正确指定，否则相应的用户组将无法看到
任何问题。
让我们回顾一个用户属于多个用户组的示例
已选择。在此情况下，过滤将使用OR条件处理标签。
| | | | | | | |
|---|---|---|---|---|---|---|
| **用户组A** | < | < | **用户组B** | < | < | **同时属于两个组的用户可见结果** |
| *标签过滤器* | < | < | < | < | < | ^ |
| *主机组* | *标签名称* | *标签值* | *主机组* | *标签名称* | *标签值* | ^ |
| 模板/数据库 | 服务 | MySQL | 模板/数据库 | 服务 | Oracle | 服务: MySQL或Oracle问题可见 |
| 模板/数据库 | *空白* | *空白* | 模板/数据库 | 服务 | Oracle | 所有可见问题 |
| *未选中* | *空白* | *空白* | 模板/数据库 | 服务 | Oracle | <服务:Oracle> 问题可见 |
::: noteimportant
添加过滤器（例如，所有标签在一个
某些 主机组 "模板/数据库" 会导致无法
查看其他主机组的问题。
:::
#### Configuration
To configure a value mapping, follow these steps:
1\. Open the host or template configuration form.
2\. In the *Value mapping* tab, click *Add* to add a new value mapping, or click on the name of an existing mapping to edit it.
Parameters of a value mapping:
|Parameter|<|Description|
|-|----------|----------------------------------------|
|*Name*|<|Unique name for the set of value mappings.|
|*Mappings*|<|Individual rules for mapping numeric/string values to string representations.<br><br>Mapping is applied in the order of the rules that can be reordered by dragging.|
| |*Type*|Mapping type:<br>**equals** - equal values will be mapped;<br>**is greater than or equals** - equal or greater values will be mapped;<br>**is less than or equals** - equal or smaller values will be mapped;<br>**in range** - values in range will be mapped; the range is expressed as <number1>-<number2> or <number>; multiple ranges are supported (for example, 1-10,101-110,201);<br>**regexp** - values corresponding to the [regular expression](/manual/regular_expressions) will be mapped (global regular expressions are not supported);<br>**default** - all outstanding values will be mapped, other than those with specific mappings.<br><br>For mapping ranges, only numeric value types (*is greater than or equals*, *is less than or equals*, *in range*) are supported.|
|^|*Value*|Incoming value (may contain a range or regular expression, depending on the mapping type).|
|^|*Mapped to*|String representation (up to 64 characters) for the incoming value.|
All mandatory input fields are marked with a red asterisk.
When viewing the value mapping in the list, only the first three mappings are visible, with three dots indicating that more mappings exist.
#### 配置
配置值映射的步骤如下：
1\. 打开 主机 或模板配置表单。
2\. 在*值映射*标签页中，点击*添加*以新增值映射，或点击现有映射名称进行编辑。
值映射的参数：
| 参数 | < | 描述 |
|-|----------|----------------------------------------|
| *Name* | < | 值映射集的唯一名称。 |
| *Mappings* | < | 将数字/string值映射到string表示的单独规则。<br><br>映射按可拖拽重新排序的规则顺序应用。 |
| | *类型* | 映射类型：<br>**等于** - 相等的值将被映射；<br>**大于或等于** - 相等或更大的值将被映射；<br>**小于或等于** - 相等或更小的值将被映射；<br>**范围内** - 范围内的值将被映射；范围表示为<数字1>-<数字2>或<数字>；支持多个范围（例如1-10,101-110,201）；<br>**正则表达式** - 符合[regular expression](/manual/regular_expressions)的值将被映射（不支持全局正则表达式）；<br>**默认** - 除具有特定映射的值外，所有未处理的值将被映射。<br><br>对于范围映射，仅支持数字值类型（*大于或等于*、*小于或等于*、*范围内*）。 |
| ^ | *值* | 输入值（可能包含范围或正则表达式，取决于映射类型）。 |
| ^ | *映射到* | 输入值的string表示（最多64个字符）。 |
所有必填输入字段均标有红色星号。
在列表中查看值映射时，仅显示前三个映射，三个点表示存在更多映射。
#### Configuration
To configure custom alert scripts as the media type:
- Go to *Administration → Media types*
- Click on *Create media type*
The **Media type** tab contains general media type attributes:
All mandatory input fields are marked with a red asterisk.
The following parameters are specific for the script media type:
|Parameter|Description|
|--|--------|
|*Script name*|Enter the name of the script file (e.g., notification.sh) that is located in the directory specified in the server [configuration file](/manual/appendix/config/zabbix_server) `AlertScriptsPath` parameter.|
|*Script parameters*|Add command-line parameters to the script.<br>{ALERT.SENDTO}, {ALERT.SUBJECT} and {ALERT.MESSAGE} [macros](/manual/appendix/macros/supported_by_location) are supported in script parameters.<br>Customizing script parameters is supported since Zabbix 3.0.|
See [common media type
parameters](/manual/config/notifications/media#common_parameters) for
details on how to configure default messages and alert processing
options.
::: notewarning
Even if an alert script doesn't use default
messages, message templates for operation types used by this media type
must still be defined, otherwise a notification will not be sent.
:::
::: noteimportant
As parallel processing of media types is
implemented since Zabbix 3.4.0, it is important to note that with more
than one script media type configured, these scripts may be processed in
parallel by alerter processes. The total number of alerter processes is
limited by the StartAlerters
[parameter](/manual/appendix/config/zabbix_server).
:::
#### 配置
配置自定义告警脚本作为媒介类型：
- 前往 *管理 → 媒介类型*
- 点击 *创建媒介类型*
**媒介类型**标签页包含通用媒介类型属性：
所有必填字段均以红色星号标记。
以下参数为脚本媒介类型特有：
| 参数 | 说明 |
|--|--------|
| *Script name* | 输入脚本名称file（例如notification.sh），该脚本需位于服务器[configuration file](/manual/appendix/config/zabbix_server)参数`AlertScriptsPath`指定的目录中。 |
| *Script parameters* | 为脚本添加命令行参数。<br>脚本参数支持{ALERT.SENDTO}、{ALERT.SUBJECT}和{ALERT.MESSAGE}[macros](/manual/appendix/macros/supported_by_location)。<br>自定义脚本参数功能自Zabbix 3.0起支持。 |
关于默认消息配置与告警处理选项的详细信息，请参阅[通用参数](/manual/config/notifications/media#通用参数)。
::: notewarning
即使告警脚本不使用默认消息，
仍需为此媒介类型使用的操作类型定义消息模板，
否则将无法发送通知。
:::
::: noteimportant
由于Zabbix 3.4.0起实现了媒介类型的并行处理，
需注意当配置多个脚本媒介类型时，
这些脚本可能由告警进程并行处理。
告警进程总数受限于StartAlerters参数
[parameter](/manual/appendix/config/zabbix_server)。
:::
#### Configuration
To configure e-mail as the media type:
- Go to *Administration → Media types*
- Click on *Create media type* (or click on *E-mail* in the list of
pre-defined media types).
The **Media type** tab contains general media type attributes:
All mandatory input fields are marked with a red asterisk.
The following parameters are specific for the e-mail media type:
|Parameter|Description|
|--|--------|
|*SMTP server*|Set an SMTP server to handle outgoing messages.|
|*SMTP server port*|Set the SMTP server port to handle outgoing messages.<br>This option is supported *starting with Zabbix 3.0*.|
|*SMTP helo*|Set a correct SMTP helo value, normally a domain name.|
|*SMTP email*|The address entered here will be used as the **From** address for the messages sent.<br>Adding a sender display name (like "Zabbix\_info" in *Zabbix\_info <zabbix\@company.com>* in the screenshot above) with the actual e-mail address is supported since Zabbix 2.2 version.<br>There are some restrictions on display names in Zabbix emails in comparison to what is allowed by RFC 5322, as illustrated by examples:<br>Valid examples:<br>*zabbix\@company.com* (only email address, no need to use angle brackets)<br>*Zabbix\_info <zabbix\@company.com>* (display name and email address in angle brackets)<br>*∑Ω-monitoring <zabbix\@company.com>* (UTF-8 characters in display name)<br>Invalid examples:<br>*Zabbix HQ zabbix\@company.com* (display name present but no angle brackets around email address)<br>*"Zabbix\\@\\<H(comment)Q\\>" <zabbix\@company.com>* (although valid by RFC 5322, quoted pairs and comments are not supported in Zabbix emails)|
|*Connection security*|Select the level of connection security:<br>**None** - do not use the [CURLOPT\_USE\_SSL](http://curl.haxx.se/libcurl/c/CURLOPT_USE_SSL.html) option<br>**STARTTLS** - use the CURLOPT\_USE\_SSL option with CURLUSESSL\_ALL value<br>**SSL/TLS** - use of CURLOPT\_USE\_SSL is optional<br>This option is supported *starting with Zabbix 3.0*.|
|*SSL verify peer*|Mark the checkbox to verify the SSL certificate of the SMTP server.<br>The value of "SSLCALocation" server configuration directive should be put into [CURLOPT\_CAPATH](http://curl.haxx.se/libcurl/c/CURLOPT_CAPATH.html) for certificate validation.<br>This sets cURL option [CURLOPT\_SSL\_VERIFYPEER](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html).<br>This option is supported *starting with Zabbix 3.0*.|
|*SSL verify host*|Mark the checkbox to verify that the *Common Name* field or the *Subject Alternate Name* field of the SMTP server certificate matches.<br>This sets cURL option [CURLOPT\_SSL\_VERIFYHOST](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html).<br>This option is supported *starting with Zabbix 3.0*.|
|*Authentication*|Select the level of authentication:<br>**None** - no cURL options are set<br>(since 3.4.2) **Username and password** - implies "AUTH=\*" leaving the choice of authentication mechanism to cURL<br>(until 3.4.2) **Normal password** - [CURLOPT\_LOGIN\_OPTIONS](http://curl.haxx.se/libcurl/c/CURLOPT_LOGIN_OPTIONS.html) is set to "AUTH=PLAIN"<br>This option is supported *starting with Zabbix 3.0*.|
|*Username*|User name to use in authentication.<br>This sets the value of [CURLOPT\_USERNAME](http://curl.haxx.se/libcurl/c/CURLOPT_USERNAME.html).<br>This option is supported *starting with Zabbix 3.0*.<br>[User macros](/manual/appendix/macros/supported_by_location_user#other-locations) supported as of Zabbix 6.0.30.|
|*Password*|Password to use in authentication.<br>This sets the value of [CURLOPT\_PASSWORD](http://curl.haxx.se/libcurl/c/CURLOPT_PASSWORD.html).<br>This option is supported *starting with Zabbix 3.0*.<br>[User macros](/manual/appendix/macros/supported_by_location_user#other-locations) supported as of Zabbix 6.0.30.|
|*Message format*|Select message format:<br>**HTML** - send as HTML<br>**Plain text** - send as plain text|
::: noteimportant
To enable SMTP authentication options, Zabbix server must be both compiled with the `--with-libcurl` [compilation](/manual/installation/install#configure_the_sources) option (with cURL 7.20.0 or higher) and use the `libcurl-full` packages during runtime.
:::
See also [common media type
parameters](/manual/config/notifications/media#common_parameters) for
details on how to configure default messages and alert processing
options.
#### 配置
配置电子邮件作为媒介类型:
- 前往*管理 → 媒介类型*
- 点击*创建媒介类型* (或在列表中点击*电子邮件*)
pre-defined media types).
**媒介类型**选项卡包含通用媒介类型属性:
所有必填字段均以红色星号标记。
以下参数为电子邮件媒介类型特有:
| 参数 | 描述 |
|--|--------|
| *SMTP server* | 设置用于处理外发邮件的SMTP服务器。 |
| *SMTP server port* | 设置用于处理外发邮件的SMTP服务器端口。<br>此选项*从Zabbix 3.0开始*支持。 |
| *SMTP helo* | 设置正确的SMTP helo值，通常为域名。 |
| *SMTP email* | 此处输入的地址将作为发送邮件的**发件人**地址。<br>从Zabbix 2.2 version开始支持添加发件人显示名称(如截图中*Zabbix\_info <zabbix\@company.com>*的"Zabbix\_info")与实际电子邮件地址组合。<br>与RFC 5322允许的内容相比，Zabbix邮件中对显示名称存在一些限制，示例如下:<br>有效示例:<br>*zabbix\@company.com* (仅邮箱地址，无需使用尖括号)<br>*Zabbix\_info <zabbix\@company.com>* (显示名称和尖括号内的邮箱地址)<br>*∑Ω-monitoring <zabbix\@company.com>* (显示名称中包含UTF-8字符)<br>无效示例:<br>*Zabbix HQ zabbix\@company.com* (存在显示名称但邮箱地址未用尖括号包裹)<br>*"Zabbix\\@\\<H(comment)Q\\>" <zabbix\@company.com>* (虽然符合RFC 5322，但Zabbix邮件不支持引号对和注释) |
| *Connection security* | 选择连接安全级别:<br>**无** - 不使用[CURLOPT\_USE\_SSL](http://curl.haxx.se/libcurl/c/CURLOPT_USE_SSL.html)选项<br>**STARTTLS** - 使用CURLOPT\_USE\_SSL选项并设置CURLUSESSL\_ALL值<br>**SSL/TLS** - CURLOPT\_USE\_SSL的使用是可选的<br>此选项*从Zabbix 3.0开始*支持。 |
| *SSL verify peer* | 勾选复选框以验证SMTP服务器的SSL证书。<br>应将服务器配置指令"SSLCALocation"的值放入[CURLOPT\_CAPATH](http://curl.haxx.se/libcurl/c/CURLOPT_CAPATH.html)以进行证书验证。<br>这会设置cURL选项[CURLOPT\_SSL\_VERIFYPEER](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html)。<br>此选项*从Zabbix 3.0开始*支持。 |
| *SSL verify host* | 勾选复选框以验证SMTP服务器证书的*通用名字段*或*主题备用名字段*是否匹配。<br>这会设置cURL选项[CURLOPT\_SSL\_VERIFYHOST](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html)。<br>此选项*从Zabbix 3.0开始*支持。 |
| *Authentication* | 选择认证级别:<br>**无** - 不设置cURL选项<br>(自3.4.2起) **用户名和密码** - 隐含"AUTH=\*"将认证机制选择权交给cURL<br>(3.4.2之前) **普通密码** - [CURLOPT\_LOGIN\_OPTIONS](http://curl.haxx.se/libcurl/c/CURLOPT_LOGIN_OPTIONS.html)设置为"AUTH=PLAIN"<br>此选项*从Zabbix 3.0开始*支持。 |
| *Username* | 认证使用的用户名。<br>这会设置[CURLOPT\_USERNAME](http://curl.haxx.se/libcurl/c/CURLOPT_USERNAME.html)的值。<br>此选项*从Zabbix 3.0开始*支持。<br>[其他位置](/manual/appendix/macros/supported_by_location_user#其他位置)自Zabbix 6.0.30起支持。 |
| *Password* | 认证使用的密码。<br>这会设置[CURLOPT\_PASSWORD](http://curl.haxx.se/libcurl/c/CURLOPT_PASSWORD.html)的值。<br>此选项*从Zabbix 3.0开始*支持。<br>[其他位置](/manual/appendix/macros/supported_by_location_user#其他位置)自Zabbix 6.0.30起支持。 |
| *Message format* | 选择消息格式:<br>**HTML** - 以HTML格式发送<br>**纯文本** - 以纯文本格式发送 |
::: noteimportant
要启用SMTP认证选项，Zabbix server必须同时满足: 编译时带有`--with-libcurl` [4-配置源代码](/manual/installation/install#4-配置源代码)选项(需cURL 7.20.0或更高版本)，且运行时使用`libcurl-full`软件包。
:::
另请参阅[通用参数](/manual/config/notifications/media#通用参数)了解
如何配置默认消息和告警处理选项的详细信息。
#### Configuration
To configure event correlation rules globally:
- Go to *Configuration* → *Event correlation*
- Click on *Create correlation* to the right (or on the correlation
name to edit an existing rule)
- Enter parameters of the correlation rule in the form
{width="600"}
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Name*|Unique correlation rule name.|
|*Type of calculation*|The following options of calculating conditions are available:<br>**And** - all conditions must be met<br>**Or** - enough if one condition is met<br>**And/Or** - AND with different condition types and OR with the same condition type<br>**Custom expression** - a user-defined calculation formula for evaluating action conditions. It must include all conditions (represented as uppercase letters A, B, C, ...) and may include spaces, tabs, brackets ( ), **and** (case sensitive), **or** (case sensitive), **not** (case sensitive).|
|*Conditions*|List of conditions. See below for details on configuring a condition.|
|*Description*|Correlation rule description.|
|*Operations*|Mark the checkbox of the operation to perform when event is correlated. The following operations are available:<br>**Close old events** - close old events when a new event happens. Always add a condition based on the old event when using the *Close old events* operation or all existing problems could be closed.<br>**Close new event** - close the new event when it happens|
|*Enabled*|If you mark this checkbox, the correlation rule will be enabled.|
To configure details of a new condition, click on
 in the Conditions
block. A popup window will open where you can edit the condition
details.
|Parameter|Description|
|--|--------|
|*New condition*|Select a condition for correlating events.<br>*Note* that if no old event condition is specified, all old events may be matched and closed. Similarly if no new event condition is specified, all new events may be matched and closed.<br>The following conditions are available:<br>**Old event tag** - specify the old event tag for matching.<br>**New event tag** - specify the new event tag for matching.<br>**New event host group** - specify the new event host group for matching.<br>**Event tag pair** - specify new event tag and old event tag for matching. In this case there will be a match if the **values** of the tags in both events match. Tag *names* need not match.<br>This option is useful for matching runtime values, which may not be known at the time of configuration (see also [Example 1](/manual/config/event_correlation/global#examples)).<br>**Old event tag value** - specify the old event tag name and value for matching, using the following operators:<br>*equals* - has the old event tag value<br>*does not equal* - does not have the old event tag value<br>*contains* - has the string in the old event tag value<br>*does not contain* - does not have the string in the old event tag value<br>**New event tag value** - specify the new event tag name and value for matching, using the following operators:<br>*equals* - has the new event tag value<br>*does not equal* - does not have the new event tag value<br>*contains* - has the string in the new event tag value<br>*does not contain* - does not have the string in the new event tag value|
::: notewarning
Because misconfiguration is possible, when similar
event tags may be created for **unrelated** problems, please review the
cases outlined below!
:::
- Actual tags and tag values only become visible when a trigger fires.
If the regular expression used is invalid, it is silently replaced
with an \*UNKNOWN\* string. If the initial problem event with an
\*UNKNOWN\* tag value is missed, there may appear subsequent OK
events with the same \*UNKNOWN\* tag value that may close problem
events which they shouldn't have closed.
```{=html}
<!-- -->
```
- If a user uses the {ITEM.VALUE} macro without macro functions as the
tag value, the 255-character limitation applies. When log messages
are long and the first 255 characters are non-specific, this may
also result in similar event tags for unrelated problems.
#### 配置
全局配置事件关联规则:
- 前往*配置* → *事件关联*
- 点击右侧的*创建关联*(或点击关联名称编辑现有规则)
- 在表单中输入关联规则的参数
{width="600"}
所有必填字段均以红色星号标记。
| 参数 | 描述 |
|--|--------|
| *Name* | 唯一的关联规则名称。 |
| *Type of calculation* | 提供以下计算条件选项:<br>**与** - 必须满足所有条件<br>**或** - 只需满足一个条件<br>**与/或** - 不同类型条件间使用AND，相同类型条件间使用OR<br>**自定义表达式** - 用户定义的动作条件计算公式。必须包含所有条件(以大写字母A、B、C...表示)，可包含空格、制表符、括号( )、**and**(区分大小写)、**or**(区分大小写)、**not**(区分大小写)。 |
| *Conditions* | 条件列表。详见下方条件配置说明。 |
| *Description* | 关联规则描述。 |
| *Operations* | 勾选事件关联时要执行的操作。可用操作包括:<br>**关闭旧事件** - 当新事件发生时关闭旧事件。使用*关闭旧事件*操作时务必添加基于旧事件的条件，否则可能关闭所有现有问题。<br>**关闭新事件** - 当新事件发生时关闭该事件 |
| *Enabled* | 勾选此复选框将启用关联规则。 |
要配置新条件的详细信息，请点击
在条件
区块中。将弹出窗口供您编辑条件详情。
| 参数 | 描述 |
|--|--------|
| *New condition* | 选择关联事件的条件。<br>*注意*:如果未指定旧事件条件，可能匹配并关闭所有旧事件。同样如果未指定新事件条件，可能匹配并关闭所有新事件。<br>可用条件包括:<br>**旧事件标签** - 指定要匹配的旧事件标签。<br>**新事件标签** - 指定要匹配的新事件标签。<br>**新事件主机组** - 指定要匹配的新事件主机组。<br>**事件标签对** - 指定要匹配的新旧事件标签。当两个事件中标签的**值**匹配时即视为匹配。标签*名称*不必相同。<br>此选项适用于匹配运行时值，这些值可能在配置时未知(另见[示例](/manual/config/event_correlation/global#示例))。<br>**旧事件标签值** - 使用以下运算符指定要匹配的旧事件标签名称和值:<br>*等于* - 具有旧事件标签值<br>*不等于* - 不具有旧事件标签值<br>*包含* - 在旧事件标签值中包含string<br>*不包含* - 在旧事件标签值中不包含string<br>**新事件标签值** - 使用以下运算符指定要匹配的新事件标签名称和值:<br>*等于* - 具有新事件标签值<br>*不等于* - 不具有新事件标签值<br>*包含* - 在新事件标签值中包含string<br>*不包含* - 在新事件标签值中不包含string |
::: notewarning
由于可能存在配置错误，当为**不相关**问题创建相似事件标签时，请仔细检查以下情况！
:::
- 实际标签和标签值仅在触发器触发时可见。
If the regular expression used is invalid, it is silently replaced
with an \*UNKNOWN\* string. If the initial problem event with an
\*UNKNOWN\* tag value is missed, there may appear subsequent OK
events with the same \*UNKNOWN\* tag value that may close problem
events which they shouldn't have closed.
```{=html}
<!-- -->
```
- 如果用户使用{ITEM.VALUE}宏(不使用宏函数)作为标签值，将受到255字符限制。当日志消息较长且前255字符不具体时，也可能导致不相关问题产生相似事件标签。
#### Configuration
To configure, select *Action log* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Sort entries by*|Sort entries by:<br>**Time** (descending or ascending)<br>**Type** (descending or ascending)<br>**Status** (descending or ascending)<br>**Recipient** (descending or ascending).|
|*Show lines*|Set how many action log lines will be displayed in the widget.|
#### 配置
要配置，请选择*操作日志*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)适用于所有小部件的参数外，
您还可以设置以下特定选项：
| | |
|--|--------|
| *按条目排序* | 按以下方式排序条目：<br>**时间**（降序或升序）<br>**类型**（降序或升序）<br>**状态**（降序或升序）<br>**接收者**（降序或升序）。 |
| *显示行数* | 设置小部件中显示的操作日志行数。 |
#### Configuration
To configure, select *Clock* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Time type*|Select local, server, or specified host time.<br>Server time will be identical to the time zone set globally or for the Zabbix user.|
|*Item*|Select the item for displaying time. To display host time, use the `system.localtime[local]` [item](/manual/config/items/itemtypes/zabbix_agent). This item must exist on the host.<br>This field is available only when *Host time* is selected.|
#### 配置
要配置时钟部件，请选择*Clock*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)所有部件通用的参数外，
您还可以设置以下特定选项：
| | |
|--|--------|
| *时间类型* | 选择本地时间、服务器时间或指定的主机时间。<br>服务器时间将与全局设置的时区或Zabbix用户的时区保持一致。 |
| *监控项* | 选择显示时间的监控项。要显示主机时间，请使用`system.localtime[local]` [item](/manual/config/items/itemtypes/zabbix_agent)。该监控项必须存在于主机上。<br>此字段仅在选择*主机时间*时可用。 |
#### Configuration
To configure, select *Data overview* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Host groups*|Select host groups. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on 'x' to remove the selected.|
|*Hosts*|Select hosts. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts. Scroll down to select. Click on 'x' to remove the selected.|
|*Tags*|Specify tags to limit the number of item data displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Show suppressed problems*|Mark the checkbox to display problems that would otherwise be suppressed (not shown) because of host maintenance.|
|*Hosts location*|Select host location - left or top.|
#### 配置
要配置，选择*数据概览*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)
所有小部件通用的参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *主机组* | 选择主机组。此字段支持自动补全，输入组名时会显示匹配组的下拉列表。滚动选择。点击'x'移除已选项。 |
| *主机* | 选择主机。此字段支持自动补全，输入一个主机名称时会显示匹配主机的下拉列表。滚动选择。点击'x'移除已选项。 |
| *标签* | 指定标签以限制小部件中显示的监控项数据量。可以包含或排除特定标签及其值。可设置多个条件。标签名称匹配始终区分大小写。<br>每个条件支持以下运算符：<br>**存在** - 包含指定标签名<br>**等于** - 包含指定标签名和值（区分大小写）<br>**包含** - 包含标签值含有输入string的标签名（子串匹配，不区分大小写）<br>**不存在** - 排除指定标签名<br>**不等于** - 排除指定标签名和值（区分大小写）<br>**不包含** - 排除标签值含有输入string的标签名（子串匹配，不区分大小写）<br>条件有两种计算类型：<br>**与/或** - 必须满足所有条件，相同标签名的条件将通过或条件分组<br>**或** - 只需满足一个条件即可 |
| *显示被抑制的问题* | 勾选此框可显示因主机维护而被抑制（不显示）的问题。 |
| *主机位置* | 选择主机位置 - 左侧或Top。 |
#### Configuration
To configure, select *Graph* as type:
{width="600"}
The **Data set** tab allows to add data sets and define their visual
representation:
| | | |
|-|----------|----------------------------------------|
|*Data set*|<|Select hosts and items to display on the graph. Alternatively, you may enter host and item patterns. Wildcard patterns may be used (for example, `*` will return results that match zero or more characters). To specify a wildcard pattern, just enter the string manually and press *Enter*. While you are typing, note how all matching hosts are displayed in the dropdown.<br>Up to 50 items may be displayed in the graph.<br>Host pattern and item pattern fields are mandatory.<br>The wildcard symbol is always interpreted, therefore it is not possible to add, for example, an item named "item\*" individually, if there are other matching items (e.g. item2, item3).|
| |*Base color*|Adjust base color, either from the color picker or manually. The base color is used to calculate different colors for each item of the data set. Base color input field is mandatory.|
|^|*Draw*|Choose the draw type of the metric. Possible draw types are *Line* (set by default), *Points*, *Staircase* and *Bar*.<br>Note that if there's only one data point in the line/staircase graph it is drawn as a point regardless of the draw type. The point size is calculated from the line width, but it cannot be smaller than 3 pixels, even if the line width is less.|
|^|*Width*|Set the line width. This option is available when *Line* or *Staircase* draw type is selected.|
|^|*Point size*|Set the point size. This option is available when *Points* draw type is selected.|
|^|*Transparency*|Set the transparency level.|
|^|*Fill*|Set the fill level. This option is available when *Line* or *Staircase* draw type is selected.|
|^|*Missing data*|Select the option for displaying missing data:<br>**None** - the gap is left empty<br>**Connected** - two border values are connected<br>**Treat as 0** - the missing data is displayed as 0 values<br>Not applicable for the *Points* and *Bar* draw type.|
|^|*Y-axis*|Select the side of the graph where the Y-axis will be displayed.|
|^|*Time shift*|Specify time shift if required. You may use [time suffixes](/manual/appendix/suffixes#time_suffixes) in this field. Negative values are allowed.|
|^|*Aggregation function*|Specify which aggregation function to use:<br>**min** - display the smallest value<br>**max** - display the largest value<br>**avg** - display the average value<br>**sum** - display the sum of values<br>**count** - display the count of values<br>**first** - display the first value<br>**last** - display the last value<br>**none** - display all values (no aggregation)<br>Aggregation allows to display an aggregated value for the chosen interval (5 minutes, an hour, a day), instead of all values. See also: [Aggregation in graphs](/manual/config/visualization/graphs/aggregate).<br>This option is supported since Zabbix 4.4.|
|^|*Aggregation interval*|Specify the interval for aggregating values. You may use [time suffixes](/manual/appendix/suffixes#time_suffixes) in this field. A numeric value without a suffix will be regarded as seconds.<br>This option is supported since Zabbix 4.4.|
|^|*Aggregate*|Specify whether to aggregate:<br>**Each item** - each item in the dataset will be aggregated and displayed separately.<br>**Data set** - all dataset items will be aggregated and displayed as one value.<br>This option is supported since Zabbix 4.4.|
Existing data sets are displayed in a list. You may:
-  -
click on this button to add a new data set
-  -
click on the color icon to expand/collapse data set details
-  -
click on the move icon and drag a data set to a new place in the
list
#### 配置
要配置，选择*Graph*作为类型：
{width="600"}
**数据集**选项卡允许添加数据集并定义其可视化
表示
| | | |
|-|----------|----------------------------------------|
| *数据集* | < | 选择主机和监控项以在图表中显示。或者，您可以输入主机和监控项模式。可以使用通配符模式（例如，`*`将返回匹配零个或多个字符的结果）。要指定通配符模式，只需手动输入string并按*Enter*键。在输入时，请注意所有匹配的主机都会在下拉菜单中显示。<br>图表中最多可显示50个监控项。<br>主机模式和监控项模式字段为必填项。<br>通配符符号始终会被解释，因此如果存在其他匹配的监控项（例如item2、item3），则无法单独添加名为"监控项\*"的监控项。 |
| | *基础颜色* | 调整基础颜色，可通过颜色选择器或手动设置。基础颜色用于计算数据集每个监控项的不同颜色。基础颜色输入字段为必填项。 |
| ^ | *绘制* | 选择指标的绘制类型。可选绘制类型包括*折线图*（默认设置）、*点图*、*阶梯图*和*柱状图*。<br>请注意，若折线图/阶梯图中仅有一个数据点，则无论选择何种绘制类型都会以点形式显示。点的大小根据线宽计算，但即使线宽小于3像素，点尺寸也不会小于3像素。 |
| ^ | *Width* | 设置线条宽度。此选项在选中*Line*或*Staircase*绘图类型时可用。 |
| ^ | *点大小* | 设置点的大小。当选择*点*绘制类型时此选项可用。 |
| ^ | *透明度* | 设置透明度级别. |
| ^ | *填充* | 设置填充级别。当选择*线型*或*阶梯型*绘制类型时，此选项可用。 |
| ^ | *缺失数据* | 选择显示缺失数据的选项:<br>**无** - 留空不显示<br>**连接** - 连接两个边界值<br>**视为0** - 将缺失数据显示为0值<br>不适用于*点*和*柱状*绘图类型. |
| ^ | *Y轴* | 选择图表中Y轴显示的位置。 |
| ^ | *时间偏移* | 如需指定时间偏移，请在此字段填写。允许使用[时间后缀](/manual/appendix/suffixes#时间后缀)，支持负值。 |
| ^ | *聚合函数* | 指定使用的聚合函数:<br>**min** - 显示最小值<br>**max** - 显示最大值<br>**avg** - 显示平均值<br>**sum** - 显示值总和<br>**count** - 显示值的计数<br>**first** - 显示第一个值<br>**last** - 显示最后一个值<br>**none** - 显示所有值(不聚合)<br>聚合功能允许为选定时间间隔(5分钟、1小时、1天)显示聚合值，而非所有值。另请参阅: [Aggregation in graphs](/manual/config/visualization/graphs/aggregate).<br>此选项自Zabbix 4.4起支持。 |
| ^ | *聚合间隔* | 指定用于聚合值的间隔。您可以在该字段中使用[时间后缀](/manual/appendix/suffixes#时间后缀)。不带后缀的数值将被视为秒数。<br>此选项自Zabbix 4.4起支持。 |
| ^ | *聚合* | 指定是否进行聚合:<br>**每个监控项** - 数据集中的每个监控项将被单独聚合并显示。<br>**数据集** - 所有数据集监控项将被聚合并显示为一个值。<br>此选项从Zabbix 4.4开始支持。 |
现有数据集显示在列表中。您可以：
-  -
点击此按钮添加新数据集
-  -
点击颜色图标以展开/折叠数据集详情
-  -
点击移动图标并将数据集拖拽到新位置
列表
#### Configuration
To configure, select *Graph (classic)* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Source*|Select graph type:<br>**Graph** - custom graph<br>**Simple graph** - simple graph|
|*Graph*|Select the custom graph to display.<br>This option is available if 'Graph' is selected as *Source*.|
|*Item*|Select the item to display in a simple graph.<br>This option is available if 'Simple graph' is selected as *Source*.|
|*Show legend*|Unmark this checkbox to hide the legend on the graph (marked by default).|
|*[Dynamic item](/manual/web_interface/frontend_sections/monitoring/dashboard#dynamic_widgets)*|Set graph to display different data depending on the selected host.|
Information displayed by the classic graph widget can be downloaded as
.png image using the [widget
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#widget_menu):
A screenshot of the widget will be saved to the Downloads folder.
#### 配置
要配置，请选择*Graph (classic)*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)适用于所有小部件的参数外，
您还可以设置以下特定选项：
| | |
|--|--------|
| *Source* | 选择图形类型：<br>**Graph** - 自定义图形<br>**Simple graph** - 简单图形 |
| *Graph* | 选择要显示的自定义图形。<br>此选项仅在*Source*选择为'Graph'时可用。 |
| *监控项* | 选择要在简单图形中显示的监控项。<br>此选项仅在*Source*选择为'Simple graph'时可用。 |
| *Show legend* | 取消勾选此复选框以隐藏图形上的图例（默认勾选）。 |
| *[动态部件](/manual/web_interface/frontend_sections/monitoring/dashboard#动态部件)* | 设置图形以根据所选主机显示不同数据。 |
经典图形小部件显示的信息可以通过[widget-菜单](/manual/web_interface/frontend_sections/monitoring/dashboard#widget-菜单)下载为.png图像：
小部件的截图将被保存到下载文件夹。
#### Configuration
To configure, select *Graph prototype* as widget type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Source*|Select source: either a **Graph prototype** or a **Simple graph prototype**.|
|*Graph prototype*|Select a graph prototype to display discovered graphs of the graph prototype.<br>This option is available if 'Graph prototype' is selected as Source.|
|*Item prototype*|Select an item prototype to display simple graphs based on discovered items of an item prototype.<br>This option is available if 'Simple graph prototype' is selected as Source.|
|*Show legend*|Mark this checkbox to show the legend on the graphs (marked by default).|
|*[Dynamic item](/manual/web_interface/frontend_sections/monitoring/dashboard#dynamic_widgets)*|Set graphs to display different data depending on the selected host.|
|*Columns*|Enter the number of columns of graphs to display within a graph prototype widget.|
|*Rows*|Enter the number of rows of graphs to display within a graph prototype widget.|
While the *Columns* and *Rows* settings allow fitting more than one
graph in the widget, there still may be more discovered graphs than
there are columns/rows in the widget. In this case paging becomes
available in the widget and a slide-up header allows to switch between
pages using the left and right arrows.
#### 配置
要配置，选择*图形原型*作为小部件类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)的参数之外
对于所有小部件，您可以设置以下特定选项：
| | |
|--|--------|
| *来源* | 选择来源: 可以是**图形原型**或**简单图形原型**. |
| *图形原型* | 选择要显示的图形原型所发现的图形.<br>当'图形原型'被选为来源时,此选项可用. |
| *监控项原型* | 选择一个监控项原型，以基于监控项原型发现的监控项显示简单图形。<br>当'简单图形原型'被选为数据源时，此选项可用。 |
| *显示图例* | 勾选此复选框以在图表上显示图例（默认已标记）。 |
| *[动态部件](/manual/web_interface/frontend_sections/monitoring/dashboard#动态部件)* | 设置图表根据所选主机显示不同数据. |
| *列数* | 输入要在图形原型小部件中显示的图形列数。 |
| *行数* | 输入要在图形原型小部件中显示的图形行数。 |
虽然*Columns*和*Rows*设置允许容纳多个
在小部件中的图表中，可能仍存在比预期更多的已发现图表
小部件中包含列/行。此时将启用分页功能
小部件中可用，滑动标题栏可切换
使用左右箭头翻页。
#### Configuration
To configure, select *Host availability* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Host groups*|Select host group(s). This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on 'x' to remove the selected.|
|*Interface type*|Select which host interfaces you want to see availability data for.<br>Availability of all interfaces is displayed by default if nothing is selected.|
|*Layout*|Select horizontal display (columns) or vertical display (lines).|
|*Show hosts in maintenance*|Include hosts that are in maintenance in the statistics.|
#### 配置
要配置，选择*主机可用性*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)适用于所有小部件的参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *主机组* | 选择主机组(s)。此字段具有自动完成功能，因此开始输入组名将显示匹配组的下拉列表。向下滚动以选择。点击'x'移除所选内容。 |
| *接口类型* | 选择您希望查看可用性数据的主机接口类型。<br>如果未选择任何内容，默认显示所有接口的可用性。 |
| *布局* | 选择水平显示（列）或垂直显示（行）。 |
| *显示维护中的主机* | 在统计中包含处于维护状态的主机。 |
#### Configuration
To configure, select *Item value* as the widget type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|_**Item**_ |Select the item. |
|_**Show**_ |Mark the checkbox to display the respective element (description, value, time, change indicator). Unmark to hide.<br>At least one element must be selected. |
|_**Advanced configuration**_ |Mark the checkbox to display [advanced configuration](#advanced-configuration) options. |
|_**[Dynamic item](/manual/web_interface/frontend_sections/monitoring/dashboard#dynamic-widgets)**_ |Mark the checkbox to display a different value depending on the selected host. |
#### 配置
要配置，选择*监控项值*作为部件类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)适用于所有部件的参数外，
您还可以设置以下特定选项：
| | |
|--|--------|
| _**监控项**_ | 选择监控项。 |
| _**显示**_ | 勾选复选框以显示相应元素（描述、值、时间、变化指示器）。取消勾选以隐藏。<br>必须至少选择一个元素。 |
| _**高级配置**_ | 勾选复选框以显示[高级配置](#advanced-configuration)选项。 |
| _**[动态部件](/manual/web_interface/frontend_sections/monitoring/dashboard#动态部件)**_ | 勾选复选框以根据所选主机显示不同的值。 |
#### Configuration
To configure, select *Map* as type:
{width="600"}
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Source type*|Select to display:<br>**Map** - network map;<br>**Map navigation tree** - one of the maps in the selected map navigation tree.|
|*Map*|Select the map to display.<br>This field is auto-complete so starting to type the name of a map will offer a dropdown of matching maps.<br>This option is available if 'Map' is selected as *Source type*.|
|*Filter*|Select the map navigation tree to display the maps of.<br>This option is available if 'Map navigation tree' is selected as *Source type*.|
#### 配置
要配置，选择*地图*作为类型：
{width="600"}
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)
适用于所有小部件的参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *源类型* | 选择显示：<br>**地图** - 网络地图；<br>**地图导航树** - 所选地图导航树中的一张地图。 |
| *地图* | 选择要显示的地图。<br>此字段支持自动完成，因此开始输入地图名称将提供匹配地图的下拉列表。<br>此选项在*源类型*选择为'地图'时可用。 |
| *过滤器* | 选择要显示其地图的地图导航树。<br>此选项在*源类型*选择为'地图导航树'时可用。 |
#### Configuration
To configure, select *Map navigation tree* as type:
{width="600"}
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Show unavailable maps*|Mark this checkbox to display maps that the user does not have read permission to.<br>Unavailable maps in the navigation tree will be displayed with a grayed-out icon.<br>Note that if this checkbox is marked, available [submaps](/manual/config/visualization/maps/map#adding-elements) are displayed even if the parent level map is unavailable. If unmarked, available submaps to an unavailable parent map will not be displayed at all.<br>Problem count is calculated based on available maps and available map elements.|
#### 配置
要配置，请选择*地图导航树*作为类型：
{width="600"}
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)适用于所有小部件的参数外，
您还可以设置以下特定选项：
| | |
|--|--------|
| *显示不可用地图* | 勾选此复选框以显示用户没有读取权限的地图。<br>导航树中不可用的地图将以灰色图标显示。<br>请注意，如果勾选此复选框，即使父级地图不可用，可用的[添加元素](/manual/config/visualization/maps/map#添加元素)也会显示。如果未勾选，不可用父级地图下的可用子地图将完全不显示。<br>问题计数基于可用地图和可用地图元素计算。 |
#### Configuration
To configure, select *Plain text* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Items*|Select the items.|
|*Items location*|Choose the location of selected items to be displayed in the widget.|
|*Show lines*|Set how many latest data lines will be displayed in the widget.|
|*Show text as HTML*|Set to display text as HTML.|
|*[Dynamic item](/manual/web_interface/frontend_sections/monitoring/dashboard#dynamic_widgets)*|Set to display different data depending on the selected host.|
#### 配置
要配置，选择*纯文本*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)适用于所有小部件的参数外，
您还可以设置以下特定选项：
| | |
|--|--------|
| *监控项* | 选择监控项。 |
| *监控项位置* | 选择要在小部件中显示的所选监控项的位置。 |
| *显示行数* | 设置将在小部件中显示的最新数据行数。 |
| *以HTML格式显示文本* | 设置为以HTML格式显示文本。 |
| *[动态部件](/manual/web_interface/frontend_sections/monitoring/dashboard#动态部件)* | 设置为根据所选主机显示不同的数据。 |
#### Configuration
To configure, select *Problem hosts* as type:
{width="600"}
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters) for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Host groups*|Enter host groups to display in the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Host data from these host groups will be displayed in the widget. If no host groups are entered, all host groups will be displayed.|
|*Exclude host groups*|Enter host groups to hide from the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Host data from these host groups will not be displayed in the widget. For example, hosts 001, 002, 003 may be in Group A and hosts 002, 003 in Group B as well. If we select to *show* Group A and *exclude* Group B at the same time, only data from host 001 will be displayed in the Dashboard.|
|*Hosts*|Enter hosts to display in the widget. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts.<br>If no hosts are entered, all hosts will be displayed.|
|*Problem*|You can limit the number of problem hosts displayed by the problem name. If you enter a string here, only those hosts with problems whose name contains the entered string will be displayed. Macros are not expanded.|
|*Severity*|Mark problem severities to filter problems to be displayed in the widget.<br>If no severities are marked, all problems will be displayed.|
|*Tags*|Specify problem tags to limit the number of problems displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Show suppressed problems*|Mark the checkbox to display problems that would otherwise be suppressed (not shown) because of host maintenance.|
|*Hide groups without problems*|Mark the *Hide groups without problems* option to hide data from host groups without problems in the widget.|
|*Problem display*|Display problem count as:<br>**All** - full problem count will be displayed<br>**Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count<br>**Unacknowledged only** - only the unacknowledged problem count will be displayed.|
#### 配置
要配置，选择*问题主机*作为类型：
{width="600"}
除了适用于所有小部件的[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *主机 组* | 输入需要在小部件中显示的主机组。该字段支持自动补全，输入组名时会显示匹配组的下拉列表。<br>指定父主机组将隐式选择所有嵌套的主机组。<br>这些主机组中的主机数据将显示在小部件中。若未输入任何主机组，则显示所有主机组。 |
| *排除主机组* | 输入需要在小部件中隐藏的主机组。该字段支持自动补全，输入组名时会显示匹配组的下拉列表。<br>指定父主机组将隐式选择所有嵌套的主机组。<br>来自这些主机组的主机数据不会显示在小部件中。例如，主机 001、002、003可能在A组，而主机 002、003也在B组。如果我们同时选择*显示*A组和*排除*B组，则仪表板中仅会显示来自主机 001的数据。 |
| *主机* | 输入 主机 以在小部件中显示。该字段支持自动补全，因此开始输入 一个主机 名称时将显示匹配 主机 的下拉列表。<br>如果未输入任何 主机，则将显示所有 主机。 |
| *问题* | 您可以通过问题名称限制显示的主机数量。若在此输入string，则仅显示名称包含该string的主机。宏不会被展开。 |
| *严重性* | 标记问题严重性以筛选要在小部件中显示的问题。<br>如果未标记任何严重性，则将显示所有问题。 |
| *标签* | 指定问题标签以限制部件中显示的问题数量。可以包含或排除特定标签及标签值。可设置多个条件。标签名称匹配始终区分大小写。<br>每个条件支持以下运算符：<br>**存在** - 包含指定的标签名称<br>**等于** - 包含指定的标签名称和值（区分大小写）<br>**包含** - 包含标签值包含输入string的指定标签名称（子字符串匹配，不区分大小写）<br>**不存在** - 排除指定的标签名称<br>**不等于** - 排除指定的标签名称和值（区分大小写）<br>**不包含** - 排除标签值包含输入string的指定标签名称（子字符串匹配，不区分大小写）<br>条件计算类型有两种：<br>**与/或** - 必须满足所有条件，相同标签名的条件将通过或条件分组<br>**或** - 只需满足一个条件即可 |
| *显示被抑制的问题* | 勾选此复选框以显示因主机维护而被抑制（不显示）的问题。 |
| *隐藏无问题组* | 勾选*隐藏无问题组*选项可在小部件中隐藏来自主机的无问题组数据。 |
| *问题显示* | 问题计数显示方式:<br>**全部** - 显示完整的问题计数<br>**分开显示** - 未确认问题计数将以"当前问题数/总问题数"的形式分开显示<br>**仅未确认** - 仅显示未确认的问题计数 |
#### Configuration
To configure, select *Problems* as type:
You can limit how many problems are displayed in the widget in various ways - by problem status, problem name, severity, host group, host, event tag, acknowledgment status, etc.
| | |
|--|--------|
|*Show*|Filter by problem status:<br>**Recent problems** - unresolved and recently resolved problems are displayed (default)<br>**Problems** - unresolved problems are displayed<br>**History** - history of all events is displayed|
|*Host groups*|Enter host groups to display problems of in the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Problems from these host groups will be displayed in the widget. If no host groups are entered, problems from all host groups will be displayed.|
|*Exclude host groups*|Enter host groups to hide problems of from the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Problems from these host groups will not be displayed in the widget. For example, hosts 001, 002, 003 may be in Group A and hosts 002, 003 in Group B as well. If we select to *show* Group A and *exclude* Group B at the same time, only problems from host 001 will be displayed in the widget.|
|*Hosts*|Enter hosts to display problems of in the widget. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts.<br>If no hosts are entered, problems of all hosts will be displayed.|
|*Problem*|You can limit the number of problems displayed by their name. If you enter a string here, only those problems whose name contains the entered string will be displayed. Macros are not expanded.|
|*Severity*|Mark problem severities to filter problems to be displayed in the widget.<br>If no severities are marked, all problems will be displayed.|
|*Tags*|Specify problem tags to limit the number of problems displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met<br>When filtered, the tags specified here will be displayed first with the problem, unless overridden by the *Tag display priority* (see below) list.|
|*Show tags*|Select the number of displayed tags:<br>**None** - no *Tags* column in *Monitoring → Problems*<br>**1** - *Tags* column contains one tag<br>**2** - *Tags* column contains two tags<br>**3** - *Tags* column contains three tags<br>To see all tags for the problem roll your mouse over the three dots icon.|
|*Tag name*|Select tag name display mode:<br>**Full** - tag names and values are displayed in full<br>**Shortened** - tag names are shortened to 3 symbols; tag values are displayed in full<br>**None** - only tag values are displayed; no names|
|*Tag display priority*|Enter tag display priority for a problem, as a comma-separated list of tags (for example: `Services,Applications,Application`). Tag names only should be used, no values. The tags of this list will always be displayed first, overriding the natural ordering by alphabet.|
|*Show operational data*|Select the mode for displaying [operational data](/manual/web_interface/frontend_sections/monitoring/problems#operational_data_of_problems):<br>**None** - no operational data is displayed<br>**Separately** - operational data is displayed in a separate column<br>**With problem name** - append operational data to the problem name, using parentheses for the operational data|
|*Show suppressed problems*|Mark the checkbox to display problems that would otherwise be suppressed (not shown) because of host maintenance.|
|*Show unacknowledged only*|Mark the checkbox to display unacknowledged problems only.|
|*Sort entries by*|Sort entries by:<br>**Time** (descending or ascending)<br>**Severity** (descending or ascending)<br>**Problem name** (descending or ascending)<br>**Host** (descending or ascending).|
|*Show timeline*|Mark the checkbox to display a visual timeline.|
|*Show lines*|Specify the number of problem lines to display.|
#### 配置
要配置，选择*问题*作为类型：
您可以通过多种方式限制小部件中显示的问题数量 - 按问题状态、问题名称、严重性、主机组、主机、事件标签、确认状态等。
| | |
|--|--------|
| *显示* | 按问题状态过滤：<br>**最近问题** - 显示未解决和最近解决的问题（默认）<br>**问题** - 显示未解决的问题<br>**历史** - 显示所有事件的历史记录 |
| *主机组* | 输入要在小部件中显示问题的主机组。此字段具有自动完成功能，开始输入组名时会显示匹配组的下拉列表。<br>指定父主机组会隐式选择所有嵌套的主机组。<br>来自这些主机组的问题将显示在小部件中。如果未输入主机组，则显示所有主机组的问题。 |
| *排除主机组* | 输入要从小部件中隐藏问题的主机组。此字段具有自动完成功能，开始输入组名时会显示匹配组的下拉列表。<br>指定父主机组会隐式选择所有嵌套的主机组。<br>来自这些主机组的问题将不会显示在小部件中。例如，主机 001、002、003可能在组A中，而主机 002、003也在组B中。如果我们同时选择*显示*组A和*排除*组B，则小部件中仅显示来自主机 001的问题。 |
| *主机* | 输入要在小部件中显示问题的主机。此字段具有自动完成功能，开始输入一个主机名称时会显示匹配的主机下拉列表。<br>如果未输入主机，则显示所有主机的问题。 |
| *问题* | 您可以通过问题名称限制显示的问题数量。如果在此处输入string，则仅显示名称包含所输入string的问题。宏不会被展开。 |
| *严重性* | 标记问题严重性以过滤要在小部件中显示的问题。<br>如果未标记严重性，则显示所有问题。 |
| *标签* | 指定问题标签以限制小部件中显示的问题数量。可以包含或排除特定标签和标签值。可以设置多个条件。标签名称匹配始终区分大小写。<br>每个条件有以下几种运算符：<br>**存在** - 包含指定的标签名称<br>**等于** - 包含指定的标签名称和值（区分大小写）<br>**包含** - 包含标签值包含所输入string的指定标签名称（子字符串匹配，不区分大小写）<br>**不存在** - 排除指定的标签名称<br>**不等于** - 排除指定的标签名称和值（区分大小写）<br>**不包含** - 排除标签值包含所输入string的指定标签名称（子字符串匹配，不区分大小写）<br>条件有两种计算类型：<br>**与/或** - 必须满足所有条件，具有相同标签名称的条件将通过或条件分组<br>**或** - 只需满足一个条件<br>过滤时，此处指定的标签将首先与问题一起显示，除非被*标签显示优先级*（见下文）列表覆盖。 |
| *显示标签* | 选择显示的标签数量：<br>**无** - *监控 → 问题*中无*标签*列<br>**1** - *标签*列包含一个标签<br>**2** - *标签*列包含两个标签<br>**3** - *标签*列包含三个标签<br>要查看问题的所有标签，请将鼠标悬停在三个点图标上。 |
| *标签名称* | 选择标签名称显示模式：<br>**完整** - 完整显示标签名称和值<br>**缩短** - 标签名称缩短为3个符号；标签值完整显示<br>**无** - 仅显示标签值；不显示名称 |
| *标签显示优先级* | 输入问题的标签显示优先级，作为逗号分隔的标签列表（例如：`Services,Applications,Application`）。仅使用标签名称，不使用值。此列表中的标签将始终首先显示，覆盖按字母顺序的自然排序。 |
| *显示操作数据* | 选择[问题的操作数据](/manual/web_interface/frontend_sections/monitoring/problems#问题的操作数据)的显示模式：<br>**无** - 不显示操作数据<br>**单独** - 操作数据显示在单独的列中<br>**与问题名称一起** - 将操作数据附加到问题名称，使用括号括起操作数据 |
| *显示被抑制的问题* | 勾选复选框以显示由于主机维护而被抑制（不显示）的问题。 |
| *仅显示未确认的问题* | 勾选复选框以仅显示未确认的问题。 |
| *排序条目* | 按以下方式排序条目：<br>**时间**（降序或升序）<br>**严重性**（降序或升序）<br>**问题名称**（降序或升序）<br>**主机**（降序或升序）。 |
| *显示时间线* | 勾选复选框以显示可视化时间线。 |
| *显示行数* | 指定要显示的问题行数。 |
#### Configuration
To configure, select *Problems by severity* as type:
{width="600"}
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters) for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Host groups*|Enter host groups to display in the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Host data from these host groups will be displayed in the widget. If no host groups are entered, all host groups will be displayed.|
|*Exclude host groups*|Enter host groups to hide from the widget. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.<br>Specifying a parent host group implicitly selects all nested host groups.<br>Host data from these host groups will not be displayed in the widget. For example, hosts 001, 002, 003 may be in Group A and hosts 002, 003 in Group B as well. If we select to *show* Group A and *exclude* Group B at the same time, only data from host 001 will be displayed in the Dashboard.|
|*Hosts*|Enter hosts to display in the widget. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts.<br>If no hosts are entered, all hosts will be displayed.|
|*Problem*|You can limit the number of problem hosts displayed by the problem name. If you enter a string here, only those hosts with problems whose name contains the entered string will be displayed. Macros are not expanded.|
|*Severity*|Mark problem severities to filter problems to be displayed in the widget.<br>If no severities are marked, all problems will be displayed.|
|*Tags*|Specify problem tags to limit the number of problems displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Show*|Select the show option:<br>**Host groups** - display problems per host group<br>**Totals** - display a problem total for all selected host groups in colored blocks corresponding to the problem severity.|
|*Layout*|Select the layout option:<br>**Horizontal** - colored blocks of totals will be displayed horizontally<br>**Vertical** - colored blocks of totals will be displayed vertically<br>This field is available for editing if 'Totals' is selected as the *Show* option.|
|*Show operational data*|Display operational data (see description of *[Operational data](/manual/web_interface/frontend_sections/monitoring/problems#operational-data-of-problems)* in *Monitoring* > *Problems*) as:<br>**None** - operational data will not be displayed<br>**Separately** - operational data will be displayed as a separate line<br>**With problem name** - operational data will be displayed together with the problem name.|
|*Show suppressed problems*|Mark the checkbox to display problems that would otherwise be suppressed (not shown) because of host maintenance.|
|*Hide groups without problems*|Mark the *Hide groups without problems* option to hide data from host groups without problems in the widget.|
|*Problem display*|Display problem count as:<br>**All** - full problem count will be displayed<br>**Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count<br>**Unacknowledged only** - only the unacknowledged problem count will be displayed.|
|*Show timeline*|Mark the checkbox to display a visual timeline.|
#### 配置
要配置该部件，请选择类型为*按严重性显示问题*：
{width="600"}
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)所有部件通用的参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *主机组* | 输入要在部件中显示的主机组。该字段支持自动补全，输入组名时会显示匹配组的下拉列表。<br>指定父主机组将隐式选择所有嵌套的主机组。<br>这些主机组的主机数据将显示在部件中。如果未输入主机组，则将显示所有主机组。 |
| *排除主机组* | 输入要从部件中隐藏的主机组。该字段支持自动补全，输入组名时会显示匹配组的下拉列表。<br>指定父主机组将隐式选择所有嵌套的主机组。<br>这些主机组的主机数据不会显示在部件中。例如，主机 001、002、003可能在A组中，而主机 002、003也在B组中。如果我们同时选择*显示*A组和*排除*B组，则仪表板中仅会显示来自主机 001的数据。 |
| *主机* | 输入要在部件中显示的主机。该字段支持自动补全，输入一个主机名称时会显示匹配主机的下拉列表。<br>如果未输入主机，则将显示所有主机。 |
| *问题* | 您可以通过问题名称限制显示的问题主机数量。如果在此处输入string，则仅显示问题名称包含该string的主机。宏不会被展开。 |
| *严重性* | 标记问题严重性以过滤要在部件中显示的问题。<br>如果未标记严重性，则将显示所有问题。 |
| *标签* | 指定问题标签以限制部件中显示的问题数量。可以包含或排除特定标签及标签值。可设置多个条件。标签名称匹配始终区分大小写。<br>每个条件有以下几种运算符：<br>**存在** - 包含指定的标签名称<br>**等于** - 包含指定的标签名称和值（区分大小写）<br>**包含** - 包含标签值包含输入string的指定标签名称（子字符串匹配，不区分大小写）<br>**不存在** - 排除指定的标签名称<br>**不等于** - 排除指定的标签名称和值（区分大小写）<br>**不包含** - 排除标签值包含输入string的指定标签名称（子字符串匹配，不区分大小写）<br>条件计算有两种类型：<br>**与/或** - 必须满足所有条件，相同标签名的条件将通过"或"条件分组<br>**或** - 只需满足一个条件即可 |
| *显示* | 选择显示选项：<br>**主机组** - 按主机组显示问题<br>**总计** - 以对应问题严重性的彩色块显示所有选定主机组的问题总数。 |
| *布局* | 选择布局选项：<br>**水平** - 总计彩色块将水平显示<br>**垂直** - 总计彩色块将垂直显示<br>此字段在*显示*选项选择"总计"时可编辑。 |
| *显示操作数据* | 将操作数据显示为（参见*监控* > *问题*中的*[问题的操作数据](/manual/web_interface/frontend_sections/monitoring/problems#问题的操作数据)*描述）：<br>**无** - 不显示操作数据<br>**单独** - 操作数据将显示为单独一行<br>**与问题名称一起** - 操作数据将与问题名称一起显示。 |
| *显示被抑制的问题* | 勾选复选框以显示因主机维护而被抑制（不显示）的问题。 |
| *隐藏无问题的组* | 勾选*隐藏无问题的组*选项以在部件中隐藏无问题的主机组数据。 |
| *问题显示* | 将问题计数显示为：<br>**全部** - 显示完整问题计数<br>**分开** - 未确认问题计数将以总数中的数字形式分开显示<br>**仅未确认** - 仅显示未确认问题计数。 |
| *显示时间线* | 勾选复选框以显示可视化时间线。 |
#### Configuration
To configure, select *SLA report* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*SLA*|Select the SLA for the report.|
|*Service*|Select the service for the report.|
|*Show periods*|Set how many periods will be displayed in the widget (20 by default, 100 maximum).|
|*From*|Select the beginning date for the report.<br>[Relative dates](/manual/config/visualization/graphs/simple#time-period-selector) are supported: `now`, `now/d`, `now/w-1w` etc; supported date modifiers: d, w, M, y.|
|*To*|Select the end date for the report.<br>[Relative dates](/manual/config/visualization/graphs/simple#time-period-selector) are supported: `now`, `now/d`, `now/w-1w` etc; supported date modifiers: d, w, M, y.|
#### 配置
配置时，选择*SLA报告*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)
适用于所有小部件的参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *SLA* | 选择报告的SLA。 |
| *Service* | 选择报告的服务。 |
| *Show periods* | 设置小部件中显示的周期数（默认为20，最大为100）。 |
| *From* | 选择报告的起始日期。<br>[时间段选择器](/manual/config/visualization/graphs/simple#时间段选择器) 支持以下格式：`now`, `now/d`, `now/w-1w` 等；支持的日期修饰符：d, w, M, y。 |
| *To* | 选择报告的结束日期。<br>[时间段选择器](/manual/config/visualization/graphs/simple#时间段选择器) 支持以下格式：`now`, `now/d`, `now/w-1w` 等；支持的日期修饰符：d, w, M, y。 |
#### Configuration
To configure, select *System information* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/dashboards/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Show*|Select what to display:<br>**System stats** - display a summary of key Zabbix server and system data;<br>**High availability nodes** - display the status of high availability nodes (if [high availability cluster](/manual/concepts/server/ha) is enabled).|
#### 配置
要配置，请选择*系统信息*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/dashboards/widgets#通用参数)
适用于所有小部件的参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *显示* | 选择要显示的内容：<br>**系统统计** - 显示关键Zabbix server和系统数据的摘要；<br>**高可用性节点** - 显示高可用性节点的状态（如果[high availability cluster](/manual/concepts/server/ha)已启用）。 |
#### Configuration
To configure, select *Top hosts* as type:
{width="600"}
#### 配置
要配置，选择*Top 主机*作为类型：
{width="600"}
#### Configuration
To configure, select *Trigger overview* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Show*|Filter triggers by trigger state:<br>**Recent problems** - *(default)* show triggers that recently have been or still are in a PROBLEM state (resolved and unresolved);<br>**Problems** - show triggers that are in a PROBLEM state (unresolved);<br>**Any** - show all triggers.|
|*Host groups*|Select the host group(s). This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups.|
|*Hosts*|Select hosts. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts. Scroll down to select. Click on 'x' to remove the selected.|
|*Tags*|Specify tags to filter the triggers displayed in the widget.<br>It is possible to include as well as exclude specific tags and tag values.<br>Several conditions can be set. Tag name matching is always case-sensitive.<br><br>**Note:** If the parameter *Show* is set to 'Any', all triggers will be displayed even if tags are specified. However, while recent trigger state changes (displayed as blinking blocks) will update for all triggers, the trigger state details (problem severity color and whether the problem is acknowledged) will only update for triggers that match the specified tags.<br><br>There are several operators available for each condition:<br>**Exists** - include the specified tag names;<br>**Equals** - include the specified tag names and values (case-sensitive);<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive);<br>**Does not exist** - exclude the specified tag names;<br>**Does not equal** - exclude the specified tag names and values (case-sensitive);<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive).<br><br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the *Or* condition;<br>**Or** - enough if one condition is met.|
|*Show suppressed problems*|Mark the checkbox to display problems that would otherwise be suppressed (not shown) because of host maintenance.|
|*Hosts location*|Select host location - left or top.|
#### 配置
要配置，选择*触发器概览*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)
所有小部件的通用参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *显示* | 按触发器状态筛选：<br>**最近问题** - *(默认)* 显示最近处于或仍处于问题状态的触发器（已解决和未解决）；<br>**问题** - 显示处于问题状态的触发器（未解决）；<br>**全部** - 显示所有触发器。 |
| *主机组* | 选择主机组。此字段支持自动补全，输入组名时会显示匹配组的下拉列表。 |
| *主机* | 选择主机。此字段支持自动补全，输入一个主机名称时会显示匹配主机的下拉列表。可滚动选择，点击'x'移除已选项。 |
| *标签* | 指定标签以筛选小部件中显示的触发器。<br>可包含或排除特定标签及其值。<br>可设置多个条件，标签名称匹配始终区分大小写。<br><br>**注意：** 若*显示*参数设为'全部'，即使指定标签也会显示所有触发器。但近期触发器状态变更（闪烁块显示）将update所有触发器，而触发器状态详情（问题严重程度颜色及确认状态）仅update匹配指定标签的触发器。<br><br>每个条件支持以下运算符：<br>**存在** - 包含指定标签名；<br>**等于** - 包含指定标签名及值（区分大小写）；<br>**包含** - 包含标签值含输入string的标签名（子串匹配，不区分大小写）；<br>**不存在** - 排除指定标签名；<br>**不等于** - 排除指定标签名及值（区分大小写）；<br>**不包含** - 排除标签值含输入string的标签名（子串匹配，不区分大小写）。<br><br>条件计算类型有两种：<br>**与/或** - 需满足所有条件，相同标签名的条件按*或*分组；<br>**或** - 只需满足任一条件。 |
| *显示被抑制的问题* | 勾选此框可显示因主机维护而被抑制（默认不显示）的问题。 |
| *主机位置* | 选择主机位置 - 左侧或Top。 |
#### Configuration
To configure, select *URL* as type:
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*URL*|Enter the URL to display.<br>External URLs must start with `http://` or `https://`.<br>Since Zabbix 4.4.8, internal URLs support relative paths (for example, `zabbix.php?action=report.status`).<br>{HOST.\*} macros are supported.|
|*[Dynamic item](/manual/web_interface/frontend_sections/monitoring/dashboard#dynamic_widgets)*|Set to display different URL content depending on the selected host.<br>This can work if {HOST.\*} macros are used in the URL.|
::: noteimportant
Browsers might not load an HTTP page included in
the widget if Zabbix frontend is accessed over HTTPS.
:::
#### 配置
要配置，选择*URL*作为类型：
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)
适用于所有小部件的参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *URL* | 输入要显示的URL。<br>外部URL必须以`http://`或`https://`开头。<br>从Zabbix 4.4.8开始，内部URL支持相对路径（例如`zabbix.php?action=report.status`）。<br>支持{主机.\*}宏。 |
| *[动态部件](/manual/web_interface/frontend_sections/monitoring/dashboard#动态部件)* | 设置为根据所选主机显示不同的URL内容。<br>如果URL中使用了{主机.\*}宏，此功能可以生效。 |
::: noteimportant
如果通过HTTPS访问Zabbix前端，
浏览器可能不会加载小部件中包含的HTTP页面。
:::
#### Configuration
To configure services, go to: *Monitoring →
[Services](/manual/web_interface/frontend_sections/monitoring/it_services)*.
In this section you can build a hierarchy of your monitored
infrastructure by adding parent services and child services to the
parent services.
#### 概述
#### Overview
服务(Serivce)监控功能是为帮助那些想要在IT基础设施监控之上获得更高层面（业务）监控需求的人设计。在许多情况下，我们不关心底层设施监控细节，比如磁盘空间不足，CPU高负载等等。我们关心的是IT部门提供的服务（业务）整体的可用性。我们还关心在
整体IT基础设施中最薄弱的环节，以及各种IT服务的SLA指标（SLA服务等级协议），更关心识别现有IT基础设施架构薄弱环节，以及更高层面（业务）的监控信息。
Service monitoring functionality is intended for those who want to get a
high-level (business) view of monitored infrastructure. In many cases,
we are not interested in low-level details, like the lack of disk space,
high processor load, etc. What we are interested in is the availability
of service provided by our IT department. We can also be interested in
identifying weak places of IT infrastructure, SLA of various IT
services, the structure of existing IT infrastructure, and other
information of a higher level.
Zabbix 服务监控（service）就是针对上述问题提出的解决方案。
Zabbix service monitoring provides answers to all mentioned questions.
服务监控（service）是分层表现监控数据的。
Services is a hierarchy representation of monitored data.
下面我们来看一个非常简单的服务监控（service）例子：
A very simple service structure may look like:
Service
|
|-Workstations
| |
| |-Workstation1
| |
| |-Workstation2
|
|-Servers
在结构上每个节点都具有监控属性状态。这个状态根据所选算法计算状态关联上层状态，服务监控（service）功能最底层是关联的触发器（triggers）。每个节点状态都是受其触发器（triggers）状态影响。
Each node of the structure has attribute status. The status is
calculated and propagated to upper levels according to the selected
algorithm. At the lowest level of services are triggers. The status of
individual nodes is affected by the status of their triggers.
::: noteclassic
提示：触发器（triggers）的严重等级 如：*不分类（Not
classified）*
或*信息（Information）*是不影响SLA指标（SLA服务等级协议）计算的。
:::
::: noteclassic
Note that triggers with a *Not classified* or *Information*
severity do not impact SLA calculation.
:::
#### 配置
#### Configuration
配置服务监控（service），请访问：*配置（Configuration） →
服务监控（Services）*. To configure services, go to: *Configuration →
Services*.
在该界面，您可以创建一个分层监控结构。
最高的父节点服务是'root'。您可以向下创建更低层服务监控（service）子节点，实现相互层级结构。
On this screen you can build a hierarchy of your monitored
infrastructure. The highest-level parent service is 'root'. You can
build your hierarchy downward by adding lower-level parent services and
then individual nodes to them.
在这个屏幕上，您可以构建被监视的基础结构的层次结构。最高级的父服务是“root”。您可以向下构建层次结构，方法是添加低级的父服务，然后向它们添加单个节点。
点击 *添加子节点（Add child）* 增加服务监控（service）。
点击名称可编辑已该服务监控（service），您可以通过弹出的界面编辑该服务监控（service）属性。
Click on *Add child* to add services. To edit an existing service, click
on its name. A form is displayed where you can edit the service
attributes.
##### 配置一个服务监控（service）
##### Configuring a service
**服务监控（service)** 选项包含通用的服务监控（service）属性
The **Service** tab contains general service attributes:
所有必填字段都标有\*红色星号。
All mandatory input fields are marked with a red asterisk.
|参数 说|<|<|
|------------------------------------------------------|-|-|
|*名称（Name）* 服务监|名称.|<|
|*上层服务（Parent service）* 服务监控（|ervice） 从属的上层父节点|<|
|*状态计算算法（Status calculation algorithm）* 服务监控（se|vice)状态计算方法:\ 服务状态的计算方法:\\ \\ \***不要计算(Do not calculate)** - 不计算节点状态。<br>**问题, 如果至少一个下层有一个问题（Problem, if at least one child has a problem）** -只要一个子节点有异常，该节点就异常。<br>**问题, 如果所有的下层都有问题（Problem, if all children have problems）** - 当所有节点都异常时，该节点才异常。|\*不计算\* \*,不计算服务状态\\ \\ \* \*问题,如果至少有一个子节点服务有问题\* \*——问题状态,如果至少一个子节点服务有问题\\ \\ \* \*问题,如果所有的孩子都有问题\* \*——问题状态,如果所有的子服务有问题|
|*计算SLA（Calculate SLA）* 勾选✔|是否计算SLA指标。|<|
|*可接受的SAL(%)（Acceptable SLA (in %)）* 此服务监控|service)节点，可接受的SLA百分比，用于报告。|<|
|*触发器（Trigger）* 选择关联|触发器（Trigger）:<br>**None** - 没有关联的触发器（Trigger）<br>**触发器名称（trigger name）** - 选择绑定触发器（Trigger），因此节点状态依赖触发器（Trigger）状态<br>. 最底层服务计算必须依赖触发器状态(否则，它们的状态将无法得到准确的计算)<br>当触发器被关联后，其触发器以前的状态告警是不计算的。|<|
|*排序（Sort order）* 显示排|的顺序，数字小的优先|<|
|Parameter|Description|
|---------|-----------|
|*Name*|Service name.|
|*Parent service*|Parent service the service belongs to.|
|*Status calculation algorithm*|Method of calculating service status:<br>**Do not calculate** - do not calculate service status<br>**Problem, if at least one child has a problem** - problem status, if at least one child service has a problem<br>**Problem, if all children have problems** - problem status, if all child services are having problems|
|*Calculate SLA*|Enable SLA calculation and display.|
|*Acceptable SLA (in %)*|SLA percentage that is acceptable for this service. Used for reporting.|
|*Trigger*|Linkage to trigger:<br>**None** - no linkage<br>**trigger name** - linked to the trigger, thus depends on the trigger status<br>Services of the lowest level must be linked to triggers. (Otherwise their state will not be represented accurately.)<br>When triggers are linked, their state prior to linking is not counted.|
|*Sort order*|Sort order for display, lowest comes first.|
**依赖关系（Dependencies）**
选项卡可以看到该服务监控（service)所有子节点。单击 *Add*
增加一个之前配置过的 服务监控（service)节点。
The **Dependencies** tab contains services the service depends on. Click
on *Add* to add a service from those that are configured.
**硬依赖和软依赖（Hard and soft dependency）** **Hard and soft
dependency**
服务的可用性指标，可能取决于其他多个服务，而不仅仅是一个。
界面第一个选项服务监控（service)是直接增加子节点。
Availability of a service may depend on several other services, not just
one. The first option is to add all those directly as child services.
而然，如果服务（service)在其他节点已增加过，则不能简单的将它移动到该子节点。那该如何创建服务（service)节点依赖？这个问题答案是"软链接"。增加一个服务（service)
依赖是，勾选√*软连接(soft)*选项。通过这种方式，服务（service)可以保留节点之前原始位置，有可以绑定依赖到其他服务（service)上。这种“软连接”的服务（service)节点在服务树上显示是灰色的。另外，如果一个服务只有一个“软连接”节点，就可以删除此服务，而不用删除软连接的子节点。
However, if some service is already added somewhere else in the services
tree, it cannot be simply moved out of there to a child service here.
How to create a dependency on it? The answer is "soft" linking. Add the
service and mark the *Soft* check box. That way the service can remain
in its original location in the tree, yet be depended upon from several
other services. Services that are "soft-linked" are displayed in grey in
the tree. Additionally, if a service has only "soft" dependencies, it
can be deleted directly, without deleting child services first.
**时间（Time）** 选型，用于设置服务（service)的工作时间。 The **Time**
tab contains the service time specification.
|参数 说|<|
|------------------------------------------|-|
|*服务时间（Service times）* 默认，所有|务（Service）都是预设 24x7x365 统计时间，如有特殊需要，请增加 新的服务时间（New service time）。|
|*新的服务时间（New service time）* 服务时间（Se|vice times）:<br>**在线时间（Uptime）** - 服务正常运行时间<br>**故障停机时间（Downtime）** - 故障停机时间周期内不会纳入SLA服务时间统计.<br>**单次停机（One-time downtime）** - 单次停机时间，在该时间阶段内不会纳入SLA服务时间统计a single downtime. Service state within this period does not affect SLA.<br>增加相应的时间段。<br>*Note*: 服务时间仅影响其配置的服务（Service）。因此，父节点服务（Service）不会考虑子节点（Service）上配置的服务时间（Service times）（除非您在父节点也配置相应的服务时间）。\\\\在前端页面计算服务（Service）状态和SLA时，会考虑这个服务时间（Service times）。然而需要您知道是，不管服务时间如何配置计算，关于服务（Service）原始可用性信息仍会连续不断写入到数据库中。|
|Parameter|Description|
|---------|-----------|
|*Service times*|By default, all services are expected to operate 24x7x365. If exceptions needed, add new service times.|
|*New service time*|Service times:<br>**Uptime** - service uptime<br>**Downtime** - service state within this period does not affect SLA.<br>**One-time downtime** - a single downtime. Service state within this period does not affect SLA.<br>Add the respective hours.<br>*Note*: Service times affect only the service they are configured for. Thus, a parent service will not take into account the service time configured on a child service (unless a corresponding service time is configured on the parent service as well).<br>Service times are taken into account when calculating service status and SLA by the frontend. However, information on service availability is being inserted into database continuously, regardless of service times.|
#### 前端显示
#### Display
服务（Service），去 监控中（Monitoring）-→ 服务（Service）
To monitor services, go to *[Monitoring →
Services](/manual/web_interface/frontend_sections/monitoring/it_services)*.
#### Configuration
To configure services, go to the [Services](/manual/web_interface/frontend_sections/services) menu.
The services menu consists of these sections:
- [Services](/manual/web_interface/frontend_sections/services/service)
In this section you can build a hierarchy of your monitored
infrastructure by adding parent services, and then - child
services to the parent services.
- [Service actions](/manual/web_interface/frontend_sections/services/service_actions)
In this section you can configure service actions.
- [SLA](/manual/web_interface/frontend_sections/services/sla)
In this section you can view the SLA of services.
- [SLA report](/manual/web_interface/frontend_sections/services/sla_report)
In this section you can view SLA reports.
#### 配置
要配置服务，请转到 [Services（服务）](/manual/web_interface/frontend_sections/services) 菜单。
服务菜单由以下部分组成：
- [Services（服务）](/manual/web_interface/frontend_sections/services/service)
在本节中，您可以通过添加父服务来构建受监控基础架构的层次结构，然后将子服务添加到父服务的下级。
- [Service actions（服务行动）](/manual/web_interface/frontend_sections/services/service_actions)
在本节中，可以配置服务操作。
- [SLA](/manual/web_interface/frontend_sections/services/sla)
在本节中，可以查看服务的 SLA。
- [SLA report](/manual/web_interface/frontend_sections/services/sla_report)
在本节中，可以查看 SLA 报告。
#### Configuration
To configure SMS as the media type:
- Go to *Administration → Media types*
- Click on *Create media type* (or click on *SMS* in the list of
pre-defined media types).
The following parameters are specific for the SMS media type:
|Parameter|Description|
|--|--------|
|*GSM modem*|Set the serial device name of the GSM modem.|
See [common media type
parameters](/manual/config/notifications/media#common_parameters) for
details on how to configure default messages and alert processing
options. Note that parallel processing of sending SMS notifications is
not possible.
#### 配置
配置短信作为媒介类型：
- 前往*管理 → 媒介类型*
- 点击*创建媒介类型*（或在列表中点击*短信*）
pre-defined media types).
以下参数专属于短信媒介类型：
| 参数 | 描述 |
|--|--------|
| *GSM modem* | 设置GSM调制解调器的串行设备名称。 |
详见[通用参数](/manual/config/notifications/media#通用参数)以获取
关于如何配置默认消息和告警处理选项的详细信息。请注意，短信通知的并行发送处理是不可行的。
#### Configuration
To create an ad-hoc graph, do the following:
- Go to *Monitoring* → *Latest data*
- Use filter to display items that you want
- Mark checkboxes of the items you want to graph
- Click on *Display stacked graph* or *Display graph* buttons
{width="600"}
Your graph is created instantly:
{width="600"}
Note that to avoid displaying too many lines in the graph, only the
average value for each item is displayed (min/max value lines are not
displayed). Triggers and trigger information is not displayed in the
graph.
In the created graph window you have the [time period
selector](/manual/config/visualization/graphs/simple#time_period_selector)
available and the possibility to switch from the "normal" line graph to
a stacked one (and back).
{width="600"}
#### 配置
要create一个临时图表，请执行以下操作：
- 前往*监控* → *最新数据*
- 使用过滤器显示您需要的监控项
- 勾选要绘制图表的监控项复选框
- 点击*显示堆叠图表*或*显示图表*按钮
{width="600"}
图表将立即生成：
{width="600"}
请注意，为避免图表中显示过多线条，仅显示每个监控项的平均值（不显示最小/最大值线条）。触发器和触发器信息不会显示在图表中。
在生成的图表窗口中，您可以[时间段选择器](/manual/config/visualization/graphs/simple#时间段选择器)，并可在"普通"折线图和堆叠图之间切换（反之亦然）。
{width="600"}
### Configuration
To create a new service action, go to the *Service actions* subsection of the *Services* menu, then click on *Create action* in the upper right corner.
Service actions are configured in the same way as other types of actions in Zabbix. For more details, see configuring [actions](/manual/config/notifications/action#configuring-an-action).
The key differences are:
- User access to service actions depends on access rights to services granted by user's [role](/manual/web_interface/frontend_sections/administration/user_roles).
- Service actions support different set of [conditions](#conditions).
### 配置
要create新的服务动作，请导航至*服务*菜单中的*服务动作*子章节，然后点击右上角的*创建动作*。
服务动作的配置方式与Zabbix中其他类型的动作相同。更多详情请参阅配置[配置操作](/manual/config/notifications/action#配置操作)。
主要区别在于：
- 用户对服务动作的访问权限取决于用户[role](/manual/web_interface/frontend_sections/administration/user_roles)授予的服务访问权限。
- 服务动作支持不同的[条件](#conditions)集合。
#### Configuration
To define a dependency, open the Dependencies tab in the trigger
[configuration form](trigger#configuration). Click on *Add* in the
'Dependencies' block and select one or more triggers that the trigger
will depend on.
Click *Update*. Now the trigger has the indication of its dependency in
the list.
#### 配置
要定义依赖关系，请打开触发器中的Dependencies选项卡
[配置](trigger#配置)。在'Dependencies'区块中点击*Add*，
并选择一个或多个该触发器将依赖的触发器。
点击*Update*。现在该触发器在列表中会显示其依赖关系标识。
#### Configuration
To define user macros, go to the corresponding location in the frontend:
- for global macros, visit *Administration → General → Macros*
- for host and template level macros, open host or template properties
and look for the *Macros* tab
::: notetip
If a user macro is used in items or triggers in a
template, it is suggested to add that macro to the template even if it
is defined on a global level. That way, if the macro type is *text*
exporting the template to XML and importing it in another system will
still allow it to work as expected. Values of secret macros are not
[exported](/manual/xml_export_import).
:::
A user macro has the following attributes:
{width="600"}
|Parameter|Description|
|--|--------|
|*Macro*|Macro name. The name must be wrapped in curly brackets and start with a dollar sign.<br>Example: {$FRONTEND\_URL}. The following characters are allowed in the macro names: **A-Z** (uppercase only) , **0-9** , **\_** , **.**|
|*Value*|Macro value. Three value types are supported:<br>**Text** (default) - plain-text value<br>**Secret text** - the value is masked with asterisks, which could be useful to protect sensitive information such as passwords or shared keys.<br>**Vault secret** - the value contains a reference path (as 'path:key', for example “secret/zabbix:password”) to a [Vault secret](/manual/config/secrets)<br><br>*Note* that while the value of a secret macro is hidden from sight, the value can be revealed through the use in items. For example, in an external script an 'echo' statement referencing a secret macro may be used to reveal the macro value to the frontend because Zabbix server has access to the real macro value.<br><br>To select the value type click on the button at the end of the value input field:<br> icon indicates a text macro;<br> icon indicates a secret text macro. Upon hovering, the value field transforms into a  button, which allows to enter a new value of the macro (to exit without saving a new value, click the backwards arrow ().<br> icon indicates a secret Vault macro.<br><br>Maximum length of a user macro value is 2048 characters (255 characters in versions before 5.2.0).|
|*Description*|Text field used to provide more information about this macro.|
::: noteclassic
URLs that contain a secret macro will not work as the macro
in them will be resolved as "\*\*\*\*\*\*".
:::
::: noteimportant
In trigger expressions user macros will resolve if
referencing a parameter or constant. They will NOT resolve if
referencing a host, item key, function, operator or another trigger
expression. Secret macros cannot be used in trigger
expressions.
:::
#### 配置
要定义用户宏，请在前端相应位置进行操作：
- 全局宏请访问*管理 → 常规 → 宏*
- 主机和模板级宏需打开主机或模板属性
and look for the *Macros* tab
::: notetip
如果在模板的监控项或触发器中使用了用户宏，
建议将该宏添加到模板中——即使已在全局层面定义。
这样当宏类型为*文本*时，将模板导出为XML并导入其他系统后，
仍能按预期工作。秘密宏的值不会被[exported](/manual/xml_export_import)。
:::
用户宏具有以下属性：
{width="600"}
| 参数 | 描述 |
|--|--------|
| *Macro* | 宏名称。名称必须用花括号包裹并以美元符号开头。<br>示例：{$FRONTEND\_URL}。宏名称允许以下字符：**A-Z**（仅大写）、**0-9**、**\_**、**.** |
| *Value* | 宏值。支持三种值类型：<br>**文本**（默认）- 纯文本值<br>**秘密文本** - 值以星号掩码显示，适用于保护密码或共享密钥等敏感信息<br>**Vault机密** - 值包含指向[Vault secret](/manual/config/secrets)的引用路径（格式如'path:key'，例如"secret/zabbix:password"）<br><br>*注意*：虽然秘密宏的值不可见，但通过监控项的使用可能暴露其值。例如在外部脚本中，引用秘密宏的'echo'语句可能将宏值暴露给前端，因为Zabbix server有权访问真实的宏值。<br><br>点击值输入字段末端的按钮选择值类型：<br>图标表示文本宏；<br>图标表示秘密文本宏。悬停时值字段会变为按钮，可输入新宏值（要退出而不保存新值，点击后退箭头）；<br>图标表示Vault机密宏。<br><br>用户宏值的最大长度为2048字符（5.2.0之前版本为255字符）。 |
| *Description* | 用于提供该宏更多信息的文本字段。 |
::: noteclassic
包含秘密宏的URL将无法正常工作，
因为其中的宏会被解析为"\*\*\*\*\*\*"。
:::
::: noteimportant
在触发器表达式中，用户宏仅在引用参数或常量时会被解析。
引用一个主机、监控项键、函数、运算符或其他触发器表达式时不会被解析。
秘密宏不能用于触发器表达式。
:::
#### Configuration
To ensure proper communication between all elements involved make sure
server configuration file and frontend configuration file parameters are
properly configured.
#### 配置
为确保所有相关组件间的正常通信，请确保服务器配置file和前端配置file参数均已正确配置。
#### Configuration
To ensure proper communication between all elements involved make sure server configuration file and frontend configuration parameters are properly configured.
#### 配置
为确保所有相关组件之间的正常通信，请确保服务器配置file和前端配置参数已正确设置。
#### Configuration
To execute a passive check immediately:
- click on *Execute now* in an existing item (or discovery rule)
configuration form:
- click on *Execute now* for selected items/rules in the list of
items/discovery rules:
In the latter case several items/rules can be selected and "executed
now" at once.
#### 配置
要立即execute被动检查:
- 在现有监控项(或发现规则)中点击*立即执行*
configuration form:
- 在列表中对选定的监控项/规则点击*立即执行*
items/discovery rules:
在后一种情况下，可以同时选择多个监控项/规则并"立即执行"。
#### Configuration
Two steps are required to close a problem manually.
#### 配置
手动关闭问题需要两个步骤。
##### Configure database for Zabbix proxy
Edit Zabbix proxy configuration file (``/etc/zabbix/zabbix_proxy.conf``):
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
In DBName for Zabbix proxy use a separate database from Zabbix server.
In DBPassword use Zabbix database password for MySQL; PostgreSQL user
password for PostgreSQL.
Use `DBHost=` with PostgreSQL. You might want to keep the default
setting `DBHost=localhost` (or an IP address), but this would make
PostgreSQL use a network socket for connecting to Zabbix. Refer to the
[respective
section](/manual/installation/install_from_packages/rhel#selinux_configuration)
for RHEL for instructions.
##### 为 Zabbix proxy 配置数据库
编辑 Zabbix proxy 配置 file (``/etc/zabbix/zabbix_proxy.conf``):
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
在 DBName 中为 Zabbix proxy 使用与 Zabbix server 分离的独立数据库.
在 DBPassword 中使用 MySQL 的 Zabbix 数据库密码; PostgreSQL 用户密码则用于 PostgreSQL.
PostgreSQL 需使用 `DBHost=`. 您可能需要保留默认设置 `DBHost=localhost` (或一个 IP 地址), 但这会使 PostgreSQL 使用网络套接字连接 Zabbix. 具体操作请参考
[selinux配置](/manual/installation/install_from_packages/rhel#selinux配置)
中针对 RHEL 的说明.
##### Configure database for Zabbix proxy
Edit Zabbix proxy configuration file (``/etc/zabbix/zabbix_proxy.conf``):
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
In DBName for Zabbix proxy use a separate database from Zabbix server.
In DBPassword use Zabbix database password for MySQL; PostgreSQL user
password for PostgreSQL.
Use `DBHost=` with PostgreSQL. You might want to keep the default
setting `DBHost=localhost` (or an IP address), but this would make
PostgreSQL use a network socket for connecting to Zabbix. See [SELinux
configuration](/manual/installation/install_from_packages/rhel#selinux_configuration)
for instructions.
##### 为 Zabbix proxy 配置数据库
编辑 Zabbix proxy 配置 file (``/etc/zabbix/zabbix_proxy.conf``):
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
在 Zabbix proxy 的 DBName 中使用与 Zabbix server 分离的独立数据库.
在 DBPassword 中为 MySQL 使用 Zabbix 数据库密码; 为 PostgreSQL 使用 PostgreSQL 用户密码.
PostgreSQL 需使用 `DBHost=`. 可保留默认设置 `DBHost=localhost` (或 IP 地址), 但这会使 PostgreSQL 使用网络套接字连接 Zabbix. 具体操作指南参见 [selinux配置](/manual/installation/install_from_packages/rhel#selinux配置).
##### Configure database for Zabbix proxy
Edit zabbix\_proxy.conf:
# vi /etc/zabbix/zabbix_proxy.conf
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
In DBName for Zabbix proxy use a separate database from Zabbix server.
In DBPassword use Zabbix database password for MySQL; PostgreSQL user
password for PostgreSQL.
Use `DBHost=` with PostgreSQL. You might want to keep the default
setting `DBHost=localhost` (or an IP address), but this would make
PostgreSQL use a network socket for connecting to Zabbix. See [SELinux
configuration](/manual/installation/install_from_packages/rhel_centos#selinux_configuration)
for instructions.
##### 为 Zabbix proxy 配置数据库
编辑zabbix\_proxy.conf文件:
# vi /etc/zabbix/zabbix_proxy.conf
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
在DBName中为Zabbix proxy使用与Zabbix server分离的独立数据库.
在DBPassword中使用MySQL的Zabbix数据库密码; PostgreSQL则使用PostgreSQL用户密码.
PostgreSQL环境下需使用`DBHost=`. 可保留默认设置`DBHost=localhost`(或IP地址), 但这会使PostgreSQL使用网络套接字连接Zabbix. 具体配置方法参见[SELinux
configuration](/manual/installation/install_from_packages/rhel_centos#selinux_configuration).
#### Configure database for Zabbix server/proxy
Edit Zabbix server configuration file (``/etc/zabbix/zabbix_server.conf``) and, if required, Zabbix proxy configuration file (``/etc/zabbix/zabbix_proxy.conf``) for their respective databases. For example:
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
In DBPassword use Zabbix database password for MySQL; PostgreSQL user
password for PostgreSQL.
Use `DBHost=` with PostgreSQL. You might want to keep the default
setting `DBHost=localhost` (or an IP address), but this would make
PostgreSQL use a network socket for connecting to Zabbix.
#### 为 Zabbix server/proxy 配置数据库
编辑Zabbix server配置file(``/etc/zabbix/zabbix_server.conf``)，并根据需要修改Zabbix proxy配置file(``/etc/zabbix/zabbix_proxy.conf``)以适配各自的数据库。例如：
DBHost=localhost
DBName=zabbix
DBUser=zabbix
DBPassword=<password>
在DBPassword中为MySQL使用Zabbix数据库密码；
为PostgreSQL使用PostgreSQL用户密码。
PostgreSQL需使用`DBHost=`。您可能希望保留默认设置`DBHost=localhost`（或IP地址），但这会使PostgreSQL使用网络套接字连接Zabbix。
#### Configure DB connection
Enter details for connecting to the database. Zabbix database must
already be created.
{width="550"}
If the *Database TLS encryption* option is checked, then additional
fields for [configuring the TLS
connection](/manual/appendix/install/db_encrypt) to the database appear
in the form (MySQL or PostgreSQL only).
If HashiCorp Vault option is selected for storing credentials,
additional fields are available for specifying the Vault API endpoint,
secret path and authentication token:
{width="550"}
#### 配置数据库连接
输入数据库连接详细信息。Zabbix数据库必须
已预先创建完成。
{width="550"}
若勾选*数据库TLS加密*选项，则表单中会显示
用于[configuring the TLS
connection](/manual/appendix/install/db_encrypt)数据库的附加字段
（仅限MySQL或PostgreSQL）。
若选择HashiCorp Vault作为凭证存储方式，
将显示用于指定Vault API终端点、
密钥路径及认证令牌的附加字段：
{width="550"}
###### Configure request
A request to execute the *Configure* function of the *Configurator* interface.
| | |
|---|---|
|direction|agent → plugin|
|response|n/a|
Parameters specific to *Configure* requests:
|Name|Type|Comments|
|---------|--------|----------|
|global_options|JSON object|JSON object containing global agent configuration options.|
|private_options|JSON object (optional)|JSON object containing private plugin configuration options, if provided.|
*Example:*
{"id":6,"type":8,"global_options":{...},"private_options":{...}}
###### 配置请求
调用*Configurator*接口中*Configure*功能的execute请求.
| | |
|---|---|
| direction | agent → plugin |
| response | n/a |
*Configure*请求的专用参数:
| Name | Type | Comments |
|---------|--------|----------|
| global_options | JSON object | 包含全局agent配置选项的JSON object. |
| private_options | JSON object (optional) | 包含私有插件配置选项的JSON object(如果提供). |
*示例:*
{"id":6,"type":8,"global_options":{...},"private_options":{...}}
#### Configuring a *Clock* widget
Configure a *Clock* widget that displays Zabbix server time.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "clock",
"name": "Clock",
"x": 0,
"y": 0,
"width": 4,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "time_type",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置*时钟*部件
配置一个显示Zabbix server时间的*时钟*部件.
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "clock",
"name": "Clock",
"x": 0,
"y": 0,
"width": 4,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "time_type",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Data overview* widget
Configure a *Data overview* widget that displays data for host "10084" and only for items for which the tag with the name "component" contains value "cpu".
In addition, display the data with hosts located on top.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "dataover",
"name": "Data overview",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids",
"value": 10084
},
{
"type": 1,
"name": "tags.tag.0",
"value": "component"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "cpu"
},
{
"type": 0,
"name": "style",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *数据概览* 部件
配置一个*数据概览*小部件，用于显示主机 "10084"的数据，并且仅显示标签名称为"component"且包含值"cpu"的监控项。
此外，显示位于Top上的主机的数据。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "dataover",
"name": "Data overview",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids",
"value": 10084
},
{
"type": 1,
"name": "tags.tag.0",
"value": "component"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "cpu"
},
{
"type": 0,
"name": "style",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring agent
Both generations of Zabbix agents run as a Windows service. For Zabbix
agent 2, replace *agentd* with *agent2* in the instructions below.
You can run a single instance of Zabbix agent or multiple instances of
the agent on a Microsoft Windows host. A single instance can use the
default configuration file `C:\zabbix_agentd.conf` or a configuration
file specified in the command line. In case of multiple instances each
agent instance must have its own configuration file (one of the
instances can use the default configuration file).
An example configuration file is available in Zabbix source archive as
`conf/zabbix_agentd.win.conf`.
See the [configuration file](/manual/appendix/config/zabbix_agentd_win)
options for details on configuring Zabbix Windows agent.
#### 配置 agent
两代Zabbix agents run均可作为Windows服务运行。适用于Zabbix
agent 2，将以下说明中的*agentd*替换为*agent2*
你可以run单个Zabbix agent实例或多个实例
在Microsoft Windows 主机上的agent。单个实例可以使用
默认配置 file `C:\zabbix_agentd.conf` 或配置
file 在命令行中指定。若存在多个实例，每个
agent实例必须拥有自己的配置file（其中之一为
实例可以使用默认配置file。
Zabbix源码归档中提供了一个示例配置file
`conf/zabbix_agentd.win.conf`.
参见[configuration file](/manual/appendix/config/zabbix_agentd_win)
有关配置Zabbix Windows agent的详细选项
#### Configuring a *Geomap* widget
Configure a *Geomap* widget that displays hosts from host groups "2" and "22" based on the following tag configuration:
tag with the name "component" contains value "node", or tag with the name "location" equals value "New York".
In addition, set the map initial view to coordinates "40.6892494" (latitude), "-74.0466891" (longitude) with the zoom level "10".
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "geomap",
"name": "Geomap",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 22
},
{
"type": 2,
"name": "groupids",
"value": 2
},
{
"type": 1,
"name": "default_view",
"value": "40.6892494,-74.0466891,10"
},
{
"type": 0,
"name": "evaltype",
"value": 2
},
{
"type": 1,
"name": "tags.tag.0",
"value": "component"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "node"
},
{
"type": 1,
"name": "tags.tag.1",
"value": "location"
},
{
"type": 0,
"name": "tags.operator.1",
"value": 1
},
{
"type": 1,
"name": "tags.value.1",
"value": "New York"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *Geomap* 部件
配置一个*地理地图*部件，根据以下标签配置显示来自主机组"2"和"22"的主机：
标签名为"component"且包含值"node"，或标签名为"location"等于值"New York"。
此外，将地图初始视图设置为坐标"40.6892494"（纬度），"-74.0466891"（经度），缩放级别为"10"。
请求：
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "geomap",
"name": "Geomap",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 22
},
{
"type": 2,
"name": "groupids",
"value": 2
},
{
"type": 1,
"name": "default_view",
"value": "40.6892494,-74.0466891,10"
},
{
"type": 0,
"name": "evaltype",
"value": 2
},
{
"type": 1,
"name": "tags.tag.0",
"value": "component"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "node"
},
{
"type": 1,
"name": "tags.tag.1",
"value": "location"
},
{
"type": 0,
"name": "tags.operator.1",
"value": 1
},
{
"type": 1,
"name": "tags.value.1",
"value": "New York"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Graph (classic)* widget
Configure a *Graph (classic)* widget that displays a simple graph for the item "42269".
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graph",
"name": "Graph (classic)",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 1
},
{
"type": 4,
"name": "itemid",
"value": 42269
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *Graph (classic)* 部件
配置一个*图形(经典)*小部件，用于显示监控项 "42269"的简单图形。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graph",
"name": "Graph (classic)",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 1
},
{
"type": 4,
"name": "itemid",
"value": 42269
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Graph prototype* widget
Configure a *Graph prototype* widget that displays a grid of 3 graphs (3 columns, 1 row) created from an item prototype (ID: "42316") by low-level discovery.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graphprototype",
"name": "Graph prototype",
"x": 0,
"y": 0,
"width": 16,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 3
},
{
"type": 5,
"name": "itemid",
"value": 42316
},
{
"type": 0,
"name": "columns",
"value": 3
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *图形原型* 部件
配置一个*图形原型*部件，该部件显示由低级发现创建的监控项原型（ID: "42316"）生成的3个图形网格（3列，1行）。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graphprototype",
"name": "Graph prototype",
"x": 0,
"y": 0,
"width": 16,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 3
},
{
"type": 5,
"name": "itemid",
"value": 42316
},
{
"type": 0,
"name": "columns",
"value": 3
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Graph* widget
Configure a *Graph* widget in the following way:
- 4 data sets for a total of 9 items on 1 host.
- Each data set consists of a line that has a custom color, width, transparency, and fill.
- Data set 4 has a configured aggregation.
- Data in the graph are displayed for a time period of the last 3 hours.
- Problems in the graph are displayed only for the configured items.
- Graph has two Y axes of which the right Y axis displays values only for Data set 4.
- Graph legend displays configured items in 2 rows.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "svggraph",
"name": "Graph",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "ds.hosts.0.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.0.0",
"value": "Zabbix server: Utilization of poller data collector processes, in %"
},
{
"type": 1,
"name": "ds.color.0",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.width.0",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.0",
"value": 3
},
{
"type": 0,
"name": "ds.fill.0",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.1.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.1.0",
"value": "Zabbix server: Utilization of trapper data collector processes, in %"
},
{
"type": 1,
"name": "ds.color.1",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.width.1",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.1",
"value": 3
},
{
"type": 0,
"name": "ds.fill.1",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.2.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.2.0",
"value": "Zabbix server: Utilization of history syncer internal processes, in %"
},
{
"type": 1,
"name": "ds.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.width.2",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.2",
"value": 3
},
{
"type": 0,
"name": "ds.fill.2",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.3.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.3.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.color.3",
"value": "000000"
},
{
"type": 0,
"name": "ds.transparency.3",
"value": 0
},
{
"type": 0,
"name": "ds.fill.3",
"value": 0
},
{
"type": 0,
"name": "ds.axisy.3",
"value": 1
},
{
"type": 0,
"name": "ds.aggregate_function.3",
"value": 3
},
{
"type": 1,
"name": "ds.aggregate_interval.3",
"value": "1m"
},
{
"type": 0,
"name": "ds.aggregate_grouping.3",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_from",
"value": "now-3h"
},
{
"type": 0,
"name": "legend_lines",
"value": 2
},
{
"type": 0,
"name": "show_problems",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *图形* 部件
按以下方式配置*图形*部件：
- 4个数据集共9个监控项显示在1个主机上
- 每个数据集包含一条具有自定义颜色、宽度、透明度和填充的线条
- 数据集4配置了聚合功能
- 图表中显示最近3小时的数据
- 图表中仅显示配置的监控项相关的问题
- 图表包含两个Y轴，其中右侧Y轴仅显示数据集4的值
- 图例以2行显示配置的监控项
请求：
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "svggraph",
"name": "Graph",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "ds.hosts.0.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.0.0",
"value": "Zabbix server: Utilization of poller data collector processes, in %"
},
{
"type": 1,
"name": "ds.color.0",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.width.0",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.0",
"value": 3
},
{
"type": 0,
"name": "ds.fill.0",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.1.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.1.0",
"value": "Zabbix server: Utilization of trapper data collector processes, in %"
},
{
"type": 1,
"name": "ds.color.1",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.width.1",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.1",
"value": 3
},
{
"type": 0,
"name": "ds.fill.1",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.2.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.2.0",
"value": "Zabbix server: Utilization of history syncer internal processes, in %"
},
{
"type": 1,
"name": "ds.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.width.2",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.2",
"value": 3
},
{
"type": 0,
"name": "ds.fill.2",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.3.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.3.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.color.3",
"value": "000000"
},
{
"type": 0,
"name": "ds.transparency.3",
"value": 0
},
{
"type": 0,
"name": "ds.fill.3",
"value": 0
},
{
"type": 0,
"name": "ds.axisy.3",
"value": 1
},
{
"type": 0,
"name": "ds.aggregate_function.3",
"value": 3
},
{
"type": 1,
"name": "ds.aggregate_interval.3",
"value": "1m"
},
{
"type": 0,
"name": "ds.aggregate_grouping.3",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_from",
"value": "now-3h"
},
{
"type": 0,
"name": "legend_lines",
"value": 2
},
{
"type": 0,
"name": "show_problems",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring alert actions
Actions determine which notifications should be sent via the webhook.
Steps for [configuring actions](/manual/config/notifications/action) involving webhooks are the same as for all other media types with these exceptions:
- If a webhook uses [webhook tags](https://www.zabbix.com/documentation/guidelines/en/webhooks#webhook-tags) to store ticket\\message ID and handle update\\resolve operations, avoid using the same webhook in multiple alert actions for a single problem event.
If {EVENT.TAGS.<tag name>} exists and gets updated in the webhook, its resulting value will be undefined. To avoid this, use a new tag name in the webhook for storing updated values.
This applies to Jira, Jira Service Desk, Mattermost, Opsgenie, OTRS, Redmine, ServiceNow, Slack, Zammad, and Zendesk webhooks provided by Zabbix and to most webhooks utilizing the *Include event menu entry* option.
Note, however, that a single webhook can be used in multiple operations or escalation steps of the same action, as well as in different actions that will not be triggered by the same problem event due to different [conditions](/manual/config/notifications/action/conditions).
- When using a webhook in actions for [internal events](/manual/config/events/sources#internal-events), ensure to mark the *Custom message* checkbox and define a custom message in the action operation configuration.
Otherwise, a notification will not be sent.
#### 配置告警动作
操作决定应通过webhook发送哪些通知.
涉及webhook的[configuring actions](/manual/config/notifications/action)步骤与其他所有媒介类型相同, 但存在以下例外情况:
- 如果webhook使用[webhook tags](https://www.zabbix.com/documentation/guidelines/en/webhooks#webhook-tags)存储票据\\消息ID并处理update\\解决操作, 请避免在单个问题事件的多个警报操作中使用相同的webhook.
如果{EVENT.TAGS.<tag name>}存在并在webhook中更新, 其最终值将未定义. 为避免这种情况, 请在webhook中使用新的标签名称来存储更新后的值.
这适用于Zabbix提供的Jira、Jira Service Desk、Mattermost、Opsgenie、OTRS、Redmine、ServiceNow、Slack、Zammad和Zendesk webhook, 以及大多数使用*包含事件菜单项*选项的webhook.
但请注意, 单个webhook可用于同一操作的多个操作或升级步骤中, 也可用于由于不同[conditions](/manual/config/notifications/action/conditions)而不会被同一问题事件触发的不同操作中.
- 在[内部事件](/manual/config/events/sources#内部事件)的操作中使用webhook时, 请确保勾选*自定义消息*复选框并在操作配置中定义自定义消息.
否则, 将不会发送通知.
#### Configuring a linked *Map* widget
Configure a *Map* widget that is linked to a [*Map navigation tree*](/manual/api/reference/dashboard/widget_fields/map_tree#configuring-a-map-navigation-tree-widget) widget.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "map",
"name": "Map",
"x": 0,
"y": 5,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 2
},
{
"type": 1,
"name": "filter_widget_reference",
"value": "ABCDE"
}
]
},
{
"type": "navtree",
"name": "Map navigation tree",
"x": 0,
"y": 0,
"width": 6,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "navtree.name.1",
"value": "Element A"
},
{
"type": 1,
"name": "navtree.name.2",
"value": "Element B"
},
{
"type": 1,
"name": "navtree.name.3",
"value": "Element C"
},
{
"type": 1,
"name": "navtree.name.4",
"value": "Element A1"
},
{
"type": 1,
"name": "navtree.name.5",
"value": "Element A2"
},
{
"type": 1,
"name": "navtree.name.6",
"value": "Element B1"
},
{
"type": 1,
"name": "navtree.name.7",
"value": "Element B2"
},
{
"type": 0,
"name": "navtree.parent.4",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.5",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.6",
"value": 2
},
{
"type": 0,
"name": "navtree.parent.7",
"value": 2
},
{
"type": 0,
"name": "navtree.order.1",
"value": 1
},
{
"type": 0,
"name": "navtree.order.2",
"value": 2
},
{
"type": 0,
"name": "navtree.order.3",
"value": 3
},
{
"type": 0,
"name": "navtree.order.4",
"value": 1
},
{
"type": 0,
"name": "navtree.order.5",
"value": 2
},
{
"type": 0,
"name": "navtree.order.6",
"value": 1
},
{
"type": 0,
"name": "navtree.order.7",
"value": 2
},
{
"type": 8,
"name": "navtree.sysmapid.6",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "ABCDE"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置关联的 *Map* 部件
配置一个与[配置-地图导航树-部件](/manual/api/reference/dashboard/widget_fields/map_tree#配置-地图导航树-部件)部件关联的*地图*部件.
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "map",
"name": "Map",
"x": 0,
"y": 5,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 2
},
{
"type": 1,
"name": "filter_widget_reference",
"value": "ABCDE"
}
]
},
{
"type": "navtree",
"name": "Map navigation tree",
"x": 0,
"y": 0,
"width": 6,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "navtree.name.1",
"value": "Element A"
},
{
"type": 1,
"name": "navtree.name.2",
"value": "Element B"
},
{
"type": 1,
"name": "navtree.name.3",
"value": "Element C"
},
{
"type": 1,
"name": "navtree.name.4",
"value": "Element A1"
},
{
"type": 1,
"name": "navtree.name.5",
"value": "Element A2"
},
{
"type": 1,
"name": "navtree.name.6",
"value": "Element B1"
},
{
"type": 1,
"name": "navtree.name.7",
"value": "Element B2"
},
{
"type": 0,
"name": "navtree.parent.4",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.5",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.6",
"value": 2
},
{
"type": 0,
"name": "navtree.parent.7",
"value": 2
},
{
"type": 0,
"name": "navtree.order.1",
"value": 1
},
{
"type": 0,
"name": "navtree.order.2",
"value": 2
},
{
"type": 0,
"name": "navtree.order.3",
"value": 3
},
{
"type": 0,
"name": "navtree.order.4",
"value": 1
},
{
"type": 0,
"name": "navtree.order.5",
"value": 2
},
{
"type": 0,
"name": "navtree.order.6",
"value": 1
},
{
"type": 0,
"name": "navtree.order.7",
"value": 2
},
{
"type": 8,
"name": "navtree.sysmapid.6",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "ABCDE"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Map navigation tree* widget
Configure a *Map navigation tree* widget that displays the following map navigation tree:
- Element A
- Element A1
- Element A2
- Element B
- Element B1 (contains linked map "1" that can be displayed in a [linked *Map widget*](/manual/api/reference/dashboard/widget_fields/map#configuring-a-linked-map-widget))
- Element B2
- Element C
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "navtree",
"name": "Map navigation tree",
"x": 0,
"y": 0,
"width": 6,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "navtree.name.1",
"value": "Element A"
},
{
"type": 1,
"name": "navtree.name.2",
"value": "Element B"
},
{
"type": 1,
"name": "navtree.name.3",
"value": "Element C"
},
{
"type": 1,
"name": "navtree.name.4",
"value": "Element A1"
},
{
"type": 1,
"name": "navtree.name.5",
"value": "Element A2"
},
{
"type": 1,
"name": "navtree.name.6",
"value": "Element B1"
},
{
"type": 1,
"name": "navtree.name.7",
"value": "Element B2"
},
{
"type": 0,
"name": "navtree.parent.4",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.5",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.6",
"value": 2
},
{
"type": 0,
"name": "navtree.parent.7",
"value": 2
},
{
"type": 0,
"name": "navtree.order.1",
"value": 1
},
{
"type": 0,
"name": "navtree.order.2",
"value": 2
},
{
"type": 0,
"name": "navtree.order.3",
"value": 3
},
{
"type": 0,
"name": "navtree.order.4",
"value": 1
},
{
"type": 0,
"name": "navtree.order.5",
"value": 2
},
{
"type": 0,
"name": "navtree.order.6",
"value": 1
},
{
"type": 0,
"name": "navtree.order.7",
"value": 2
},
{
"type": 8,
"name": "navtree.sysmapid.6",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "ABCDE"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *地图导航树* 部件
配置一个*地图导航树*部件，用于显示以下地图导航树结构：
- 元素A
- 元素A1
- 元素A2
- 元素B
- 元素B1（包含可显示在[配置关联的-map-部件](/manual/api/reference/dashboard/widget_fields/map#配置关联的-map-部件)中的链接地图"1"）
- 元素B2
- 元素C
请求：
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "navtree",
"name": "Map navigation tree",
"x": 0,
"y": 0,
"width": 6,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "navtree.name.1",
"value": "Element A"
},
{
"type": 1,
"name": "navtree.name.2",
"value": "Element B"
},
{
"type": 1,
"name": "navtree.name.3",
"value": "Element C"
},
{
"type": 1,
"name": "navtree.name.4",
"value": "Element A1"
},
{
"type": 1,
"name": "navtree.name.5",
"value": "Element A2"
},
{
"type": 1,
"name": "navtree.name.6",
"value": "Element B1"
},
{
"type": 1,
"name": "navtree.name.7",
"value": "Element B2"
},
{
"type": 0,
"name": "navtree.parent.4",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.5",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.6",
"value": 2
},
{
"type": 0,
"name": "navtree.parent.7",
"value": 2
},
{
"type": 0,
"name": "navtree.order.1",
"value": 1
},
{
"type": 0,
"name": "navtree.order.2",
"value": 2
},
{
"type": 0,
"name": "navtree.order.3",
"value": 3
},
{
"type": 0,
"name": "navtree.order.4",
"value": 1
},
{
"type": 0,
"name": "navtree.order.5",
"value": 2
},
{
"type": 0,
"name": "navtree.order.6",
"value": 1
},
{
"type": 0,
"name": "navtree.order.7",
"value": 2
},
{
"type": 8,
"name": "navtree.sysmapid.6",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "ABCDE"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Map* widget
Configure a *Map* widget that displays the map "1".
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "map",
"name": "Map",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 8,
"name": "sysmapid",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *地图* 部件
配置一个显示地图"1"的*地图*部件。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "map",
"name": "Map",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 8,
"name": "sysmapid",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring an action
To configure an action, do the following:
- Go to *Configuration* -> *Actions* and select
the required action type from the submenu (you can
switch to another type later, using the title dropdown)
- Click on *Create action*
- Name the action
- Choose [conditions](/manual/config/notifications/action/conditions)
upon which operations are carried out
- Choose the
[operations](/manual/config/notifications/action/operation) to carry
out
*Note* that service actions can be configured in the [service action](/manual/web_interface/frontend_sections/services/service_actions) section.
General action attributes:
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Name*|Unique action name.|
|*Type of calculation*|Select the evaluation [option](/manual/config/notifications/action/conditions#type_of_calculation) for action conditions (with more than one condition):<br>**And** - all conditions must be met<br>**Or** - enough if one condition is met<br>**And/Or** - combination of the two: AND with different condition types and OR with the same condition type<br>**Custom expression** - a user-defined calculation formula for evaluating action conditions.|
|*Conditions*|List of action conditions.<br>Click on *Add* to add a new [condition](/manual/config/notifications/action/conditions).<br>If no conditions are configured, the action will run for every event that corresponds to the [action type](#overview) being configured.|
|*Enabled*|Mark the checkbox to enable the action. Otherwise, it will be disabled.|
#### 配置操作
配置操作步骤如下：
- 前往*配置* -> *操作*，从子菜单中选择所需的操作类型（后续可通过标题下拉菜单切换其他类型）
- 点击*创建操作*
- 命名操作
- 选择[conditions](/manual/config/notifications/action/conditions)作为执行操作的基础
- 选择
[operations](/manual/config/notifications/action/operation) to carry
out
*注意*：服务操作可在[service action](/manual/web_interface/frontend_sections/services/service_actions)部分配置。
通用操作属性：
所有必填字段均以红色星号标记。
| 参数 | 描述 |
|--|--------|
| *Name* | 唯一操作名称。 |
| *Type of calculation* | 选择操作条件的评估[计算类型](/manual/config/notifications/action/conditions#计算类型)（当存在多个条件时）：<br>**与** - 需满足所有条件<br>**或** - 只需满足任一条件<br>**与/或** - 两种逻辑的组合：不同条件类型间使用AND，相同条件类型间使用OR<br>**自定义表达式** - 用户定义的条件评估计算公式。 |
| *Conditions* | 操作条件列表。<br>点击*添加*新增[condition](/manual/config/notifications/action/conditions)。<br>若未配置条件，该操作将run所有符合[操作类型](#overview)的事件。 |
| *Enabled* | 勾选复选框以启用操作，否则操作将处于禁用状态。 |
#### Configuring an action
To configure an action, do the following:
- In the *Configuration* menu section, click on *Actions* and select
the required action type from the submenu that appears. (You can
also use the title dropdown to switch between action types later.)
- Click on *Create action*
- Name the action
- Choose [conditions](/manual/config/notifications/action/conditions)
upon which operations are carried out
- Choose the
[operations](/manual/config/notifications/action/operation) to carry
out
General action attributes:
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|---------|-----------|
|*Name*|Unique action name.|
|*Type of calculation*|Select the evaluation [option](/manual/config/notifications/action/conditions#type_of_calculation) for action conditions (with more than one condition):<br>**And** - all conditions must be met<br>**Or** - enough if one condition is met<br>**And/Or** - combination of the two: AND with different condition types and OR with the same condition type<br>**Custom expression** - a user-defined calculation formula for evaluating action conditions.|
|*Conditions*|List of action conditions.<br>Click on *Add* to add a new [condition](/manual/config/notifications/action/conditions).|
|*Enabled*|Mark the checkbox to enable the action. Otherwise, it will be disabled.|
#### 配置动作
配置动作，步骤如下：
- 在 *Configuration* 菜单中点击*Actions*并且选择对应的动作类型。(也可以在标题下拉框中进行动作类型的切换)
- 点击*Create action*
- 给动作命名
- 选择执行动作的条件[conditions](/manual/config/notifications/action/conditions)
- 选择执行动作的操作[operations](/manual/config/notifications/action/operation)
常见动作属性：
带有红色星号的为必填字段。
|参数|说明|
|---------|-----------|
|*Name*|动作名称(需唯一)|
|*Type of calculation*|选择评估 [option](/manual/config/notifications/action/conditions#type_of_calculation) 作为行动条件（有多个条件）：<br>**And** - 必须满足所有条件<br>**Or** - 只需满足其中一个条件<br>**And/Or** - 两者的组合：AND有不同的条件类型，OR有相同的条件类型<br>**自定义的表达式** - 用户自定义计算公式来进行条件的计算.|
|*Conditions*|条件的清单。<br>点击*Add*添加一个新的[condition](/manual/config/notifications/action/conditions).|
|*Enabled*|选中复选框以启用该操作。否则将被禁用。|
#### Configuring and running Java gateway
By default, Java gateway listens on port 10052. If you plan on running
Java gateway on a different port, you can specify that in settings.sh
script. See the description of [Java gateway configuration
file](/manual/appendix/config/zabbix_java) for how to specify this and
other options.
::: notewarning
Port 10052 is not [IANA
registered](http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt).
:::
Once you are comfortable with the settings, you can start Java gateway
by running the startup script:
./startup.sh
Likewise, once you no longer need Java gateway, run the shutdown script
to stop it:
./shutdown.sh
Note that unlike server or proxy, Java gateway is lightweight and does
not need a database.
#### 配置并运行Java网关
默认情况下，Java网关监听端口10052。如果计划运行
在不同端口上运行的Java网关，可以在settings.sh中指定
脚本。有关如何指定此内容，请参阅[Java gateway configuration
file](/manual/appendix/config/zabbix_java)的描述。
其他选项。
::: notewarning
端口10052未[IANA
registered](http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt)。
:::
一旦您对设置感到满意，就可以启动Java网关
通过运行启动脚本:
./startup.sh
同样地，当您不再需要Java网关时，run关闭脚本
要停止它：
./shutdown.sh
请注意，与server 或 proxy不同，Java网关是轻量级的且不会
不需要数据库。
#### Configuring and running Java gateway
Configuration parameters of Zabbix Java gateway may be tuned in the
file:
/etc/zabbix/zabbix_java_gateway.conf
For more details, see Zabbix Java gateway configuration
[parameters](/manual/appendix/config/zabbix_java).
To start Zabbix Java gateway:
# service zabbix-java-gateway restart
To automatically start Zabbix Java gateway on boot:
RHEL 7 and later:
# systemctl enable zabbix-java-gateway
RHEL prior to 7:
# chkconfig --level 12345 zabbix-java-gateway on
#### 配置并运行 JAVA 网关
Zabbix Java 网关的配置参数可以通过如下文件进行调整：
/etc/zabbix/zabbix_java_gateway.conf
关于更多信息，详见 Zabbix Java 网关配置[参数](/manual/appendix/config/zabbix_java)。
通过以下命令启动 Zabbix Java 网关:
# service zabbix-java-gateway restart
通过以下命令配置 Zabbix Java 网关开机自启动:
RHEL 7 和 RHEL 7 之后的系统：
# systemctl enable zabbix-java-gateway
RHEL 7 之前的系统：
# chkconfig --level 12345 zabbix-java-gateway on
#### Configuring and running Java gateway
Configuration parameters of Zabbix Java gateway may be tuned in the
file:
/etc/zabbix/zabbix_java_gateway.conf
For more details, see Zabbix Java gateway configuration
[parameters](/manual/appendix/config/zabbix_java).
To start Zabbix Java gateway:
systemctl restart zabbix-java-gateway
To automatically start Zabbix Java gateway on boot:
RHEL 7 and later:
systemctl enable zabbix-java-gateway
RHEL prior to 7:
chkconfig --level 12345 zabbix-java-gateway on
#### 配置并运行Java网关
Zabbix Java网关的配置参数可在
file中进行调整:
/etc/zabbix/zabbix_java_gateway.conf
更多详情请参阅Zabbix Java网关配置
[parameters](/manual/appendix/config/zabbix_java).
启动Zabbix Java网关:
systemctl restart zabbix-java-gateway
设置Zabbix Java网关开机自启:
RHEL 7及更高版本:
systemctl enable zabbix-java-gateway
RHEL 7之前版本:
chkconfig --level 12345 zabbix-java-gateway on
#### Configuring and running Java gateway
Java gateway configuration may be tuned in the file:
/etc/zabbix/zabbix_java_gateway.conf
For more details, see Zabbix Java gateway configuration
[parameters](/manual/appendix/config/zabbix_java).
To start Zabbix Java gateway:
systemctl restart zabbix-java-gateway
To automatically start Zabbix Java gateway on boot:
systemctl enable zabbix-java-gateway
#### 配置并运行Java网关
Java网关配置可通过file进行调整:
/etc/zabbix/zabbix_java_gateway.conf
更多详情请参阅Zabbix Java网关配置
[parameters](/manual/appendix/config/zabbix_java).
启动Zabbix Java网关:
systemctl restart zabbix-java-gateway
设置Zabbix Java网关开机自启:
systemctl enable zabbix-java-gateway
#### Configuring an *Item value* widget
Configure an *Item value* widget that displays the item value for the item "42266" (Zabbix agent availability).
In addition, visually fine-tune the widget with multiple advanced options.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "item",
"name": "Item value",
"x": 0,
"y": 0,
"width": 4,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid",
"value": 42266
},
{
"type": 0,
"name": "show",
"value": 1
},
{
"type": 0,
"name": "show",
"value": 2
},
{
"type": 0,
"name": "show",
"value": 3
},
{
"type": 0,
"name": "adv_conf",
"value": 1
},
{
"type": 1,
"name": "bg_color",
"value": "D1C4E9"
},
{
"type": 1,
"name": "description",
"value": "Agent status"
},
{
"type": 0,
"name": "desc_h_pos",
"value": 0
},
{
"type": 0,
"name": "desc_v_pos",
"value": 0
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 1,
"name": "desc_color",
"value": "F06291"
},
{
"type": 0,
"name": "value_h_pos",
"value": 0
},
{
"type": 0,
"name": "value_size",
"value": 25
},
{
"type": 1,
"name": "value_color",
"value": "FFFF00"
},
{
"type": 0,
"name": "units_show",
"value": 0
},
{
"type": 0,
"name": "time_h_pos",
"value": 2
},
{
"type": 0,
"name": "time_v_pos",
"value": 2
},
{
"type": 0,
"name": "time_size",
"value": 10
},
{
"type": 0,
"name": "time_bold",
"value": 1
},
{
"type": 1,
"name": "time_color",
"value": "9FA8DA"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *监控项 值* 部件
配置一个显示监控项 "42266"(Zabbix agent可用性)的监控项值的*监控项值*部件
同时通过多项高级选项对部件进行视觉微调
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "item",
"name": "Item value",
"x": 0,
"y": 0,
"width": 4,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid",
"value": 42266
},
{
"type": 0,
"name": "show",
"value": 1
},
{
"type": 0,
"name": "show",
"value": 2
},
{
"type": 0,
"name": "show",
"value": 3
},
{
"type": 0,
"name": "adv_conf",
"value": 1
},
{
"type": 1,
"name": "bg_color",
"value": "D1C4E9"
},
{
"type": 1,
"name": "description",
"value": "Agent status"
},
{
"type": 0,
"name": "desc_h_pos",
"value": 0
},
{
"type": 0,
"name": "desc_v_pos",
"value": 0
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 1,
"name": "desc_color",
"value": "F06291"
},
{
"type": 0,
"name": "value_h_pos",
"value": 0
},
{
"type": 0,
"name": "value_size",
"value": 25
},
{
"type": 1,
"name": "value_color",
"value": "FFFF00"
},
{
"type": 0,
"name": "units_show",
"value": 0
},
{
"type": 0,
"name": "time_h_pos",
"value": 2
},
{
"type": 0,
"name": "time_v_pos",
"value": 2
},
{
"type": 0,
"name": "time_size",
"value": 10
},
{
"type": 0,
"name": "time_bold",
"value": 1
},
{
"type": 1,
"name": "time_color",
"value": "9FA8DA"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring an operation
To configure an operation, go to the *Operations* tab in
[action](/manual/config/notifications/action) configuration.
{width="600"}
General operation attributes:
|Parameter|Description|
|--|-----------|
|*Default operation step duration*|Duration of one operation step by default (60 seconds to 1 week).<br>For example, an hour-long step duration means that if an operation is carried out, an hour will pass before the next step.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 60s, 1m, 2h, 1d, since Zabbix 3.4.0.<br>[User macros](/manual/config/macros/user_macros) are supported, since Zabbix 3.4.0.|
|*Operations*|Action operations (if any) are displayed, with these details:<br>**Steps** - escalation step(s) to which the operation is assigned<br>**Details** - type of operation and its recipient/target.<br>The operation list also displays the media type (e-mail, SMS or script) used as well as the name and surname (in parentheses after the username) of a notification recipient.<br>**Start in** - how long after an event the operation is performed<br>**Duration (sec)** - step duration is displayed. *Default* is displayed if the step uses default duration, and a time is displayed if custom duration is used.<br>**Action** - links for editing and removing an operation are displayed.|
|*Recovery operations*|Action operations (if any) are displayed, with these details:<br>**Details** - type of operation and its recipient/target.<br>The operation list also displays the media type (e-mail, SMS or script) used as well as the name and surname (in parentheses after the username) of a notification recipient.<br>**Action** - links for editing and removing an operation are displayed.|
|*Update operations*|Action operations (if any) are displayed, with these details:<br>**Details** - type of operation and its recipient/target.<br>The operation list also displays the media type (e-mail, SMS or script) used as well as the name and surname (in parentheses after the username) of a notification recipient.<br>**Action** - links for editing and removing an operation are displayed.|
|*Pause operations for suppressed problems*|Mark this checkbox to delay the start of operations for the duration of a maintenance period. When operations are started, after the maintenance, all operations are performed including those for the events during the maintenance.<br>Note that this setting affects only problem escalations; recovery and update operations will not be affected.<br>If you unmark this checkbox, operations will be executed without delay even during a maintenance period.<br>This option is not available for *Service actions*.|
|*Notify about canceled escalations*|Unmark this checkbox to disable notifications about canceled escalations (when host, item, trigger or action is disabled).|
All mandatory input fields are marked with a red asterisk.
To configure details of a new operation, click on
 in the
Operations block. To edit an existing operation, click on
 next to the
operation. A popup window will open where you can edit the operation
step details.
#### 配置操作
要配置操作，请转到[action](/manual/config/notifications/action)配置中的*操作*选项卡。
{width="600"}
常规操作属性：
| 参数 | 描述 |
|--|-----------|
| *Default operation step duration* | 默认情况下单个操作步骤的持续时间（60秒至1周）。<br>例如，一小时的步骤持续时间意味着如果执行一个操作，将在1小时后执行下一步骤。<br>支持[Time suffixes](/manual/appendix/suffixes)，例如60s、1m、2h、1d，自Zabbix 3.4.0起。<br>支持[User macros](/manual/config/macros/user_macros)，自Zabbix 3.4.0起。 |
| *Operations* | 显示动作操作（如果有），包含以下详细信息：<br>**步骤** - 操作分配的升级步骤<br>**详情** - 操作类型及其接收者/目标。<br>操作列表还显示使用的媒体类型（电子邮件、短信或脚本）以及通知接收者的姓名和姓氏（在用户名后的括号中）。<br>**开始于** - 事件发生后多久执行操作<br>**持续时间（秒）** - 显示步骤持续时间。如果步骤使用默认持续时间，则显示*默认*；如果使用自定义持续时间，则显示时间。<br>**操作** - 显示用于编辑和删除操作的链接。 |
| *Recovery operations* | 显示动作操作（如果有），包含以下详细信息：<br>**详情** - 操作类型及其接收者/目标。<br>操作列表还显示使用的媒体类型（电子邮件、短信或脚本）以及通知接收者的姓名和姓氏（在用户名后的括号中）。<br>**操作** - 显示用于编辑和删除操作的链接。 |
| *Update operations* | 显示动作操作（如果有），包含以下详细信息：<br>**详情** - 操作类型及其接收者/目标。<br>操作列表还显示使用的媒体类型（电子邮件、短信或脚本）以及通知接收者的姓名和姓氏（在用户名后的括号中）。<br>**操作** - 显示用于编辑和删除操作的链接。 |
| *Pause operations for suppressed problems* | 勾选此复选框以延迟操作开始时间至维护期结束。当操作开始时，维护期结束后，将执行所有操作，包括维护期间的事件操作。<br>注意此设置仅影响问题升级；恢复和update操作不受影响。<br>如果取消勾选此复选框，操作将在维护期内无延迟执行。<br>此选项不适用于*服务操作*。 |
| *Notify about canceled escalations* | 取消勾选此复选框以禁用关于取消升级的通知（当主机、监控项、触发器或动作被禁用时）。 |
所有必填输入字段均标有红色星号。
要配置新操作的详细信息，请点击操作块中的。要编辑现有操作，请点击操作旁边的。将弹出一个窗口，您可以在其中编辑操作步骤的详细信息。
#### Configuring an *SLA report* widget
Configure an *SLA report* widget that displays the SLA report for SLA "4" service "2" for the period of last 30 days.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "slareport",
"name": "SLA report",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 10,
"name": "slaid",
"value": 4
},
{
"type": 9,
"name": "serviceid",
"value": 2
},
{
"type": 1,
"name": "date_from",
"value": "now-30d"
},
{
"type": 1,
"name": "date_to",
"value": "now"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *SLA 报告* 小部件
配置一个*SLA报表*小部件，用于显示SLA ID为"4"、服务ID为"2"的SLA报表，时间范围为最近30天。
请求：
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "slareport",
"name": "SLA report",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 10,
"name": "slaid",
"value": 4
},
{
"type": 9,
"name": "serviceid",
"value": 2
},
{
"type": 1,
"name": "date_from",
"value": "now-30d"
},
{
"type": 1,
"name": "date_to",
"value": "now"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring an update operation
To configure an update operation go to the *Operations* tab in action
[configuration](/manual/config/notifications/action).
To configure details of a new update operation, click on
 in the Update
operations block. To edit an existing operation, click on
 next to the
operation. A popup window will open where you can edit the operation
step details.
#### 配置更新操作
要配置update操作，请前往动作的*操作*选项卡
[configuration](/manual/config/notifications/action).
要配置新update操作的详细信息，请点击
更新操作块中的。要编辑现有操作，请点击
操作旁边的。
将弹出一个窗口，您可以在其中编辑操作步骤的详细信息。
#### Configuring a *Plain text* widget
Configure a *Plain text* widget that displays latest data for items "42269" and "42253".
In addition, configure the item names to be located at the top of the data columns, and only 15 lines of data to be displayed.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "plaintext",
"name": "Plain text",
"x": 0,
"y": 0,
"width": 6,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemids",
"value": 42269
},
{
"type": 4,
"name": "itemids",
"value": 42253
},
{
"type": 0,
"name": "style",
"value": 1
},
{
"type": 0,
"name": "show_lines",
"value": 15
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *纯文本* 部件
配置一个*纯文本*部件，用于显示监控项 "42269"和"42253"的最新数据。
此外，配置监控项名称位于数据列的Top，并且仅显示15行数据。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "plaintext",
"name": "Plain text",
"x": 0,
"y": 0,
"width": 6,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemids",
"value": 42269
},
{
"type": 4,
"name": "itemids",
"value": 42253
},
{
"type": 0,
"name": "style",
"value": 1
},
{
"type": 0,
"name": "show_lines",
"value": 15
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Problem hosts* widget
Configure a *Problem hosts* widget that displays hosts from host groups "2" and "4"
that have problems with a name that includes the string "CPU" and that have the following severities: "Warning", "Average", "High", "Disaster".
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problemhosts",
"name": "Problem hosts",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 2
},
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "problem",
"value": "cpu"
},
{
"type": 0,
"name": "severities",
"value": 2
},
{
"type": 0,
"name": "severities",
"value": 3
},
{
"type": 0,
"name": "severities",
"value": 4
},
{
"type": 0,
"name": "severities",
"value": 5
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *问题主机* 部件
配置一个*问题主机*小部件，用于显示来自主机组"2"和"4"的主机
这些问题的名称包含string"CPU"且具有以下严重级别："Warning"、"Average"、"High"、"Disaster"
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problemhosts",
"name": "Problem hosts",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 2
},
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "problem",
"value": "cpu"
},
{
"type": 0,
"name": "severities",
"value": 2
},
{
"type": 0,
"name": "severities",
"value": 3
},
{
"type": 0,
"name": "severities",
"value": 4
},
{
"type": 0,
"name": "severities",
"value": 5
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Problems by severity* widget
Configure a *Problems by severity* widget that displays problem totals for all host groups.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problemsbysv",
"name": "Problems by severity",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "show_type",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *按严重程度分类的问题* 部件
配置一个*按严重程度显示问题*的小部件，用于展示所有主机组的问题总数。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problemsbysv",
"name": "Problems by severity",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "show_type",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Problems* widget
Configure a *Problems* widget that displays problems for host group "4" that satisfy the following conditions:
- Problems that have a tag with the name "scope" that contains values "performance" or "availability", or "capacity".
- Problems that have the following severities: "Warning", "Average", "High", "Disaster".
In addition, configure the widget to show tags and operational data.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"name": "Problems",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "tags.tag.0",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "performance"
},
{
"type": 1,
"name": "tags.tag.1",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.1",
"value": 0
},
{
"type": 1,
"name": "tags.value.1",
"value": "availability"
},
{
"type": 1,
"name": "tags.tag.2",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.2",
"value": 0
},
{
"type": 1,
"name": "tags.value.2",
"value": "capacity"
},
{
"type": 0,
"name": "severities",
"value": 2
},
{
"type": 0,
"name": "severities",
"value": 3
},
{
"type": 0,
"name": "severities",
"value": 4
},
{
"type": 0,
"name": "severities",
"value": 5
},
{
"type": 0,
"name": "show_tags",
"value": 1
},
{
"type": 0,
"name": "show_opdata",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *问题* 部件
配置一个显示主机组 "4"问题的问题部件，需满足以下条件：
- 问题需包含名为"scope"的标签，且标签值为"performance"、"availability"或"capacity"
- 问题需包含以下严重级别："Warning"、"Average"、"High"、"Disaster"
同时配置该部件以显示标签和操作数据。
请求：
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"name": "Problems",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "tags.tag.0",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "performance"
},
{
"type": 1,
"name": "tags.tag.1",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.1",
"value": 0
},
{
"type": 1,
"name": "tags.value.1",
"value": "availability"
},
{
"type": 1,
"name": "tags.tag.2",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.2",
"value": 0
},
{
"type": 1,
"name": "tags.value.2",
"value": "capacity"
},
{
"type": 0,
"name": "severities",
"value": 2
},
{
"type": 0,
"name": "severities",
"value": 3
},
{
"type": 0,
"name": "severities",
"value": 4
},
{
"type": 0,
"name": "severities",
"value": 5
},
{
"type": 0,
"name": "show_tags",
"value": 1
},
{
"type": 0,
"name": "show_opdata",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
### Configuring a recovery operation
To configure a recovery operation, go to the *Operations* tab in
[action](/manual/config/notifications/action) configuration.
To configure details of a new recovery operation, click on
 in the *Recovery
operations* block. To edit an existing operation, click on
 next to the
operation. A popup window will open where you can edit the operation
step details.
### 配置恢复操作
要配置恢复操作，请前往[action](/manual/config/notifications/action)配置中的*操作*选项卡。
要配置新恢复操作的详细信息，请在*恢复操作*区块中点击。要编辑现有操作，请点击操作旁边的。将弹出一个窗口，您可以在其中编辑操作步骤的详细信息。
#### Configuring a *Top hosts* widget
Configure a *Top hosts* widget that displays top hosts by CPU utilization in host group "4".
In addition, configure the following custom columns: "Host name", "Utilization", "1m avg", "5m avg", "15m avg", "Processes".
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "columns.name.0",
"value": ""
},
{
"type": 0,
"name": "columns.data.0",
"value": 2
},
{
"type": 1,
"name": "columns.base_color.0",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.0",
"value": ""
},
{
"type": 1,
"name": "columns.name.1",
"value": "Utilization"
},
{
"type": 0,
"name": "columns.data.1",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.1",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.timeshift.1",
"value": ""
},
{
"type": 1,
"name": "columns.item.1",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.display.1",
"value": 3
},
{
"type": 1,
"name": "columns.min.1",
"value": "0"
},
{
"type": 1,
"name": "columns.max.1",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.color.1.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.color.1.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.color.1.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.2",
"value": "90"
},
{
"type": 1,
"name": "columns.name.2",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.data.2",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.2",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.2",
"value": ""
},
{
"type": 1,
"name": "columns.item.2",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.name.3",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.data.3",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.3",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.3",
"value": ""
},
{
"type": 1,
"name": "columns.item.3",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.name.4",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.data.4",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.4",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.4",
"value": ""
},
{
"type": 1,
"name": "columns.item.4",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.name.5",
"value": "Processes"
},
{
"type": 0,
"name": "columns.data.5",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.5",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.5",
"value": ""
},
{
"type": 1,
"name": "columns.item.5",
"value": "Number of processes"
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *Top 主机* 部件
配置一个显示Top 主机按CPU利用率排序的*Top 主机*部件，在主机组 "4"中展示。
同时配置以下自定义列："主机名"、"Utilization"、"1m avg"、"5m avg"、"15m avg"、"Processes"。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "columns.name.0",
"value": ""
},
{
"type": 0,
"name": "columns.data.0",
"value": 2
},
{
"type": 1,
"name": "columns.base_color.0",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.0",
"value": ""
},
{
"type": 1,
"name": "columns.name.1",
"value": "Utilization"
},
{
"type": 0,
"name": "columns.data.1",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.1",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.timeshift.1",
"value": ""
},
{
"type": 1,
"name": "columns.item.1",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.display.1",
"value": 3
},
{
"type": 1,
"name": "columns.min.1",
"value": "0"
},
{
"type": 1,
"name": "columns.max.1",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.color.1.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.color.1.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.color.1.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.2",
"value": "90"
},
{
"type": 1,
"name": "columns.name.2",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.data.2",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.2",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.2",
"value": ""
},
{
"type": 1,
"name": "columns.item.2",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.name.3",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.data.3",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.3",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.3",
"value": ""
},
{
"type": 1,
"name": "columns.item.3",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.name.4",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.data.4",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.4",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.4",
"value": ""
},
{
"type": 1,
"name": "columns.item.4",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.name.5",
"value": "Processes"
},
{
"type": 0,
"name": "columns.data.5",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.5",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.5",
"value": ""
},
{
"type": 1,
"name": "columns.item.5",
"value": "Number of processes"
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *Trigger overview* widget
Configure a *Trigger overview* widget that displays trigger states for all host groups that have triggers with a tag that has the name "scope" and contains value "availability".
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "trigover",
"name": "Trigger overview",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "tags.tag.0",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "availability"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *Trigger overview* 部件
配置一个*触发器概览*部件，用于显示所有主机组中触发器状态，这些触发器需满足：具有名为"scope"的标签且包含值"availability"。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "trigover",
"name": "Trigger overview",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "tags.tag.0",
"value": "scope"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 0
},
{
"type": 1,
"name": "tags.value.0",
"value": "availability"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a *URL* widget
Configure a *URL* widget that displays the home page of Zabbix manual.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "url",
"name": "URL",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "url",
"value": "https://www.zabbix.com/documentation/6.0/en"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置*URL*部件
配置一个显示Zabbix手册首页的*URL*部件。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "url",
"name": "URL",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "url",
"value": "https://www.zabbix.com/documentation/6.0/en"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring authentication
The **Authentication** tab allows you to configure scenario
authentication options. A green dot next to the tab name indicates that
some type of HTTP authentication is enabled.
Authentication parameters:
|Parameter|Description|
|--|--------|
|*Authentication*|Authentication options.<br>**None** - no authentication used.<br>**Basic** - basic authentication is used.<br>**NTLM** - NTLM ([Windows NT LAN Manager)](http://en.wikipedia.org/wiki/NTLM) authentication is used.<br>**Kerberos** - Kerberos authentication is used. See also: [Configuring Kerberos with Zabbix](/manual/appendix/items/kerberos).<br>**Digest** - Digest authentication is used.<br>Selecting an authentication method will provide two additional fields for entering a user name and password.<br>User macros can be used in user and password fields.|
|*SSL verify peer*|Mark the checkbox to verify the SSL certificate of the web server.<br>The server certificate will be automatically taken from system-wide certificate authority (CA) location. You can override the location of CA files using Zabbix server or proxy configuration parameter [SSLCALocation](/manual/appendix/config/zabbix_server).<br>This sets the [CURLOPT\_SSL\_VERIFYPEER](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html) cURL option.|
|*SSL verify host*|Mark the checkbox to verify that the *Common Name* field or the *Subject Alternate Name* field of the web server certificate matches.<br>This sets the [CURLOPT\_SSL\_VERIFYHOST](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html) cURL option.|
|*SSL certificate file*|Name of the SSL certificate file used for client authentication. The certificate file must be in PEM^1^ format. If the certificate file contains also the private key, leave the *SSL key file* field empty. If the key is encrypted, specify the password in *SSL key password* field. The directory containing this file is specified by Zabbix server or proxy configuration parameter [SSLCertLocation](/manual/appendix/config/zabbix_server).<br>`HOST.*` macros and user macros can be used in this field.<br>This sets the [CURLOPT\_SSLCERT](http://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT.html) cURL option.|
|*SSL key file*|Name of the SSL private key file used for client authentication. The private key file must be in PEM^1^ format. The directory containing this file is specified by Zabbix server or proxy configuration parameter [SSLKeyLocation](/manual/appendix/config/zabbix_server).<br>`HOST.*` macros and user macros can be used in this field.<br>This sets the [CURLOPT\_SSLKEY](http://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY.html) cURL option.|
|*SSL key password*|SSL private key file password.<br>User macros can be used in this field.<br>This sets the [CURLOPT\_KEYPASSWD](http://curl.haxx.se/libcurl/c/CURLOPT_KEYPASSWD.html) cURL option.|
::: noteimportant
\[1\] Zabbix supports certificate and private key
files in PEM format only. In case you have your certificate and private
key data in PKCS \#12 format file (usually with extension \*.p12 or
\*.pfx) you may generate the PEM file from it using the following
commands:
openssl pkcs12 -in ssl-cert.p12 -clcerts -nokeys -out ssl-cert.pem
openssl pkcs12 -in ssl-cert.p12 -nocerts -nodes -out ssl-cert.key
:::
::: noteclassic
Zabbix server picks up changes in certificates without a
restart.
:::
::: noteclassic
If you have client certificate and private key in a single
file just specify it in a "SSL certificate file" field and leave "SSL
key file" field empty. The certificate and key must still be in PEM
format. Combining certificate and key is easy:
cat client.crt client.key > client.pem
:::
#### 配置认证
**认证**选项卡允许您配置场景认证选项。选项卡名称旁的绿色圆点表示已启用某种HTTP认证类型。
认证参数：
| 参数 | 描述 |
|--|--------|
| *Authentication* | 认证选项。<br>**无** - 不使用认证。<br>**基本** - 使用基本认证。<br>**NTLM** - 使用NTLM([Windows NT LAN Manager)](http://en.wikipedia.org/wiki/NTLM)认证。<br>**Kerberos** - 使用Kerberos认证。另见：[Configuring Kerberos with Zabbix](/manual/appendix/items/kerberos).<br>**摘要** - 使用摘要认证。<br>选择认证方法将提供两个额外字段用于输入用户名和密码。<br>用户宏可用于用户和密码字段。 |
| *SSL verify peer* | 勾选复选框以验证Web服务器的SSL证书。<br>服务器证书将自动从系统级证书颁发机构(CA)位置获取。您可以使用Zabbix server或proxy配置参数[SSLCALocation](/manual/appendix/config/zabbix_server)覆盖CA文件的位置。<br>这将设置[CURLOPT\_SSL\_VERIFYPEER](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html) cURL选项。 |
| *SSL verify host* | 勾选复选框以验证Web服务器证书的*通用名字段*或*主题备用名字段*是否匹配。<br>这将设置[CURLOPT\_SSL\_VERIFYHOST](http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html) cURL选项。 |
| *SSL certificate file* | 用于客户端认证的SSL证书file名称。证书file必须为PEM^1^格式。如果证书file包含私钥，则留空*SSL密钥file*字段。如果密钥已加密，请在*SSL密钥密码*字段指定密码。包含此file的目录由Zabbix server或proxy配置参数[SSLCertLocation](/manual/appendix/config/zabbix_server)指定。<br>`HOST.*`宏和用户宏可用于此字段。<br>这将设置[CURLOPT\_SSLCERT](http://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT.html) cURL选项。 |
| *SSL key file* | 用于客户端认证的SSL私钥file名称。私钥file必须为PEM^1^格式。包含此file的目录由Zabbix server或proxy配置参数[SSLKeyLocation](/manual/appendix/config/zabbix_server)指定。<br>`HOST.*`宏和用户宏可用于此字段。<br>这将设置[CURLOPT\_SSLKEY](http://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY.html) cURL选项。 |
| *SSL key password* | SSL私钥file密码。<br>用户宏可用于此字段。<br>这将设置[CURLOPT\_KEYPASSWD](http://curl.haxx.se/libcurl/c/CURLOPT_KEYPASSWD.html) cURL选项。 |
::: noteimportant
\[1\] Zabbix仅支持PEM格式的证书和私钥文件。如果您拥有PKCS \#12格式file的证书和私钥数据(通常扩展名为\*.p12或\*.pfx)，您可以使用以下命令generate PEMfile：
openssl pkcs12 -in ssl-cert.p12 -clcerts -nokeys -out ssl-cert.pem
openssl pkcs12 -in ssl-cert.p12 -nocerts -nodes -out ssl-cert.key
:::
::: noteclassic
Zabbix server无需重启即可获取证书变更。
:::
::: noteclassic
如果您在单个file中拥有客户端证书和私钥，只需在"SSL证书file"字段中指定它，并留空"SSL密钥file"字段。证书和密钥仍必须为PEM格式。合并证书和密钥很简单：
cat client.crt client.key > client.pem
:::
#### Configuring a *Web monitoring* widget
Configure a *Web monitoring* widget that displays a status summary of the active web monitoring scenarios for host group "4".
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "web",
"name": "Web monitoring",
"x": 0,
"y": 0,
"width": 6,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### 配置 *Web 监控* 小组件
配置一个*Web监测*小部件，用于显示主机组 "4"的活动Web监测场景状态摘要。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "web",
"name": "Web monitoring",
"x": 0,
"y": 0,
"width": 6,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
#### Configuring a web scenario
To configure a web scenario:
- Go to: *Configuration → Hosts* (or *Templates*)
- Click on *Web* in the row of the host/template
- Click on *Create web scenario* to the right (or on the scenario name to
edit an existing scenario)
- Enter parameters of the scenario in the form
The **Scenario** tab allows you to configure the general parameters of a
web scenario.
All mandatory input fields are marked with a red asterisk.
Scenario parameters:
|Parameter|Description|
|--|--------|
|*Name*|Unique scenario name.<br>[User macros](/manual/config/macros/user_macros) are supported. *Note* that if user macros are used, these macros will be left unresolved in [web monitoring item](/manual/web_monitoring/items) names.|
|*Update interval*|How often the scenario will be executed.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 30s, 1m, 2h, 1d.<br>[User macros](/manual/config/macros/user_macros) are supported. *Note* that if a user macro is used and its value is changed (e.g. 5m → 30s), the next check will be executed according to the previous value (farther in the future with the example values).|
|*Attempts*|The number of attempts for executing web scenario steps. In case of network problems (timeout, no connectivity, etc) Zabbix can repeat executing a step several times. The figure set will equally affect each step of the scenario. Up to 10 attempts can be specified, default value is 1.<br>*Note*: Zabbix will not repeat a step because of a wrong response code or the mismatch of a required string.|
|*Agent*|Select a client agent.<br>Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.<br>User macros can be used in this field.|
|*HTTP proxy*|You can specify an HTTP proxy to use, using the format `[protocol://][username[:password]@]proxy.example.com[:port]`.<br>This sets the [CURLOPT\_PROXY](https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html) cURL option.<br>The optional `protocol://` prefix may be used to specify alternative proxy protocols (the protocol prefix support was added in cURL 7.21.7). With no protocol specified, the proxy will be treated as an HTTP proxy.<br>By default, 1080 port will be used.<br>If specified, the proxy will overwrite proxy related environment variables like http\_proxy, HTTPS\_PROXY. If not specified, the proxy will not overwrite proxy-related environment variables. The entered value is passed on "as is", no sanity checking takes place.<br>You may also enter a SOCKS proxy address. If you specify the wrong protocol, the connection will fail and the item will become unsupported.<br>*Note* that only simple authentication is supported with HTTP proxy.<br>User macros can be used in this field.|
|*Variables*|Variables that may be used in scenario steps (URL, post variables).<br>They have the following format:<br>**{macro1}**=value1<br>**{macro2}**=value2<br>**{macro3}**=regex:<regular expression><br>For example:<br>{username}=Alexei<br>{password}=kj3h5kJ34bd<br>{hostid}=regex:hostid is (\[0-9\]+)<br>The macros can then be referenced in the steps as {username}, {password} and {hostid}. Zabbix will automatically replace them with actual values. Note that variables with `regex:` need one step to get the value of the regular expression so the extracted value can only be applied to the step after.<br>If the value part starts with `regex:` then the part after it is treated as a regular expression that searches the web page and, if found, stores the match in the variable. At least one subgroup must be present so that the matched value can be extracted.<br>User macros and {HOST.\*} [macros](/manual/appendix/macros/supported_by_location) are supported.<br>Variables are automatically URL-encoded when used in query fields or form data for post variables, but must be URL-encoded manually when used in raw post or directly in URL.|
|*Headers*|HTTP Headers are used when performing a request. Default and custom headers can be used.<br>Headers will be assigned using default settings depending on the Agent type selected from a drop-down list on a scenario level, and will be applied to all the steps, unless they are custom defined on a step level.<br>**It should be noted that defining the header on a step level automatically discards all the previously defined headers, except for a default header that is assigned by selecting the 'User-Agent' from a drop-down list on a scenario level.**<br>However, even the 'User-Agent' default header can be overridden by specifying it on a step level.<br>To unset the header on a scenario level, the header should be named and attributed with no value on a step level.<br>Headers should be listed using the same syntax as they would appear in the HTTP protocol, optionally using some additional features supported by the [CURLOPT\_HTTPHEADER](http://curl.haxx.se/libcurl/c/CURLOPT_HTTPHEADER.html) cURL option.<br>For example:<br>Accept-Charset=utf-8<br>Accept-Language=en-US<br>Content-Type=application/xml; charset=utf-8<br>User macros and {HOST.\*} [macros](/manual/appendix/macros/supported_by_location) are supported.|
|*Enabled*|The scenario is active if this box is checked, otherwise - disabled.|
Note that when editing an existing scenario, two extra buttons are
available in the form:
| | |
|--|--------|
||Create another scenario based on the properties of the existing one.|
||Delete history and trend data for the scenario. This will make the server perform the scenario immediately after deleting the data.|
::: notetip
If *HTTP proxy* field is left empty, another way for
using an HTTP proxy is to set proxy related environment variables.
For HTTP checks - set the **http\_proxy** environment variable for the
Zabbix server user. For example,
`http_proxy=http://proxy_ip:proxy_port`.
For HTTPS checks - set the **HTTPS\_PROXY** environment variable. For
example, `HTTPS_PROXY=http://proxy_ip:proxy_port`. More details are
available by running a shell command: *\# man curl*.
:::
The **Steps** tab allows you to configure the web scenario steps. To add
a web scenario step, click on *Add* in the *Steps* block.
{width="600"}
::: noteclassic
Secret [user
macros](/manual/config/macros/user_macros#configuration) must not be
used in URLs as they will resolve to "\*\*\*\*\*\*".
:::
#### 配置Web场景
要配置一个Web场景:
- 前往：*配置 → 主机*（或 *模板*）
- 在 主机/template 行中点击 *Web*
- 点击右侧的*创建Web场景*（或点击场景名称以
编辑现有场景)
- 在表单中输入场景的参数
**Scenario**（场景）选项卡允许您配置一个
Web场景
所有必填字段均以红色星号标记。
场景参数:
| 参数 | 描述 |
|--|--------|
| *Name* | 唯一场景名称。<br>支持[User macros](/manual/config/macros/user_macros)。*注意*：如果使用了用户宏，这些宏在[web monitoring item](/manual/web_monitoring/items)名称中将保持未解析状态。 |
| *Update interval* | 场景执行的频率。<br>支持[Time suffixes](/manual/appendix/suffixes)，例如30s、1m、2h、1d。<br>支持[User macros](/manual/config/macros/user_macros)。*注意*：如果使用了用户宏且其值被更改（例如5m→30s），下一次检查将根据之前的值执行（以示例值为例会更晚执行）。 |
| *Attempts* | 执行Web场景步骤的尝试次数。当出现网络问题（超时、无法连接等）时，Zabbix可多次重试执行步骤。该数值将同等作用于场景的每个步骤。最多可指定10次尝试，默认值为1。<br>*注意*：Zabbix不会因响应码错误或不符合要求的string而重复执行步骤。 |
| *Agent* | 选择客户端 agent.<br>Zabbix将模拟所选浏览器行为. 当网站针对不同浏览器返回不同内容时, 此功能非常有用.<br>此字段支持使用用户宏. |
| *HTTP proxy* | 您可以使用`[protocol://][username[:password]@]proxy.example.com[:port]`格式指定要使用的HTTP proxy.<br>这将设置[CURLOPT\_PROXY](https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html) cURL选项.<br>可选前缀`protocol://`可用于指定替代proxy协议(协议前缀支持在cURL 7.21.7版本中添加). 若未指定协议, proxy将被视为HTTP proxy.<br>默认情况下将使用1080端口.<br>如果指定, proxy将覆盖http\_proxy, HTTPS\_PROXY等proxy相关环境变量. 若未指定, proxy将不会覆盖proxy相关环境变量. 输入的值将"原样"传递, 不进行完整性检查.<br>您也可以输入SOCKS proxy地址. 如果指定了错误的协议, 连接将失败且监控项将变为不支持状态.<br>*注意*: HTTP proxy仅支持简单认证.<br>此字段中可使用用户宏. |
| *Variables* | 可在场景步骤中使用的变量（URL、post变量）.<br>其格式如下:<br>**{macro1}**=value1<br>**{macro2}**=value2<br>**{macro3}**=regex:<正则表达式><br>例如:<br>{username}=Alexei<br>{password}=kj3h5kJ34bd<br>{hostid}=regex:hostid is (\[0-9\]+)<br>随后可在步骤中通过{username}、{password}和{hostid}引用这些宏.Zabbix会自动将其替换为实际值.注意带有`regex:`的变量需要一个步骤来get正则表达式的值,因此提取的值只能应用于后续步骤.<br>若值部分以`regex:`开头,则其后内容将被视为在网页中搜索的正则表达式,若匹配成功则将匹配结果存入变量.必须至少包含一个子组以便提取匹配值.<br>支持用户宏和{主机.\*} [macros](/manual/appendix/macros/supported_by_location).<br>当在query字段或post变量的表单数据中使用时,变量会自动进行URL编码,但在原始post或直接用于URL时必须手动进行URL编码. |
| *Headers* | HTTP头部用于执行请求时使用，可配置默认及自定义头部。<br>根据场景层级下拉菜单选择的Agent类型，头部将按默认设置分配并应用于所有步骤，除非在步骤层级进行了自定义定义。<br>**需注意：在步骤层级定义头部将自动丢弃所有先前定义的头部（通过场景层级下拉菜单选择'User-Agent'分配的默认头部除外）。**<br>但即使'User-Agent'默认头部也可通过在步骤层级指定来覆盖。<br>若需取消场景层级的头部设置，应在步骤层级将该头部名称赋空值。<br>头部列表需采用与HTTP协议相同的语法格式，可选支持[CURLOPT\_HTTPHEADER](http://curl.haxx.se/libcurl/c/CURLOPT_HTTPHEADER.html) cURL选项的附加特性。<br>例如：<br>Accept-Charset=utf-8<br>Accept-Language=en-US<br>Content-Type=application/xml; charset=utf-8<br>支持用户宏和{主机.\*} [macros](/manual/appendix/macros/supported_by_location)。 |
| *Enabled* | 勾选此框表示场景处于激活状态，否则为禁用状态。 |
请注意，在编辑现有场景时，会出现两个额外的按钮
以以下形式提供：
| | |
|--|--------|
|  | 基于现有场景的属性创建另一个场景。 |
|  | 删除场景的历史数据和趋势数据。这将使服务器在删除数据后立即执行该场景。 |
::: notetip
如果 *HTTP proxy* 字段留空，另一种方式用于
使用HTTP proxy的目的是设置与proxy相关的环境变量。
对于HTTP检查 - 设置**http\_proxy**环境变量
Zabbix server 用户。例如，
`http_proxy=http://proxy_ip:proxy_port`.
对于HTTPS检查 - 设置**HTTPS\_PROXY**环境变量。对于
示例，`HTTPS_PROXY=http://proxy_ip:proxy_port`。更多详情请见
可通过运行shell命令获取：*\# man curl*。
:::
**步骤**选项卡允许您配置Web场景的步骤。要添加
一个Web场景步骤，在*Steps*区块中点击*Add*。
{width="600"}
::: noteclassic
密钥 [配置](/manual/config/macros/user_macros#配置) 不得
在URL中使用时，它们将被解析为"\*\*\*\*\*\*"。
:::
#### Configuring custom graphs
To create a custom graph, do the following:
- Go to *Configuration → Hosts (or Templates)*
- Click on *Graphs* in the row next to the desired host or template
- In the Graphs screen click on *Create graph*
- Edit graph attributes
{width="600"}
All mandatory input fields are marked with a red asterisk.
Graph attributes:
|Parameter|<|Description|
|-|----------|----------------------------------------|
|*Name*|<|Unique graph name.<br>Expression [macros](/manual/appendix/macros/supported_by_location) are supported in this field, but only with `avg`, `last`, `min` and `max` functions, with time as parameter (for example, `{?avg(/host/key,1h)}`).<br>{HOST.HOST<1-9>} macros are supported for the use within this macro, referencing the first, second, third, etc. host in the graph, for example `{?avg(/{HOST.HOST2}/key,1h)}`. Note that referencing the first host with this macro is redundant, as the first host can be referenced implicitly, for example `{?avg(//key,1h)}`.|
|*Width*|<|Graph width in pixels (for preview and pie/exploded graphs only).|
|*Height*|<|Graph height in pixels.|
|*Graph type*|<|Graph type:<br>**Normal** - normal graph, values displayed as lines<br>**Stacked** - stacked graph, filled areas displayed<br>**Pie** - pie graph<br>**Exploded** - "exploded" pie graph, portions displayed as "cut out" of the pie|
|*Show legend*|<|Checking this box will set to display the graph legend.|
|*Show working time*|<|If selected, non-working hours will be shown with a gray background. This parameter is not available for pie and exploded pie graphs.|
|*Show triggers*|<|If selected, simple triggers will be displayed as lines with black dashes over trigger severity color. This parameter is not available for pie and exploded pie graphs.|
|*Percentile line (left)*|<|Display percentile for left Y-axis. If, for example, 95% percentile is set, then the percentile line will be at the level where 95 percent of the values fall under. Displayed as a bright green line. Only available for normal graphs.|
|*Percentile line (right)*|<|Display percentile for right Y-axis. If, for example, 95% percentile is set, then the percentile line will be at the level where 95 percent of the values fall under. Displayed as a bright red line. Only available for normal graphs.|
|*Y axis MIN value*|<|Minimum value of Y-axis:<br>**Calculated** - Y axis minimum value will be automatically calculated.<br>**Fixed** - fixed minimum value for Y-axis. <br>**Item** - last value of the selected item will be the minimum value.<br><br> This parameter is not available for pie and exploded pie graphs.|
|*Y axis MAX value*|<|Maximum value of Y-axis:<br>**Calculated** - Y axis maximum value will be automatically calculated.<br>**Fixed** - fixed maximum value for Y-axis. <br>**Item** - last value of the selected item will be the maximum value<br><br> This parameter is not available for pie and exploded pie graphs.|
|*3D view*|<|Enable 3D style. For pie and exploded pie graphs only.|
|*Items*|<|Items, data of which are to be displayed in this graph. Click on *Add* to select items. You can also select various displaying options (function, draw style, left/right axis display, color).|
|<|*Sort order (0→100)*|Draw order. 0 will be processed first. Can be used to draw lines or regions behind (or in front of) another.<br>You can drag and drop items using the icon at the beginning of a line to set the sort order or which item is displayed in front of the other.|
|^|*Name*|Name of the selected item is displayed as a link. Clicking on the link opens the list of other available items.|
|^|*Type*|Type (only available for pie and exploded pie graphs):<br>**Simple** - the value of the item is represented proportionally on the pie<br>**Graph sum** - the value of the item represents the whole pie<br>Note that coloring of the "graph sum" item will only be visible to the extent that it is not taken up by "proportional" items.|
|^|*Function*|Select what values will be displayed when more than one value exists per vertical graph pixel for an item:<br>**all** - display all possible values (minimum, maximum, average) in the graph. Note that for shorter periods this setting has no effect; only for longer periods, when data congestion in a vertical graph pixel increases, 'all' starts displaying minimum, maximum, and average values. This function is only available for *Normal* graph type. See also: Generating graphs [from history/trends](/manual/config/visualization/graphs/simple#generating_from_historytrends).<br>**avg** - display the average values<br>**last** - display the latest values. This function is only available if either *Pie/Exploded pie* is selected as graph type.<br>**max** - display the maximum values<br>**min** - display the minimum values|
|^|*Draw style*|Select the draw style (only available for normal graphs; for stacked graphs filled region is always used) to apply to the item data - *Line*, *Bold line*, *Filled region*, *Dot*, *Dashed line*, *Gradient line*.|
|^|*Y axis side*|Select the Y axis side to show the item data - *Left*, *Right*.|
|^|*Color*|Select the color to apply to the item data.|
#### 配置自定义图表
要create自定义图表，请执行以下操作：
- 前往*配置 → 主机（或模板）*
- 在所需主机或模板所在行点击*图表*
- 在图表界面点击*创建图表*
- 编辑图表属性
{width="600"}
所有必填字段均以红色星号标记。
图表属性：
| 参数 | < | 描述 |
|-|----------|----------------------------------------|
| *Name* | < | 唯一图表名称。<br>本字段支持[macros](/manual/appendix/macros/supported_by_location)表达式，但仅限`avg`、`last`、`min`和`max`函数，且参数为时间（例如`{?avg(/host/key,1h)}`）。<br>支持{主机.主机<1-9>}宏，用于引用图表中第一、第二、第三等主机，例如`{?avg(/{HOST.HOST2}/key,1h)}`。注意通过此宏引用第一个主机是冗余的，因为第一个主机可隐式引用，例如`{?avg(//key,1h)}`。 |
| *Width* | < | 图表宽度（像素，仅适用于预览及饼图/爆炸饼图）。 |
| *Height* | < | 图表高度（像素）。 |
| *Graph type* | < | 图表类型：<br>**普通** - 常规图表，数值显示为线条<br>**堆叠** - 堆叠图表，显示填充区域<br>**饼图** - 饼状图<br>**爆炸饼图** - "爆炸"式饼图，部分显示为从饼图中"切出" |
| *Show legend* | < | 勾选此框将显示图表图例。 |
| *Show working time* | < | 若选中，非工作时间将显示为灰色背景。此参数不适用于饼图和爆炸饼图。 |
| *Show triggers* | < | 若选中，简单触发器将显示为黑色虚线覆盖在触发器严重性颜色上。此参数不适用于饼图和爆炸饼图。 |
| *Percentile line (left)* | < | 显示左侧Y轴百分位。例如若设置为95%，则百分位线将位于95%数值所处的水平位置，显示为亮绿色线。仅适用于普通图表。 |
| *Percentile line (right)* | < | 显示右侧Y轴百分位。例如若设置为95%，则百分位线将位于95%数值所处的水平位置，显示为亮红色线。仅适用于普通图表。 |
| *Y axis MIN value* | < | Y轴最小值：<br>**计算** - Y轴最小值将自动计算<br>**固定** - Y轴固定最小值<br>**监控项** - 所选监控项的最后一个值作为最小值<br><br>此参数不适用于饼图和爆炸饼图。 |
| *Y axis MAX value* | < | Y轴最大值：<br>**计算** - Y轴最大值将自动计算<br>**固定** - Y轴固定最大值<br>**监控项** - 所选监控项的最后一个值作为最大值<br><br>此参数不适用于饼图和爆炸饼图。 |
| *3D view* | < | 启用3D样式。仅适用于饼图和爆炸饼图。 |
| *Items* | < | 监控项，其数据将显示在此图表中。点击*添加*选择监控项。还可选择多种显示选项（函数、绘制样式、左/右轴显示、颜色）。 |
| < | *排序顺序(0→100)* | 绘制顺序。0将优先处理。可用于将线条或区域绘制在另一对象后方（或前方）。<br>可通过行首图标拖拽监控项来设置排序顺序或决定哪个监控项显示在前。 |
| ^ | *名称* | 所选监控项名称显示为链接。点击链接可打开其他可用监控项列表。 |
| ^ | *类型* | 类型（仅适用于饼图和爆炸饼图）：<br>**简单** - 监控项值按比例显示在饼图中<br>**图表总和** - 监控项值代表整个饼图<br>注意"图表总和"监控项的着色仅在未被"比例"监控项占据的部分可见。 |
| ^ | *函数* | 选择当监控项每个垂直图表像素存在多个值时显示的数值：<br>**all** - 显示图表中所有可能值（最小值、最大值、平均值）。注意对于较短周期此设置无效；仅当垂直图表像素数据密度增加时，'all'开始显示最小、最大和平均值。此功能仅适用于*普通*图表类型。另见：生成图表[基于历史数据趋势数据生成](/manual/config/visualization/graphs/simple#基于历史数据趋势数据生成)。<br>**avg** - 显示平均值<br>**last** - 显示最新值。此功能仅在选择*饼图/爆炸饼图*作为图表类型时可用。<br>**max** - 显示最大值<br>**min** - 显示最小值 |
| ^ | *绘制样式* | 选择应用于监控项数据的绘制样式（仅适用于普通图表；堆叠图表始终使用填充区域）- *线条*、*粗线*、*填充区域*、*点*、*虚线*、*渐变线*。 |
| ^ | *Y轴侧* | 选择显示监控项数据的Y轴侧 - *左侧*、*右侧*。 |
| ^ | *颜色* | 选择应用于监控项数据的颜色。 |
#### Configuring JMX interfaces and items in Zabbix frontend
With Java gateway running, server knowing where to find it and a Java
application started with support for remote JMX monitoring, it is time
to configure the interfaces and items in Zabbix GUI.
#### 在 Zabbix 前端配置 JMX 接口和 监控项
在Java网关运行、服务器知道其位置以及启动了支持远程JMX监控的Java应用程序后，现在该在Zabbix GUI中配置接口和监控项了。
#### Configuring low-level discovery rules
See the [low-level discovery](/manual/discovery/low_level_discovery)
section of the manual.
#### 配置低级发现规则
参见手册中的[low-level discovery](/manual/discovery/low_level_discovery)
部分。
### Configuring low-level discovery
We will illustrate low-level discovery based on an example of file
system discovery.
To configure the discovery, do the following:
- Go to: *Configuration* → *Templates* or *Hosts*
- Click on *Discovery* in the row of an appropriate template/host
{width="600"}
- Click on *Create discovery rule* in the upper right corner of the
screen
- Fill in the discovery rule form with the required details
### 配置低级发现
我们将通过file系统发现的示例来说明低级发现机制.
配置发现规则需执行以下步骤:
- 前往: *Configuration* → *模板* 或 *主机*
- 在相应模板/主机的行中点击*Discovery*
{width="600"}
- 点击屏幕右上角的*Create discovery rule*
- 在发现规则表单中填写必要信息
#### Configuring nested templates
To link templates, you need to take an existing template or a new one, and then:
- Open the [template configuration form](/manual/config/templates/template#creating-a-template)
- Find the *Templates* field
- Click *Select* to open the *Templates* popup window
- In the popup window, choose required templates, then click *Select* to add the templates to the list
- Click *Add* or *Update* in the template configuration form
Thus, all entities of the parent template, as well as all entities
of linked templates (such as items, triggers, graphs, etc.) will now appear
in the template configuration, except for linked template
dashboards, which will, nevertheless, be inherited by hosts.
To unlink any of the linked templates, in the same form use the *Unlink*
or *Unlink and clear* buttons and click *Update*.
Choosing the *Unlink* option will simply remove the association with the
linked template, while not removing all its entities (items, triggers, graphs, etc.).
Choosing the *Unlink and clear* option will remove both the association
with the linked template and all its entities (items, triggers, graphs, etc.).
#### 配置嵌套模板
要链接模板，您需要选择一个现有模板或新模板，然后：
- 打开[创建模板](/manual/config/templates/template#创建模板)
- 找到*模板*字段
- 点击*Select*打开*模板*弹出窗口
- 在弹出窗口中，选择所需的模板，然后点击*Select*将模板添加到列表中
- 在模板配置表单中点击*Add*或*Update*
这样，父模板的所有实体以及链接模板的所有实体（如监控项、触发器、图形等）现在都会出现在模板配置中，但链接模板的仪表板除外，它们仍会被主机继承。
要取消链接任何已链接的模板，在同一表单中使用*Unlink*或*Unlink and clear*按钮，然后点击*Update*。
选择*Unlink*选项将仅移除与链接模板的关联，而不会移除其所有实体（监控项、触发器、图形等）。
选择*Unlink and clear*选项将同时移除与链接模板的关联及其所有实体（监控项、触发器、图形等）。
##### Configuring Perl trap receiver
Requirements: Perl, Net-SNMP compiled with --enable-embedded-perl (done
by default since Net-SNMP 5.4)
A Perl trap receiver (look for misc/snmptrap/zabbix\_trap\_receiver.pl)
can be used to pass traps to Zabbix server directly from snmptrapd. To
configure it:
- add the Perl script to the snmptrapd configuration file
(snmptrapd.conf), e.g.:
```perl
perl do "[FULL PATH TO PERL RECEIVER SCRIPT]";
```
- configure the receiver, e.g:
```ini
$SNMPTrapperFile = '[TRAP FILE]';
$DateTimeFormat = '[DATE TIME FORMAT]';
```
::: notetip
If the script name is not quoted, snmptrapd will refuse to
start up with messages, similar to these:<br><br>
```yaml
Regexp modifiers "/l" and "/a" are mutually exclusive at (eval 2) line 1, at end of line
Regexp modifier "/l" may not appear twice at (eval 2) line 1, at end of line
```
:::
##### 配置 Perl trap 接收器
需求: Perl, 已编译启用--enable-embedded-perl的Net-SNMP (自Net-SNMP 5.4起默认启用)
可通过Perl trap接收器(参考misc/snmptrap/zabbix\_trap\_receiver.pl)将陷阱直接从snmptrapd传递给Zabbix server。配置步骤如下:
- 将Perl脚本添加至snmptrapd的file配置项
(snmptrapd.conf), e.g.:
```perl
perl do "[FULL PATH TO PERL RECEIVER SCRIPT]";
```
- 配置接收器，例如:
```ini
$SNMPTrapperFile = '[TRAP FILE]';
$DateTimeFormat = '[DATE TIME FORMAT]';
```
::: notetip
若脚本名称未加引号，snmptrapd将拒绝启动并显示类似以下信息:<br><br>
```yaml
Regexp modifiers "/l" and "/a" are mutually exclusive at (eval 2) line 1, at end of line
Regexp modifier "/l" may not appear twice at (eval 2) line 1, at end of line
```
:::
### Configuring plugins
This section provides common plugin configuration principles and best
practices.
All plugins are configured using *Plugins.\** parameter, which can
either be part of the Zabbix agent 2 [configuration
file](/manual/appendix/config/zabbix_agent2) or a plugin's own
[configuration file](/manual/appendix/config/zabbix_agent2_plugins). If
a plugin uses a separate configuration file, path to this file should be
specified in the Include parameter of Zabbix agent 2 configuration file.
A typical plugin parameter has the following structure:
*Plugins.<PluginName>.<Parameter>=<Value>*
Additionally, there are two specific groups of parameters:
- *Plugins.<PluginName>.Default.<Parameter>=<Value>* used for defining [default parameter values](#default-values).
- *Plugins.<PluginName>.<SessionName>.<Parameter>=<Value>* used for defining separate sets of parameters for different monitoring targets via [named sessions](#named-sessions).
All parameter names should adhere to the following requirements:
- it is recommended to capitalize the names of your plugins;
- the parameter should be capitalized;
- special characters are not allowed;
- nesting isn't limited by a maximum level;
- the number of parameters is not limited.
### 配置插件
本节提供插件配置的通用原则与最佳实践。
所有插件均通过*Plugins.\**参数进行配置，该参数可以是Zabbix agent 2 [configuration
file](/manual/appendix/config/zabbix_agent2)的组成部分，也可属于插件自身的[configuration file](/manual/appendix/config/zabbix_agent2_plugins)。若插件使用独立的配置file，则应在Zabbix agent 2配置file的Include参数中指定该file路径。
典型插件参数结构如下：
*Plugins.<PluginName>.<Parameter>=<Value>*
此外存在两类特殊参数组：
- *Plugins.<PluginName>.Default.<Parameter>=<Value>* 用于定义[默认参数值](#default-values)
- *Plugins.<PluginName>.<SessionName>.<Parameter>=<Value>* 用于通过[命名会话](#named-sessions)为不同监控目标定义独立参数集
所有参数命名需符合以下要求：
- 建议插件名称采用首字母大写；
- 参数名称应大写；
- 禁止使用特殊字符；
- 嵌套层级不受限制；
- 参数数量无限制。
#### Configuring PSK for server - active proxy communication (example)
On the proxy, write the PSK value into a file, for example,
`/home/zabbix/zabbix_proxy.psk`. The file must contain PSK in the first
text string, for example:
e560cb0d918d26d31b4f642181f5f570ad89a390931102e5391d08327ba434e9
Set access rights to PSK file - it must be readable only by Zabbix user.
Edit TLS parameters in proxy configuration file `zabbix_proxy.conf`, for
example, set:
TLSConnect=psk
TLSPSKFile=/home/zabbix/zabbix_proxy.psk
TLSPSKIdentity=PSK 002
The proxy will connect to server using PSK. PSK identity will be "PSK
002".
(To minimize downtime see how to change connection type in [Connection
encryption
management](/manual/encryption#connection_encryption_management)).
Configure PSK for this proxy in Zabbix frontend. Go to
*Administration→Proxies*, select the proxy, go to "Encryption" tab. In
"Connections from proxy" mark `PSK`. Paste into "PSK identity" field
"PSK 002" and
"e560cb0d918d26d31b4f642181f5f570ad89a390931102e5391d08327ba434e9" into
"PSK" field. Click "Update".
Restart proxy. It will start using PSK-based encrypted connections to
server. Check server and proxy logfiles for error messages.
For a passive proxy the procedure is very similar. The only difference -
set `TLSAccept=psk` in proxy configuration file and set "Connections to
proxy" in Zabbix frontend to `PSK`.
#### 为服务器配置PSK以进行主动proxy通信（示例）
在proxy上，将PSK值写入file，例如
`/home/zabbix/zabbix_proxy.psk`。该file必须在第一个文本string中包含PSK，例如：
e560cb0d918d26d31b4f642181f5f570ad89a390931102e5391d08327ba434e9
设置PSK file的访问权限 - 必须仅允许Zabbix用户可读。
在proxy配置文件file `zabbix_proxy.conf`中编辑TLS参数，例如设置：
TLSConnect=psk
TLSPSKFile=/home/zabbix/zabbix_proxy.psk
TLSPSKIdentity=PSK 002
proxy将使用PSK连接服务器。PSK标识将为"PSK 002"。
（要最小化停机时间，请参阅[连接加密管理](/manual/encryption#连接加密管理)中关于更改连接类型的方法）。
在Zabbix前端为此proxy配置PSK。前往
*管理→Proxies*，选择proxy，进入"加密"标签页。在
"来自proxy的连接"中勾选`PSK`。在"PSK标识"字段输入
"PSK 002"并在
"PSK"字段输入"e560cb0d918d26d31b4f642181f5f570ad89a390931102e5391d08327ba434e9"。点击"更新"。
重启proxy。它将开始使用基于PSK的加密连接与服务器通信。检查服务器和proxy日志文件中的错误信息。
对于被动式proxy，操作流程非常相似。唯一区别是 -
在proxy配置文件file中设置`TLSAccept=psk`，并在Zabbix前端将"连接到
proxy"设置为`PSK`。
#### Configuring PSK for server-agent communication (example)
On the agent host, write the PSK value into a file, for example,
`/home/zabbix/zabbix_agentd.psk`. The file must contain PSK in the first
text string, for example:
1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952
Set access rights to PSK file - it must be readable only by Zabbix user.
Edit TLS parameters in agent configuration file `zabbix_agentd.conf`,
for example, set:
TLSConnect=psk
TLSAccept=psk
TLSPSKFile=/home/zabbix/zabbix_agentd.psk
TLSPSKIdentity=PSK 001
The agent will connect to server (active checks) and accept from server
and `zabbix_get` only connections using PSK. PSK identity will be "PSK
001".
Restart the agent. Now you can test the connection using `zabbix_get`,
for example:
zabbix_get -s 127.0.0.1 -k "system.cpu.load[all,avg1]" --tls-connect=psk --tls-psk-identity="PSK 001" --tls-psk-file=/home/zabbix/zabbix_agentd.psk
(To minimize downtime see how to change connection type in [Connection
encryption
management](/manual/encryption?&#connection_encryption_management)).
Configure PSK encryption for this agent in Zabbix frontend:
- Go to: *Configuration → Hosts*
- Select host and click on **Encryption** tab
Example:
All mandatory input fields are marked with a red asterisk.
When configuration cache is synchronized with database the new
connections will use PSK. Check server and agent logfiles for error
messages.
#### 为服务器-agent通信配置PSK（示例）
在agent 主机上，将PSK值写入file，例如
`/home/zabbix/zabbix_agentd.psk`。该file必须在第一个文本string中包含PSK，例如：
1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952
设置PSK file的访问权限 - 必须仅允许Zabbix用户可读。
在agent配置文件file `zabbix_agentd.conf`中编辑TLS参数，
例如设置：
TLSConnect=psk
TLSAccept=psk
TLSPSKFile=/home/zabbix/zabbix_agentd.psk
TLSPSKIdentity=PSK 001
该agent将连接到服务器（主动检查）并仅接受来自服务器
和`zabbix_get`的使用PSK的连接。PSK标识将为"PSK 001"。
重启agent。现在可以使用`zabbix_get`测试连接，例如：
zabbix_get -s 127.0.0.1 -k "system.cpu.load[all,avg1]" --tls-connect=psk --tls-psk-identity="PSK 001" --tls-psk-file=/home/zabbix/zabbix_agentd.psk
（要最小化停机时间，请参阅如何更改[连接加密管理](/manual/encryption?&#连接加密管理)中的连接类型）。
在Zabbix前端为此agent配置PSK加密：
- 前往：*配置 → 主机*
- 选择主机并点击**加密**标签页
示例：
所有必填字段都用红色星号标记。
当configuration cache与数据库同步后，新连接将使用PSK。检查server 和 agent日志文件中的错误信息。
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### 配置服务器以与 Java 网关配合使用
在Java网关启动并运行后，您需要告知Zabbix server如何找到Zabbix Java网关。这通过在[server configuration
file](/manual/appendix/config/zabbix_server)中指定JavaGateway和JavaGatewayPort参数来实现。如果运行JMX应用程序的主机由Zabbix proxy监控，则应在[proxy configuration
file](/manual/appendix/config/zabbix_proxy)中指定连接参数。
JavaGateway=192.168.3.14
JavaGatewayPort=10052
默认情况下，服务器不会启动任何与JMX监控相关的进程。但如果您希望使用此功能，则必须指定预分叉的Java轮询器实例数量。这与指定常规轮询器和捕获器的方式相同。
StartJavaPollers=5
完成配置后，请勿忘记重启server 或 proxy。
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### 配置 Zabbix Server 关联 Java 网关
当Java网关启动并运行后，你需要告诉Zabbix server去哪里找Zabbix Java网关。通过在[server 配置文件](/manual/appendix/config/zabbix_server)中指定JavaGateway和JavaGatewayPort来完成这个操作。如果运行JMX应用程序的主机是由Zabbix代理监控的，则可以在[proxy 配置文件](/manual/appendix/config/zabbix_server)中指定连接参数。
JavaGateway=192.168.3.14
JavaGatewayPort=10052
默认情况下，server不会启动任何与JMX监控相关的进程。如果你希望用到它，则必须指定Java pollers的数量。此操作与配置常规 pollers 和 trappers数量一样。
StartJavaPollers=5
配置完server或proxy后，一定不要忘记重启server或proxy。
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### 配置服务器以与 Java 网关配合使用
在Java网关启动并运行后，您需要告知Zabbix server如何找到Zabbix Java网关。这通过在[server configuration
file](/manual/appendix/config/zabbix_server)中指定JavaGateway和JavaGatewayPort参数来实现。如果运行JMX应用程序的主机由Zabbix proxy监控，则应在[proxy configuration
file](/manual/appendix/config/zabbix_proxy)中指定连接参数。
JavaGateway=192.168.3.14
JavaGatewayPort=10052
默认情况下，服务器不会启动任何与JMX监控相关的进程。但如果您希望使用此功能，则必须指定预分叉的Java轮询器实例数量。这与指定常规轮询器和陷阱器的方式相同。
StartJavaPollers=5
完成配置后，请勿忘记重启server 或 proxy。
#### Configuring server for use with Java gateway
With Java gateway up and running, you have to tell Zabbix server where
to find Zabbix Java gateway. This is done by specifying JavaGateway and
JavaGatewayPort parameters in the [server configuration
file](/manual/appendix/config/zabbix_server). If the host on which JMX
application is running is monitored by Zabbix proxy, then you specify
the connection parameters in the [proxy configuration
file](/manual/appendix/config/zabbix_proxy) instead.
JavaGateway=192.168.3.14
JavaGatewayPort=10052
By default, server does not start any processes related to JMX
monitoring. If you wish to use it, however, you have to specify the
number of pre-forked instances of Java pollers. You do this in the same
way you specify regular pollers and trappers.
StartJavaPollers=5
Do not forget to restart server or proxy, once you are done with
configuring them.
#### 配置服务器以与 Java 网关配合使用
在Java网关启动并运行后，您需要告知Zabbix server如何找到Zabbix Java网关。这通过在[server configuration
file](/manual/appendix/config/zabbix_server)中指定JavaGateway和JavaGatewayPort参数来实现。如果运行JMX应用程序的主机由Zabbix proxy监控，则应在[proxy configuration
file](/manual/appendix/config/zabbix_proxy)中指定连接参数。
JavaGateway=192.168.3.14
JavaGatewayPort=10052
默认情况下，服务器不会启动任何与JMX监控相关的进程。但如果您希望使用此功能，则必须指定预分叉的Java轮询器实例数量。这与指定常规轮询器和捕获器的方式相同。
StartJavaPollers=5
配置完成后，请勿忘记重启server 或 proxy。
#### Configuring SNMP monitoring
To start monitoring a device through SNMP, the following steps have to
be performed:
#### 配置 SNMP 监控
要通过SNMP监控设备，需执行以下步骤：
#### Configuring SNMP traps
This item type requires the following frontend configuration.
1\. Create an SNMP interface for your host
- In *Configuration > Hosts*, create/edit the host, and in the *Interfaces* field, add the interface type "SNMP", specifying the IP or DNS address.<br><br>The address from each received trap will be compared to the IP and DNS addresses of all SNMP interfaces to find the corresponding hosts.
2\. Configure the item
- In *Configuration > Hosts*, create/edit the necessary item.
- In the *Key* field, use one of the SNMP trap keys:
|Key|<|<|
|--|--|------|
|Description|Return value|Comments|
|**snmptrap**\[regexp\]|<|<|
|Catches all SNMP traps that match the [regular expression](/manual/regular_expressions) specified in **regexp**. If regexp is unspecified, catches any trap.|SNMP trap|This item can be set only for SNMP interfaces.<br>User macros and global regular expressions are supported in the parameter of this item key.|
|**snmptrap.fallback**|<|<|
|Catches all SNMP traps that were not caught by any of the snmptrap\[\] items for that interface.|SNMP trap|This item can be set only for SNMP interfaces.|
::: noteclassic
Multiline regular expression matching is not supported at this time.
:::
- Set the *Type of information* to "Log" for the timestamps to be parsed. Other formats such as "Numeric" are also acceptable but might require a custom trap handler.
#### 配置SNMP陷阱
此监控项类型需要以下前端配置。
1\. 为您的主机创建SNMP接口
- 在*配置 > 主机*中，create/编辑主机，并在*接口*字段中添加接口类型"SNMP"，指定IP或DNS地址。<br><br>每个接收到的陷阱地址将与所有SNMP接口的IP和DNS地址进行比较，以找到对应的主机。
2\. 配置监控项
- 在*配置 > 主机*中，create/编辑必要的监控项。
- 在*键*字段中，使用以下SNMP陷阱键之一：
| 键 | < | < |
|--|--|------|
| 描述 | 返回值 | 注释 |
| **snmptrap**\[regexp\] | < | < |
| 捕获与**regexp**中指定的[regular expression](/manual/regular_expressions)匹配的所有SNMP陷阱。如果未指定regexp，则捕获任何陷阱。 | SNMP陷阱 | 此监控项只能为SNMP接口设置。<br>此监控项键的参数支持用户宏和全局正则表达式。 |
| **snmptrap.fallback** | < | < |
| 捕获未被该接口的任何snmptrap\[\] 监控项捕获的所有SNMP陷阱。 | SNMP陷阱 | 此监控项只能为SNMP接口设置。 |
::: noteclassic
目前不支持多行正则表达式匹配。
:::
- 将*信息类型*设置为"日志"以解析时间戳。其他格式如"数值"也可接受，但可能需要自定义陷阱处理程序。
##### Configuring SNMPTT
At first, snmptrapd should be configured to use SNMPTT.
::: notetip
For the best performance, SNMPTT should be configured as
a daemon using **snmptthandler-embedded** to pass the traps to it. See
instructions for [configuring SNMPTT](http://snmptt.sourceforge.net/docs/snmptt.shtml).
:::
When SNMPTT is configured to receive the traps, configure `snmptt.ini`:
1. enable the use of the Perl module from the NET-SNMP package:
```ini
net_snmp_perl_enable = 1
```
2. log traps to the trap file which will be read by Zabbix:
```ini
log_enable = 1
log_file = [TRAP FILE]
```
3. set the date-time format:
```ini
date_time_format = %H:%M:%S %Y/%m/%d
```
::: notewarning
The "net-snmp-perl" package has been removed in RHEL 8.0-8.2;
re-added in RHEL 8.3. For more information, see the [known
issues](/manual/installation/known_issues#snmp_traps).
:::
Now format the traps for Zabbix to recognize them (edit snmptt.conf):
1. Each FORMAT statement should start with "ZBXTRAP \[address\]", where
\[address\] will be compared to IP and DNS addresses of SNMP
interfaces on Zabbix. E.g.:
```ini
EVENT coldStart .1.3.6.1.6.3.1.1.5.1 "Status Events" Normal
FORMAT ZBXTRAP $aA Device reinitialized (coldStart)
```
2. See more about SNMP trap format below.
::: noteimportant
Do not use unknown traps - Zabbix will not be able to recognize them.
Unknown traps can be handled by defining a general event in snmptt.conf:<br><br>
```ini
EVENT general .* "General event" Normal
```
:::
##### 配置 SNMPTT
首先，需要配置snmptrapd以使用SNMPTT。
::: notetip
为获得最佳性能，应将SNMPTT配置为守护进程，使用**snmptthandler-embedded**来传递陷阱。具体配置方法参见[configuring SNMPTT](http://snmptt.sourceforge.net/docs/snmptt.shtml)。
:::
当SNMPTT配置为接收陷阱后，需配置`snmptt.ini`：
1. 启用NET-SNMP包中的Perl模块：
```ini
net_snmp_perl_enable = 1
```
2. 将陷阱日志记录到file函数中，该日志将由Zabbix读取：
```ini
log_enable = 1
log_file = [TRAP FILE]
```
3. 设置日期时间格式：
```ini
date_time_format = %H:%M:%S %Y/%m/%d
```
::: notewarning
注意："net-snmp-perl"包在RHEL 8.0-8.2版本中已被移除，在RHEL 8.3中重新加入。更多信息请参阅[known
issues](/manual/installation/known_issues#snmp_traps)。
:::
现在为Zabbix识别格式化陷阱（编辑snmptt.conf文件）：
1. 每个FORMAT语句应以"ZBXTRAP [address]"开头，其中
\[address\] will be compared to IP and DNS addresses of SNMP
interfaces on Zabbix. E.g.:
```ini
EVENT coldStart .1.3.6.1.6.3.1.1.5.1 "Status Events" Normal
FORMAT ZBXTRAP $aA Device reinitialized (coldStart)
```
2. 更多关于SNMP陷阱格式的信息请见下文。
::: noteimportant
不要使用未知陷阱 - Zabbix将无法识别它们。可以通过在snmptt.conf中定义通用事件来处理未知陷阱：<br><br>
```ini
EVENT general .* "General event" Normal
```
:::
#### Configuring steps
{width="600"}
Step parameters:
|Parameter|Description|
|--|--------|
|*Name*|Unique step name.<br>[User macros](/manual/config/macros/user_macros) are supported. *Note* that if user macros are used, these macros will be left unresolved in [web monitoring item](/manual/web_monitoring/items) names.|
|*URL*|URL to connect to and retrieve data. For example:<br>https://www.example.com<br>http://www.example.com/download<br>Domain names can be specified in Unicode characters. They are automatically punycode-converted to ASCII when executing the web scenario step.<br>The *Parse* button can be used to separate optional query fields (like ?name=Admin&password=mypassword) from the URL, moving the attributes and values into *Query fields* for automatic URL-encoding.<br>Variables can be used in the URL, using the {macro} syntax. Variables can be URL-encoded manually using a {{macro}.urlencode()} syntax.<br>User macros and {HOST.\*} [macros](/manual/appendix/macros/supported_by_location) are supported.<br>Limited to 2048 characters.|
|*Query fields*|HTTP GET variables for the URL.<br>Specified as attribute and value pairs.<br>Values are URL-encoded automatically. Values from scenario variables, user macros or {HOST.\*} macros are resolved and then URL-encoded automatically. Using a {{macro}.urlencode()} syntax will double URL-encode them.<br>User macros and {HOST.\*} [macros](/manual/appendix/macros/supported_by_location) are supported.|
|*Post*|HTTP POST variables.<br>In **Form data** mode, specified as attribute and value pairs.<br>Values are URL-encoded automatically. Values from scenario variables, user macros or {HOST.\*} macros are resolved and then URL-encoded automatically.<br>In **Raw data** mode, attributes/values are displayed on a single line and concatenated with a **&** symbol.<br>Raw values can be URL-encoded/decoded manually using a {{macro}.urlencode()} or {{macro}.urldecode()} syntax.<br>For example: id=2345&userid={user}<br>If {user} is defined as a variable of the web scenario, it will be replaced by its value when the step is executed. If you wish to URL-encode the variable, substitute {user} with {{user}.urlencode()}.<br>User macros and {HOST.\*} [macros](/manual/appendix/macros/supported_by_location) are supported.|
|*Variables*|Step-level variables that may be used for GET and POST functions.<br>Specified as attribute and value pairs.<br>Step-level variables override scenario-level variables or variables from the previous step. However, the value of a step-level variable only affects the step after (and not the current step).<br>They have the following format:<br>**{macro}**=value<br>**{macro}**=regex:<regular expression><br>For more information see variable description on the [scenario](web_monitoring#configuring_a_web_scenario) level.<br>Variables are automatically URL-encoded when used in query fields or form data for post variables, but must be URL-encoded manually when used in raw post or directly in URL.|
|*Headers*|Custom HTTP headers that will be sent when performing a request.<br>Specified as attribute and value pairs.<br>A header defined on a step level will be used for that particular step.<br>**It should be noted that defining the header on a step level automatically discards all the previously defined headers, except for a default header that is assigned by selecting the 'User-Agent' from a drop-down list on a scenario level.**<br>However, even the 'User-Agent' default header can be overridden by specifying it on a step level.<br>For example, assigning the name to a header, but setting no value will unset the default header on a scenario level.<br>User macros and {HOST.\*} macros are supported.<br>This sets the [CURLOPT\_HTTPHEADER](http://curl.haxx.se/libcurl/c/CURLOPT_HTTPHEADER.html) cURL option.<br>Specifying custom headers is supported *starting with Zabbix 2.4*.|
|*Follow redirects*|Mark the checkbox to follow HTTP redirects.<br>This sets the [CURLOPT\_FOLLOWLOCATION](http://curl.haxx.se/libcurl/c/CURLOPT_FOLLOWLOCATION.html) cURL option.|
|*Retrieve mode*|Select the retrieve mode:<br>**Body** - retrieve only body from the HTTP response<br>**Headers** - retrieve only headers from the HTTP response<br>**Body and headers** - retrieve body and headers from the HTTP response|
|*Timeout*|Zabbix will not spend more than the set amount of time on processing the URL (from one second to maximum of 1 hour). Actually this parameter defines the maximum time for making connection to the URL and maximum time for performing an HTTP request. Therefore, Zabbix will not spend more than **2 x Timeout** seconds on the step.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 30s, 1m, 1h. [User macros](/manual/config/macros/user_macros) are supported.|
|*Required string*|Required regular expression pattern.<br>Unless retrieved content (HTML) matches the required pattern the step will fail. If empty, no check on required string is performed.<br>For example:<br>Homepage of Zabbix<br>Welcome.\*admin<br>*Note*: Referencing [regular expressions](regular_expressions) created in the Zabbix frontend is not supported in this field.<br>User macros and {HOST.\*} [macros](/manual/appendix/macros/supported_by_location) are supported.|
|*Required status codes*|List of expected HTTP status codes. If Zabbix gets a code which is not in the list, the step will fail.<br>If empty, no check on status codes is performed.<br>For example: 200,201,210-299<br>User macros are supported.|
::: noteclassic
Any changes in web scenario steps will only be saved when
the whole scenario is saved.
:::
See also a [real-life example](/manual/web_monitoring/example) of how
web monitoring steps can be configured.
#### 配置步骤
{width="600"}
步骤参数：
| 参数 | 描述 |
|--|--------|
| *Name* | 唯一步骤名称。<br>[User macros](/manual/config/macros/user_macros) 支持使用。*注意*：如果使用了用户宏，这些宏在[web monitoring item](/manual/web_monitoring/items)名称中将保持未解析状态。 |
| *URL* | 用于连接并获取数据的URL。例如:<br>https://www.example.com<br>http://www.example.com/download<br>域名可以使用Unicode字符指定。在执行Web场景步骤时，它们会自动转换为Punycode编码的ASCII格式。<br>可使用*解析*按钮将可选的query字段(如?name=Admin&password=mypassword)从URL中分离出来，将属性和值移至*query字段*进行自动URL编码。<br>URL中可以使用变量，采用{macro}语法。变量可以通过{{macro}.urlencode()}语法手动进行URL编码。<br>支持用户宏和{主机.\*} [macros](/manual/appendix/macros/supported_by_location)。<br>限制为2048个字符。 |
| *Query fields* | URL的HTTP GET变量。<br>以属性和值对的形式指定。<br>值会自动进行URL编码。来自场景变量、用户宏或{主机.\*}宏的值会被解析后自动进行URL编码。使用{{macro}.urlencode()}语法将会对它们进行双重URL编码。<br>支持用户宏和{主机.\*} [macros](/manual/appendix/macros/supported_by_location)。 |
| *Post* | HTTP POST变量。<br>在**表单数据**模式下，以属性和值对的形式指定。<br>值会自动进行URL编码。来自场景变量、用户宏或{主机.\*}宏的值会被解析后自动进行URL编码。<br>在**原始数据**模式下，属性/值显示在单行上，并用**&**符号连接。<br>原始值可以使用{{macro}.urlencode()}或{{macro}.urldecode()}语法手动进行URL编码/解码。<br>例如：id=2345&userid={user}<br>如果{user}定义为Web场景的变量，在执行步骤时将被其值替换。若要对变量进行URL编码，请将{user}替换为{{user}.urlencode()}。<br>支持用户宏和{主机.\*} [macros](/manual/appendix/macros/supported_by_location)。 |
| *Variables* | 可用于GET和POST函数的步骤级变量。<br>以属性-值对形式指定。<br>步骤级变量会覆盖场景级变量或前一步骤的变量。但步骤级变量的值仅影响后续步骤（不影响当前步骤）。<br>其格式如下：<br>**{macro}**=值<br>**{macro}**=regex:<正则表达式><br>更多信息请参阅[配置web场景](web_monitoring#配置web场景)级别的变量描述。<br>当在query字段或post变量的表单数据中使用时，变量会自动进行URL编码；但在原始post或直接用于URL时需手动进行URL编码。 |
| *Headers* | 执行请求时发送的自定义HTTP头部.<br>需以属性-值对形式指定.<br>在步骤级别定义的头部仅适用于该特定步骤.<br>**需注意：在步骤级别定义头部将自动丢弃所有先前定义的头部（通过场景级别下拉列表选择'User-Agent'分配的默认头部除外）.**<br>但即使是'User-Agent'默认头部，也可通过在步骤级别指定来覆盖.<br>例如：为头部分配名称但不设置值，将取消场景级别的默认头部设置.<br>支持用户宏和{主机.\*}宏.<br>此设置对应[CURLOPT\_HTTPHEADER](http://curl.haxx.se/libcurl/c/CURLOPT_HTTPHEADER.html) cURL选项.<br>*从Zabbix 2.4开始*支持自定义头部设置. |
| *Follow redirects* | 勾选此复选框以跟随HTTP重定向。<br>这将设置[CURLOPT\_FOLLOWLOCATION](http://curl.haxx.se/libcurl/c/CURLOPT_FOLLOWLOCATION.html) cURL选项。 |
| *Retrieve mode* | 选择检索模式:<br>**Body** - 仅从HTTP响应中检索正文<br>**Headers** - 仅从HTTP响应中检索头部信息<br>**Body and headers** - 从HTTP响应中同时检索正文和头部信息 |
| *Timeout* | Zabbix在处理URL时不会超过设定的时间（从1秒到最长1小时）。实际上，此参数定义了连接到URL的最大时间以及执行HTTP请求的最大时间。因此，Zabbix在该步骤上花费的时间不会超过**2 x 超时**秒。<br>支持[Time suffixes](/manual/appendix/suffixes)，例如30s、1m、1h。支持[User macros](/manual/config/macros/user_macros)。 |
| *Required string* | 必需的正则表达式模式.<br>除非检索到的内容(HTML)匹配所需模式，否则该步骤将失败。若留空则不执行对必需string的检查.<br>例如:<br>Zabbix主页<br>Welcome.\*admin<br>*注意*: 该字段不支持引用在Zabbix前端创建的[regular expressions](regular_expressions).<br>支持用户宏和{主机.\*} [macros](/manual/appendix/macros/supported_by_location). |
| *Required status codes* | 预期的HTTP状态码列表。如果Zabbix获取到的状态码不在列表中，该步骤将失败。<br>如果为空，则不执行状态码检查。<br>例如：200,201,210-299<br>支持用户宏。 |
::: noteclassic
Web场景步骤的任何变更仅在以下情况下才会保存
整个场景已保存。
:::
另请参阅[real-life example](/manual/web_monitoring/example)了解如何
可以配置网页监控步骤。
#### Configuring tags
The **Tags** tab allows to define scenario-level
[tags](/manual/config/tagging).
Tagging allows to filter web scenarios and web monitoring
[items](/manual/web_monitoring/items).
#### 配置标签
**标签**选项卡允许定义场景级别的
[tags](/manual/config/tagging).
标记功能允许筛选Web场景和Web监控
[items](/manual/web_monitoring/items).
#### Configuring TLS
Certificate signed by a certificate authority (CA) should be added to
the default CA store. Alternatively a custom CA store location can be
specified using the SSLCALocation configuration parameter; note that in
this case the certificate directory must be prepared using the openssl
c\_rehash utility, for example configure SSLCALocation and copy "ca.pem"
inside that directory, then run the following command:
c_rehash .
#### 配置 TLS
由证书颁发机构(CA)签发的证书应添加到默认CA存储中。或者，可以使用SSLCALocation配置参数指定自定义CA存储位置；请注意，在这种情况下，必须使用openssl c_rehash工具准备证书目录，例如在该目录中配置SSLCALocation和copy "ca.pem"文件，然后run以下命令：
c_rehash .
#### Configuring unixODBC
ODBC configuration is done by editing the **odbcinst.ini** and
**odbc.ini** files. To verify the configuration file location, type:
odbcinst -j
**odbcinst.ini** is used to list the installed ODBC database drivers:
[mysql]
Description = ODBC for MySQL
Driver = /usr/lib/libmyodbc5.so
Parameter details:
|Attribute|Description|
|--|--------|
|*mysql*|Database driver name.|
|*Description*|Database driver description.|
|*Driver*|Database driver library location.|
**odbc.ini** is used to define data sources:
[test]
Description = MySQL test database
Driver = mysql
Server = 127.0.0.1
User = root
Password =
Port = 3306
Database = zabbix
Parameter details:
|Attribute|Description|
|--|--------|
|*test*|Data source name (DSN).|
|*Description*|Data source description.|
|*Driver*|Database driver name - as specified in odbcinst.ini|
|*Server*|Database server IP/DNS.|
|*User*|Database user for connection.|
|*Password*|Database user password.|
|*Port*|Database connection port.|
|*Database*|Database name.|
To verify if ODBC connection is working successfully, a connection to
database should be tested. That can be done with the **isql** utility
(included in the unixODBC package):
isql test
+---------------------------------------+
| Connected! |
| |
| sql-statement |
| help [tablename] |
| quit |
| |
+---------------------------------------+
#### 配置 unixODBC
ODBC配置通过编辑**odbcinst.ini**和
**odbc.ini** 文件。要验证配置file位置，请输入：
odbcinst -j
**odbcinst.ini** 用于列出已安装的ODBC数据库驱动程序:
[mysql]
Description = ODBC for MySQL
Driver = /usr/lib/libmyodbc5.so
参数详情:
| 属性 | 描述 |
|--|--------|
| *mysql* | 数据库驱动名称. |
| *描述* | 数据库驱动描述. |
| *Driver* | 数据库驱动库路径。 |
**odbc.ini** 用于定义数据源:
[test]
Description = MySQL test database
Driver = mysql
Server = 127.0.0.1
User = root
Password =
Port = 3306
Database = zabbix
参数详情:
| 属性 | 描述 |
|--|--------|
| *test* | 数据源名称(DSN). |
| *描述* | 数据源描述. |
| *Driver* | 数据库驱动名称 - 如odbcinst.ini中所指定 |
| *Server* | 数据库服务器IP/DNS. |
| *User* | 用于连接的数据库用户。 |
| *Password* | 数据库用户密码. |
| *Port* | 数据库连接端口. |
| *Database* | 数据库名称. |
要验证ODBC连接是否成功工作，需建立到
数据库应进行测试。这可以通过**isql**实用工具完成
（包含在unixODBC包中）:
isql test
+---------------------------------------+
| Connected! |
| |
| sql-statement |
| help [tablename] |
| quit |
| |
+---------------------------------------+
##### Configuring Zabbix server/proxy
To read the traps, Zabbix server or proxy must be configured to start
the SNMP trapper process and point to the trap file that is being
written by SNMPTT or a Bash/Perl trap receiver. To do that, edit the
configuration file
([zabbix\_server.conf](/manual/appendix/config/zabbix_server) or
[zabbix\_proxy.conf](/manual/appendix/config/zabbix_proxy)):
```ini
StartSNMPTrapper=1
SNMPTrapperFile=[TRAP FILE]
```
::: notewarning
If systemd parameter
**[PrivateTmp](http://www.freedesktop.org/software/systemd/man/systemd.exec.html#PrivateTmp=)**
is used, this file is unlikely to work in */tmp*.
:::
##### Configuring Bash trap receiver
Requirements: only snmptrapd.
A Bash trap receiver [script](https://raw.githubusercontent.com/zabbix/zabbix-docker/6.0/Dockerfiles/snmptraps/alpine/conf/usr/sbin/zabbix_trap_handler.sh)
can be used to pass traps to Zabbix server directly from snmptrapd. To
configure it, add the `traphandle` option to snmptrapd configuration file (`snmptrapd.conf`),
see [example](https://raw.githubusercontent.com/zabbix/zabbix-docker/6.0/Dockerfiles/snmptraps/alpine/conf/etc/snmp/snmptrapd.conf).
##### 配置 Zabbix server/proxy
要读取SNMP陷阱，必须配置Zabbix server或proxy以启动SNMP trapper进程，并指向由SNMPTT或Bash/Perl陷阱接收器写入的陷阱file。为此，请编辑配置文件file
([zabbix\_server.conf](/manual/appendix/config/zabbix_server)或
[zabbix\_proxy.conf](/manual/appendix/config/zabbix_proxy)):
```ini
StartSNMPTrapper=1
SNMPTrapperFile=[TRAP FILE]
```
::: notewarning
如果使用了systemd参数
**[PrivateTmp](http://www.freedesktop.org/software/systemd/man/systemd.exec.html#PrivateTmp=)**
，此file在*/tmp*目录下可能无法正常工作。
:::
##### 配置Bash陷阱接收器
要求：仅需snmptrapd。
可以使用Bash陷阱接收器[script](https://raw.githubusercontent.com/zabbix/zabbix-docker/6.0/Dockerfiles/snmptraps/alpine/conf/usr/sbin/zabbix_trap_handler.sh)
将陷阱直接从snmptrapd传递给Zabbix server。要配置它，请将`traphandle`选项添加到snmptrapd配置文件file中（`snmptrapd.conf`），
参见[example](https://raw.githubusercontent.com/zabbix/zabbix-docker/6.0/Dockerfiles/snmptraps/alpine/conf/etc/snmp/snmptrapd.conf)。
#### Connection encryption management
Connections in Zabbix can use:
- no encryption (default)
- [RSA certificate-based
encryption](/manual/encryption/using_certificates)
- [PSK-based encryption](/manual/encryption/using_pre_shared_keys)
There are two important parameters used to specify encryption between
Zabbix components:
- TLSConnect - specifies what encryption to use for outgoing
connections (unencrypted, PSK or certificate)
- TLSAccept - specifies what types of connections are allowed for
incoming connections (unencrypted, PSK or certificate). One or more
values can be specified.
`TLSConnect` is used in the configuration files for Zabbix proxy (in
active mode, specifies only connections to server) and Zabbix agent (for
active checks). In Zabbix frontend the TLSConnect equivalent is the
*Connections to host* field in *Configuration → Hosts → <some
host> → Encryption* tab and the *Connections to proxy* field in
*Administration → Proxies → <some proxy> → Encryption* tab. If the
configured encryption type for connection fails, no other encryption
types will be tried.
`TLSAccept` is used in the configuration files for Zabbix proxy (in
passive mode, specifies only connections from server) and Zabbix agent
(for passive checks). In Zabbix frontend the TLSAccept equivalent is the
*Connections from host* field in *Configuration → Hosts → <some
host> → Encryption* tab and the *Connections from proxy* field in
*Administration → Proxies → <some proxy> → Encryption* tab.
Normally you configure only one type of encryption for incoming
connections. But you may want to switch the encryption type, e.g. from
unencrypted to certificate-based with minimum downtime and rollback
possibility. To achieve this:
- Set `TLSAccept=unencrypted,cert` in the agent configuration file and
restart Zabbix agent
- Test connection with zabbix\_get to the agent using certificate. If
it works, you can reconfigure encryption for that agent in Zabbix
frontend in the *Configuration → Hosts → <some host> →
Encryption* tab by setting *Connections to host* to "Certificate".
- When server configuration cache gets updated (and proxy
configuration is updated if the host is monitored by proxy) then
connections to that agent will be encrypted
- If everything works as expected you can set `TLSAccept=cert` in the
agent configuration file and restart Zabbix agent. Now the agent
will be accepting only encrypted certificate-based connections.
Unencrypted and PSK-based connections will be rejected.
In a similar way it works on server and proxy. If in Zabbix frontend in
host configuration *Connections from host* is set to "Certificate" then
only certificate-based encrypted connections will be accepted from the
agent (active checks) and zabbix\_sender (trapper items).
Most likely you will configure incoming and outgoing connections to use
the same encryption type or no encryption at all. But technically it is
possible to configure it asymmetrically, e.g. certificate-based
encryption for incoming and PSK-based for outgoing connections.
Encryption configuration for each host is displayed in the Zabbix
frontend, in *Configuration → Hosts* in the *Agent encryption* column.
For example:
|Example|Connections to host|Allowed connections from host|Rejected connections from host|
|-------|-------------------|-------------------|-------------------|
||Unencrypted|Unencrypted|Encrypted, certificate and PSK-based encrypted|
||Encrypted, certificate-based|Encrypted, certificate-based|Unencrypted and PSK-based encrypted|
||Encrypted, PSK-based|Encrypted, PSK-based|Unencrypted and certificate-based encrypted|
||Encrypted, PSK-based|Unencrypted and PSK-based encrypted|Certificate-based encrypted|
||Encrypted, certificate-based|Unencrypted, PSK or certificate-based encrypted|\-|
::: noteimportant
Connections are unencrypted by default. Encryption
must be configured for each host and proxy individually.
:::
#### 连接加密管理
Zabbix中的连接可使用:
- 无加密（默认）
- [RSA certificate-based
encryption](/manual/encryption/using_certificates)
- [PSK-based encryption](/manual/encryption/using_pre_shared_keys)
有两个重要参数用于指定加密方式
Zabbix组件:
- TLSConnect - 指定用于传出连接的加密方式
连接（未加密、PSK或证书）
- TLSAccept - 指定允许的连接类型
incoming connections (unencrypted, PSK or certificate). One or more
values can be specified.
`TLSConnect` 用于 Zabbix proxy 的配置文件中（在
主动模式，仅指定与服务器的连接）和Zabbix agent（用于
主动检查）。在Zabbix前端中，TLSConnect的对应项是
*配置 → 主机 → <某个*中的*连接到 主机*字段
主机 > 加密*选项卡和*连接到proxy*字段
*管理 → Proxies → <某些 proxy> → 加密* 标签页。如果
配置的连接加密类型失败，无其他可用加密方式
将尝试类型。
`TLSAccept` 用于 Zabbix proxy 的配置文件中（在
被动模式（仅指定来自服务器的连接）和Zabbix agent
（用于被动检查）。在Zabbix前端中，TLSAccept的等效参数是
*配置 → 主机 → <某个*中的*来自主机的连接*字段
主机> → 加密* 选项卡和 *来自 proxy 的连接* 字段
*管理 → Proxies → <某些 proxy> → 加密* 标签
通常您只需为传入配置一种加密类型
连接。但您可能需要切换加密类型，例如从
从非加密到基于证书的转换，实现最短停机时间和回滚能力
可能性。为实现此目标：
- 在agent配置file中设置`TLSAccept=unencrypted,cert`
重启 Zabbix agent
- 使用证书通过zabbix\_get测试与agent的连接。如果
它正常工作，您可以在Zabbix中为那个agent重新配置加密
前端在*配置 → 主机 → <某个 主机> →
加密* 选项卡，通过将 *连接到 主机* 设置为 "证书"。
- 当服务器configuration cache更新时（且proxy
配置会在以下情况下更新：如果主机由proxy监控
与那个agent的连接将被加密
- 如果一切按预期运行，您可以在 `TLSAccept=cert` 中设置
agent configuration file and restart Zabbix agent. Now the agent
will be accepting only encrypted certificate-based connections.
Unencrypted and PSK-based connections will be rejected.
同样地，它也适用于服务器和proxy。如果在Zabbix前端中
主机配置 *来自主机的连接* 设置为"证书"时
仅接受基于证书的加密连接
agent（主动检查）和zabbix\_sender（trapper 监控项）。
您很可能需要配置入站和出站连接以使用
相同的加密类型或完全不加密。但从技术上讲
可以非对称配置，例如基于证书
传入连接使用加密，传出连接基于PSK（预共享密钥）。
每个主机的加密配置显示在Zabbix中
前端，在*配置 → 主机*中的*Agent加密*列。
例如:
| 示例 | 连接到 主机 | 来自 主机 的允许连接 | 来自 主机 的被拒绝连接 |
|-------|-------------------|-------------------|-------------------|
|  | 未加密 | 未加密 | 加密, 基于证书和PSK的加密 |
|  | 基于证书的加密 | 基于证书的加密 | 基于PSK的加密及未加密 |
|  | 基于PSK加密 | 基于PSK加密 | 未加密及基于证书加密 |
|  | 基于PSK的加密 | 未加密及基于PSK的加密 | 基于证书的加密 |
|  | 基于证书的加密 | 基于PSK或证书的未加密 | \- |
::: noteimportant
默认情况下连接未加密。加密
必须为每个主机和proxy单独配置。
:::
### Connection options for Oracle plugin
The Oracle plugin, supported for Zabbix agent 2, now allows to specify `as sysdba`, `as sysoper`, or `as sysasm` login option.
The option can be appended either to the user item key parameter or to the plugin configuration parameter Plugins.Oracle.Sessions.<SessionName>.User in the format `user as sysdba` (login option is case-insensitive; must not contain a trailing space).
### Connection options for Oracle plugin
Oracle插件现支持为Zabbix agent 2指定`as sysdba`、`as sysoper`或`as sysasm` login选项。
该选项可附加到用户监控项键参数，或以`user as sysdba`格式附加到插件配置参数Plugins.Oracle.Sessions.<SessionName>.User中（login选项不区分大小写；不得包含尾随空格）。
### Connection set up
Zabbix supports two types of connect identifiers (connection methods):
- Easy Connect
- Net Service Name
Connection configuration parameters for Zabbix server and Zabbix proxy
can be set in the configuration files. Important parameters for the
server and proxy are *DBHost*, *DBUser*, *DBName* and *DBPassword*. The
same parameters are important for the frontend: *$DB\["SERVER"\]*,
*$DB\["PORT"\]*, *$DB\["DATABASE"\]*, *$DB\["USER"\]*,
*$DB\["PASSWORD"\]*.
Zabbix uses the following connection string syntax:
{DBUser/DBPassword[@<connect_identifier>]}
<connect\_identifier> can be specified either in the form of "Net
Service Name" or "Easy Connect".
@[[//]Host[:Port]/<service_name> | <net_service_name>]
### 连接建立
Zabbix支持两种类型的连接标识符（连接方式）：
- Easy Connect
- Net Service Name
Zabbix server和Zabbix proxy的连接配置参数可在配置文件中设置。服务器和proxy的重要参数包括*DBHost*、*DBUser*、*DBName*和*DBPassword*。前端同样重要的参数有：*$DB["SERVER"]*、*$DB["PORT"]*、*$DB["DATABASE"]*、*$DB["USER"]*、*$DB["PASSWORD"]*。
Zabbix使用以下连接string语法：
{DBUser/DBPassword[@<connect_identifier>]}
<connect\_identifier>可以指定为"Net Service Name"或"Easy Connect"格式。
@[[//]主机[:Port]/<service_name> | <net_service_name>]
#### Consistency introduced in sha256 checksums of vfs.file.cksum item
In earlier Zabbix versions, the Zabbix agent item [`vfs.file.cksum`](/manual/config/items/itemtypes/zabbix_agent#virtual-file-system-data) produced different sha256 sums for the same file depending on the platform (processor architecture) – sha256 sums on AIX, HP-UX (Itanium) and Solaris (SPARC) differed from those produced on Intel x86-64 platforms.
The issue has now been fixed; however, after upgrading, monitoring sha256 sums of files on AIX, HP-UX, or Solaris SPARC may result in false positives of files having been modified.
#### vfs.file.cksum 监控项 的 sha256 校验和一致性引入
在早期Zabbix版本中，Zabbix agent监控项[`vfs.file.cksum`](/manual/config/监控项/itemtypes/zabbix_agent#virtual-file-system-data)会为相同的file生成不同的sha256校验值，具体取决于平台（处理器架构）——AIX、HP-UX（Itanium）和Solaris（SPARC）上的sha256校验值与Intel x86-64平台生成的结果不同。
该问题现已被修复；但升级后，在AIX、HP-UX或Solaris SPARC系统上监控文件的sha256校验值可能导致文件被修改的误报。
#### Content conversion to UTF-8
HTTP agent items, web scenarios, web checks and JavaScript items have been improved to convert to UTF-8 from the character set specified in the HTTP header or HTTP meta tag.
#### 内容转换为 UTF-8 编码
HTTP agent 监控项、Web场景、Web检查及JavaScript 监控项已改进为可从HTTP头部或HTTP meta标签指定的字符集转换为UTF-8编码。
#### Copy an LLD rule to multiple hosts
Copy an LLD rule to two hosts.
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.copy",
"params": {
"discoveryids": [
"27426"
],
"hostids": [
"10196",
"10197"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
#### 将LLD规则复制到多个主机
将LLD规则复制到两个主机.
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.copy",
"params": {
"discoveryids": [
"27426"
],
"hostids": [
"10196",
"10197"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
#### Copying/pasting pages
Dashboard pages can be copied and pasted, allowing to create a new page
with the properties of an existing one. They can be pasted from the same
dashboard or a different dashboard.
To paste an existing page to the dashboard, first copy it, using the
[page menu](#page_menu):
To paste the copied page:
- Make sure the dashboard is in the [editing
mode](#viewing_and_editing_a_dashboard)
- Click on the arrow next to the *Add* button and select the *Paste
page* option
#### 复制/粘贴页面
仪表板页面可被复制和粘贴，从而create一个具有现有页面属性的新页面。这些页面可以从同一仪表板或不同仪表板粘贴。
要将现有页面粘贴到仪表板，首先需copy该页面，使用[页面菜单](#page_menu):
粘贴已复制的页面:
- 确保仪表板处于[编辑模式](#viewing_and_editing_a_dashboard)
- 点击*添加*按钮旁的箭头并选择*粘贴页面*选项
#### Copying/pasting widgets
Dashboard widgets can be copied and pasted, allowing to create a new
widget with the properties of an existing one. They can be copy-pasted
within the same dashboard, or between dashboards opened in different
tabs.
A widget can be copied using the [widget menu](#widget_menu). To paste
the widget:
- click on the arrow next to the *Add* button and selecting the *Paste
widget* option, when editing the dashboard
- use the *Paste widget* option when adding a new widget by selecting
some area in the dashboard (a widget must be copied first for the
paste option to become available)
A copied widget can be used to paste over an existing widget using the
*Paste* option in the [widget menu](#widget_menu).
#### 复制/粘贴部件
仪表板小部件可被复制粘贴，从而create一个具有现有小部件属性的新部件。它们可在同一仪表板内或不同标签页打开的仪表板之间copy粘贴。
可通过[部件菜单](#widget_menu)复制小部件。粘贴小部件的操作如下：
- 在编辑仪表板时，点击*添加*按钮旁的箭头并选择*粘贴部件*选项
- 通过选择添加新部件时使用*粘贴部件*选项
some area in the dashboard (a widget must be copied first for the
paste option to become available)
已复制的部件可通过[部件菜单](#widget_menu)中的*粘贴*选项覆盖现有部件。
##### Copying PHP files
Zabbix frontend is written in PHP, so to run it a PHP supported
webserver is needed. Installation is done by simply copying the PHP
files from the ui directory to the webserver HTML documents directory.
Common locations of HTML documents directories for Apache web servers
include:
- /usr/local/apache2/htdocs (default directory when installing Apache
from source)
- /srv/www/htdocs (OpenSUSE, SLES)
- /var/www/html (Debian, Ubuntu, Fedora, RHEL)
It is suggested to use a subdirectory instead of the HTML root. To
create a subdirectory and copy Zabbix frontend files into it, execute
the following commands, replacing the actual directory:
mkdir <htdocs>/zabbix
cd ui
cp -a . <htdocs>/zabbix
If planning to use any other language than English, see [Installation of
additional frontend languages](/manual/appendix/install/locales) for
instructions.
##### 复制PHP文件
Zabbix前端采用PHP编写，因此需要支持PHP的Web服务器才能run。安装过程只需将ui目录中的PHP文件复制到Web服务器的HTML文档目录即可。
Apache Web服务器常见的HTML文档目录位置包括：
- /usr/local/apache2/htdocs (从源码安装Apache时的默认目录)
- /srv/www/htdocs (OpenSUSE, SLES系统)
- /var/www/html (Debian, Ubuntu, Fedora, RHEL系统)
建议使用子目录而非HTML根目录。要create子目录并将Zabbix前端文件copy其中，请execute以下命令（需替换实际目录）：
mkdir <htdocs>/zabbix
cd ui
cp -a . <htdocs>/zabbix
若需使用英语之外的其他语言，请参阅[Installation of
additional frontend languages](/manual/appendix/install/locales)获取配置说明。
### Copyright notice
Zabbix documentation is NOT distributed under a GPL license. Use
of Zabbix documentation is subject to the following terms:
You may create a printed copy of this documentation solely for your
own personal use. Conversion to other formats is allowed as long as
the actual content is not altered or edited in any way. You shall
not publish or distribute this documentation in any form or on any
media, except if you distribute the documentation in a manner similar
to how Zabbix disseminates it (that is, electronically for download
on a Zabbix web site) or on a USB or similar medium, provided however
that the documentation is disseminated together with the software on
the same medium. Any other use, such as any dissemination of printed
copies or use of this documentation, in whole or in part, in another
publication, requires the prior written consent from an authorized
representative of Zabbix. Zabbix reserves any and all rights to this
documentation not expressly granted above.
### 版权声明
Zabbix文档未采用GPL许可证分发。使用Zabbix文档需遵守以下条款：
您可create打印copy本文档仅供个人使用。允许转换为其他格式，但不得以任何方式修改或编辑实际内容。除非以Zabbix官方传播方式（即通过Zabbix网站电子下载）或在USB等同类介质上分发（需确保文档与软件在同一介质上分发），否则不得以任何形式或媒介发布或分发本文档。任何其他用途，包括但不限于分发印刷副本或将本文档全部或部分用于其他出版物，均需事先获得Zabbix授权代表的书面许可。Zabbix保留本文档未明确授予的所有权利。
# correlation.create
# correlation.create
# correlation.delete
# correlation.delete
#### Correlation filter condition
The correlation filter condition object defines a specific condition
that must be checked before running the correlation operations.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**type**<br>(required)|integer|Type of condition.<br><br>Possible values:<br>0 - old event tag;<br>1 - new event tag;<br>2 - new event host group;<br>3 - event tag pair;<br>4 - old event tag value;<br>5 - new event tag value.|
|tag|string|Event tag (old or new). Required when type of condition is: 0, 1, 4, 5.|
|groupid|string|Host group ID. Required when type of condition is: 2.|
|oldtag|string|Old event tag. Required when type of condition is: 3.|
|newtag|string|New event tag. Required when type of condition is: 3.|
|value|string|Event tag (old or new) value. Required when type of condition is: 4, 5.|
|formulaid|string|Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|operator|integer|Condition operator.<br><br>Required when type of condition is: 2, 4, 5.|
::: notetip
To better understand how to use filters with various
types of expressions, see examples on the
[correlation.get](get#retrieve_correlations) and
[correlation.create](create#using_a_custom_expression_filter) method
pages.
:::
The following operators and values are supported for each condition
type.
|Condition|Condition name|Supported operators|Expected value|
|---------|--------------|-------------------|--------------|
|2|Host group|=, <>|Host group ID.|
|4|Old event tag value|=, <>, like, not like|string|
|5|New event tag value|=, <>, like, not like|string|
#### 关联过滤条件
关联过滤器条件object定义了在运行关联操作前必须检查的特定条件。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **type**<br>(required) | integer | 条件类型。<br><br>可选值:<br>0 - 旧事件标签;<br>1 - 新事件标签;<br>2 - 新事件主机组;<br>3 - 事件标签对;<br>4 - 旧事件标签值;<br>5 - 新事件标签值。 |
| tag | string | 事件标签(旧或新)。当条件类型为以下值时必需: 0, 1, 4, 5。 |
| groupid | string | 主机组 ID。当条件类型为以下值时必需: 2。 |
| oldtag | string | 旧事件标签。当条件类型为以下值时必需: 3。 |
| newtag | string | 新事件标签。当条件类型为以下值时必需: 3。 |
| value | string | 事件标签(旧或新)值。当条件类型为以下值时必需: 4, 5。 |
| formulaid | string | 用于从自定义表达式引用条件的任意唯一ID。只能包含大写字母。修改过滤条件时必须由用户定义该ID，但在后续请求时会重新生成。 |
| operator | integer | 条件运算符。<br><br>当条件类型为以下值时必需: 2, 4, 5。 |
::: notetip
要更好地理解如何将过滤器与各种表达式类型结合使用，请参阅
[correlation.get](get#retrieve_correlations)和
[correlation.create](create#using_a_custom_expression_filter)方法页面的示例。
:::
以下列出了每种条件类型支持的运算符和值。
| 条件 | 条件名称 | 支持的运算符 | 期望值 |
|---------|--------------|-------------------|--------------|
| 2 | Host group | =, <> | 主机组 ID。 |
| 4 | Old event tag value | =, <>, like, not like | string |
| 5 | New event tag value | =, <>, like, not like | string |
### Correlation filter
The correlation filter object defines a set of conditions that must be
met to perform the configured correlation operations. It has the
following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**evaltype**<br>(required)|integer|Filter condition evaluation method.<br><br>Possible values:<br>0 - and/or;<br>1 - and;<br>2 - or;<br>3 - custom expression.|
|**conditions**<br>(required)|array|Set of filter conditions to use for filtering results.|
|eval\_formula|string|*(readonly)* Generated expression that will be used for evaluating filter conditions. The expression contains IDs that reference specific filter conditions by its `formulaid`. The value of `eval_formula` is equal to the value of `formula` for filters with a custom expression.|
|formula|string|User-defined expression to be used for evaluating conditions of filters with a custom expression. The expression must contain IDs that reference specific filter conditions by its `formulaid`. The IDs used in the expression must exactly match the ones defined in the filter conditions: no condition can remain unused or omitted.<br><br>Required for custom expression filters.|
### 关联过滤器
关联过滤器object定义了一组必须满足的条件才能执行配置的关联操作. 它具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **evaltype**<br>(required) | integer | 过滤条件评估方法.<br><br>可能的值:<br>0 - 与/或;<br>1 - 与;<br>2 - 或;<br>3 - 自定义表达式. |
| **conditions**<br>(required) | array | 用于过滤结果的过滤条件集合. |
| eval\_formula | string | *(只读)* 生成的表达式,将用于评估过滤条件.该表达式包含通过`formulaid`引用特定过滤条件的ID.对于自定义表达式的过滤器,`eval_formula`的值等于`formula`的值. |
| formula | string | 用户定义的表达式,用于评估具有自定义表达式的过滤器的条件.该表达式必须包含通过`formulaid`引用特定过滤条件的ID.表达式中使用的ID必须与过滤条件中定义的完全匹配:不能有任何条件未被使用或遗漏.<br><br>自定义表达式过滤器必需. |
# correlation.get
# correlation.get
### Correlation operation
The correlation operation object defines an operation that will be
performed when a correlation is executed. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**type**<br>(required)|integer|Type of operation.<br><br>Possible values:<br>0 - close old events;<br>1 - close new event.|
### 关联操作
关联操作object定义了执行关联时将执行的操作。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **type**<br>(required) | integer | 操作类型。<br><br>可能的值:<br>0 - 关闭旧事件;<br>1 - 关闭新事件。 |
### Correlation
The correlation object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|correlationid|string|*(readonly)* ID of the correlation.|
|**name**<br>(required)|string|Name of the correlation.|
|description|string|Description of the correlation.|
|status|integer|Whether the correlation is enabled or disabled.<br><br>Possible values are:<br>0 - *(default)* enabled;<br>1 - disabled.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 关联
关联object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| correlationid | string | *(只读)* 关联的ID. |
| **name**<br>(required) | string | 关联的名称. |
| description | string | 关联的描述. |
| status | integer | 关联是否启用或禁用.<br><br>可能的值为:<br>0 - *(默认)* 启用;<br>1 - 禁用. |
请注意，某些方法(update, delete)所需/可选参数组合有所不同.
# correlation.update
# correlation.update
### Cosmos DB monitoring
The template *Azure by HTTP* now also works with Azure Cosmos DB for MongoDB.
You can get this template:
- In *Configuration → Templates* in new installations.
- If you are upgrading from previous versions, you can download this template from Zabbix [Git repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) or find it in the *zabbix/templates* directory of the downloaded latest Zabbix version. Then, while in *Configuration → Templates* you can import it manually into Zabbix.
### Cosmos DB 监控
HTTP方式Azure模板现在也支持Azure Cosmos DB for MongoDB。
您可以get此模板：
- 在全新安装的Zabbix中，通过*配置 → 模板*获取
- 若从旧版本升级，可从Zabbix [Git repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/azure_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)下载该模板，或在最新Zabbix version的*zabbix/templates*目录中找到。然后通过*配置 → 模板*手动import到Zabbix中。
##### Counting of threads in `proc.mem[]` and `proc.num[]` items
Linux kernel threads are counted by `proc.num[]` item but do not report
memory in `proc.mem[]` item. For example:
$ ps -ef | grep kthreadd
root 2 0 0 09:51 ? 00:00:00 [kthreadd]
$ zabbix_get -s localhost -k 'proc.num[kthreadd]'
1
$ zabbix_get -s localhost -k 'proc.mem[kthreadd]'
ZBX_NOTSUPPORTED: Cannot get amount of "VmSize" memory.
But what happens if there is a user process with the same name as a
kernel thread ? Then it could look like this:
$ ps -ef | grep kthreadd
root 2 0 0 09:51 ? 00:00:00 [kthreadd]
zabbix 9611 6133 0 17:58 pts/1 00:00:00 ./kthreadd
$ zabbix_get -s localhost -k 'proc.num[kthreadd]'
2
$ zabbix_get -s localhost -k 'proc.mem[kthreadd]'
4157440
`proc.num[]` counted both the kernel thread and the user process.
`proc.mem[]` reports memory for the user process only and counts the
kernel thread memory as if it was 0. This is different from the case
above when ZBX\_NOTSUPPORTED was reported.
Be careful when using `proc.mem[]` and `proc.num[]` items if the program
name happens to match one of the thread.
Before putting parameters into `proc.mem[]` and `proc.num[]` items, you
may want to test the parameters using `proc.num[]` item and `ps`
command.
##### Counting of threads in `proc.mem[]` and `proc.num[]` items
Linux内核线程会被`proc.num[]` 监控项计数，但不会在`proc.mem[]` 监控项中报告memory。例如：
$ ps -ef | grep kthreadd
root 2 0 0 09:51 ? 00:00:00 [kthreadd]
$ zabbix_get -s localhost -k 'proc.num[kthreadd]'
1
$ zabbix_get -s localhost -k 'proc.mem[kthreadd]'
ZBX_NOTSUPPORTED: Cannot get amount of "VmSize" memory.
但如果存在与内核线程同名的用户进程会怎样？那么情况可能如下：
$ ps -ef | grep kthreadd
root 2 0 0 09:51 ? 00:00:00 [kthreadd]
zabbix 9611 6133 0 17:58 pts/1 00:00:00 ./kthreadd
$ zabbix_get -s localhost -k 'proc.num[kthreadd]'
2
$ zabbix_get -s localhost -k 'proc.mem[kthreadd]'
4157440
`proc.num[]`会同时统计内核线程和用户进程。`proc.mem[]`仅报告用户进程的memory，并将内核线程的memory视为0。这与之前报告ZBX_NOTSUPPORTED的情况不同。
当程序名恰好与某个线程匹配时，使用`proc.mem[]`和`proc.num[]` 监控项需谨慎。
在将参数放入`proc.mem[]`和`proc.num[]` 监控项之前，建议先使用`proc.num[]` 监控项和`ps`命令测试参数。
**CPU**
Zabbix and especially Zabbix database may require significant CPU
resources depending on number of monitored parameters and chosen
database engine.
**CPU**
Zabbix及其数据库可能需要大量CPU资源，具体取决于监控参数的数量和所选数据库引擎。
#### Create a custom script
Create a custom script that will reboot a server. The script will
require write access to the host and will display a configuration
message before running in the frontend.
Request:
```json
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Reboot server",
"command": "reboot server 1",
"confirmation": "Are you sure you would like to reboot the server?",
"scope": 2,
"type": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"4"
]
},
"id": 1
}
```
#### 创建自定义脚本
创建一个用于重启服务器的自定义脚本。该脚本需要
对主机具有写入权限，并在前端运行时
显示配置消息。
请求:
```json
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Reboot server",
"command": "reboot server 1",
"confirmation": "Are you sure you would like to reboot the server?",
"scope": 2,
"type": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"4"
]
},
"id": 1
}
```
#### Create a discovery action
Create a discovery action that will link discovered hosts to template "10001".
Request:
```json
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Discovery action",
"eventsource": 1,
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 21,
"operator": 0,
"value": "1"
},
{
"conditiontype": 10,
"operator": 0,
"value": "2"
}
]
},
"operations": [
{
"operationtype": 6,
"optemplate": [
{
"templateid": "10001"
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"18"
]
},
"id": 1
}
```
#### 创建发现动作
创建一个发现动作，将发现的主机关联到模板"10001"。
请求:
```json
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Discovery action",
"eventsource": 1,
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 21,
"operator": 0,
"value": "1"
},
{
"conditiontype": 10,
"operator": 0,
"value": "2"
}
]
},
"operations": [
{
"operationtype": 6,
"optemplate": [
{
"templateid": "10001"
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"18"
]
},
"id": 1
}
```
#### Create a discovery action
Create an action that will link discovered hosts to template "10091".
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Discovery action",
"eventsource": 1,
"status": 0,
"esc_period": "0s",
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 21,
"value": "1"
},
{
"conditiontype": 10,
"value": "2"
}
]
},
"operations": [
{
"esc_step_from": 1,
"esc_period": "0s",
"optemplate": [
{
"templateid": "10091"
}
],
"operationtype": 6,
"esc_step_to": 1
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"18"
]
},
"id": 1
}
```
#### 创建发现动作
创建一个将发现的主机链接到模板 `30085` 的动作。
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Discovery action",
"eventsource": 1,
"status": 0,
"esc_period": "0s",
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 21,
"value": "1"
},
{
"conditiontype": 10,
"value": "2"
}
]
},
"operations": [
{
"esc_step_from": 1,
"esc_period": "0s",
"optemplate": [
{
"templateid": "10091"
}
],
"operationtype": 6,
"esc_step_to": 1
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"18"
]
},
"id": 1
}
```
#### Create a discovery rule
Create a discovery rule to find machines running the Zabbix agent in the
local network. The rule must use a single Zabbix agent check on port
10050.
Request:
```json
{
"jsonrpc": "2.0",
"method": "drule.create",
"params": {
"name": "Zabbix agent discovery",
"iprange": "192.168.1.1-255",
"dchecks": [
{
"type": "9",
"key_": "system.uname",
"ports": "10050",
"uniq": "0"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"druleids": [
"6"
]
},
"id": 1
}
```
#### 创建发现规则
创建发现规则以在本地网络中查找运行Zabbix agent的机器。该规则必须在端口10050上使用单一的Zabbix agent检查。
请求:
```json
{
"jsonrpc": "2.0",
"method": "drule.create",
"params": {
"name": "Zabbix agent discovery",
"iprange": "192.168.1.1-255",
"dchecks": [
{
"type": "9",
"key_": "system.uname",
"ports": "10050",
"uniq": "0"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"druleids": [
"6"
]
},
"id": 1
}
```
#### Create agent autoregistration rule
Add a host to host group "Linux servers" when host name contains "SRV"
or metadata contains "CentOS".
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Register Linux servers",
"eventsource": "2",
"status": "0",
"filter": {
"evaltype": "2",
"formula": "A or B",
"conditions": [
{
"conditiontype": "22",
"operator": "2",
"value": "SRV",
"value2": "",
"formulaid": "B"
},
{
"conditiontype": "24",
"operator": "2",
"value": "CentOS",
"value2": "",
"formulaid": "A"
}
]
},
"operations": [
{
"actionid": "9",
"operationtype": "4",
"esc_period": "0",
"esc_step_from": "1",
"esc_step_to": "1",
"evaltype": "0",
"opgroup": [
{
"operationid": "16",
"groupid": "2"
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"actionids": [
19
]
},
"id": 1
}
```
### 参见
- [Action filter](object#action_filter)
- [Action operation](object#action_operation)
#### Create agent autoregistration rule
Create an autoregistration action that adds a host to host group "2" when the host name contains "SRV" or metadata contains "AlmaLinux".
Request:
```json
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Register Linux servers",
"eventsource": "2",
"filter": {
"evaltype": "2",
"conditions": [
{
"conditiontype": "22",
"operator": "2",
"value": "SRV"
},
{
"conditiontype": "24",
"operator": "2",
"value": "AlmaLinux"
}
]
},
"operations": [
{
"operationtype": "4",
"opgroup": [
{
"groupid": "2"
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
19
]
},
"id": 1
}
```
#### 创建 agent 自动注册规则
创建一个自动注册动作，当主机名称包含"SRV"或元数据包含"AlmaLinux"时，将一个主机添加到主机组 "2"中。
请求:
```json
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Register Linux servers",
"eventsource": "2",
"filter": {
"evaltype": "2",
"conditions": [
{
"conditiontype": "22",
"operator": "2",
"value": "SRV"
},
{
"conditiontype": "24",
"operator": "2",
"value": "AlmaLinux"
}
]
},
"operations": [
{
"operationtype": "4",
"opgroup": [
{
"groupid": "2"
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
19
]
},
"id": 1
}
```
#### Create a host map
Create a map with two host elements and a link between them. Note the
use of temporary "selementid1" and "selementid2" values in the map link
object to refer to map elements.
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Host map",
"width": 600,
"height": 600,
"selements": [
{
"selementid": "1",
"elements": [
{"hostid": "1033"}
],
"elementtype": 0,
"iconid_off": "2"
},
{
"selementid": "2",
"elements": [
{"hostid": "1037"}
],
"elementtype": 0,
"iconid_off": "2"
}
],
"links": [
{
"selementid1": "1",
"selementid2": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 1
}
```
#### 创建主机地图
创建包含两个主机元素及其间连线的地图. 注意在地图连线object中使用临时值"selementid1"和"selementid2"来引用地图元素.
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Host map",
"width": 600,
"height": 600,
"selements": [
{
"selementid": "1",
"elements": [
{"hostid": "1033"}
],
"elementtype": 0,
"iconid_off": "2"
},
{
"selementid": "2",
"elements": [
{"hostid": "1037"}
],
"elementtype": 0,
"iconid_off": "2"
}
],
"links": [
{
"selementid1": "1",
"selementid2": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 1
}
```
#### Create an active proxy
Create an action proxy "Active proxy" and assign a host to be monitored
by it.
Request:
```json
{
"jsonrpc": "2.0",
"method": "proxy.create",
"params": {
"host": "Active proxy",
"status": "5",
"hosts": [
{
"hostid": "10279"
}
]
},
"auth": "ab9638041ec6922cb14b07982b268f47",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10280"
]
},
"id": 1
}
```
#### 创建主动式 proxy
创建一个动作proxy "活跃proxy" 并分配一个主机由其监控
请求:
```json
{
"jsonrpc": "2.0",
"method": "proxy.create",
"params": {
"host": "Active proxy",
"status": "5",
"hosts": [
{
"hostid": "10279"
}
]
},
"auth": "ab9638041ec6922cb14b07982b268f47",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10280"
]
},
"id": 1
}
```
#### Create an empty map
Create a map with no elements.
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map",
"width": 600,
"height": 600
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"8"
]
},
"id": 1
}
```
#### 创建空白地图
创建不含任何元素的地图.
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map",
"width": 600,
"height": 600
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"8"
]
},
"id": 1
}
```
#### Create a new event tag correlation
Create a correlation using evaluation method `AND/OR` with one condition
and one operation. By default the correlation will be enabled.
Request:
```json
{
"jsonrpc": "2.0",
"method": "correlation.create",
"params": {
"name": "new event tag correlation",
"filter": {
"evaltype": 0,
"conditions": [
{
"type": 1,
"tag": "ok"
}
]
},
"operations": [
{
"type": 0
}
]
},
"auth": "343baad4f88b4106b9b5961e77437688",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"correlationids": [
"1"
]
},
"id": 1
}
```
#### 创建新的事件标签关联
使用评估方法`AND/OR`创建一个关联规则，包含一个条件和一个操作。默认情况下该关联规则将处于启用状态。
请求:
```json
{
"jsonrpc": "2.0",
"method": "correlation.create",
"params": {
"name": "new event tag correlation",
"filter": {
"evaltype": 0,
"conditions": [
{
"type": 1,
"tag": "ok"
}
]
},
"operations": [
{
"type": 0
}
]
},
"auth": "343baad4f88b4106b9b5961e77437688",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"correlationids": [
"1"
]
},
"id": 1
}
```
#### Create a new interface
Create a secondary IP agent interface on host "30052."
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.create",
"params": {
"hostid": "30052",
"main": "0",
"type": "1",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "10050"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30062"
]
},
"id": 1
}
```
#### 创建新接口
在主机 "30052"上创建次级IPagent接口
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.create",
"params": {
"hostid": "30052",
"main": "0",
"type": "1",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "10050"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30062"
]
},
"id": 1
}
```
#### Create an icon map
Create an icon map to display hosts of different types.
Request:
```json
{
"jsonrpc": "2.0",
"method": "iconmap.create",
"params": {
"name": "Type icons",
"default_iconid": "2",
"mappings": [
{
"inventory_link": 1,
"expression": "server",
"iconid": "3"
},
{
"inventory_link": 1,
"expression": "switch",
"iconid": "4"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"iconmapids": [
"2"
]
},
"id": 1
}
```
#### 创建图标映射
创建图标映射以显示不同类型的主机
请求:
```json
{
"jsonrpc": "2.0",
"method": "iconmap.create",
"params": {
"name": "Type icons",
"default_iconid": "2",
"mappings": [
{
"inventory_link": 1,
"expression": "server",
"iconid": "3"
},
{
"inventory_link": 1,
"expression": "switch",
"iconid": "4"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"iconmapids": [
"2"
]
},
"id": 1
}
```
#### Create an image
Create a cloud icon.
Request:
```json
{
"jsonrpc": "2.0",
"method": "image.create",
"params": {
"imagetype": 1,
"name": "Cloud_(24)",
"image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAANCAYAAACzbK7QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAACmAAAApgBNtNH3wAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAIcSURBVDjLrZLbSxRRHMdPKiEiRQ89CD0s+N5j9BIMEf4Hg/jWexD2ZEXQbC9tWUFZimtLhswuZiVujK1UJmYXW9PaCUdtb83enL3P7s6ss5f5dc7EUsmqkPuFH3M4/Ob7+V0OAgC0UyDENFEU03rh1uNOs/lFG75o2i2/rkd9Y3Tgyj3HiaezbukdH9A/rP4E9vWi0u+Y4fuGnMf3DRgYc3Z/84YrQSkD3mgKhFAC+KAEK74Y2Lj3MjPoOokQ3Xyx/1GHeXCifbfO6lRPH/wi+AvZQhGSsgKxdB5CCRkCGPbDgMXBMbukTc4vK5/WRHizsq7fZl2LFuvE4T0BZDTXHtgv4TNUqlUolsqQL2qQwbDEXzBBTIJ7I4y/cfAENmHZF4XrY9Mc+X9HAFmoyXS2ddy1IOg6/KNyBcM0DFP/wFZFCcOy4N9Mw0YkCTOfhdL5AfZQXQBFn2t/ODXHC8FYVcoWjNEQ03qqwTJ5FdI44jg/msoB2Zd5ZKq3q6evA1FUS60bYyyj3AJf3V72HiLZJQxTtRLk1C2IYEg4mTNg63hPd1mOJd7Ict911OMNlWEf0nFxpCt16zcshTuLpGSwDDuPIfv0xzNyQYVGicC0cgUUDLM6Xp02lvvW/V2EBssnxlSGmWsxljw0znV9XfPLjTCW84r+cn7Jc8c2eWrbM6Wbe6/aTJbhJ/TNkWc9/xXW592Xb9iPkKnUfH8BKdLgFy0lDyQAAAAASUVORK5CYII="
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"imageids": [
"188"
]
},
"id": 1
}
```
#### 创建图像
创建云图标。
请求:
```json
{
"jsonrpc": "2.0",
"method": "image.create",
"params": {
"imagetype": 1,
"name": "Cloud_(24)",
"image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAANCAYAAACzbK7QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAACmAAAApgBNtNH3wAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAIcSURBVDjLrZLbSxRRHMdPKiEiRQ89CD0s+N5j9BIMEf4Hg/jWexD2ZEXQbC9tWUFZimtLhswuZiVujK1UJmYXW9PaCUdtb83enL3P7s6ss5f5dc7EUsmqkPuFH3M4/Ob7+V0OAgC0UyDENFEU03rh1uNOs/lFG75o2i2/rkd9Y3Tgyj3HiaezbukdH9A/rP4E9vWi0u+Y4fuGnMf3DRgYc3Z/84YrQSkD3mgKhFAC+KAEK74Y2Lj3MjPoOokQ3Xyx/1GHeXCifbfO6lRPH/wi+AvZQhGSsgKxdB5CCRkCGPbDgMXBMbukTc4vK5/WRHizsq7fZl2LFuvE4T0BZDTXHtgv4TNUqlUolsqQL2qQwbDEXzBBTIJ7I4y/cfAENmHZF4XrY9Mc+X9HAFmoyXS2ddy1IOg6/KNyBcM0DFP/wFZFCcOy4N9Mw0YkCTOfhdL5AfZQXQBFn2t/ODXHC8FYVcoWjNEQ03qqwTJ5FdI44jg/msoB2Zd5ZKq3q6evA1FUS60bYyyj3AJf3V72HiLZJQxTtRLk1C2IYEg4mTNg63hPd1mOJd7Ict911OMNlWEf0nFxpCt16zcshTuLpGSwDDuPIfv0xzNyQYVGicC0cgUUDLM6Xp02lvvW/V2EBssnxlSGmWsxljw0znV9XfPLjTCW84r+cn7Jc8c2eWrbM6Wbe6/aTJbhJ/TNkWc9/xXW592Xb9iPkKnUfH8BKdLgFy0lDyQAAAAASUVORK5CYII="
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"imageids": [
"188"
]
},
"id": 1
}
```
#### Create an interface with SNMP details
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.create",
"params": {
"hostid": "10456",
"main": "0",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "1601",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}"
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30063"
]
},
"id": 1
}
```
#### 创建包含 SNMP 详细信息的接口
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.create",
"params": {
"hostid": "10456",
"main": "0",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "1601",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}"
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30063"
]
},
"id": 1
}
```
Create another child service of Zabbix cluster with name "Zabbix server node 2".
Set the Problem tags as:
- Name: component
- Operation: Equals
- Value: HA node 2
Switch to the *Tags* tab and add a service tag: `Zabbix server:node 2`.
Save the new service.
创建一个名为"Zabbix server node 2"的Zabbix集群子服务。
设置问题标签如下：
- Name: component
- Operation: Equals
- Value: HA node 2
切换到*Tags*标签页并添加服务标签：`Zabbix server:node 2`。
保存新服务。
#### Create an SSH script
Create an SSH script with public key authentication that can be executed
on a host and has a context menu.
Request:
```json
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "SSH script",
"command": "my script command",
"type": 2,
"username": "John",
"publickey": "pub.key",
"privatekey": "priv.key",
"password": "secret",
"port": "12345",
"scope": 2,
"menu_path": "All scripts/SSH",
"usrgrpid": "7",
"groupid": "4"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"5"
]
},
"id": 1
}
```
#### 创建 SSH 脚本
创建一个支持公钥认证的SSH脚本，该脚本可在一个主机上执行并包含上下文菜单。
请求:
```json
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "SSH script",
"command": "my script command",
"type": 2,
"username": "John",
"publickey": "pub.key",
"privatekey": "priv.key",
"password": "secret",
"port": "12345",
"scope": 2,
"menu_path": "All scripts/SSH",
"usrgrpid": "7",
"groupid": "4"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"5"
]
},
"id": 1
}
```
#### Create a passive proxy
Create a passive proxy "Passive proxy" and assign two hosts to be
monitored by it.
Request:
```json
{
"jsonrpc": "2.0",
"method": "proxy.create",
"params": {
"host": "Passive proxy",
"status": "6",
"interface": {
"ip": "127.0.0.1",
"dns": "",
"useip": "1",
"port": "10051"
},
"hosts": [
{
"hostid": "10192"
},
{
"hostid": "10139"
}
]
},
"auth": "ab9638041ec6922cb14b07982b268f47",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10284"
]
},
"id": 1
}
```
#### 创建被动式 proxy
创建一个被动proxy"Passive proxy"并分配两个主机供其监控
请求:
```json
{
"jsonrpc": "2.0",
"method": "proxy.create",
"params": {
"host": "Passive proxy",
"status": "6",
"interface": {
"ip": "127.0.0.1",
"dns": "",
"useip": "1",
"port": "10051"
},
"hosts": [
{
"hostid": "10192"
},
{
"hostid": "10139"
}
]
},
"auth": "ab9638041ec6922cb14b07982b268f47",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10284"
]
},
"id": 1
}
```
#### Create a token
Create an enabled token that never expires and authenticates user of ID
2.
Request:
```json
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"userid": "2"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"188"
]
},
"id": 1
}
```
Create a disabled token that expires at January 21st, 2021. This token
will authenticate current user.
Request:
```json
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"status": "1",
"expires_at": "1611238072"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"189"
]
},
"id": 1
}
```
#### 创建令牌
创建一个永不过期且用于认证ID为2用户的已启用令牌。
请求:
```json
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"userid": "2"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"188"
]
},
"id": 1
}
```
创建一个将于2021年1月21日过期的禁用令牌。该令牌将用于认证当前用户。
请求:
```json
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"status": "1",
"expires_at": "1611238072"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"189"
]
},
"id": 1
}
```
#### Create a trigger action
Create an action that will be run when a trigger from host "10084" that
has the word "memory" in its name goes into problem state. The action
must first send a message to all users in user group "7". If the event
is not resolved in 4 minutes, it will run script "3" on all hosts in
group "2". On trigger recovery it will notify all users who received any
messages regarding the problem before. On trigger update, message with
custom subject and body will be sent to all who left acknowledgments and
comments via all media types.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Trigger action",
"eventsource": 0,
"status": 0,
"esc_period": "2m",
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 1,
"operator": 0,
"value": "10084"
},
{
"conditiontype": 3,
"operator": 2,
"value": "memory"
}
]
},
"operations": [
{
"operationtype": 0,
"esc_period": "0s",
"esc_step_from": 1,
"esc_step_to": 2,
"evaltype": 0,
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage": {
"default_msg": 1,
"mediatypeid": "1"
}
},
{
"operationtype": 1,
"esc_step_from": 3,
"esc_step_to": 4,
"evaltype": 0,
"opconditions": [
{
"conditiontype": 14,
"operator": 0,
"value": "0"
}
],
"opcommand_grp": [
{
"groupid": "2"
}
],
"opcommand": {
"scriptid": "3"
}
}
],
"recovery_operations": [
{
"operationtype": "11",
"opmessage": {
"default_msg": 1
}
}
],
"update_operations": [
{
"operationtype": "12",
"opmessage": {
"default_msg": 0,
"message": "Custom update operation message body",
"subject": "Custom update operation message subject"
}
}
],
"pause_suppressed": "0",
"notify_if_canceled": "0"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"17"
]
},
"id": 1
}
```
#### 创建触发器动作
创建一个动作，动作如下描述，当主机 `30045` ，它的触发器中的 `memory`
进入问题状态时。该动作必须首先向用户组 `7`
中的所有用户发送消息。如果事件在 4 分钟内未被解决，它将在 `2`
组中的所有主机上运行脚本
`3`。在触发恢复中，它将通知所有接收到关于该问题的消息的用户。在触发器确认中，带有自定义主体和主体的消息将通过所有媒体类型发送给所有确认和评论的所有人。
请求:
``` {.java}
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Trigger action",
"eventsource": 0,
"status": 0,
"esc_period": "2m",
"def_shortdata": "{TRIGGER.NAME}: {TRIGGER.STATUS}",
"def_longdata": "{TRIGGER.NAME}: {TRIGGER.STATUS}\r\nLast value: {ITEM.LASTVALUE}\r\n\r\n{TRIGGER.URL}",
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 1,
"operator": 0,
"value": "10084"
},
{
"conditiontype": 3,
"operator": 2,
"value": "memory"
}
]
},
"operations": [
{
"operationtype": 0,
"esc_period": "0s",
"esc_step_from": 1,
"esc_step_to": 2,
"evaltype": 0,
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage": {
"default_msg": 1,
"mediatypeid": "1"
}
},
{
"operationtype": 1,
"esc_step_from": 3,
"esc_step_to": 4,
"evaltype": 0,
"opconditions": [
{
"conditiontype": 14,
"operator": 0,
"value": "0"
}
],
"opcommand_grp": [
{
"groupid": "2"
}
],
"opcommand": {
"type": 4,
"scriptid": "3"
}
}
],
"recovery_operations": [
{
"operationtype": "11",
"opmessage": {
"default_msg": 1
}
}
],
"acknowledge_operations": [
{
"operationtype": "12",
"opmessage": {
"message": "Custom acknowledge operation message body",
"subject": "Custom acknowledge operation message subject"
}
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"17"
]
},
"id": 1
}
```
#### Create a trigger action
Create a trigger action that will begin once a trigger (with the word "memory" in its name) from host "10084" goes into a PROBLEM state.
The action will have 4 configured operations.
The first and immediate operation will send a message to all users in user group "7" via media type "1".
If the event is not resolved in 30 minutes, the second operation will run [script](/manual/web_interface/frontend_sections/administration/scripts#configuring-a-global-script) "5" (script with scope "Action operation") on all hosts in group "2".
If the event is resolved, a recovery operation will notify all users who received any messages regarding the problem.
If the event is updated, an acknowledge/update operation will notify (with a custom subject and message) all users who received any messages regarding the problem.
Request:
```json
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Trigger action",
"eventsource": 0,
"esc_period": "30m",
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 1,
"operator": 0,
"value": "10084"
},
{
"conditiontype": 3,
"operator": 2,
"value": "memory"
}
]
},
"operations": [
{
"operationtype": 0,
"esc_step_from": 1,
"esc_step_to": 1,
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage": {
"default_msg": 1,
"mediatypeid": "1"
}
},
{
"operationtype": 1,
"esc_step_from": 2,
"esc_step_to": 2,
"opconditions": [
{
"conditiontype": 14,
"operator": 0,
"value": "0"
}
],
"opcommand_grp": [
{
"groupid": "2"
}
],
"opcommand": {
"scriptid": "5"
}
}
],
"recovery_operations": [
{
"operationtype": "11",
"opmessage": {
"default_msg": 1
}
}
],
"update_operations": [
{
"operationtype": "12",
"opmessage": {
"default_msg": 0,
"message": "Custom update operation message body",
"subject": "Custom update operation message subject"
}
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"17"
]
},
"id": 1
}
```
#### 创建触发器动作
创建一个触发器动作，当来自主机 "10084"的触发器（名称中包含"memory"字样）进入PROBLEM状态时触发。
该动作将配置4个操作。
第一个即时操作将通过媒介类型"1"向用户组"7"中的所有用户发送消息。
如果事件在30分钟内未解决，第二个操作将在组"2"中的所有主机上run[配置全局脚本](/manual/web_interface/frontend_sections/administration/scripts#配置全局脚本)"5"（作用域为"Action operation"的脚本）。
如果事件解决，恢复操作将通知所有收到过该问题相关消息的用户。
如果事件更新，acknowledge/update操作将以自定义主题和消息通知所有收到过该问题相关消息的用户。
请求:
```json
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Trigger action",
"eventsource": 0,
"esc_period": "30m",
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 1,
"operator": 0,
"value": "10084"
},
{
"conditiontype": 3,
"operator": 2,
"value": "memory"
}
]
},
"operations": [
{
"operationtype": 0,
"esc_step_from": 1,
"esc_step_to": 1,
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage": {
"default_msg": 1,
"mediatypeid": "1"
}
},
{
"operationtype": 1,
"esc_step_from": 2,
"esc_step_to": 2,
"opconditions": [
{
"conditiontype": 14,
"operator": 0,
"value": "0"
}
],
"opcommand_grp": [
{
"groupid": "2"
}
],
"opcommand": {
"scriptid": "5"
}
}
],
"recovery_operations": [
{
"operationtype": "11",
"opmessage": {
"default_msg": 1
}
}
],
"update_operations": [
{
"operationtype": "12",
"opmessage": {
"default_msg": 0,
"message": "Custom update operation message body",
"subject": "Custom update operation message subject"
}
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"17"
]
},
"id": 1
}
```
#### Create a trigger map
Create a map with trigger element, which contains two triggers.
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Trigger map",
"width": 600,
"height": 600,
"selements": [
{
"elements": [
{"triggerid": "12345"},
{"triggerid": "67890"}
],
"elementtype": 2,
"iconid_off": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"10"
]
},
"id": 1
}
```
#### 创建触发器映射
创建一个包含触发器元素的地图，该地图包含两个触发器。
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Trigger map",
"width": 600,
"height": 600,
"selements": [
{
"elements": [
{"triggerid": "12345"},
{"triggerid": "67890"}
],
"elementtype": 2,
"iconid_off": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"10"
]
},
"id": 1
}
```
#### Create a webhook script
Create a webhook script that sends HTTP request to external service.
Request:
```json
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Webhook script",
"command": "try {\n var request = new HttpRequest(),\n response,\n data;\n\n request.addHeader('Content-Type: application/json');\n\n response = request.post('https://localhost/post', value);\n\n try {\n response = JSON.parse(response);\n }\n catch (error) {\n response = null;\n }\n\n if (request.getStatus() !== 200 || !('data' in response)) {\n throw 'Unexpected response.';\n }\n\n data = JSON.stringify(response.data);\n\n Zabbix.Log(3, '[Webhook Script] response data: ' + data);\n\n return data;\n}\ncatch (error) {\n Zabbix.Log(3, '[Webhook Script] script execution failed: ' + error);\n throw 'Execution failed: ' + error + '.';\n}",
"type": 5,
"timeout": "40s",
"parameters": [
{
"name": "token",
"value": "{$WEBHOOK.TOKEN}"
},
{
"name": "host",
"value": "{HOST.HOST}"
},
{
"name": "v",
"value": "2.2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"3"
]
},
"id": 1
}
```
#### 创建 webhook 脚本
创建一个向外部服务发送HTTP请求的webhook脚本。
请求:
```json
{
"jsonrpc": "2.0",
"method": "script.create",
"params": {
"name": "Webhook script",
"command": "try {\n var request = new HttpRequest(),\n response,\n data;\n\n request.addHeader('Content-Type: application/json');\n\n response = request.post('https://localhost/post', value);\n\n try {\n response = JSON.parse(response);\n }\n catch (error) {\n response = null;\n }\n\n if (request.getStatus() !== 200 || !('data' in response)) {\n throw 'Unexpected response.';\n }\n\n data = JSON.stringify(response.data);\n\n Zabbix.Log(3, '[Webhook Script] response data: ' + data);\n\n return data;\n}\ncatch (error) {\n Zabbix.Log(3, '[Webhook Script] script execution failed: ' + error);\n throw 'Execution failed: ' + error + '.';\n}",
"type": 5,
"timeout": "40s",
"parameters": [
{
"name": "token",
"value": "{$WEBHOOK.TOKEN}"
},
{
"name": "host",
"value": "{HOST.HOST}"
},
{
"name": "v",
"value": "2.2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"3"
]
},
"id": 1
}
```
#### Create HTTP agent item
Create POST request method item with JSON response preprocessing.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"url": "http://127.0.0.1/http.php",
"query_fields": [
{
"mode": "json"
},
{
"min": "10"
},
{
"max": "100"
}
],
"interfaceid": "1",
"type": 19,
"hostid": "10254",
"delay": "5s",
"key_": "json",
"name": "HTTP agent example JSON",
"value_type": 0,
"output_format": 1,
"preprocessing": [
{
"type": 12,
"params": "$.random",
"error_handler": 0,
"error_handler_params": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### 创建 HTTP agent 监控项
创建POST请求方法监控项并预处理JSON响应.
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"url": "http://127.0.0.1/http.php",
"query_fields": [
{
"mode": "json"
},
{
"min": "10"
},
{
"max": "100"
}
],
"interfaceid": "1",
"type": 19,
"hostid": "10254",
"delay": "5s",
"key_": "json",
"name": "HTTP agent example JSON",
"value_type": 0,
"output_format": 1,
"preprocessing": [
{
"type": 12,
"params": "$.random",
"error_handler": 0,
"error_handler_params": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### Create HTTP agent item prototype
Create item prototype with URL using user macro, query fields and custom
headers.
Request:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"type": "19",
"hostid": "10254",
"ruleid": "28256",
"interfaceid": "2",
"name": "api item prototype example",
"key_": "api_http_item",
"value_type": 3,
"url": "{$URL_PROTOTYPE}",
"query_fields": [
{
"min": "10"
},
{
"max": "100"
}
],
"headers": {
"X-Source": "api"
},
"delay": "35"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"28305"
]
},
"id": 1
}
```
#### 创建 HTTP agent 监控项 原型
使用用户宏、query字段和自定义头部创建带URL的监控项原型
请求:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"type": "19",
"hostid": "10254",
"ruleid": "28256",
"interfaceid": "2",
"name": "api item prototype example",
"key_": "api_http_item",
"value_type": 3,
"url": "{$URL_PROTOTYPE}",
"query_fields": [
{
"min": "10"
},
{
"max": "100"
}
],
"headers": {
"X-Source": "api"
},
"delay": "35"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"28305"
]
},
"id": 1
}
```
#### Create script item
Create a simple data collection using a script item.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Script example",
"key_": "custom.script.item",
"hostid": "12345",
"type": 21,
"value_type": 4,
"params": "var request = new CurlHttpRequest();\nreturn request.Post(\"https://postman-echo.com/post\", JSON.parse(value));",
"parameters": [
{
"name": "host",
"value": "{HOST.CONN}"
}
],
"timeout": "6s",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### 创建脚本 监控项
使用脚本监控项创建简单数据收集
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Script example",
"key_": "custom.script.item",
"hostid": "12345",
"type": 21,
"value_type": 4,
"params": "var request = new CurlHttpRequest();\nreturn request.Post(\"https://postman-echo.com/post\", JSON.parse(value));",
"parameters": [
{
"name": "host",
"value": "{HOST.CONN}"
}
],
"timeout": "6s",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### Create script item prototype
Create a simple data collection using a script item prototype.
Request:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"name": "Script example",
"key_": "custom.script.itemprototype",
"hostid": "12345",
"type": 21,
"value_type": 4,
"params": "var request = new CurlHttpRequest();\nreturn request.Post(\"https://postman-echo.com/post\", JSON.parse(value));",
"parameters": [
{
"name": "host",
"value": "{HOST.CONN}"
}
],
"timeout": "6s",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### 创建脚本 监控项 原型
使用脚本监控项原型创建一个简单的数据收集。
请求:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"name": "Script example",
"key_": "custom.script.itemprototype",
"hostid": "12345",
"type": 21,
"value_type": 4,
"params": "var request = new CurlHttpRequest();\nreturn request.Post(\"https://postman-echo.com/post\", JSON.parse(value));",
"parameters": [
{
"name": "host",
"value": "{HOST.CONN}"
}
],
"timeout": "6s",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### Create script LLD rule
Create a simple data collection using a script LLD rule.
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Script example",
"key_": "custom.script.lldrule",
"hostid": "12345",
"type": 21,
"params": "var request = new CurlHttpRequest();\nreturn request.Post(\"https://postman-echo.com/post\", JSON.parse(value));",
"parameters": [
{
"name": "host",
"value": "{HOST.CONN}"
}
],
"timeout": "6s",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### 创建脚本LLD规则
使用脚本LLD规则创建简单数据收集
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Script example",
"key_": "custom.script.lldrule",
"hostid": "12345",
"type": 21,
"params": "var request = new CurlHttpRequest();\nreturn request.Post(\"https://postman-echo.com/post\", JSON.parse(value));",
"parameters": [
{
"name": "host",
"value": "{HOST.CONN}"
}
],
"timeout": "6s",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"23865"
]
},
"id": 3
}
```
#### Creating a dashboard
Create a dashboard named "My dashboard" with one Problems widget with
tags and using two types of sharing (user group and user) on a single
dashboard page.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "tags.tag.0",
"value": "service"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 1
},
{
"type": 1,
"name": "tags.value.0",
"value": "zabbix_server"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": "7",
"permission": 2
}
],
"users": [
{
"userid": "4",
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 1
}
```
#### 创建仪表板
创建一个名为"My dashboard"的仪表板，在单个仪表板页面上包含一个带标签的Problems部件，并使用两种共享类型（用户组和用户）。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "tags.tag.0",
"value": "service"
},
{
"type": 0,
"name": "tags.operator.0",
"value": 1
},
{
"type": 1,
"name": "tags.value.0",
"value": "zabbix_server"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": "7",
"permission": 2
}
],
"users": [
{
"userid": "4",
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 1
}
```
#### Creating a dashboard
It is possible to create a new dashboard in two ways:
- Click on *Create dashboard*, when viewing all dashboards
- Select *Create new* from the action menu, when viewing a single
dashboard
You will be first asked to enter general dashboard parameters:
|Parameter|Description|
|--|--------|
|*Owner*|Select system user that will be the dashboard owner.|
|*Name*|Enter dashboard name.|
|*Default page display period*|Select period for how long a dashboard page is displayed before rotating to the next page in a [slideshow](#creating_a_slideshow).|
|*Start slideshow automatically*|Mark this checkbox to run a slideshow automatically one more than one dashboard page exists.|
When you click on *Apply*, an empty dashboard is opened:
{width="600"}
To populate the dashboard, you can add widgets and pages.
Click on the *Save changes* button to save the dashboard. If you click
on *Cancel*, the dashboard will not be created.
#### 创建仪表板
可以通过两种方式create新仪表板:
- 在查看所有仪表板时点击*创建仪表板*
- 在查看单个仪表板时从操作菜单中选择*新建*
dashboard
首先需要输入仪表板的一般参数:
| 参数 | 描述 |
|--|--------|
| *Owner* | 选择将成为仪表板所有者的系统用户。 |
| *Name* | 输入仪表板名称。 |
| *Default page display period* | 为[幻灯片放映](#creating_a_slideshow)选择仪表板页面在轮换到下一页之前显示的时长。 |
| *Start slideshow automatically* | 勾选此复选框以run当存在多个仪表板页面时自动启动幻灯片放映。 |
点击*应用*后，将打开一个空仪表板:
{width="600"}
要填充仪表板，可以添加小部件和页面。
点击*保存更改*按钮保存仪表板。如果点击
*取消*，则不会创建仪表板。
#### Creating a global macro
Create a global macro "{$SNMP\_COMMUNITY}" with value "public".
Request:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.createglobal",
"params": {
"macro": "{$SNMP_COMMUNITY}",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"globalmacroids": [
"6"
]
},
"id": 1
}
```
#### 创建全局宏
创建全局宏"{$SNMP\_COMMUNITY}"，值为"public"。
请求:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.createglobal",
"params": {
"macro": "{$SNMP_COMMUNITY}",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"globalmacroids": [
"6"
]
},
"id": 1
}
```
#### Creating a graph
Create a graph with two items.
Request:
```json
{
"jsonrpc": "2.0",
"method": "graph.create",
"params": {
"name": "MySQL bandwidth",
"width": 900,
"height": 200,
"gitems": [
{
"itemid": "22828",
"color": "00AA00"
},
{
"itemid": "22829",
"color": "3333FF"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652"
]
},
"id": 1
}
```
#### 创建图表
创建包含两个监控项的图表.
请求:
```json
{
"jsonrpc": "2.0",
"method": "graph.create",
"params": {
"name": "MySQL bandwidth",
"width": 900,
"height": 200,
"gitems": [
{
"itemid": "22828",
"color": "00AA00"
},
{
"itemid": "22829",
"color": "3333FF"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652"
]
},
"id": 1
}
```
#### Creating a graph prototype
Create a graph prototype with two items.
Request:
```json
{
"jsonrpc": "2.0",
"method": "graphprototype.create",
"params": {
"name": "Disk space usage {#FSNAME}",
"width": 900,
"height": 200,
"gitems": [
{
"itemid": "22828",
"color": "00AA00"
},
{
"itemid": "22829",
"color": "3333FF"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652"
]
},
"id": 1
}
```
#### 创建图形原型
创建一个包含两个监控项的图形原型.
请求:
```json
{
"jsonrpc": "2.0",
"method": "graphprototype.create",
"params": {
"name": "Disk space usage {#FSNAME}",
"width": 900,
"height": 200,
"gitems": [
{
"itemid": "22828",
"color": "00AA00"
},
{
"itemid": "22829",
"color": "3333FF"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652"
]
},
"id": 1
}
```
#### Creating a host
Create a host called "Linux server" with an IP interface and tags, add
it to a group, link a template to it and set the MAC addresses in the
host inventory.
Request:
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "Linux server",
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "50"
}
],
"tags": [
{
"tag": "Host name",
"value": "Linux server"
}
],
"templates": [
{
"templateid": "20045"
}
],
"macros": [
{
"macro": "{$USER_ID}",
"value": "123321"
},
{
"macro": "{$USER_LOCATION}",
"value": "0:0:0",
"description": "latitude, longitude and altitude coordinates"
}
],
"inventory_mode": 0,
"inventory": {
"macaddress_a": "01234",
"macaddress_b": "56768"
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"107819"
]
},
"id": 1
}
```
#### 创建主机
创建名为"Linux服务器"的一个主机，配置IP接口和标签，
将其添加到主机组，关联模板并在主机资产清单中设置MAC地址。
请求:
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "Linux server",
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "50"
}
],
"tags": [
{
"tag": "Host name",
"value": "Linux server"
}
],
"templates": [
{
"templateid": "20045"
}
],
"macros": [
{
"macro": "{$USER_ID}",
"value": "123321"
},
{
"macro": "{$USER_LOCATION}",
"value": "0:0:0",
"description": "latitude, longitude and altitude coordinates"
}
],
"inventory_mode": 0,
"inventory": {
"macaddress_a": "01234",
"macaddress_b": "56768"
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"107819"
]
},
"id": 1
}
```
#### Creating a host group
Create a host group called "Linux servers".
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostgroup.create",
"params": {
"name": "Linux servers"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"107819"
]
},
"id": 1
}
```
#### 创建主机组
创建名为"Linux servers"的一个主机组。
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostgroup.create",
"params": {
"name": "Linux servers"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"107819"
]
},
"id": 1
}
```
#### Creating a host group
::: noteimportant
Only Super Admin users can create host groups.
:::
To create a host group in Zabbix frontend, do the following:
- Go to: *Configuration → Host groups*
- Click on *Create Group* in the upper right corner of the screen
- Enter parameters of the group in the form
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|---------|-----------|
|*Group name*|Enter a unique host group name.<br>To create a nested host group, use the '/' forward slash separator, for example `Europe/Latvia/Riga/Zabbix servers`. You can create this group even if none of the three parent host groups (`Europe/Latvia/Riga`) exist. In this case creating these parent host groups is up to the user; they will not be created automatically.<br>Leading and trailing slashes, several slashes in a row are not allowed. Escaping of '/' is not supported.<br>Nested representation of host groups is supported since Zabbix 3.2.0.|
|*Apply permissions and tag filters to all subgroups*|Checkbox is available to Super Admin users only and only when editing an existing host group.<br>Mark this checkbox and click on *Update* to apply the same level of permissions/tag filters to all nested host groups. For user groups that may have had differing [permissions](/manual/config/users_and_usergroups/usergroup#configuration) assigned to nested host groups, the permission level of the parent host group will be enforced on the nested groups.<br>This is a one-time option that is not saved in the database.<br>This option is supported since Zabbix 3.4.0.|
**Permissions to nested host groups**
- When creating a child host group to an existing parent host group,
[user group](/manual/config/users_and_usergroups/usergroup)
permissions to the child are inherited from the parent (for example,
when creating `Riga/Zabbix servers` if `Riga` already exists)
- When creating a parent host group to an existing child host group,
no permissions to the parent are set (for example, when creating
`Riga` if `Riga/Zabbix servers` already exists)
#### 创建主机组
::: noteimportant
只有 Super Admin users（超级管理员用户） 可以创建主机组。
:::
要在 Zabbix 前端创建主机组，请执行以下操作：
- 点击： *Configuration（配置） → Host groups（主机群组）*
- 单机屏幕右上角 *Create Group（创建主机群组）*
- 在表单中输入主机群组的相关参数
所有标有红色星号的字段为必填项。
|参数|描述|
|---------|-----------|
|*Group name（群组名）*|输入唯一的主机组名称。<br>要创建嵌套主机组，请使用 '/' 正斜杠分隔符，例如 `Europe/Latvia/Riga/Zabbix servers`。 即使三个父主机组 (`Europe/Latvia/Riga`) 都不存在，也可以创建此组。在这种情况下，是否创建这些父主机群组取决于用户；它们不会自动创建。<br>不允许字符串最前和最后出现斜杠、不允许连续出现多个斜杠。不支持转义 '/' 。<br>自 Zabbix 3.2.0 起支持主机组的嵌套模式。|
|*Apply permissions and tag filters to all subgroups（应用权限和标签过滤器到所有子组）*|复选框仅对超级管理员用户可用且仅在编辑已存在的主机组时可用。<br>标记此复选框并单击 *Update（更新）* 以将相同级别的权限/标签过滤器应用于所有嵌套主机组。对于可能为嵌套主机组分配了不同 [权限](/manual/config/users_and_usergroups/usergroup#configuration) 的用户组，将对嵌套组强制执行父主机组的权限级别。<br>这是不保存在数据库中的一次性选项。<br>自 Zabbix 3.4.0 起支持此选项。|
**嵌套主机组的权限**
- 为已存在的父主机组创建子主机组时，子主机组的 [用户组](/manual/config/users_and_usergroups/usergroup)权限从父主机继承（例如，在父主机群组 `Riga` 已经存在的情况下创建子主机群组 `Riga/Zabbix servers`）
- 为已存在的子主机组创建父主机组时，不会设置父主机组的权限（例如，在子主机群组 `Riga/Zabbix servers` 已经存在的情况下创建父主机群组 `Riga` ）
#### Creating a host inventory item
Create a Zabbix agent item to populate the host's "OS" inventory field.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "uname",
"key_": "system.uname",
"hostid": "30021",
"type": 0,
"interfaceid": "30007",
"value_type": 1,
"delay": "10s",
"inventory_link": 5
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"24759"
]
},
"id": 1
}
```
#### 创建主机清单 监控项
创建一个Zabbix agent 监控项来填充主机的"OS"资产字段.
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "uname",
"key_": "system.uname",
"hostid": "30021",
"type": 0,
"interfaceid": "30007",
"value_type": 1,
"delay": "10s",
"inventory_link": 5
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"24759"
]
},
"id": 1
}
```
#### Creating a host macro
Create a host macro "{$SNMP\_COMMUNITY}" with the value "public" on host
"10198".
Request:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.create",
"params": {
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostmacroids": [
"11"
]
},
"id": 1
}
```
#### 创建主机宏
在主机 "10198"上创建值为"public"的一个主机宏"{$SNMP\_COMMUNITY}".
请求:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.create",
"params": {
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostmacroids": [
"11"
]
},
"id": 1
}
```
#### Creating a host prototype
Create a host prototype "{\#VM.NAME}" on LLD rule "23542" with a group
prototype "{\#HV.NAME}", tag pair "Datacenter": "{\#DATACENTER.NAME}"
and custom SNMPv2 interface 127.0.0.1:161 with community
{$SNMP\_COMMUNITY}. Link it to host group "2".
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostprototype.create",
"params": {
"host": "{#VM.NAME}",
"ruleid": "23542",
"custom_interfaces": "1",
"groupLinks": [
{
"groupid": "2"
}
],
"groupPrototypes": [
{
"name": "{#HV.NAME}"
}
],
"tags": [
{
"tag": "Datacenter",
"value": "{#DATACENTER.NAME}"
}
],
"interfaces": [
{
"main": "1",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}"
}
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10103"
]
},
"id": 1
}
```
#### 创建主机原型
在LLD规则"23542"上创建一个主机原型"{\#VM.NAME}"，附带组原型"{\#HV.NAME}"、标签对"Datacenter": "{\#DATACENTER.NAME}"
以及自定义SNMPv2接口127.0.0.1:161（团体名为{$SNMP\_COMMUNITY}）。将其链接至主机组 "2"。
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostprototype.create",
"params": {
"host": "{#VM.NAME}",
"ruleid": "23542",
"custom_interfaces": "1",
"groupLinks": [
{
"groupid": "2"
}
],
"groupPrototypes": [
{
"name": "{#HV.NAME}"
}
],
"tags": [
{
"tag": "Datacenter",
"value": "{#DATACENTER.NAME}"
}
],
"interfaces": [
{
"main": "1",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}"
}
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10103"
]
},
"id": 1
}
```
#### Creating a host with PSK encryption
Create a host called "PSK host" with PSK encryption configured.
Note that the host has to be [pre-configured to use PSK](/manual/encryption/using_pre_shared_keys#configuring-psk-for-server-agent-communication-example).
Request:
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "PSK host",
"interfaces": [
{
"type": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050",
"useip": 1,
"main": 1
}
],
"groups": [
{
"groupid": "2"
}
],
"tls_accept": 2,
"tls_connect": 2,
"tls_psk_identity": "PSK 001",
"tls_psk": "1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10590"
]
},
"id": 1
}
```
#### 创建使用PSK加密的主机
创建名为"PSK 主机"的一个主机并配置PSK加密
注意主机必须[为服务器agent通信配置psk示例](/manual/encryption/using_pre_shared_keys#为服务器agent通信配置psk示例)
请求:
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "PSK host",
"interfaces": [
{
"type": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050",
"useip": 1,
"main": 1
}
],
"groups": [
{
"groupid": "2"
}
],
"tls_accept": 2,
"tls_connect": 2,
"tls_psk_identity": "PSK 001",
"tls_psk": "1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10590"
]
},
"id": 1
}
```
#### Creating a host with SNMP interface
Create a host called "SNMP host" with an SNMPv3 interface with details.
Request:
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "SNMP host",
"interfaces": [
{
"type": 2,
"main": 1,
"useip": 1,
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": 3,
"bulk": 0,
"securityname": "mysecurityname",
"contextname": "",
"securitylevel": 1
}
}
],
"groups": [
{
"groupid": "4"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10658"
]
},
"id": 1
}
```
#### 创建带有 SNMP 接口的主机
创建名为"SNMP 主机"的一个主机，并配置包含详细信息的SNMPv3接口。
请求:
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "SNMP host",
"interfaces": [
{
"type": 2,
"main": 1,
"useip": 1,
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": 3,
"bulk": 0,
"securityname": "mysecurityname",
"contextname": "",
"securitylevel": 1
}
}
],
"groups": [
{
"groupid": "4"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10658"
]
},
"id": 1
}
```
#### Creating a maintenance
Create a maintenance with data collection for host group "2" with
problem tags **<service:mysqld>** and **error**. It must be active from
22.01.2013 till 22.01.2014, come in effect each Sunday at 18:00 and last
for one hour.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "maintenance.create",
"params": {
"name": "Sunday maintenance",
"active_since": 1358844540,
"active_till": 1390466940,
"tags_evaltype": 0,
"groupids": [
"2"
],
"timeperiods": [
{
"timeperiod_type": 3,
"every": 1,
"dayofweek": 64,
"start_time": 64800,
"period": 3600
}
],
"tags": [
{
"tag": "service",
"operator": "0",
"value": "mysqld"
},
{
"tag": "error",
"operator": "2",
"value": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### Creating a maintenance 创建一个维护模式
Create a maintenance with data collection for host group "2". It must be
active from 22.01.2013 till 22.01.2014, come in effect each Sunday at
18:00 and last for one hour. 为主机组"2"以with data
collection(持续收集数据)模式创建一个维护模式。该维护模式生效于22.01.2013
到 22.01.2014，每周六的18:00生效，并持续1个小时。
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "maintenance.create",
"params": {
"name": "Sunday maintenance",
"active_since": 1358844540,
"active_till": 1390466940,
"groupids": [
"2"
],
"timeperiods": [
{
"timeperiod_type": 3,
"every": 1,
"dayofweek": 64,
"start_time": 64800,
"period": 3600
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### Creating a maintenance
Create a maintenance with data collection for host group with ID "2" and with
problem tags **service:mysqld** and **error**. It must be active from
22.01.2013 till 22.01.2014, come in effect each Sunday at 18:00 and last
for one hour.
Request:
```json
{
"jsonrpc": "2.0",
"method": "maintenance.create",
"params": {
"name": "Sunday maintenance",
"active_since": 1358844540,
"active_till": 1390466940,
"tags_evaltype": 0,
"groups": [
{"groupid": "2"}
],
"timeperiods": [
{
"period": 3600,
"timeperiod_type": 3,
"start_time": 64800,
"every": 1,
"dayofweek": 64
}
],
"tags": [
{
"tag": "service",
"operator": "0",
"value": "mysqld"
},
{
"tag": "error",
"operator": "2",
"value": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### 创建维护周期
创建一个针对ID为"2"的主机组的数据收集维护周期，需包含问题标签**service:mysqld**和**error**。该维护周期从2013年1月22日生效至2014年1月22日，每周日18:00开始执行，持续1小时。
请求:
```json
{
"jsonrpc": "2.0",
"method": "maintenance.create",
"params": {
"name": "Sunday maintenance",
"active_since": 1358844540,
"active_till": 1390466940,
"tags_evaltype": 0,
"groups": [
{"groupid": "2"}
],
"timeperiods": [
{
"period": 3600,
"timeperiod_type": 3,
"start_time": 64800,
"every": 1,
"dayofweek": 64
}
],
"tags": [
{
"tag": "service",
"operator": "0",
"value": "mysqld"
},
{
"tag": "error",
"operator": "2",
"value": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3"
]
},
"id": 1
}
```
#### Creating a map
To create a map, do the following:
- Go to *Monitoring → Maps*
- Go to the view with all maps
- Click on *Create map*
You can also use the *Clone* and *Full clone* buttons in the
configuration form of an existing map to create a new map. Clicking on
*Clone* will retain general layout attributes of the original map, but
no elements. *Full clone* will retain both the general layout attributes
and all elements of the original map.
The **Map** tab contains general map attributes:
All mandatory input fields are marked with a red asterisk.
General map attributes:
|Parameter|Description|
|--|--------|
|*Owner*|Name of map owner.|
|*Name*|Unique map name.|
|*Width*|Map width in pixels.|
|*Height*|Map height in pixels.|
|*Background image*|Use background image:<br>**No image** - no background image (white background)<br>**Image** - selected image to be used as a background image. No scaling is performed. You may use a geographical map or any other image to enhance your map.|
|*Automatic icon mapping*|You can set to use an automatic icon mapping, configured in *Administration → General → Icon mapping*. Icon mapping allows mapping certain icons against certain host inventory fields.|
|*Icon highlight*|If you check this box, map elements will be highlighted.<br>Elements with an active trigger will receive a round background, in the same color as the highest severity trigger. Moreover, a thick green line will be displayed around the circle, if all problems are acknowledged.<br>Elements with "disabled" or "in maintenance" status will get a square background, gray and orange respectively.<br>See also: [Viewing maps](/manual/web_interface/frontend_sections/monitoring/maps#viewing_maps)|
|*Mark elements on trigger status change*|A recent change of trigger status (recent problem or resolution) will be highlighted with markers (inward-pointing red triangles) on the three sides of the element icon that are free of the label. Markers are displayed for 30 minutes.|
|*Display problems*|Select how problems are displayed with a map element:<br>**Expand single problem** - if there is only one problem, the problem name is displayed. Otherwise, the total number of problems is displayed.<br>**Number of problems** - the total number of problems is displayed<br>**Number of problems and expand most critical one** - the name of the most critical problem and the total number of problems is displayed.<br>'Most critical' is determined based on problem severity and, if equal, problem event ID (higher ID or later problem displayed first). For a *trigger map element* it is based on problem severity and if equal, trigger position in the trigger list. In case of multiple problems of the same trigger, the most recent one will be displayed.|
|*Advanced labels*|If you check this box you will be able to define separate label types for separate element types.|
|*Map element label type*|Label type used for map elements:<br>**Label** - map element label<br>**IP address** - IP address<br>**Element name** - element name (for example, host name)<br>**Status only** - status only (OK or PROBLEM)<br>**Nothing** - no labels are displayed|
|*Map element label location*|Label location in relation to the map element:<br>**Bottom** - beneath the map element<br>**Left** - to the left<br>**Right** - to the right<br>**Top** - above the map element|
|*Problem display*|Display problem count as:<br>**All** - full problem count will be displayed<br>**Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count<br>**Unacknowledged only** - only the unacknowledged problem count will be displayed|
|*Minimum trigger severity*|Problems below the selected minimum severity level will not be displayed on the map.<br>For example, with *Warning* selected, changes with *Information* and *Not classified* level triggers will not be reflected in the map.<br>This parameter is supported starting with Zabbix 2.2.|
|*Show suppressed problems*|Mark the checkbox to display problems that would otherwise be suppressed (not shown) because of host maintenance.|
|*URLs*|URLs for each element type can be defined (with a label). These will be displayed as links when a user clicks on the element in the map viewing mode.<br>Macros can be used in map URL names and values. For a full list, see [supported macros](/manual/appendix/macros/supported_by_location) and search for 'map URL names and values'.|
#### 创建地图
要create地图，请执行以下操作：
- 前往*监控 → 地图*
- 进入包含所有地图的视图
- 点击*创建地图*
您也可以在现有地图的配置表单中使用*克隆*和*完全克隆*按钮来create新地图。点击*克隆*将保留原始地图的常规布局属性，但不包含元素。*完全克隆*将同时保留原始地图的常规布局属性和所有元素。
**地图**选项卡包含常规地图属性：
所有必填字段均以红色星号标记。
常规地图属性：
| 参数 | 描述 |
|--|--------|
| *Owner* | 地图所有者的名称。 |
| *Name* | 唯一的地图名称。 |
| *Width* | 地图宽度（像素）。 |
| *Height* | 地图高度（像素）。 |
| *Background image* | 使用背景图像：<br>**无图像** - 无背景图像（白色背景）<br>**图像** - 使用选定图像作为背景图像。不进行缩放。您可以使用地理地图或其他图像来增强地图效果。 |
| *Automatic icon mapping* | 您可以设置为使用自动图标映射，配置路径为*管理 → 常规 → 图标映射*。图标映射允许将特定图标映射到特定主机资产字段。 |
| *Icon highlight* | 勾选此框将高亮显示地图元素。<br>具有活动触发器的元素将获得圆形背景，颜色与最高严重性触发器相同。此外，如果所有问题均已确认，圆圈周围将显示一条粗绿色边框。<br>状态为"禁用"或"维护中"的元素将get方形背景，分别为灰色和橙色。<br>另请参阅：[查看网络拓扑图](/manual/web_interface/frontend_sections/monitoring/maps#查看网络拓扑图) |
| *Mark elements on trigger status change* | 触发器状态的最近变化（最近的问题或解决）将通过标记（向内指向的红色三角形）在元素图标的三侧高亮显示。标记显示30分钟。 |
| *Display problems* | 选择如何在地图元素上显示问题：<br>**展开单个问题** - 如果只有一个问题，则显示问题名称。否则，显示问题总数。<br>**问题数量** - 显示问题总数<br>**问题数量并展开最严重的一个** - 显示最严重问题的名称和问题总数。<br>'最严重'基于问题严重性确定，如果相同，则基于问题事件ID（较高ID或较晚问题优先显示）。对于*触发器地图元素*，基于问题严重性，如果相同，则基于触发器在触发器列表中的位置。如果同一触发器有多个问题，将显示最近的一个。 |
| *Advanced labels* | 勾选此框可为不同元素类型定义单独的标签类型。 |
| *Map element label type* | 用于地图元素的标签类型：<br>**标签** - 地图元素标签<br>**IP地址** - IP地址<br>**元素名称** - 元素名称（例如，主机名）<br>**仅状态** - 仅显示状态（OK或PROBLEM）<br>**无** - 不显示标签 |
| *Map element label location* | 标签相对于地图元素的位置：<br>**底部** - 地图元素下方<br>**左侧** - 左侧<br>**右侧** - 右侧<br>**Top** - 地图元素上方 |
| *Problem display* | 问题计数显示方式：<br>**全部** - 显示完整问题计数<br>**分开** - 未确认问题计数将以总数的一部分显示<br>**仅未确认** - 仅显示未确认问题计数 |
| *Minimum trigger severity* | 低于所选最低严重级别的问题将不会显示在地图上。<br>例如，选择*警告*时，*信息*和*未分类*级别的触发器变更将不会反映在地图中。<br>此参数从Zabbix 2.2开始支持。 |
| *Show suppressed problems* | 勾选复选框以显示因主机维护而被抑制（不显示）的问题。 |
| *URLs* | 可以为每种元素类型定义URL（带标签）。当用户在地图查看模式下点击元素时，这些URL将显示为链接。<br>宏可用于地图URL名称和值。完整列表请参阅[supported macros](/manual/appendix/macros/supported_by_location)并搜索'map URL names and values'。 |
#### Creating an e-mail media type
Create a new e-mail media type with a custom SMTP port and message
templates.
Request:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.create",
"params": {
"type": "0",
"name": "E-mail",
"smtp_server": "mail.example.com",
"smtp_helo": "example.com",
"smtp_email": "zabbix@example.com",
"smtp_port": "587",
"content_type": "1",
"message_templates": [
{
"eventsource": "0",
"recovery": "0",
"subject": "Problem: {EVENT.NAME}",
"message": "Problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" started at {EVENT.TIME}."
},
{
"eventsource": "0",
"recovery": "1",
"subject": "Resolved in {EVENT.DURATION}: {EVENT.NAME}",
"message": "Problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}."
},
{
"eventsource": "0",
"recovery": "2",
"subject": "Updated problem in {EVENT.AGE}: {EVENT.NAME}",
"message": "{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}."
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"7"
]
},
"id": 1
}
```
#### 创建邮件媒介类型
创建具有自定义SMTP端口和消息模板的新电子邮件媒介类型
请求:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.create",
"params": {
"type": "0",
"name": "E-mail",
"smtp_server": "mail.example.com",
"smtp_helo": "example.com",
"smtp_email": "zabbix@example.com",
"smtp_port": "587",
"content_type": "1",
"message_templates": [
{
"eventsource": "0",
"recovery": "0",
"subject": "Problem: {EVENT.NAME}",
"message": "Problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" started at {EVENT.TIME}."
},
{
"eventsource": "0",
"recovery": "1",
"subject": "Resolved in {EVENT.DURATION}: {EVENT.NAME}",
"message": "Problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}."
},
{
"eventsource": "0",
"recovery": "2",
"subject": "Updated problem in {EVENT.AGE}: {EVENT.NAME}",
"message": "{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}."
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"7"
]
},
"id": 1
}
```
#### Creating a new global regular expression.
Request:
```json
{
"jsonrpc": "2.0",
"method": "regexp.create",
"params": {
"name": "Storage devices for SNMP discovery",
"test_string": "/boot",
"expressions": [
{
"expression": "^(Physical memory|Virtual memory|Memory buffers|Cached memory|Swap space)$",
"expression_type": "4",
"case_sensitive": "1"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"regexpids": [
"16"
]
},
"id": 1
}
```
#### 创建新的全局正则表达式
请求:
```json
{
"jsonrpc": "2.0",
"method": "regexp.create",
"params": {
"name": "Storage devices for SNMP discovery",
"test_string": "/boot",
"expressions": [
{
"expression": "^(Physical memory|Virtual memory|Memory buffers|Cached memory|Swap space)$",
"expression_type": "4",
"case_sensitive": "1"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"regexpids": [
"16"
]
},
"id": 1
}
```
#### Creating a new item
Let's create a new [item](/manual/api/reference/item/object) on "Zabbix
server" using the data we've obtained from the previous `host.get`
request. This can be done by using the
[item.create](/manual/api/reference/item/create) method:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Free disk space on /home/joe/",
"key_": "vfs.fs.size[/home/joe/,free]",
"hostid": "10084",
"type": 0,
"value_type": 3,
"interfaceid": "1",
"delay": 30
},
"auth": "0424bd59b807674191e7d77572075f33",
"id": 3
}
```
A successful response will contain the ID of the newly created item,
which can be used to reference the item in the following requests:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"24759"
]
},
"id": 3
}
```
::: notetip
The `item.create` method as well as other create methods
can also accept arrays of objects and create multiple items with one API
call.
:::
#### 创建新的 监控项
让我们基于从上一个`host.get`请求获取的数据，在"Zabbix服务器"上create一个新的[item](/manual/api/reference/item/object)。这可以通过使用[item.create](/manual/api/reference/item/create)方法实现：
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Free disk space on /home/joe/",
"key_": "vfs.fs.size[/home/joe/,free]",
"hostid": "10084",
"type": 0,
"value_type": 3,
"interfaceid": "1",
"delay": 30
},
"auth": "0424bd59b807674191e7d77572075f33",
"id": 3
}
```
成功响应将包含新创建的监控项的ID，该ID可用于在后续请求中引用该监控项：
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"24759"
]
},
"id": 3
}
```
::: notetip
`item.create`方法以及其他create方法也可以接受objects数组，并通过一次API调用来create多个监控项。
:::
#### Creating an item
Create a numeric Zabbix agent item with 2 item tags to monitor free disk space on host with ID "30074".
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Free disk space on /home/joe/",
"key_": "vfs.fs.size[/home/joe/,free]",
"hostid": "30074",
"type": 0,
"value_type": 3,
"interfaceid": "30084",
"tags": [
{
"tag": "Disk usage"
},
{
"tag": "Equipment",
"value": "Workstation"
}
],
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"24758"
]
},
"id": 1
}
```
#### 创建监控项
创建一个带有2位监控项标签的数字型Zabbix agent监控项，用于监控ID为"30074"的主机上的磁盘剩余空间。
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Free disk space on /home/joe/",
"key_": "vfs.fs.size[/home/joe/,free]",
"hostid": "30074",
"type": 0,
"value_type": 3,
"interfaceid": "30084",
"tags": [
{
"tag": "Disk usage"
},
{
"tag": "Equipment",
"value": "Workstation"
}
],
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"24758"
]
},
"id": 1
}
```
#### Creating an item prototype
Create an item prototype to monitor free disk space on a discovered file
system. Discovered items should be numeric Zabbix agent items updated
every 30 seconds.
Request:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"name": "Free disk space on {#FSNAME}",
"key_": "vfs.fs.size[{#FSNAME},free]",
"hostid": "10197",
"ruleid": "27665",
"type": 0,
"value_type": 3,
"interfaceid": "112",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27666"
]
},
"id": 1
}
```
#### 创建 监控项 原型
创建一个监控项原型用于监控被发现的file系统上的磁盘剩余空间。被发现的监控项应为数值型Zabbix agent 监控项，每30秒更新一次。
请求:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"name": "Free disk space on {#FSNAME}",
"key_": "vfs.fs.size[{#FSNAME},free]",
"hostid": "10197",
"ruleid": "27665",
"type": 0,
"value_type": 3,
"interfaceid": "112",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27666"
]
},
"id": 1
}
```
#### Creating an item prototype with preprocessing
Create an item using change per second and a custom multiplier as a
second step.
Request:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"name": "Incoming network traffic on {#IFNAME}",
"key_": "net.if.in[{#IFNAME}]",
"hostid": "10001",
"ruleid": "27665",
"type": 0,
"value_type": 3,
"delay": "60s",
"units": "bps",
"interfaceid": "1155",
"preprocessing": [
{
"type": 10,
"params": "",
"error_handler": 0,
"error_handler_params": ""
},
{
"type": 1,
"params": "8",
"error_handler": 2,
"error_handler_params": "10"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44211"
]
},
"id": 1
}
```
#### 创建带有预处理的 监控项 原型
使用每秒变化值和自定义乘数作为第二步创建监控项.
请求:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"name": "Incoming network traffic on {#IFNAME}",
"key_": "net.if.in[{#IFNAME}]",
"hostid": "10001",
"ruleid": "27665",
"type": 0,
"value_type": 3,
"delay": "60s",
"units": "bps",
"interfaceid": "1155",
"preprocessing": [
{
"type": 10,
"params": "",
"error_handler": 0,
"error_handler_params": ""
},
{
"type": 1,
"params": "8",
"error_handler": 2,
"error_handler_params": "10"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44211"
]
},
"id": 1
}
```
#### Creating an item with preprocessing
Create an item using custom multiplier.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Device uptime",
"key_": "sysUpTime",
"hostid": "11312",
"type": 4,
"snmp_oid": "SNMPv2-MIB::sysUpTime.0",
"value_type": 1,
"delay": "60s",
"units": "uptime",
"interfaceid": "1156",
"preprocessing": [
{
"type": 1,
"params": "0.01",
"error_handler": 1,
"error_handler_params": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44210"
]
},
"id": 1
}
```
#### 创建带有预处理的 监控项
使用自定义乘数创建监控项.
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Device uptime",
"key_": "sysUpTime",
"hostid": "11312",
"type": 4,
"snmp_oid": "SNMPv2-MIB::sysUpTime.0",
"value_type": 1,
"delay": "60s",
"units": "uptime",
"interfaceid": "1156",
"preprocessing": [
{
"type": 1,
"params": "0.01",
"error_handler": 1,
"error_handler_params": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44210"
]
},
"id": 1
}
```
#### Creating an LLD rule
Create a Zabbix agent LLD rule to discover mounted file systems.
Discovered items will be updated every 30 seconds.
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Mounted filesystem discovery",
"key_": "vfs.fs.discovery",
"hostid": "10197",
"type": 0,
"interfaceid": "112",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27665"
]
},
"id": 1
}
```
#### 创建 LLD 规则
创建一个Zabbix agent LLD规则来发现已挂载的file系统。
被发现的监控项将每30秒更新一次。
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Mounted filesystem discovery",
"key_": "vfs.fs.discovery",
"hostid": "10197",
"type": 0,
"interfaceid": "112",
"delay": "30s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27665"
]
},
"id": 1
}
```
#### Creating an LLD rule with macro paths
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "LLD rule with LLD macro paths",
"key_": "lld",
"hostid": "10116",
"type": 0,
"interfaceid": "13",
"delay": "30s",
"lld_macro_paths": [
{
"lld_macro": "{#MACRO1}",
"path": "$.path.1"
},
{
"lld_macro": "{#MACRO2}",
"path": "$.path.2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27665"
]
},
"id": 1
}
```
#### 创建带宏路径的LLD规则
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "LLD rule with LLD macro paths",
"key_": "lld",
"hostid": "10116",
"type": 0,
"interfaceid": "13",
"delay": "30s",
"lld_macro_paths": [
{
"lld_macro": "{#MACRO1}",
"path": "$.path.1"
},
{
"lld_macro": "{#MACRO2}",
"path": "$.path.2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"27665"
]
},
"id": 1
}
```
#### Creating an LLD rule with overrides
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Discover database host",
"key_": "lld.with.overrides",
"hostid": "10001",
"type": 0,
"delay": "60s",
"interfaceid": "1155",
"overrides": [
{
"name": "Discover MySQL host",
"step": "1",
"stop": "1",
"filter": {
"evaltype": "2",
"conditions": [
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^mysqld\\.service$"
},
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^mariadb\\.service$"
}
]
},
"operations": [
{
"operationobject": "3",
"operator": "2",
"value": "Database host",
"opstatus": {
"status": "0"
},
"optemplate": [
{
"templateid": "10170"
}
],
"optag": [
{
"tag": "Database",
"value": "MySQL"
}
]
}
]
},
{
"name": "Discover PostgreSQL host",
"step": "2",
"stop": "1",
"filter": {
"evaltype": "0",
"conditions": [
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^postgresql\\.service$"
}
]
},
"operations": [
{
"operationobject": "3",
"operator": "2",
"value": "Database host",
"opstatus": {
"status": "0"
},
"optemplate": [
{
"templateid": "10263"
}
],
"optag": [
{
"tag": "Database",
"value": "PostgreSQL"
}
]
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"30980"
]
},
"id": 1
}
```
#### 创建带覆盖的LLD规则
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Discover database host",
"key_": "lld.with.overrides",
"hostid": "10001",
"type": 0,
"delay": "60s",
"interfaceid": "1155",
"overrides": [
{
"name": "Discover MySQL host",
"step": "1",
"stop": "1",
"filter": {
"evaltype": "2",
"conditions": [
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^mysqld\\.service$"
},
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^mariadb\\.service$"
}
]
},
"operations": [
{
"operationobject": "3",
"operator": "2",
"value": "Database host",
"opstatus": {
"status": "0"
},
"optemplate": [
{
"templateid": "10170"
}
],
"optag": [
{
"tag": "Database",
"value": "MySQL"
}
]
}
]
},
{
"name": "Discover PostgreSQL host",
"step": "2",
"stop": "1",
"filter": {
"evaltype": "0",
"conditions": [
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^postgresql\\.service$"
}
]
},
"operations": [
{
"operationobject": "3",
"operator": "2",
"value": "Database host",
"opstatus": {
"status": "0"
},
"optemplate": [
{
"templateid": "10263"
}
],
"optag": [
{
"tag": "Database",
"value": "PostgreSQL"
}
]
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"30980"
]
},
"id": 1
}
```
#### Creating an LLD rule with preprocessing
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Discovery rule with preprocessing",
"key_": "lld.with.preprocessing",
"hostid": "10001",
"ruleid": "27665",
"type": 0,
"delay": "60s",
"interfaceid": "1155",
"preprocessing": [
{
"type": 20,
"params": "20",
"error_handler": 0,
"error_handler_params": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44211"
]
},
"id": 1
}
```
#### 创建带预处理的LLD规则
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.create",
"params": {
"name": "Discovery rule with preprocessing",
"key_": "lld.with.preprocessing",
"hostid": "10001",
"ruleid": "27665",
"type": 0,
"delay": "60s",
"interfaceid": "1155",
"preprocessing": [
{
"type": 20,
"params": "20",
"error_handler": 0,
"error_handler_params": ""
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44211"
]
},
"id": 1
}
```
#### Creating an SLA
Instruct to create an SLA entry for:
* tracking uptime for SQL-engine related services;
* custom schedule of all weekdays excluding last hour on Saturday;
* an effective date of the last day of the year 2022;
* with 1 hour and 15 minutes long planned downtime starting at midnight on the 4th of July;
* SLA weekly report calculation will be on;
* the minimum acceptable SLO will be 99.9995%.
#### 创建 SLA
指示为以下内容create一个SLA条目:
* 跟踪SQL引擎相关服务的运行时间;
* 自定义排程包含所有工作日但排除周六最后一小时;
* 生效日期为2022年最后一天;
* 包含7月4日午夜开始持续1小时15分钟的计划停机时间;
* SLA周报计算功能将开启;
* 最低可接受SLO标准为99.9995%.
##### Creating application
1\. Log into Microsoft Entra admin center at [Microsoft Entra ID](https://entra.microsoft.com). For testing purposes, you may create a free trial account in Microsoft Entra ID.
2\. In Microsoft Entra admin center select *Applications* -> *Enterprise applications* -> *New application* -> *Create your own application*.
3\. Add the name of your app and select the *Integrate any other application...* option. After that, click on *Create*.
{width="550"}
##### 创建应用
1\. 登录Microsoft Entra管理中心 [Microsoft Entra ID](https://entra.microsoft.com). 出于测试目的, 您可以在Microsoft Entra ID中create一个免费试用账户.
2\. 在Microsoft Entra管理中心选择*应用程序* -> *企业应用程序* -> *新建应用程序* -> *创建您自己的应用程序*.
3\. 添加您的应用程序名称并选择*集成任何其他应用程序...*选项. 完成后点击*创建*.
{width="550"}
#### Creating a role
Create a role with type "User" and denied access to two UI elements.
Request:
```json
{
"jsonrpc": "2.0",
"method": "role.create",
"params": {
"name": "Operator",
"type": "1",
"rules": {
"ui": [
{
"name": "monitoring.hosts",
"status": "0"
},
{
"name": "monitoring.maps",
"status": "0"
}
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}
```
#### 创建角色
创建一个类型为"User"的角色，并拒绝对两个UI元素的访问权限。
请求:
```json
{
"jsonrpc": "2.0",
"method": "role.create",
"params": {
"name": "Operator",
"type": "1",
"rules": {
"ui": [
{
"name": "monitoring.hosts",
"status": "0"
},
{
"name": "monitoring.maps",
"status": "0"
}
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}
```
#### Creating a scheduled report
Create a weekly report that will be prepared for the previous week every
Monday-Friday at 12:00 from 2021-04-01 to 2021-08-31.
Request:
```json
{
"jsonrpc": "2.0",
"method": "report.create",
"params": {
"userid": "1",
"name": "Weekly report",
"dashboardid": "1",
"period": "1",
"cycle": "1",
"start_time": "43200",
"weekdays": "31",
"active_since": "2021-04-01",
"active_till": "2021-08-31",
"subject": "Weekly report",
"message": "Report accompanying text",
"status": "1",
"description": "Report description",
"users": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
},
{
"userid": "2",
"access_userid": "0",
"exclude": "1"
}
],
"user_groups": [
{
"usrgrpid": "7",
"access_userid": "0"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}
```
#### 创建定时报告
创建一份每周报告，该报告将在2021-04-01至2021-08-31期间每周一至周五12:00为前一周生成。
请求:
```json
{
"jsonrpc": "2.0",
"method": "report.create",
"params": {
"userid": "1",
"name": "Weekly report",
"dashboardid": "1",
"period": "1",
"cycle": "1",
"start_time": "43200",
"weekdays": "31",
"active_since": "2021-04-01",
"active_till": "2021-08-31",
"subject": "Weekly report",
"message": "Report accompanying text",
"status": "1",
"description": "Report description",
"users": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
},
{
"userid": "2",
"access_userid": "0",
"exclude": "1"
}
],
"user_groups": [
{
"usrgrpid": "7",
"access_userid": "0"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}
```
#### Creating a script media type
Create a new script media type with a custom value for the number of
attempts and the interval between them.
Request:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.create",
"params": {
"type": "1",
"name": "Push notifications",
"exec_path": "push-notification.sh",
"exec_params": "{ALERT.SENDTO}\n{ALERT.SUBJECT}\n{ALERT.MESSAGE}\n",
"maxattempts": "5",
"attempt_interval": "11s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"8"
]
},
"id": 1
}
```
#### 创建脚本媒介类型
创建一个新的脚本媒介类型，自定义尝试次数及其间隔时间。
请求:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.create",
"params": {
"type": "1",
"name": "Push notifications",
"exec_path": "push-notification.sh",
"exec_params": "{ALERT.SENDTO}\n{ALERT.SUBJECT}\n{ALERT.MESSAGE}\n",
"maxattempts": "5",
"attempt_interval": "11s"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"8"
]
},
"id": 1
}
```
#### Creating a service
Create a service that will be switched to problem state, if at least one
child has a problem.
Request:
```json
{
"jsonrpc": "2.0",
"method": "service.create",
"params": {
"name": "Server 1",
"algorithm": 1,
"sortorder": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"5"
]
},
"id": 1
}
```
#### 创建服务
创建一个服务，当至少一个子项出现问题时，该服务将切换至问题状态。
请求:
```json
{
"jsonrpc": "2.0",
"method": "service.create",
"params": {
"name": "Server 1",
"algorithm": 1,
"sortorder": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"5"
]
},
"id": 1
}
```
#### Creating a service
Create a service that will be switched to problem state, if at least one
child has a problem. SLA calculation will be on and the minimum
acceptable SLA will be 99.99%.
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "service.create",
"params": {
"name": "Server 1",
"algorithm": 1,
"showsla": 1,
"goodsla": 99.99,
"sortorder": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"5"
]
},
"id": 1
}
```
#### Creating an service 创建服务
Create an service that will be switched to problem state, if at least
one child has a problem. SLA calculation will be on and the minimum
acceptable SLA is 99.99%.
创建一个至少有一个子服务有问题，将被切换到问题状态的服务。SLA计算将打开并且SLA最低可接受99.99%。
Request 请求:
``` {.java}
{
"jsonrpc": "2.0",
"method": "service.create",
"params": {
"name": "Server 1",
"algorithm": 1,
"showsla": 1,
"goodsla": 99.99,
"sortorder": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response 响应:
``` {.java}
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"5"
]
},
"id": 1
}
```
#### Creating a slideshow
A slideshow will run automatically if the dashboard contains two or more
pages (see [Adding pages](#adding_pages)) and if one of the following is
true:
- The *Start slideshow automatically* option is marked in dashboard
properties
- The dashboard URL contains a `slideshow=1` parameter
The pages rotate according to the intervals given in the properties of
the dashboard and individual pages. Click on:
- *Stop slideshow* - to stop the slideshow
- *Start slideshow* - to start the slideshow
Slideshow-related controls are also available in [kiosk
mode](#viewing_and_editing_a_dashboard) (where only the page content is
shown):
-  -
stop slideshow
-  -
start slideshow
-  -
go back one page
-  -
go to the next page
#### 创建幻灯片放映
如果仪表板包含两个或更多页面（参见[添加页面](#adding_pages)）且满足以下任一条件时，幻灯片将run自动播放：
- 仪表板属性中勾选了*自动启动幻灯片*选项
- 仪表板URL包含`slideshow=1`参数
页面轮播间隔时间由仪表板属性和各页面单独设置决定。点击：
- *停止幻灯片* - 停止播放
- *开始幻灯片* - 开始播放
[kiosk模式](#viewing_and_editing_a_dashboard)（仅显示页面内容）下也提供幻灯片控制功能：
-  -
停止幻灯片
-  -
开始幻灯片
-  -
返回上一页
-  -
跳转下一页
#### Creating a task
Create a task `check now` for two items. One is an item, the other is a low-level discovery rule.
Request:
```json
{
"jsonrpc": "2.0",
"method": "task.create",
"params": [
{
"type": 6,
"request": {
"itemid": "10092"
}
},
{
"type": "6",
"request": {
"itemid": "10093"
}
}
],
"auth": "700ca65537074ec963db7efabda78259",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"taskids": [
"1",
"2"
]
},
"id": 1
}
```
Create a task `diagnostic information` task.
Request:
```json
{
"jsonrpc": "2.0",
"method": "task.create",
"params": [
{
"type": 1,
"request": {
"alerting": {
"stats": [
"alerts"
],
"top": {
"media.alerts": 10
}
},
"lld": {
"stats": "extend",
"top": {
"values": 5
}
}
},
"proxy_hostid": 0
}
],
"auth": "700ca65537074ec963db7efabda78259",
"id": 2
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"taskids": [
"3"
]
},
"id": 2
}
```
#### 创建任务
为两个监控项创建任务`check now`。一个是监控项，另一个是低级发现规则。
请求:
```json
{
"jsonrpc": "2.0",
"method": "task.create",
"params": [
{
"type": 6,
"request": {
"itemid": "10092"
}
},
{
"type": "6",
"request": {
"itemid": "10093"
}
}
],
"auth": "700ca65537074ec963db7efabda78259",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"taskids": [
"1",
"2"
]
},
"id": 1
}
```
创建`diagnostic information`任务。
请求:
```json
{
"jsonrpc": "2.0",
"method": "task.create",
"params": [
{
"type": 1,
"request": {
"alerting": {
"stats": [
"alerts"
],
"top": {
"media.alerts": 10
}
},
"lld": {
"stats": "extend",
"top": {
"values": 5
}
}
},
"proxy_hostid": 0
}
],
"auth": "700ca65537074ec963db7efabda78259",
"id": 2
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"taskids": [
"3"
]
},
"id": 2
}
```
#### Creating a template
Create a template with tags and link two templates to this template.
Request:
```json
{
"jsonrpc": "2.0",
"method": "template.create",
"params": {
"host": "Linux template",
"groups": {
"groupid": 1
},
"templates": [
{
"templateid": "11115"
},
{
"templateid": "11116"
}
],
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"11117"
]
},
"id": 1
}
```
#### 创建模板
创建一个带标签的模板并将两个模板链接至该模板。
请求:
```json
{
"jsonrpc": "2.0",
"method": "template.create",
"params": {
"host": "Linux template",
"groups": {
"groupid": 1
},
"templates": [
{
"templateid": "11115"
},
{
"templateid": "11116"
}
],
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"11117"
]
},
"id": 1
}
```
#### Creating a template dashboard
Create a template dashboard named “Graphs” with one Graph widget on a
single dashboard page.
Request:
```json
{
"jsonrpc": "2.0",
"method": "templatedashboard.create",
"params": {
"templateid": "10318",
"name": "Graphs",
"pages": [
{
"widgets": [
{
"type": "graph",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 6,
"name": "graphid",
"value": "1123"
}
]
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"32"
]
},
"id": 1
}
```
#### 创建模板仪表盘
创建一个名为"Graphs"的模板仪表板，在单个仪表板页面上包含一个图形小部件。
请求:
```json
{
"jsonrpc": "2.0",
"method": "templatedashboard.create",
"params": {
"templateid": "10318",
"name": "Graphs",
"pages": [
{
"widgets": [
{
"type": "graph",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 6,
"name": "graphid",
"value": "1123"
}
]
}
]
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"32"
]
},
"id": 1
}
```
#### Creating a template
To create a template, do the following:
- Go to *Configuration → Templates*
- Click on *Create template*
- Edit template attributes
The **Template** tab contains general template attributes.
{width="600"}
All mandatory input fields are marked with a red asterisk.
Template attributes:
|Parameter|Description|
|--|--------|
|*Template name*|Unique template name. Alphanumerics, spaces, dots, dashes, and underscores are allowed. However, leading and trailing spaces are disallowed.|
|*Visible name*|If you set this name, it will be the one visible in lists, maps, etc.|
|*Templates*|Link one or more "nested" templates to this template. All entities (items, triggers, graphs, etc.) will be inherited from the linked templates.<br>To link a new template, start typing the template name in the *Templates* field. A list of matching templates will appear; scroll down to select. Alternatively, you may click on *Select* next to the *Templates* field; then, first select the host group by clicking on *Select* next to the *Host groups* field; mark the checkbox in front of one or multiple templates from the list displayed below; click on *Select*. The template(s) that are selected in the *Templates* field will be linked to the template when the template configuration form is saved or updated.<br>To unlink a template, use one of the two options in the *Templates* block:<br>*Unlink* - unlink the template, but preserve its items, triggers, and graphs<br>*Unlink and clear* - unlink the template and remove all its items, triggers, and graphs|
|*Groups*|Host/template groups the template belongs to.|
|*Description*|Enter the template description.|
The **Tags** tab allows you to define template-level
[tags](/manual/config/tagging). All problems of hosts linked to this
template will be tagged with the values entered here.
User macros, {INVENTORY.\*} macros, {HOST.HOST}, {HOST.NAME},
{HOST.CONN}, {HOST.DNS}, {HOST.IP}, {HOST.PORT} and {HOST.ID} macros are
supported in tags.
The **Macros** tab allows you to define template-level [user
macros](/manual/config/macros/user_macros) as a name-value pairs. Note
that macro values can be kept as plain text, secret text, or Vault
secret. Adding a description is also supported.
You may also view here macros from linked templates and global macros if
you select the *Inherited and template macros* option. That is where all
defined user macros for the template are displayed with the value they
resolve to as well as their origin.
For convenience, links to respective templates and global macro
configuration are provided. It is also possible to edit a nested
template/global macro on the template level, effectively creating a copy
of the macro on the template.
The **Value mapping** tab allows to configure human-friendly
representation of item data in [value
mappings](/manual/config/items/mapping).
Buttons:
| | |
|--|--------|
||Add the template. The added template should appear in the list.|
||Update the properties of an existing template.|
||Create another template based on the properties of the current template, including the entities (items, triggers, etc) inherited from linked templates.|
||Create another template based on the properties of the current template, including the entities (items, triggers, etc) both inherited from linked templates and directly attached to the current template.|
||Delete the template; entities of the template (items, triggers, etc) remain with the linked hosts.|
||Delete the template and all its entities from linked hosts.|
||Cancel the editing of template properties.|
With a template created, it is time to add some entities to it.
::: noteimportant
Items have to be added to a template first.
Triggers and graphs cannot be added without the corresponding
item.
:::
#### 创建模板
要create模板，请执行以下操作：
- 前往 *配置 → 模板*
- 点击 *创建模板*
- 编辑模板属性
**模板**选项卡包含通用模板属性。
{width="600"}
所有必填字段均以红色星号标记。
模板属性:
| 参数 | 描述 |
|--|--------|
| *Template name* | 唯一模板名称。允许使用字母数字、空格、点号、连字符和下划线。但禁止使用前导或尾部空格。 |
| *Visible name* | 若设置此名称，它将在列表、地图等界面中显示 |
| *Templates* | 将一个或多个"嵌套"模板链接到此模板。所有实体（监控项、触发器、图形等）将从链接的模板继承。<br>要链接新模板，请在*模板*字段中开始输入模板名称。将显示匹配模板列表；向下滚动以选择。或者，您可以点击*模板*字段旁边的*选择*；然后首先通过点击*主机组*字段旁边的*选择*来选择主机组；从下方显示的列表中标记一个或多个模板前的复选框；点击*选择*。当模板配置表单保存或更新时，*模板*字段中选定的模板将被链接到该模板。<br>要取消链接模板，请使用*模板*块中的两个选项之一：<br>*取消链接* - 取消链接模板，但保留其监控项、触发器和图形<br>*取消链接并clear* - 取消链接模板并移除其所有监控项、触发器和图形 |
| *Groups* | 主机/模板所属的模板组。 |
| *Description* | 输入模板描述。 |
**Tags**（标签）选项卡允许您定义模板级别的
[tags](/manual/config/tagging). 所有与此关联的主机问题
模板将标记为在此处输入的值。
用户宏, {INVENTORY.\*}宏, {HOST.HOST}, {HOST.NAME},
{HOST.CONN}、{HOST.DNS}、{HOST.IP}、{HOST.PORT}和{HOST.ID}宏是
支持在标签中使用。
**宏**选项卡允许您以名称-值对的形式定义模板级别的[user
macros](/manual/config/macros/user_macros)。注意
该宏值可以保存为纯文本、机密文本或Vault
支持添加描述。
您也可以在此处查看来自关联模板的宏和全局宏（如果存在）
您选择了*继承和模板宏*选项。这就是所有
模板中定义的用户宏会显示其对应的值
解析及其来源
为方便起见，指向相应模板和全局宏的链接
提供了配置。也可以编辑嵌套的
模板级别的全局宏，有效地创建了一个copy
模板宏的
**值映射**选项卡允许配置用户友好的
监控项数据在[value
mappings](/manual/config/items/mapping)中的表示
按钮:
| | |
|--|--------|
|  | 添加模板。添加的模板应出现在列表中。 |
|  | 更新现有模板的属性。 |
|  | 基于当前模板属性创建另一个模板，包括从链接模板继承的实体（监控项、触发器等）。 |
|  | 基于当前模板的属性创建另一个模板，包括从链接模板继承的实体（监控项、触发器等）以及直接附加到当前模板的实体。 |
|  | 删除模板；模板的实体（监控项、触发器等）仍保留在关联的主机中。 |
|  | 从关联的主机中删除模板及其所有实体。 |
|  | 取消模板属性编辑。 |
模板创建完成后，现在可以向其中添加一些实体。
::: noteimportant
监控项 必须先被添加到模板中
无法添加没有相应项的触发器和图形
监控项.
:::
#### Creating a trigger
Create a trigger with a single trigger dependency.
Request:
```json
{
"jsonrpc": "2.0",
"method": "trigger.create",
"params": [
{
"description": "Processor load is too high on {HOST.NAME}",
"expression": "last(/Linux server/system.cpu.load[percpu,avg1])>5",
"dependencies": [
{
"triggerid": "17367"
}
]
},
{
"description": "Service status",
"expression": "length(last(/Linux server/log[/var/log/system,Service .* has stopped]))<>0",
"dependencies": [
{
"triggerid": "17368"
}
],
"tags": [
{
"tag": "service",
"value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
},
{
"tag": "error",
"value": ""
}
]
}
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"17369",
"17370"
]
},
"id": 1
}
```
#### 创建触发器
创建具有单一触发器依赖项的触发器。
请求:
```json
{
"jsonrpc": "2.0",
"method": "trigger.create",
"params": [
{
"description": "Processor load is too high on {HOST.NAME}",
"expression": "last(/Linux server/system.cpu.load[percpu,avg1])>5",
"dependencies": [
{
"triggerid": "17367"
}
]
},
{
"description": "Service status",
"expression": "length(last(/Linux server/log[/var/log/system,Service .* has stopped]))<>0",
"dependencies": [
{
"triggerid": "17368"
}
],
"tags": [
{
"tag": "service",
"value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
},
{
"tag": "error",
"value": ""
}
]
}
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"17369",
"17370"
]
},
"id": 1
}
```
#### Creating a trigger prototype
Create a trigger prototype to detect when a file system has less than
20% free disk space.
Request:
```json
{
"jsonrpc": "2.0",
"method": "triggerprototype.create",
"params": {
"description": "Free disk space is less than 20% on volume {#FSNAME}",
"expression": "last(/Zabbix server/vfs.fs.size[{#FSNAME},pfree])<20",
"tags": [
{
"tag": "volume",
"value": "{#FSNAME}"
},
{
"tag": "type",
"value": "{#FSTYPE}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"17372"
]
},
"id": 1
}
```
#### 创建触发器原型
创建一个触发器原型，用于检测file系统的可用磁盘空间低于20%的情况。
请求:
```json
{
"jsonrpc": "2.0",
"method": "triggerprototype.create",
"params": {
"description": "Free disk space is less than 20% on volume {#FSNAME}",
"expression": "last(/Zabbix server/vfs.fs.size[{#FSNAME},pfree])<20",
"tags": [
{
"tag": "volume",
"value": "{#FSNAME}"
},
{
"tag": "type",
"value": "{#FSTYPE}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"17372"
]
},
"id": 1
}
```
#### Creating a user
Create a new user, add him to a user group and create a new media for
him.
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.create",
"params": {
"username": "John",
"passwd": "Doe123",
"roleid": "5",
"usrgrps": [
{
"usrgrpid": "7"
}
],
"medias": [
{
"mediatypeid": "1",
"sendto": [
"support@company.com"
],
"active": 0,
"severity": 63,
"period": "1-7,00:00-24:00"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"userids": [
"12"
]
},
"id": 1
}
```
#### 创建用户
创建新用户，将其添加到用户组并create为其配置新媒介。
请求：
```json
{
"jsonrpc": "2.0",
"method": "user.create",
"params": {
"username": "John",
"passwd": "Doe123",
"roleid": "5",
"usrgrps": [
{
"usrgrpid": "7"
}
],
"medias": [
{
"mediatypeid": "1",
"sendto": [
"support@company.com"
],
"active": 0,
"severity": 63,
"period": "1-7,00:00-24:00"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"userids": [
"12"
]
},
"id": 1
}
```
#### Creating a user group
Create a user group, which denies access to host group "2", and add a
user to it.
Request:
```json
{
"jsonrpc": "2.0",
"method": "usergroup.create",
"params": {
"name": "Operation managers",
"rights": {
"permission": 0,
"id": "2"
},
"users": [
{"userid": "12"}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"20"
]
},
"id": 1
}
```
#### 创建用户组
创建一个用户组，该组拒绝访问主机组 "2"，并向其中添加用户。
请求：
```json
{
"jsonrpc": "2.0",
"method": "usergroup.create",
"params": {
"name": "Operation managers",
"rights": {
"permission": 0,
"id": "2"
},
"users": [
{"userid": "12"}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"20"
]
},
"id": 1
}
```
#### Creating a value map
Create one value map with two mappings.
Request:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.create",
"params": {
"hostid": "50009",
"name": "Service state",
"mappings": [
{
"type": "1",
"value": "1",
"newvalue": "Up"
},
{
"type": "5",
"newvalue": "Down"
}
]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"1"
]
},
"id": 1
}
```
#### 创建值映射
创建一个包含两个映射的值映射表.
请求:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.create",
"params": {
"hostid": "50009",
"name": "Service state",
"mappings": [
{
"type": "1",
"value": "1",
"newvalue": "Up"
},
{
"type": "5",
"newvalue": "Down"
}
]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"1"
]
},
"id": 1
}
```
#### Creating a webhook media type
Create a new webhook media type.
Request:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.create",
"params": {
"type": "4",
"name": "Webhook",
"script": "var Webhook = {\r\n token: null,\r\n to: null,\r\n subject: null,\r\n message: null,\r\n\r\n sendMessage: function() {\r\n // some logic\r\n }\r\n}",
"parameters": [
{
"name": "Message",
"value": "{ALERT.MESSAGE}"
},
{
"name": "Subject",
"value": "{ALERT.SUBJECT}"
},
{
"name": "To",
"value": "{ALERT.SENDTO}"
},
{
"name": "Token",
"value": "<Token>"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"9"
]
},
"id": 1
}
```
#### 创建 Webhook 媒介类型
创建新的Webhook媒介类型。
请求:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.create",
"params": {
"type": "4",
"name": "Webhook",
"script": "var Webhook = {\r\n token: null,\r\n to: null,\r\n subject: null,\r\n message: null,\r\n\r\n sendMessage: function() {\r\n // some logic\r\n }\r\n}",
"parameters": [
{
"name": "Message",
"value": "{ALERT.MESSAGE}"
},
{
"name": "Subject",
"value": "{ALERT.SUBJECT}"
},
{
"name": "To",
"value": "{ALERT.SENDTO}"
},
{
"name": "Token",
"value": "<Token>"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"9"
]
},
"id": 1
}
```
#### Creating a web scenario
Create a web scenario to monitor the company home page. The scenario
will have two steps, to check the home page and the "About" page and
make sure they return the HTTP status code 200.
Request:
```json
{
"jsonrpc": "2.0",
"method": "httptest.create",
"params": {
"name": "Homepage check",
"hostid": "10085",
"steps": [
{
"name": "Homepage",
"url": "http://example.com",
"status_codes": "200",
"no": 1
},
{
"name": "Homepage / About",
"url": "http://example.com/about",
"status_codes": "200",
"no": 2
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"httptestids": [
"5"
]
},
"id": 1
}
```
#### 创建 Web 场景
创建一个用于监控公司主页的Web场景。该场景
将包含两个步骤，分别检查主页和"关于"页面，
并确保它们返回HTTP状态码200。
请求:
```json
{
"jsonrpc": "2.0",
"method": "httptest.create",
"params": {
"name": "Homepage check",
"hostid": "10085",
"steps": [
{
"name": "Homepage",
"url": "http://example.com",
"status_codes": "200",
"no": 1
},
{
"name": "Homepage / About",
"url": "http://example.com/about",
"status_codes": "200",
"no": 2
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"httptestids": [
"5"
]
},
"id": 1
}
```
### Creating custom LLD rules
It is also possible to create a completely custom LLD rule, discovering
any type of entities - for example, databases on a database server.
To do so, a custom item should be created that returns JSON, specifying
found objects and optionally - some properties of them. The amount of
macros per entity is not limited - while the built-in discovery rules
return either one or two macros (for example, two for filesystem
discovery), it is possible to return more.
The required JSON format is best illustrated with an example. Suppose we
are running an old Zabbix 1.8 agent (one that does not support
"vfs.fs.discovery"), but we still need to discover file systems. Here is
a simple Perl script for Linux that discovers mounted file systems and
outputs JSON, which includes both file system name and type. One way to
use it would be as a UserParameter with key "vfs.fs.discovery\_perl":
``` {.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"{#FSNAME}\":\"$fsname\",\n";
print "\t\t\"{#FSTYPE}\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
::: noteimportant
Allowed symbols for LLD macro names are **0-9** ,
**A-Z** , **\_** , **.**\
\
Lowercase letters are not supported in the names.
:::
An example of its output (reformatted for clarity) is shown below. JSON
for custom discovery checks has to follow the same format.
``` {.javascript}
[
{ "{#FSNAME}":"/", "{#FSTYPE}":"rootfs" },
{ "{#FSNAME}":"/sys", "{#FSTYPE}":"sysfs" },
{ "{#FSNAME}":"/proc", "{#FSTYPE}":"proc" },
{ "{#FSNAME}":"/dev", "{#FSTYPE}":"devtmpfs" },
{ "{#FSNAME}":"/dev/pts", "{#FSTYPE}":"devpts" },
{ "{#FSNAME}":"/lib/init/rw", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/dev/shm", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/home", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/tmp", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/usr", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/var", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/sys/fs/fuse/connections", "{#FSTYPE}":"fusectl" }
]
```
In previous example it is required that the keys match the LLD macro
names used in prototypes, the alternative is to extract LLD macro values
using JSONPath `{#FSNAME}` → `$.fsname` and `{#FSTYPE}` → `$.fstype`,
thus making such script possible:
``` {.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"fsname\":\"$fsname\",\n";
print "\t\t\"fstype\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
An example of its output (reformatted for clarity) is shown below. JSON
for custom discovery checks has to follow the same format.
``` {.javascript}
[
{ "fsname":"/", "fstype":"rootfs" },
{ "fsname":"/sys", "fstype":"sysfs" },
{ "fsname":"/proc", "fstype":"proc" },
{ "fsname":"/dev", "fstype":"devtmpfs" },
{ "fsname":"/dev/pts", "fstype":"devpts" },
{ "fsname":"/lib/init/rw", "fstype":"tmpfs" },
{ "fsname":"/dev/shm", "fstype":"tmpfs" },
{ "fsname":"/home", "fstype":"ext3" },
{ "fsname":"/tmp", "fstype":"ext3" },
{ "fsname":"/usr", "fstype":"ext3" },
{ "fsname":"/var", "fstype":"ext3" },
{ "fsname":"/sys/fs/fuse/connections", "fstype":"fusectl" }
]
```
Then, in the discovery rule's "Filter" field, we could specify
"{\#FSTYPE}" as a macro and "rootfs|ext3" as a regular expression.
::: noteclassic
You don't have to use macro names FSNAME/FSTYPE with custom
LLD rules, you are free to use whatever names you like. In case JSONPath
is used then LLD row will be an array element that can be an object, but
it can be also another array or a value.
:::
Note that, if using a user parameter, the return value is limited to 512
KB. For more details, see [data limits for LLD return
values](/manual/discovery/low_level_discovery/notes#data_limits_for_return_values).
### 创建自定义LLD规则
可以创建完全自定义的底层自动发现(LLD)规则，用于发现任何类型的实体 - 例如，服务器上运行的数据库。
要实现此功能，需要创建一个自定义监控项，监控项需要返回JSON数据，其中包含发现的对象以及其它可选项 - 对象的一些属性。每个实体的宏没有数量限制 - 内置的自动发现规则返回一个或两个宏(比如文件系统自动发现返回两个宏)，但自定义的LLD可以返回更多个宏。
最好用一个例子来演示所需的JSON格式比较容易理解。假设一个旧版的Zabbix 1.8的agent正在运行(该agent不支持"vfs.fs.discovery"这个监控项的键)，不过我们还需要对文件系统进行自动发现。下面是个简单的Perl脚本，运行在Linux上，用于发现挂载的文件系统并输出JSON数据，JSON数据中包含文件系统名称和类型。使用Perl脚本的其中一种方式是作为一个UserParameter，利用 "vfs.fs.discovery\_perl" 这个键：
``` {.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"{#FSNAME}\":\"$fsname\",\n";
print "\t\t\"{#FSTYPE}\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
::: 重要
LLD宏的名称允许使用的符号有 **0-9** ,**A-Z** , **\_** , **.**\
\
名称中不支持小写字母。
:::
下面是一个输出(为了看的更清晰，重新排版)的例子。自定义的自动发现检查的JSON格式必须遵循相同的形式。
``` {.javascript}
[
{ "{#FSNAME}":"/", "{#FSTYPE}":"rootfs" },
{ "{#FSNAME}":"/sys", "{#FSTYPE}":"sysfs" },
{ "{#FSNAME}":"/proc", "{#FSTYPE}":"proc" },
{ "{#FSNAME}":"/dev", "{#FSTYPE}":"devtmpfs" },
{ "{#FSNAME}":"/dev/pts", "{#FSTYPE}":"devpts" },
{ "{#FSNAME}":"/lib/init/rw", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/dev/shm", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/home", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/tmp", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/usr", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/var", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/sys/fs/fuse/connections", "{#FSTYPE}":"fusectl" }
]
```
上面的例子中需要让键匹配原型中使用的LLD宏的名称，另一种方式是提取LLD宏的值，提取的方式是通过JSONPath `{#FSNAME}` → `$.fsname` 和 `{#FSTYPE}` → `$.fstype`,
于是可以使用下面的脚本来实现此功能:
``` {.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"fsname\":\"$fsname\",\n";
print "\t\t\"fstype\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
下面是一个输出(为了看的更清晰，重新排版)的例子。自定义的自动发现检查的JSON格式必须遵循相同的形式。
``` {.javascript}
[
{ "fsname":"/", "fstype":"rootfs" },
{ "fsname":"/sys", "fstype":"sysfs" },
{ "fsname":"/proc", "fstype":"proc" },
{ "fsname":"/dev", "fstype":"devtmpfs" },
{ "fsname":"/dev/pts", "fstype":"devpts" },
{ "fsname":"/lib/init/rw", "fstype":"tmpfs" },
{ "fsname":"/dev/shm", "fstype":"tmpfs" },
{ "fsname":"/home", "fstype":"ext3" },
{ "fsname":"/tmp", "fstype":"ext3" },
{ "fsname":"/usr", "fstype":"ext3" },
{ "fsname":"/var", "fstype":"ext3" },
{ "fsname":"/sys/fs/fuse/connections", "fstype":"fusectl" }
]
```
然后在自动发现规则的 "过滤器" 选项卡中，可以指定"{\#FSTYPE}" 作为宏 和"rootfs|ext3" 作为正则表达式。
::: 注意
无需使用 FSNAME/FSTYPE 作为自定义LLD规则中的宏的名称，可以使用任何名称。一旦使用了JSONPath，则LLD返回的数据会是一个数组元素，该元素可以是一个对象、另一个数组或一个值。
:::
注意，如果使用一个用户参数，返回值限制在512 KB大小。更多信息请参考 [LLD返回值的数据大小限制](/manual/discovery/low_level_discovery#data_limits_for_return_values).
##### Creating database
[Create](/manual/appendix/install/db_scripts) a separate database for
Zabbix proxy.
Zabbix server and Zabbix proxy cannot use the same database. If they are
installed on the same host, the proxy database must have a different
name.
##### 创建数据库
[Create](/manual/appendix/install/db_scripts) 为Zabbix proxy使用独立数据库
Zabbix server和Zabbix proxy不能使用相同数据库。若它们安装在同一主机上，proxy数据库必须使用不同名称。
##### Creating database
[Create](/manual/appendix/install/db_scripts) a separate database for
Zabbix proxy.
Zabbix server and Zabbix proxy cannot use the same database. If they are
installed on the same host, the proxy database must have a different
name.
##### 创建数据库
为Zabbix proxy 单独[创建数据库](/manual/appendix/install/db_scripts) 。
Zabbix server和Zabbix proxy 不能使用同一个数据库。如果他们是安装在同一个主机中的，则proxy数据库需要另命名。
##### Creating database
[Create](/manual/appendix/install/db_scripts) a separate database for
Zabbix proxy.
Zabbix server and Zabbix proxy cannot use the same database. If they are
installed on the same host, the proxy database must have a different
name.
##### 创建数据库
[Create](/manual/appendix/install/db_scripts) 为
Zabbix proxy 使用独立数据库
Zabbix server 和 Zabbix proxy 不能使用同一数据库。若它们安装在同一台 主机 上，proxy 数据库必须使用不同名称。
#### Creating database
For Zabbix [server](/manual/concepts/server) and
[proxy](/manual/concepts/proxy) daemons a database is required. It is
not needed to run Zabbix [agent](/manual/concepts/agent).
::: notewarning
Separate databases are needed for Zabbix server and
Zabbix proxy; they cannot use the same database. Therefore, if they are
installed on the same host, their databases must be created with
different names!
:::
Create the database using the provided instructions for
[MySQL](/manual/appendix/install/db_scripts#mysql) or
[PostgreSQL](/manual/appendix/install/db_scripts#postgresql).
#### 创建数据库
对于Zabbix [server](/manual/concepts/server)和
[proxy](/manual/concepts/proxy) 守护进程需要一个数据库。它是
不需要run Zabbix [agent](/manual/concepts/agent).
::: notewarning
需要为Zabbix server单独配置数据库
Zabbix proxy; 它们不能使用同一个数据库。因此，如果它们
安装在同一主机上时，其数据库必须使用
不同名称！
:::
根据提供的说明创建数据库
[mysql](/manual/appendix/install/db_scripts#mysql) 或
[postgresql](/manual/appendix/install/db_scripts#postgresql).
#### Creating dependent item
Create a dependent item for the master item with ID 24759. Only
dependencies on the same host are allowed, therefore master and the
dependent item should have the same hostid.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"hostid": "30074",
"name": "Dependent test item",
"key_": "dependent.item",
"type": 18,
"master_itemid": "24759",
"value_type": 2
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44211"
]
},
"id": 1
}
```
#### 创建依赖 监控项
为主ID为24759的监控项创建一个依赖的监控项。仅
允许在同一主机上存在依赖关系，因此主节点和
依赖的监控项应具有相同的hostid。
请求
```json
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"hostid": "30074",
"name": "Dependent test item",
"key_": "dependent.item",
"type": 18,
"master_itemid": "24759",
"value_type": 2
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44211"
]
},
"id": 1
}
```
#### Creating dependent item prototype
Create Dependent item prototype for Master item prototype with ID 44211.
Only dependencies on same host (template/discovery rule) are allowed,
therefore Master and Dependent item should have same hostid and ruleid.
Request:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"hostid": "10001",
"ruleid": "27665",
"name": "Dependent test item prototype",
"key_": "dependent.prototype",
"type": 18,
"master_itemid": "44211",
"value_type": 3
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44212"
]
},
"id": 1
}
```
#### 创建依赖的 监控项 原型
为ID为44211的主监控项原型创建依赖监控项原型
仅允许对同一主机（模板/发现规则）的依赖关系
因此主节点和从属节点的监控项应具有相同的主机ID和规则ID。
请求：
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.create",
"params": {
"hostid": "10001",
"ruleid": "27665",
"name": "Dependent test item prototype",
"key_": "dependent.prototype",
"type": 18,
"master_itemid": "44211",
"value_type": 3
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"44212"
]
},
"id": 1
}
```
#### Creating hosts from Monitoring
It is now also possible to create new hosts from *Monitoring* →
*[Hosts](/manual/web_interface/frontend_sections/monitoring/hosts)*.
The *Create host* button is available for Admin and Super Admin users.
#### 从监控创建主机
现在还可以通过*监控* → *[Hosts](/manual/web_interface/frontend_sections/monitoring/hosts)*来create新的主机.
*创建主机*按钮对管理员和超级管理员用户可见.
#### Creating host subgroups
A host subgroup (or nested host group) is a child of the parent host group that contains it. Nested representation of host groups is supported since Zabbix 3.2.0.
A subgroup is created by using the forward slash '/' in the group name input field to denote its relation to the parent group(s). For example:
- inputting `Europe/Latvia` creates the `Europe/Latvia` subgroup of the parent group `Europe`.
- inputting `Europe/Latvia/Riga/Zabbix servers` creates the respective subgroup within the nested parent groups `Europe`, `Europe/Latvia`, `Europe/Latvia/Riga`.
When creating a subgroup, using leading or trailing slashes, or several slashes in a row is not allowed. Escaping of '/' is not supported.
It is not required to create any parent host group(s) before creating a subgroup. You can choose whether to start by creating a subgroup (for example, `Europe/Latvia`) or any parent host group(s) (in our example, `Europe`). If you start by creating a subgroup, parent host group(s) will **not** be created automatically.
#### 创建主机子组
一个主机子组（或称嵌套主机组）是指包含它的父主机组的子项。自Zabbix 3.2.0起支持主机组的嵌套表示。
通过在组名输入字段中使用正斜杠'/'来表示与父组的关系，从而创建子组。例如：
- 输入`Europe/Latvia`会创建父组`Europe`下的`Europe/Latvia`子组。
- 输入`Europe/Latvia/Riga/Zabbix servers`会在嵌套父组`Europe`、`Europe/Latvia`、`Europe/Latvia/Riga`下创建相应的子组。
创建子组时，不允许使用开头或结尾的斜杠，也不允许连续使用多个斜杠。不支持对'/'进行转义。
在创建子组之前，不需要create任何父主机组。您可以选择先创建子组（例如`Europe/Latvia`）或任何父主机组（在我们的示例中为`Europe`）。如果先创建子组，父主机组**不会**自动创建。
#### Creating interfaces
Create an interface on two hosts.
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.massadd",
"params": {
"hosts": [
{
"hostid": "30050"
},
{
"hostid": "30052"
}
],
"interfaces": {
"dns": "",
"ip": "127.0.0.1",
"main": 0,
"port": "10050",
"type": 1,
"useip": 1
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30069",
"30070"
]
},
"id": 1
}
```
#### 创建接口
在两个主机上创建接口.
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.massadd",
"params": {
"hosts": [
{
"hostid": "30050"
},
{
"hostid": "30052"
}
],
"interfaces": {
"dns": "",
"ip": "127.0.0.1",
"main": 0,
"port": "10050",
"type": 1,
"useip": 1
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30069",
"30070"
]
},
"id": 1
}
```
#### Creating multiple triggers
So if create methods accept arrays, we can add multiple
[triggers](/manual/api/reference/trigger/object) like so:
```json
{
"jsonrpc": "2.0",
"method": "trigger.create",
"params": [
{
"description": "Processor load is too high on {HOST.NAME}",
"expression": "last(/Linux server/system.cpu.load[percpu,avg1])>5",
},
{
"description": "Too many processes on {HOST.NAME}",
"expression": "avg(/Linux server/proc.num[],5m)>300",
}
],
"auth": "0424bd59b807674191e7d77572075f33",
"id": 4
}
```
A successful response will contain the IDs of the newly created
triggers:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"17369",
"17370"
]
},
"id": 4
}
```
#### 创建多个触发器
如果create方法接受数组参数，我们可以像这样批量添加
[triggers](/manual/api/reference/trigger/object)：
```json
{
"jsonrpc": "2.0",
"method": "trigger.create",
"params": [
{
"description": "Processor load is too high on {HOST.NAME}",
"expression": "last(/Linux server/system.cpu.load[percpu,avg1])>5",
},
{
"description": "Too many processes on {HOST.NAME}",
"expression": "avg(/Linux server/proc.num[],5m)>300",
}
],
"auth": "0424bd59b807674191e7d77572075f33",
"id": 4
}
```
成功响应将包含新建触发器ID数组：
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"17369",
"17370"
]
},
"id": 4
}
```
##### Creating new secret
The following procedure describes how to create a new secret using
Openshift Console.
**1.** Open the Workloads → Secrets section and switch project to the
Zabbix Operator project (by default, "zabbix").
{width="600"}
**2.** Create a new secret using the *From YAML* option.
{width="600"}
##### 创建新密钥
以下流程描述如何通过Openshift控制台create新密钥.
**1.** 打开Workloads → Secrets部分并切换项目至Zabbix Operator项目(默认为"zabbix").
{width="600"}
**2.** 使用*From YAML*选项创建新密钥.
{width="600"}
### Critical
To complete successful Zabbix server upgrade on MySQL and MariaDB, you may require to set `GLOBAL log_bin_trust_function_creators = 1` in MySQL
if binary logging is enabled, there are no superuser privileges and `log_bin_trust_function_creators = 1` is not set in MySQL configuration file.
To set the variable using the MySQL console, run:
mysql> SET GLOBAL log_bin_trust_function_creators = 1;
Once the upgrade has been successfully completed, `log_bin_trust_function_creators` can be disabled:
mysql> SET GLOBAL log_bin_trust_function_creators = 0;
### 严重
要在MySQL和mariadb上成功完成Zabbix server升级，如果启用了二进制日志记录且没有超级用户权限，同时MySQL配置file中未设置`log_bin_trust_function_creators = 1`，则可能需要在MySQL中设置`GLOBAL log_bin_trust_function_creators = 1`。
要通过MySQL控制台设置该变量，请run：
mysql> SET GLOBAL log_bin_trust_function_creators = 1;
升级成功完成后，可以禁用`log_bin_trust_function_creators`：
mysql> SET GLOBAL log_bin_trust_function_creators = 0;
#### CRL expired or expires during server operation
[*OpenSSL*]{.underline}, in server log:
- before expiration:
```{=html}
<!-- -->
```
cannot connect to proxy "proxy-openssl-1.0.1e": TCP successful, cannot establish TLS to [[127.0.0.1]:20004]:\
SSL_connect() returned SSL_ERROR_SSL: file s3_clnt.c line 1253: error:14090086:\
SSL routines:ssl3_get_server_certificate:certificate verify failed:\
TLS write fatal alert "certificate revoked"
- after expiration:
```{=html}
<!-- -->
```
cannot connect to proxy "proxy-openssl-1.0.1e": TCP successful, cannot establish TLS to [[127.0.0.1]:20004]:\
SSL_connect() returned SSL_ERROR_SSL: file s3_clnt.c line 1253: error:14090086:\
SSL routines:ssl3_get_server_certificate:certificate verify failed:\
TLS write fatal alert "certificate expired"
The point here is that with valid CRL a revoked certificate is reported
as "certificate revoked". When CRL expires the error message changes to
"certificate expired" which is quite misleading.
[*GnuTLS*]{.underline}, in server log:
- before and after expiration the same:
```{=html}
<!-- -->
```
cannot connect to proxy "proxy-openssl-1.0.1e": TCP successful, cannot establish TLS to [[127.0.0.1]:20004]:\
invalid peer certificate: The certificate is NOT trusted. The certificate chain is revoked.
#### CRL 已过期或将在服务器运行期间过期
[*OpenSSL*]{.underline}，在服务器日志中：
- 过期前：
```{=html}
<!-- -->
```
无法连接到proxy "proxy-openssl-1.0.1e"：TCP连接成功，但无法与[[127.0.0.1]:20004]建立TLS连接：\
SSL_connect()返回SSL_ERROR_SSL：file s3_clnt.c第1253行：错误14090086：\
SSL例程：ssl3_get_server_certificate：证书验证失败：\
TLS写入致命警报"证书已吊销"
- 过期后：
```{=html}
<!-- -->
```
无法连接到proxy "proxy-openssl-1.0.1e"：TCP连接成功，但无法与[[127.0.0.1]:20004]建立TLS连接：\
SSL_connect()返回SSL_ERROR_SSL：file s3_clnt.c第1253行：错误14090086：\
SSL例程：ssl3_get_server_certificate：证书验证失败：\
TLS写入致命警报"证书已过期"
关键在于：当CRL有效时，被吊销的证书会报告为"证书已吊销"。而当CRL过期后，错误信息会变为"证书已过期"，这相当具有误导性。
[*GnuTLS*]{.underline}，在服务器日志中：
- 过期前后相同：
```{=html}
<!-- -->
```
无法连接到proxy "proxy-openssl-1.0.1e"：TCP连接成功，但无法与[[127.0.0.1]:20004]建立TLS连接：\
无效的对等证书：该证书不受信任。证书链已被吊销。
### Cryptography
### 密码学
### Custom interface details
The details object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**version**<br>(required)|integer|SNMP interface version.<br><br>Possible values are:<br>1 - SNMPv1;<br>2 - SNMPv2c;<br>3 - SNMPv3|
|bulk|integer|Whether to use bulk SNMP requests.<br><br>Possible values are:<br>0 - don't use bulk requests;<br>1 - *(default)* - use bulk requests.|
|community|string|SNMP community. Used only by SNMPv1 and SNMPv2 interfaces.|
|securityname|string|SNMPv3 security name. Used only by SNMPv3 interfaces.|
|securitylevel|integer|SNMPv3 security level. Used only by SNMPv3 interfaces.<br><br>Possible values are:<br>0 - *(default)* - noAuthNoPriv;<br>1 - authNoPriv;<br>2 - authPriv.|
|authpassphrase|string|SNMPv3 authentication passphrase. Used only by SNMPv3 interfaces.|
|privpassphrase|string|SNMPv3 privacy passphrase. Used only by SNMPv3 interfaces.|
|authprotocol|integer|SNMPv3 authentication protocol. Used only by SNMPv3 interfaces.<br><br>Possible values are:<br>0 - *(default)* - MD5;<br>1 - SHA1;<br>2 - SHA224;<br>3 - SHA256;<br>4 - SHA384;<br>5 - SHA512.|
|privprotocol|integer|SNMPv3 privacy protocol. Used only by SNMPv3 interfaces.<br><br>Possible values are:<br>0 - *(default)* - DES;<br>1 - AES128;<br>2 - AES192;<br>3 - AES256;<br>4 - AES192C;<br>5 - AES256C.|
|contextname|string|SNMPv3 context name. Used only by SNMPv3 interfaces.|
### 自定义接口详情
该 object 详情具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **version**<br>(required) | integer | SNMP 接口 version.<br><br>可能值为:<br>1 - SNMPv1;<br>2 - SNMPv2c;<br>3 - SNMPv3 |
| bulk | integer | 是否使用批量SNMP请求.<br><br>可能值为:<br>0 - 不使用批量请求;<br>1 - *(默认)* - 使用批量请求. |
| community | string | SNMP团体名. 仅用于SNMPv1和SNMPv2接口. |
| securityname | string | SNMPv3安全名称. 仅用于SNMPv3接口. |
| securitylevel | integer | SNMPv3安全级别. 仅用于SNMPv3接口.<br><br>可能值为:<br>0 - *(默认)* - 无认证无加密;<br>1 - 认证无加密;<br>2 - 认证加密. |
| authpassphrase | string | SNMPv3认证密码. 仅用于SNMPv3接口. |
| privpassphrase | string | SNMPv3加密密码. 仅用于SNMPv3接口. |
| authprotocol | integer | SNMPv3认证协议. 仅用于SNMPv3接口.<br><br>可能值为:<br>0 - *(默认)* - MD5;<br>1 - SHA1;<br>2 - SHA224;<br>3 - SHA256;<br>4 - SHA384;<br>5 - SHA512. |
| privprotocol | integer | SNMPv3加密协议. 仅用于SNMPv3接口.<br><br>可能值为:<br>0 - *(默认)* - DES;<br>1 - AES128;<br>2 - AES192;<br>3 - AES256;<br>4 - AES192C;<br>5 - AES256C. |
| contextname | string | SNMPv3上下文名称. 仅用于SNMPv3接口. |
### Custom interface
The custom interface object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dns|string|DNS name used by the interface.<br><br>**Required** if the connection is made via DNS. Can contain macros.|
|ip|string|IP address used by the interface.<br><br>**Required** if the connection is made via IP. Can contain macros.|
|**main**<br>(required)|integer|Whether the interface is used as default on the host. Only one interface of some type can be set as default on a host.<br><br>Possible values are:<br>0 - not default;<br>1 - default.|
|**port**<br>(required)|string|Port number used by the interface. Can contain user and LLD macros.|
|**type**<br>(required)|integer|Interface type.<br><br>Possible values are:<br>1 - agent;<br>2 - SNMP;<br>3 - IPMI;<br>4 - JMX.<br>|
|**useip**<br>(required)|integer|Whether the connection should be made via IP.<br><br>Possible values are:<br>0 - connect using host DNS name;<br>1 - connect using host IP address for this host interface.|
|details|object|Additional object for interface. **Required** if interface 'type' is SNMP.|
### 自定义接口
自定义接口object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dns | string | 接口使用的DNS名称。<br><br>**必填** 如果通过DNS建立连接。可包含宏。 |
| ip | string | 接口使用的IP地址。<br><br>**必填** 如果通过IP建立连接。可包含宏。 |
| **main**<br>(required) | integer | 该接口是否作为主机上的默认接口。同一类型的接口在一个主机上只能有一个被设为默认。<br><br>可能的值为：<br>0 - 非默认；<br>1 - 默认。 |
| **port**<br>(required) | string | 接口使用的端口号。可包含用户和LLD宏。 |
| **type**<br>(required) | integer | 接口类型。<br><br>可能的值为：<br>1 - agent;<br>2 - SNMP;<br>3 - IPMI;<br>4 - JMX.<br> |
| **useip**<br>(required) | integer | 是否应通过IP建立连接。<br><br>可能的值为：<br>0 - 使用主机DNS名称连接；<br>1 - 为此主机接口使用主机IP地址连接。 |
| details | object | 接口的额外object。**必填** 如果接口'类型'类型为SNMP。 |
#### Custom macros
The **LLD macros** tab allows to specify custom low-level discovery
macros.
Custom macros are useful in cases when the returned JSON does not have
the required macros already defined. So, for example:
- The native `vfs.fs.discovery` key for filesystem discovery returns a
JSON with some pre-defined LLD macros such as {\#FSNAME},
{\#FSTYPE}. These macros can be used in item, trigger prototypes
(see subsequent sections of the page) directly; defining custom
macros is not needed;
- The `vfs.fs.get` agent item also returns a JSON with [filesystem
data](/manual/discovery/low_level_discovery/examples/mounted_filesystems),
but without any pre-defined LLD macros. In this case you may define
the macros yourself, and map them to the values in the JSON using
JSONPath:
The extracted values can be used in discovered items, triggers, etc.
Note that values will be extracted from the result of discovery and any
preprocessing steps so far.
|Parameter|Description|
|--|--------|
|*LLD macro*|Name of the low-level discovery macro, using the following syntax: {\#MACRO}.|
|*JSONPath*|Path that is used to extract LLD macro value from an LLD row, using JSONPath syntax.<br>The values extracted from the returned JSON are used to replace the LLD macros in item, trigger, etc. prototype fields.<br>JSONPath can be specified using the dot notation or the bracket notation. Bracket notation should be used in case of any special characters and Unicode, like `$['unicode + special chars #1']['unicode + special chars #2']`.<br><br>For example, `$.foo` will extract "bar" and "baz" from this JSON: `[{"foo":"bar"}, {"foo":"baz"}]`<br>Note that `$.foo` will extract "bar" and "baz" also from this JSON: `{"data":[{"foo":"bar"}, {"foo":"baz"}]}` because a single "data" object is processed automatically (for [backwards compatibility](#overview) with the low-level discovery implementation in Zabbix versions before 4.2).|
#### 自定义宏
**LLD宏**选项卡允许指定自定义低级发现宏。
当返回的JSON未定义所需宏时，自定义宏非常有用。例如：
- 原生文件系统发现的`vfs.fs.discovery`键会返回包含预定义LLD宏（如{\#FSNAME}、{\#FSTYPE}）的JSON。这些宏可直接用于监控项和触发器原型（参见本页后续章节），无需定义自定义宏；
- `vfs.fs.get` agent 监控项同样返回包含[filesystem
data](/manual/discovery/low_level_discovery/examples/mounted_filesystems),
but without any pre-defined LLD macros. In this case you may define
the macros yourself, and map them to the values in the JSON using
JSONPath:
的JSON
提取的值可用于发现的监控项、触发器等。注意这些值将从发现结果及当前所有预处理步骤中提取。
| 参数 | 描述 |
|--|--------|
| *LLD macro* | 低级发现宏名称，使用以下语法：{\#MACRO}。 |
| *JSONPath* | 用于从LLD行提取LLD宏值的路径，采用JSONPath语法。<br>从返回JSON中提取的值将替换监控项、触发器等原型字段中的LLD宏。<br>JSONPath可使用点表示法或括号表示法。若存在特殊字符和Unicode（如`$['unicode + special chars #1']['unicode + special chars #2']`），应使用括号表示法。<br><br>例如，`$.foo`将从以下JSON提取"bar"和"baz"：`[{"foo":"bar"}, {"foo":"baz"}]`<br>注意`$.foo`也会从该JSON提取"bar"和"baz"：`{"data":[{"foo":"bar"}, {"foo":"baz"}]}`，因为单个"data" object会被自动处理（以保持与Zabbix 4.2之前版本低级发现实现的[向后兼容性](#overview)）。 |
#### Custom script limit
Available custom script length depends on the database used:
|Database|Limit in characters|Limit in bytes|
|---|---|---|
|**MySQL**|65535|65535|
|**Oracle Database**|2048|4000|
|**PostgreSQL**|65535|not limited|
|**SQLite (only Zabbix proxy)**|65535|not limited|
#### 自定义脚本限制
可用自定义脚本长度取决于所使用的数据库:
| 数据库 | 字符数限制 | 字节数限制 |
|---|---|---|
| **MySQL** | 65535 | 65535 |
| **Oracle Database** | 2048 | 4000 |
| **PostgreSQL** | 65535 | 无限制 |
| **SQLite (仅Zabbix proxy)** | 65535 | 无限制 |
# dashboard.create
# dashboard.create
# dashboard.delete
# dashboard.delete
# dashboard.get
# dashboard.get
### Dashboard page
The dashboard page object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dashboard\_pageid|string|*(readonly)* ID of the dashboard page.|
|name|string|Dashboard page name.<br><br>Default: empty string.|
|display\_period|integer|Dashboard page display period (in seconds).<br><br>Possible values: 0, 10, 30, 60, 120, 600, 1800, 3600.<br><br>Default: 0 (will use the default page display period).|
|widgets|array|Array of the [dashboard widget](object#dashboard-widget) objects.|
### 仪表板页面
仪表板页面object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dashboard\_pageid | string | *(只读)* 仪表板页面的ID。 |
| name | string | 仪表板页面名称。<br><br>默认值：空string。 |
| display\_period | integer | 仪表板页面显示周期（以秒为单位）。<br><br>可能的值：0, 10, 30, 60, 120, 600, 1800, 3600。<br><br>默认值：0（将使用默认页面显示周期）。 |
| widgets | array | array的[仪表板小部件](object#仪表板小部件)objects。 |
##### Dashboard size
The minimum width of a dashboard is 1200 pixels. The dashboard will not shrink below this width; instead a
horizontal scrollbar is displayed if the browser window is smaller than that.
The maximum width of a dashboard is the browser window width. Dashboard widgets stretch horizontally to fit the window.
At the same time, a dashboard widget cannot be stretched horizontally beyond the window limits.
Technically the dashboard consists of 12 horizontal columns of always equal width that stretch/shrink dynamically (but
not to less than 1200 pixels total).
Vertically the dashboard may contain a maximum of 64 rows. Each row has a fixed height of 70 pixels. A widget may be
up to 32 rows high.
##### 仪表板尺寸
仪表板的最小宽度为1200像素。当浏览器窗口小于该宽度时，仪表板不会进一步收缩，而是显示水平滚动条。
仪表板的最大宽度为浏览器窗口宽度。仪表板小部件会水平拉伸以适应窗口。同时，仪表板小部件不能超出窗口限制进行水平拉伸。
从技术上讲，仪表板由12个水平列组成，这些列的宽度始终保持相等并动态拉伸/收缩（但总宽度不会小于1200像素）。
垂直方向上，仪表板最多可包含64行。每行固定高度为70像素。一个小部件的高度最多可达32行。
#### Dashboards
Manage dashboards and make scheduled reports based on them.
[Dashboard API](/manual/api/reference/dashboard) | [Template dashboard
API](/manual/api/reference/templatedashboard) | [Report
API](/manual/api/reference/report)
#### 仪表盘
管理仪表盘并基于它们生成定期报告。
[Dashboard API](/manual/api/reference/dashboard) | [Template dashboard
API](/manual/api/reference/templatedashboard) | [Report
API](/manual/api/reference/report)
### Dashboard
The dashboard object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dashboardid|string|*(readonly)* ID of the dashboard.|
|**name**<br>(required)|string|Name of the dashboard.|
|userid|string|Dashboard owner user ID.|
|private|integer|Type of dashboard sharing.<br><br>Possible values:<br>0 - public dashboard;<br>1 - *(default)* private dashboard.|
|display\_period|integer|Default page display period (in seconds).<br><br>Possible values: 10, 30, 60, 120, 600, 1800, 3600.<br><br>Default: 30.|
|auto\_start|integer|Auto start slideshow.<br><br>Possible values:<br>0 - do not auto start slideshow;<br>1 - *(default)* auto start slideshow.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 仪表板
仪表板 object 具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dashboardid | string | *(只读)* 仪表板的ID. |
| **name**<br>(required) | string | 仪表板的名称. |
| userid | string | 仪表板所有者的用户ID. |
| private | integer | 仪表板共享类型.<br><br>可能的值:<br>0 - 公共仪表板;<br>1 - *(默认)* 私有仪表板. |
| display\_period | integer | 默认页面显示周期(以秒为单位).<br><br>可能的值: 10, 30, 60, 120, 600, 1800, 3600.<br><br>默认值: 30. |
| auto\_start | integer | 自动启动幻灯片播放.<br><br>可能的值:<br>0 - 不自动启动幻灯片播放;<br>1 - *(默认)* 自动启动幻灯片播放. |
请注意，对于某些方法 (update, delete) 所需/可选参数的组合是不同的.
# dashboard.update
# dashboard.update
### Dashboard user group
List of dashboard permissions based on user groups. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**usrgrpid**<br>(required)|string|User group ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write.|
### Dashboard 用户组
基于用户组的仪表板权限列表. 具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **usrgrpid**<br>(required) | string | 用户组ID. |
| **permission**<br>(required) | integer | 权限级别类型.<br><br>可能的值:<br>2 - 只读;<br>3 - 读写. |
### Dashboard user
List of dashboard permissions based on users. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**userid**<br>(required)|string|User ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write.|
### 仪表盘用户
基于用户的仪表板权限列表。包含以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **userid**<br>(required) | string | 用户ID。 |
| **permission**<br>(required) | integer | 权限级别类型。<br><br>可选值：<br>2 - 只读；<br>3 - 读写。 |
# Dashboard widget fields
# 仪表板小部件字段
### Dashboard widget field
The dashboard widget field object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**type**<br>(required)|integer|Type of the widget field.<br><br>Possible values:<br>0 - Integer;<br>1 - String;<br>2 - Host group;<br>3 - Host;<br>4 - Item;<br>5 - Item prototype;<br>6 - Graph;<br>7 - Graph prototype;<br>8 - Map;<br>9 - Service;<br>10 - SLA.|
|**name**<br>(required)|string|Widget field name.<br><br>Possible values: see [Dashboard widget fields](/manual/api/reference/dashboard/widget_fields).|
|**value**<br>(required)|mixed|Widget field value depending on the type.<br><br>Possible values: see [Dashboard widget fields](/manual/api/reference/dashboard/widget_fields).|
### 仪表板小部件字段
仪表板小部件字段object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **type**<br>(required) | integer | 小部件字段类型。<br><br>可能的值：<br>0 - integer;<br>1 - string;<br>2 - 主机组;<br>3 - 主机;<br>4 - 监控项;<br>5 - 监控项原型;<br>6 - 图形;<br>7 - 图形原型;<br>8 - 地图;<br>9 - 服务;<br>10 - SLA。 |
| **name**<br>(required) | string | 小部件字段名称。<br><br>可能的值：参见[Dashboard widget fields](/manual/api/reference/dashboard/widget_fields)。 |
| **value**<br>(required) | mixed | 根据类型确定的小部件字段值。<br><br>可能的值：参见[Dashboard widget fields](/manual/api/reference/dashboard/widget_fields)。 |
### Dashboard widget
The dashboard widget object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|widgetid|string|*(readonly)* ID of the dashboard widget.|
|**type**<br>(required)|string|Type of the dashboard widget.<br><br>Possible values:<br>actionlog - Action log;<br>clock - Clock;<br>dataover - Data overview;<br>discovery - Discovery status;<br>favgraphs - Favorite graphs;<br>favmaps - Favorite maps;<br>graph - Graph (classic);<br>graphprototype - Graph prototype;<br>hostavail - Host availability;<br>item - Item value;<br>map - Map;<br>navtree - Map Navigation Tree;<br>plaintext - Plain text;<br>problemhosts - Problem hosts;<br>problems - Problems;<br>problemsbysv - Problems by severity;<br>svggraph - Graph;<br>systeminfo - System information;<br>trigover - Trigger overview;<br>url - URL;<br>web - Web monitoring.|
|name|string|Custom widget name.|
|x|integer|A horizontal position from the left side of the dashboard.<br><br>Valid values range from 0 to 23.|
|y|integer|A vertical position from the top of the dashboard.<br><br>Valid values range from 0 to 62.|
|width|integer|The widget width.<br><br>Valid values range from 1 to 24.|
|height|integer|The widget height.<br><br>Valid values range from 2 to 32.|
|view\_mode|integer|The widget view mode.<br><br>Possible values:<br>0 - (default) default widget view;<br>1 - with hidden header;|
|fields|array|Array of the [dashboard widget field](object#dashboard_widget_field) objects.|
### 仪表板小部件字段
仪表板小部件字段对象具有以下属性：
|属性 类|描述|<|
|------------------|------|-|
|**type**<br>（需要的）|整数 小<br>|件字段的值。<br>可能的值：<br>0 - 整数；<br>1 - 字符串；<br>2 - 主机组；<br>3 - 主机；<br>4 - 监控项；<br>6 - 图形；<br>8 - 拓扑图；|
|name|字符串 小部|字段的名称。|
|**value**<br>（需要的）|混合型 取决|类型的小部件字段值。|
### Dashboard widget
The dashboard widget object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|widgetid|string|*(readonly)* ID of the dashboard widget.|
|**type**<br>(required)|string|Type of the dashboard widget.<br><br>Possible values:<br>actionlog - Action log;<br>clock - Clock;<br>*(deprecated)* dataover - Data overview;<br>discovery - Discovery status;<br>favgraphs - Favorite graphs;<br>favmaps - Favorite maps;<br>geomap - Geomap;<br>graph - Graph (classic);<br>graphprototype - Graph prototype;<br>hostavail - Host availability;<br>item - Item value;<br>map - Map;<br>navtree - Map Navigation Tree;<br>plaintext - Plain text;<br>problemhosts - Problem hosts;<br>problems - Problems;<br>problemsbysv - Problems by severity;<br>slareport - SLA report;<br>svggraph - Graph;<br>systeminfo - System information;<br>tophosts - Top hosts;<br>trigover - Trigger overview;<br>url - URL;<br>web - Web monitoring.|
|name|string|Custom widget name.|
|x|integer|A horizontal position from the left side of the dashboard.<br><br>Valid values range from 0 to 23.|
|y|integer|A vertical position from the top of the dashboard.<br><br>Valid values range from 0 to 62.|
|width|integer|The widget width.<br><br>Valid values range from 1 to 24.|
|height|integer|The widget height.<br><br>Valid values range from 2 to 32.|
|view\_mode|integer|The widget view mode.<br><br>Possible values:<br>0 - *(default)* default widget view;<br>1 - with hidden header;|
|fields|array|Array of the [dashboard widget field](object#dashboard-widget-field) objects.<br><br>Required for specific widgets; see individual widgets in [Dashboard widget fields](/manual/api/reference/dashboard/widget_fields).|
### 仪表板小部件
仪表板小部件object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| widgetid | string | *(只读)* 仪表板小部件的ID。 |
| **type**<br>(required) | string | 仪表板小部件的类型。<br><br>可能的值：<br>actionlog - 操作日志；<br>clock - 时钟；<br>*(已弃用)* dataover - 数据概览；<br>discovery - 发现状态；<br>favgraphs - 收藏图表；<br>favmaps - 收藏地图；<br>geomap - 地理地图；<br>graph - 图表（经典）；<br>graphprototype - 图表原型；<br>hostavail - 主机可用性；<br>监控项 - 监控项值；<br>map - 地图；<br>navtree - 地图导航树；<br>plaintext - 纯文本；<br>problemhosts - 问题主机；<br>problems - 问题；<br>problemsbysv - 按严重程度分类的问题；<br>slareport - SLA报告；<br>svggraph - 图表；<br>systeminfo - 系统信息；<br>tophosts - Top 主机；<br>trigover - 触发器概览；<br>url - URL；<br>web - 网页监控。 |
| name | string | 自定义小部件名称。 |
| x | integer | 距离仪表板左侧的水平位置。<br><br>有效值范围为0到23。 |
| y | integer | 距离仪表板Top的垂直位置。<br><br>有效值范围为0到62。 |
| width | integer | 小部件宽度。<br><br>有效值范围为1到24。 |
| height | integer | 小部件高度。<br><br>有效值范围为2到32。 |
| view\_mode | integer | 小部件视图模式。<br><br>可能的值：<br>0 - *(默认)* 默认小部件视图；<br>1 - 隐藏标题； |
| fields | array | [仪表板小部件字段](object#仪表板小部件字段)objects的array。<br><br>特定小部件需要；参见[Dashboard widget fields](/manual/api/reference/dashboard/widget_fields)中的各个小部件。 |
#### Database changes
A slow template cloning issue has been resolved by adding indexes for the uuid field. This change may cause long upgrade times on large datasets.
#### 数据库变更
通过为uuid字段添加索引，解决了问题模板克隆缓慢的问题。该变更可能导致大型数据集升级时间延长。
### Database creation
We assume that a *zabbix* database user with *password* password exists
and has permissions to create database objects in ORCL service located
on the *host* Oracle database server. Zabbix requires a Unicode database
character set and a `UTF8` national character set. Check current
settings:
sqlplus> select parameter,value from v$nls_parameters where parameter='NLS_CHARACTERSET' or parameter='NLS_NCHAR_CHARACTERSET';
Now prepare the database:
cd /path/to/zabbix-sources/database/oracle
sqlplus zabbix/password@oracle_host/ORCL
sqlplus> @schema.sql
# stop here if you are creating database for Zabbix proxy
sqlplus> @images.sql
sqlplus> @data.sql
::: notetip
Please set the initialization parameter
CURSOR\_SHARING=FORCE for best performance.
:::
### 数据库创建
我们假设已存在一个密码为*password*的*zabbix*数据库用户
且该用户对位于*主机* Oracle数据库服务器上ORCL服务中的
create数据库objects具有权限。Zabbix要求数据库使用Unicode字符集
及`UTF8`国家字符集。请检查当前设置：
sqlplus> select parameter,value from v$nls_parameters where parameter='NLS_CHARACTERSET' or parameter='NLS_NCHAR_CHARACTERSET';
现在准备数据库：
cd /path/to/zabbix-sources/database/oracle
sqlplus zabbix/password@oracle_host/ORCL
sqlplus> @schema.sql
# stop here if you are creating database for Zabbix proxy
sqlplus> @images.sql
sqlplus> @data.sql
::: notetip
为获得最佳性能，请将初始化参数
CURSOR\_SHARING设置为FORCE。
:::
#### Database credentials
It is supported to store database credentials used by Zabbix server,
proxies and frontend secretly in Vault:
- Vault-related parameters for retrieving database credentials can be
optionally entered in the frontend [installation
wizard](/manual/installation/frontend).
Database credentials retrieved from Vault will be cached by the
frontend. Note that the filesystem temporary file directory is used for
database credential caching in frontend. You may use the
ZBX\_DATA\_CACHE\_TTL [constant](/manual/web_interface/definitions) to
control how often the data cache is refreshed/invalidated.
- For server/proxy the VaultDBPath configuration parameter may be used
to specify the path from where credentials for database will be
retrieved by keys 'password' and 'username' (for example:
secret/zabbix/database).
The following commands may be used to set the values for the path
mentioned in example:
# Enable "secret/" mount point if not already enabled, note that "kv-v2" must be used
vault secrets enable -path=secret/ kv-v2
# Put new secrets with keys username and password under mount point "secret/" and path "secret/zabbix/database"
vault kv put secret/zabbix/database username=zabbix password=<password>
# Test that secret is successfully added
vault kv get secret/zabbix/database
# Finally test with Curl, note that "data" need to be manually added after mount point and "/v1" before the mount point, also see --capath parameter
curl --header "X-Vault-Token: <VaultToken>" https://127.0.0.1:8200/v1/secret/data/zabbix/database
#### 数据库凭据
支持将Zabbix server、proxies及前端使用的数据库凭证安全存储在Vault中：
- 用于获取数据库凭证的Vault相关参数可配置
optionally entered in the frontend [installation
wizard](/manual/installation/frontend).
从Vault获取的数据库凭证将由前端进行缓存。需注意前端使用文件系统临时file目录作为数据库凭证缓存位置。可通过ZBX\_DATA\_CACHE\_TTL[constant](/manual/web_interface/definitions)参数控制数据缓存的刷新/失效频率。
- 对于server/proxy可使用VaultDBPath配置参数
to specify the path from where credentials for database will be
retrieved by keys 'password' and 'username' (for example:
secret/zabbix/database).
以下命令可用于设置示例中提及路径的对应值：
# Enable "secret/" mount point if not already enabled, note that "kv-v2" must be used
vault secrets enable -path=secret/ kv-v2
# 在挂载点"secret/"和路径"secret/zabbix/database"下新增包含username和password键的密钥
vault kv put secret/zabbix/database username=zabbix password=<password>
# 测试密钥是否成功添加
vault kv get secret/zabbix/database
# 最后使用Curl测试，注意需在挂载点后手动添加"data"并在挂载点前添加"/v1"，另见--capath参数
curl --header "X-Vault-Token: <VaultToken>" https://127.0.0.1:8200/v1/secret/data/zabbix/database
#### Database engine
This is probably the most important part of Zabbix tuning. Zabbix
heavily depends on the availability and performance of database engine.
- use fastest database engine, i.e. MySQL or PostgreSQL
- use stable release of a database engine
- rebuild MySQL or PostgreSQL from sources to get maximum performance
- follow performance tuning instructions taken from MySQL or
PostgreSQL documentation
- for MySQL, use InnoDB table structure
- ZABBIX works at least 1.5 times faster (comparing to MyISAM) if
InnoDB is used. This is because of increased parallelism. However,
InnoDB requires more CPU power.
- tuning the database server for the best performance is highly
recommended.
- keep database tables on different hard disks
- 'history', 'history\_str, 'items' 'functions', triggers', and
'trends' are most heavily used tables.
- for large installations keeping MySQL temporary files in tmpfs is:
- MySQL >= 5.5: not recommended ([MySQL bug
\#58421](https://bugs.mysql.com/bug.php?id=58421))
- MySQL < 5.5: recommended
#### 数据库引擎
这可能是 Zabbix 调优中最重要的部分。Zabbix 很大程度上依赖于数据库引擎的可用性和性能。
- 使用最快的数据库引擎，即 MySQL 或 PostgreSQL
- 使用稳定版本的数据库引擎
- 从源代码重建 MySQL 或 PostgreSQL 以获得最佳性能
- 遵循从 MySQL 或 PostgreSQL 文档中获取的性能调整说明
- 对于 MySQL，使用 InnoDB 表结构
- 如果使用 InnoDB，ZABBIX 的运行速度至少快 1.5 倍（与 MyISAM 相比）。这是因为增加了并行性。然而，InnoDB 需要更多的 CPU算力
- 强烈建议调整数据库服务器以获得最佳性能
- 将数据库表保存在不同的硬盘上
- 'history', 'history\_str, 'items' 'functions', triggers', 和'trends' 是使用最频繁的表。
- 对于将 MySQL 临时文件保存在 tmpfs 中的大型安装是：
- MySQL >= 5.5: 不推荐 ([MySQL 错误 \#58421](https://bugs.mysql.com/bug.php?id=58421))
- MySQL < 5.5: 推荐
##### Database management system
|Software|Supported versions|Comments|
|--------|------------------|--------|
|*MySQL/Percona*|8.0.X|Required if MySQL (or Percona) is used as Zabbix backend database. InnoDB engine is required. We recommend using the [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) library for building server/proxy.|
|*MariaDB*|10.5.00-10.6.X|InnoDB engine is required. We recommend using the [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) library for building server/proxy.|
|*Oracle*|19c - 21c|Required if Oracle is used as Zabbix backend database.|
|*PostgreSQL*|13.0 - 14.X|Required if PostgreSQL is used as Zabbix backend database.|
|*TimescaleDB* for PostgreSQL|2.0.1-2.3|Required if TimescaleDB is used as Zabbix backend database. Make sure to install the distribution of TimescaleDB with the compression supported.|
|*SQLite*|3.3.5-3.34.X|SQLite is only supported with Zabbix proxies. Required if SQLite is used as Zabbix proxy database.|
::: noteclassic
Although Zabbix can work with databases available in the
operating systems, for the best experience, we recommend using databases
installed from the official database developer repositories.
:::
##### 数据库管理系统
|数据库软件|支持的版本|备注|
|--------|------------------|--------|
|*MySQL/Percona*|8.0.X|如果需要使用 MySQL (or Percona) 作为 Zabbix 后端数据库。 需要 InnoDB engine 。 我们推荐使用 [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) 来构建 server/proxy。|
|*MariaDB*|10.5.00-10.6.X|需要 InnoDB engine 。我们推荐使用 [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) 来构建 server/proxy。|
|*Oracle*|19c - 21c|如果需要使用 Oracle 作为 Zabbix 后端数据库。|
|*PostgreSQL*|13.0 - 14.X|如果需要使用 PostgreSQL 作为 Zabbix 后端数据库。|
|*TimescaleDB* for PostgreSQL|2.0.1-2.3|如果需要使用 TimescaleDB 作为 Zabbix 后端数据库。确保安装的 TimescaleDB 发行版支持压缩。|
|*SQLite*|3.3.5-3.34.X|如果需要使用 SQLite 作为 Zabbix 后端数据库。 SQLite 只支持 Zabbix proxy。|
::: noteclassic
尽管 Zabbix 可以使用操作系统中可用的数据库，但为了获得最佳体验，我们建议使用从官方数据库开发者仓库安装的数据库。
:::
##### Database management system
|Software|Supported versions|Comments|
|--------|------------------|--------|
|*MySQL/Percona*|8.0.X|Required if MySQL (or Percona) is used as Zabbix backend database. InnoDB engine is required. We recommend using the [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) library for building server/proxy.|
|*MariaDB*|10.5.00-10.6.X|InnoDB engine is required. We recommend using the [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) library for building server/proxy.|
|*Oracle*|19c - 21c|Required if Oracle is used as Zabbix backend database.|
|*PostgreSQL*|13.X|Required if PostgreSQL is used as Zabbix backend database.|
|*TimescaleDB* for PostgreSQL|2.0.1-2.3|Required if TimescaleDB is used as Zabbix backend database. Make sure to install the distribution of TimescaleDB with the compression supported.|
|*SQLite*|3.3.5-3.34.X|SQLite is only supported with Zabbix proxies. Required if SQLite is used as Zabbix proxy database.|
::: noteclassic
Although Zabbix can work with databases available in the
operating systems, for the best experience, we recommend using databases
installed from the official database developer repositories.
:::
##### 数据库管理系统
|数据库软件|支持的版本|备注|
|--------|------------------|--------|
|*MySQL/Percona*|8.0.X|如果需要使用 MySQL (or Percona) 作为 Zabbix 后端数据库。 需要 InnoDB engine 。 我们推荐使用 [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) 来构建 server/proxy。|
|*MariaDB*|10.5.00-10.6.X|需要 InnoDB engine 。 我们推荐使用 [MariaDB Connector/C](https://downloads.mariadb.org/connector-c/) 来构建 server/proxy。|
|*Oracle*|19c - 21c|如果需要使用 Oracle 作为 Zabbix 后端数据库。|
|*PostgreSQL*|13.X|如果需要使用 PostgreSQL 作为 Zabbix 后端数据库。|
|*TimescaleDB* for PostgreSQL|2.0.1-2.3|如果需要使用 TimescaleDB 作为 Zabbix 后端数据库。确保安装的 TimescaleDB 发行版支持压缩。|
|*SQLite*|3.3.5-3.34.X| 如果需要使用 SQLite 作为 Zabbix 后端数据库。 SQLite 只支持 Zabbix proxy。|
::: noteclassic
尽管 Zabbix 可以使用操作系统中可用的数据库，但为了获得最佳体验，我们建议使用从官方数据库开发者仓库安装的数据库。
:::
## Databases
## 数据库
## Databases
## 数据库
## Databases
## 数据库
## Databases
## 数据库
## Databases
## 数据库
## Databases
## 数据库
## Databases
## 数据库
## Databases
## 数据库
## Databases
## 数据库
## Databases
#### Supported versions
PostgreSQL **16** and MariaDB **11.1** are now supported. See also: [Requirements](/manual/installation/requirements#third-party-external-surrounding-software).
## 数据库
#### 支持版本
PostgreSQL **16** 和 mariadb **11.1** 现已获得支持。另请参阅：[第三方外部配套软件](/manual/installation/requirements#第三方外部配套软件)。
## Databases
To create the optimal user experience and ensure the best Zabbix performance in various production environments, the
support of some older database releases has been dropped. This primarily applies to the database versions that are
nearing their end of service life point and versions with unfixed issues that may interfere with normal performance.
Starting from Zabbix 6.0, the following [database](/manual/installation/requirements#required-software) versions are officially
supported:
- *MySQL/Percona* 8.0.X
- *MariaDB* 10.5.X - 10.6.X
- *PostgreSQL* 13.X - 14.X
- *Oracle* 19c - 21c
- *TimescaleDB* 2.0.1-2.3
- *SQLite* 3.3.5-3.34.X
By default, Zabbix server and proxy will not start if an unsupported database version is detected. It is now possible,
though not recommended, to turn off DB version check by modifying AllowUnsupportedDBVersions configuration parameter for
the [server](/manual/appendix/config/zabbix_server) or [proxy](/manual/appendix/config/zabbix_proxy).
## 数据库
为了create最佳用户体验并确保Zabbix在各种生产环境中获得最佳性能
部分旧版数据库版本已停止支持。这主要适用于那些已
接近其服务寿命终点且版本存在未修复的问题问题，可能影响正常性能。
自Zabbix 6.0起，以下[所需软件](/manual/installation/requirements#所需软件)版本正式
支持
- *MySQL/Percona* 8.0.X
- *mariadb* 10.5.X - 10.6.X
- *PostgreSQL* 13.X - 14.X
- *Oracle* 19c - 21c
- *TimescaleDB* 2.0.1-2.3
- *SQLite* 3.3.5-3.34.X
默认情况下，如果检测到不支持的数据库version，Zabbix server和proxy将不会启动。现在可以，
尽管不推荐，但可以通过修改AllowUnsupportedDBVersions配置参数来关闭数据库version检查
[server](/manual/appendix/config/zabbix_server) 或 [proxy](/manual/appendix/config/zabbix_proxy)。
##### Databases
To create the optimal user experience and ensure the best Zabbix
performance in various production environments, the support of some
older database releases has been dropped. This primarily applies to the
database versions that are nearing their end of service life point and
versions with unfixed issues that may interfere with normal performance.
Starting from Zabbix 6.0, the following
[database](/manual/installation/requirements#required-software) versions are officially supported:
- *MySQL/Percona* 8.0.X
- *MariaDB* 10.5.X - 10.6.X
- *PostgreSQL* 13.X
- *Oracle* 19c - 21c
- *TimescaleDB* 2.0.1-2.3
- *SQLite* 3.3.5-3.34.X
By default, Zabbix server and proxy will not start if an unsupported
database version is detected. It is now possible, though not
recommended, to turn off DB version check by modifying
AllowUnsupportedDBVersions configuration parameter for the
[server](/manual/appendix/config/zabbix_server) or
[proxy](/manual/appendix/config/zabbix_proxy).
##### 数据库
为create最佳用户体验并确保Zabbix在各种生产环境中获得最优性能，我们停止了对部分旧版数据库的支持。这主要适用于即将终止服务周期的数据库版本以及存在未修复问题可能影响正常性能的版本。
从Zabbix 6.0开始，官方支持以下[所需软件](/manual/installation/requirements#所需软件)版本：
- *MySQL/Percona* 8.0.X
- *mariadb* 10.5.X - 10.6.X
- *PostgreSQL* 13.X
- *Oracle* 19c - 21c
- *TimescaleDB* 2.0.1-2.3
- *SQLite* 3.3.5-3.34.X
默认情况下，当检测到不受支持的数据库version时，Zabbix server和proxy将不会启动。不过现在可以通过修改[server](/manual/appendix/config/zabbix_server)或[proxy](/manual/appendix/config/zabbix_proxy)的AllowUnsupportedDBVersions配置参数来关闭数据库version检查（尽管不建议这样做）。
### Databases
To create the optimal user experience and ensure the best Zabbix
performance in various production environments, the support of some
older database releases has been dropped. This primarily applies to the
database versions that are nearing their end of service life point and
versions with unfixed issues that may interfere with normal performance.
Starting from Zabbix 6.0, the following
[database](/manual/installation/requirements#Software) versions are
officially supported:
- *MySQL/Percona* 8.0.X
- *MariaDB* 10.5.X - 10.6.X
- *PostgreSQL* 13.X
- *Oracle* 19c - 21c
- *TimescaleDB* 2.0.1-2.3
- *SQLite* 3.3.5-3.34.X
By default, Zabbix server and proxy will not start if an unsupported
database version is detected. It is now possible, though not
recommended, to turn off DB version check by modifying
AllowUnsupportedDBVersions configuration parameter for the
[server](/manual/appendix/config/zabbix_server) or
[proxy](/manual/appendix/config/zabbix_proxy).
### JavaScript methods
HTTP methods PATCH, HEAD, OPTIONS, TRACE, CONNECT have been added to the
JavaScript engine. Also, the engine now allows sending custom HTTP
method requests with the new JS method HttpRequest.customRequest.
See also: [Additional JavaScript
objects](/manual/config/items/preprocessing/javascript/javascript_objects).
##### Database storage
All configuration information as well as the data gathered by Zabbix is
stored in a database.
##### 数据库存储
所有配置信息以及Zabbix收集的数据均存储在数据库中。
#### Database TLS connection for MySQL on SLES 12
The packages for server/proxy installation on SUSE Linux Enterprise Server version 12 are now built using
MariaDB Connector/C library, thus enabling the encryption of connection to MySQL
using the DBTLSConnect [parameter](/manual/appendix/config/zabbix_server).
The supported encryption values are "required" and "verify\_full".
#### SLES 12 上 MySQL 的数据库 TLS 连接
在SUSE Linux Enterprise Server version 12上安装server/proxy的软件包现在使用
mariadb Connector/C库构建，从而支持通过DBTLSConnect [parameter](/manual/appendix/config/zabbix_server)
实现MySQL连接的加密。
支持的加密值为"required"和"verify\_full"。
#### Database TLS connection with MariaDB
Database TLS connection is not supported with the *verify\_ca* option
for the DBTLSConnect [parameter](/manual/appendix/config/zabbix_server)
if MariaDB is used.
#### 数据库 TLS 连接与 mariadb
数据库TLS连接不支持在使用mariadb时
为DBTLSConnect [parameter](/manual/appendix/config/zabbix_server)
配置*verify_ca*选项
##### Data collection with parameters
Collect the content of a specific page and make use of parameters:
- Create an item with type "Script" and two parameters:
- **url : {$DOMAIN}** (the user macro {$DOMAIN} should be defined, preferably on the host level)
- **subpage : /release_notes**
{width=600}
- In the *Script* field, enter:
```javascript
var obj = JSON.parse(value);
var url = obj.url;
var subpage = obj.subpage;
var request = new HttpRequest();
return request.get(url + subpage);
```
##### 带参数的数据收集
收集特定页面的内容并利用参数:
- 创建一个类型为"脚本"的监控项并设置两个参数:
- **url : {$DOMAIN}** (the user macro {$DOMAIN} should be defined, preferably on the host level)
- **subpage : /release_notes**
{width=600}
- 在*脚本*字段中输入:
```javascript
var obj = JSON.parse(value);
var url = obj.url;
var subpage = obj.subpage;
var request = new HttpRequest();
return request.get(url + subpage);
```
#### Data flow
In addition it is important to take a step back and have a look at the
overall data flow within Zabbix. In order to create an item that gathers
data you must first create a host. Moving to the other end of the Zabbix
spectrum you must first have an item to create a trigger. You must have
a trigger to create an action. Thus if you want to receive an alert that
your CPU load is too high on *Server X* you must first create a host
entry for *Server X* followed by an item for monitoring its CPU, then a
trigger which activates if the CPU is too high, followed by an action
which sends you an email. While that may seem like a lot of steps, with
the use of templating it really isn't. However, due to this design it is
possible to create a very flexible setup.
#### 数据流
此外，退一步审视Zabbix内部整体数据流非常重要。为了create一个收集数据的监控项，你必须先create一个主机。转到Zabbix体系的另一端，你必须先有一个监控项才能create触发器。你必须有一个触发器才能create动作。因此，如果你想收到*服务器X* CPU负载过高的警报，你必须先为*服务器X* create一个主机条目，接着创建一个监控其CPU的监控项，然后设置一个在CPU过高时激活的触发器，最后配置一个发送邮件给你的动作。虽然这看起来步骤很多，但通过使用模板功能其实并不复杂。然而，正是这种设计使得create非常灵活的配置成为可能。
#### Data limits for return values
There is no limit for low-level discovery rule JSON data if it is received directly by Zabbix server.
This is because the return values are processed without being stored in a database.
There is also no limit for custom low-level discovery rules.
However, if custom low-level discovery rule data is retrieved using a user parameter, the user parameter [return value limit](/manual/config/items/userparameters#command-result) applies.
If data has to go through Zabbix proxy, it has to store this data in the database.
In such a case, [database limits](/manual/config/items/item#text_data_limits) apply.
#### 返回值数据限制
如果低级发现规则的JSON数据直接由Zabbix server接收，则没有大小限制。
这是因为返回值会被直接处理而无需存储在数据库中。
自定义低级发现规则同样没有限制。
但如果通过用户参数获取自定义低级发现规则数据，则需遵守用户参数[命令结果](/manual/config/items/userparameters#命令结果)的限制。
若数据必须经由Zabbix proxy处理，则需将数据存入数据库。
这种情况下，需遵循[文本数据限制](/manual/config/items/item#文本数据限制)的限制。
#### Data set
The following parameters are supported for configuring a *Data set*.
::: noteclassic
The first number in the property name (e.g. ds.hosts.0.0, ds.items.0.0) represents the particular data set,
while the second number, if present, represents the configured host or item.
:::
|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|***Host pattern***<br>(required)|1|ds.hosts.0.0|[Host](/manual/api/reference/host/get) name or pattern (e.g. `Zabbix*`).|
|***Item pattern***<br>(required)|1|ds.items.0.0|[Item](/manual/api/reference/item/get) name or pattern (e.g. `*: Number of processed *values per second`).|
|*Color*|1|ds.color.0|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: `FF465C`.|
|*Draw*|0|ds.type.0|0 - *(default)* Line;<br>1 - Points;<br>2 - Staircase;<br>3 - Bar.|
|*Width*|0|ds.width.0|Valid values range from 1-10.<br><br>Default: 1.<br><br>Parameter *Width* not available if *Draw* is set to "Points" or "Bar".|
|*Point size*|0|ds.pointsize.0|Valid values range from 1-10.<br><br>Default: 3.<br><br>Parameter *Point size* not available if *Draw* is set to "Line", "Staircase" or "Bar".|
|*Transparency*|0|ds.transparency.0|Valid values range from 1-10.<br><br>Default: 5.|
|*Fill*|0|ds.fill.0|Valid values range from 1-10.<br><br>Default: 3.<br><br>Parameter *Fill* not available if *Draw* is set to "Points" or "Bar".|
|*Missing data*|0|ds.missingdatafunc.0|0 - *(default)* None;<br>1 - Connected;<br>2 - Treat as 0.<br><br>Parameter *Missing data* not available if *Draw* is set to "Points" or "Bar".|
|*Y-axis*|0|ds.axisy.0|0 - *(default)* Left;<br>1 - Right.|
|*Time shift*|1|ds.timeshift.0|Valid time string (e.g. `3600`, `1h`, etc.).<br>You may use [time suffixes](/manual/appendix/suffixes#time-suffixes). Negative values are also allowed.<br><br>Default: `""` (empty).|
|*Aggregation function*|0|ds.aggregate_function.0|0 - *(default)* none;<br>1 - min;<br>2 - max;<br>3 - avg;<br>4 - count;<br>5 - sum;<br>6 - first;<br>7 - last.|
|*Aggregation interval*|1|ds.aggregate_interval.0|Valid time string (e.g. `3600`, `1h`, etc.).<br>You may use [time suffixes](/manual/appendix/suffixes#time-suffixes).<br><br>Default: `1h`.|
|*Aggregate*|0|ds.aggregate_grouping.0|0 - *(default)* Each item;<br>1 - Data set.<br><br>Parameter *Aggregate* not available if *Aggregation function* is set to "none".|
#### 数据集
以下参数可用于配置*数据集*.
::: noteclassic
属性名称中的第一个数字(例如 ds.主机.0.0, ds.监控项.0.0)表示特定数据集,
而第二个数字(如果存在)则表示配置的主机或监控项.
:::
| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| ***Host pattern***<br>(required) | 1 | ds.hosts.0.0 | [Host](/manual/api/reference/host/get)名称或模式(例如 `Zabbix*`). |
| ***Item pattern***<br>(required) | 1 | ds.items.0.0 | [Item](/manual/api/reference/item/get)名称或模式(例如 `*: Number of processed *values per second`). |
| *Color* | 1 | ds.color.0 | 十六进制颜色代码(例如 `FF0000`).<br><br>默认: `FF465C`. |
| *Draw* | 0 | ds.type.0 | 0 - *(默认)* 折线;<br>1 - 点;<br>2 - 阶梯线;<br>3 - 柱状图. |
| *Width* | 0 | ds.width.0 | 有效值范围为1-10.<br><br>默认: 1.<br><br>当*绘制*设置为"点"或"柱状图"时,*宽度*参数不可用. |
| *Point size* | 0 | ds.pointsize.0 | 有效值范围为1-10.<br><br>默认: 3.<br><br>当*绘制*设置为"折线"、"阶梯线"或"柱状图"时,*点大小*参数不可用. |
| *Transparency* | 0 | ds.transparency.0 | 有效值范围为1-10.<br><br>默认: 5. |
| *Fill* | 0 | ds.fill.0 | 有效值范围为1-10.<br><br>默认: 3.<br><br>当*绘制*设置为"点"或"柱状图"时,*填充*参数不可用. |
| *Missing data* | 0 | ds.missingdatafunc.0 | 0 - *(默认)* 无;<br>1 - 连接;<br>2 - 视为0.<br><br>当*绘制*设置为"点"或"柱状图"时,*缺失数据*参数不可用. |
| *Y-axis* | 0 | ds.axisy.0 | 0 - *(默认)* 左;<br>1 - 右. |
| *Time shift* | 1 | ds.timeshift.0 | 有效时间string(例如 `3600`, `1h`等).<br>可以使用[时间后缀](/manual/appendix/suffixes#时间后缀). 也允许负值.<br><br>默认: `""`(空). |
| *Aggregation function* | 0 | ds.aggregate_function.0 | 0 - *(默认)* 无;<br>1 - 最小值;<br>2 - 最大值;<br>3 - 平均值;<br>4 - 计数;<br>5 - 总和;<br>6 - 第一个;<br>7 - 最后一个. |
| *Aggregation interval* | 1 | ds.aggregate_interval.0 | 有效时间string(例如 `3600`, `1h`等).<br>可以使用[时间后缀](/manual/appendix/suffixes#时间后缀).<br><br>默认: `1h`. |
| *Aggregate* | 0 | ds.aggregate_grouping.0 | 0 - *(默认)* 每个监控项;<br>1 - 数据集.<br><br>当*聚合函数*设置为"无"时,*聚合*参数不可用. |
#### Data types
The Zabbix API supports the following data types as input:
|Type|Description|
|--|--------|
|boolean|A boolean value, accepts either `true` or `false`.|
|flag|The value is considered to be `true` if it is passed and not equal to `null`; otherwise, it is considered to be `false`.|
|integer|A whole number.|
|float|A floating point number.|
|string|A text string.|
|text|A longer text string.|
|timestamp|A Unix timestamp.|
|array|An ordered sequence of values, that is, a plain array.|
|object|An associative array.|
|query|A value which defines, what data should be returned.<br><br>Can be defined as an array of property names to return only specific properties, or as one of the predefined values:<br>`extend` - returns all object properties;<br>`count` - returns the number of retrieved records, supported only by certain subselects.|
::: noteimportant
Zabbix API always returns values as strings or
arrays only.
:::
#### 数据类型
Zabbix API支持以下数据类型作为输入：
| 类型 | 描述 |
|--|--------|
| boolean | boolean值，接受`true`或`false`。 |
| flag | 如果值存在且不等于`null`，则视为`true`；否则视为`false`。 |
| integer | 整型数字。 |
| float | 浮点数字。 |
| string | 文本string。 |
| text | 长文本string。 |
| timestamp | Unix时间戳。 |
| array | 有序值序列，即普通array。 |
| object | 关联型array。 |
| query | 定义应返回数据的值。<br><br>可定义为属性名array以返回特定属性，或使用预定义值：<br>`extend` - 返回所有object属性；<br>`count` - 返回检索记录数（仅部分子查询支持）。 |
::: noteimportant
Zabbix API始终仅返回字符串或数组类型的值。
:::
### DB schema update
A new column *name_upper* has been added to the database table **items**. The column contains a capitalized version of the item name or the LLD rule name. This change has been implemented to allow the use of the index with case-insensitive search for API query [optimization](#optimized-api-queries).
### 数据库架构更新
数据库表**监控项**新增了*name_upper*列。该列存储了监控项名称或LLD规则名称的大写version版本。此项变更是为了支持在APIquery中使用索引进行不区分大小写的搜索[优化](#optimized-api-queries)。
# dcheck.get
# dcheck.get
### Debian/Ubuntu
Open the `/etc/apt/sources.list.d/zabbix.list` and uncomment "Zabbix unstable repository".
# Zabbix unstable repository
deb https://repo.zabbix.com/zabbix/5.5/debian bullseye main
deb-src https://repo.zabbix.com/zabbix/5.5/debian bullseye main
### Debian/Ubuntu
打开`/etc/apt/sources.list.d/zabbix.list`文件并取消注释"Zabbix不稳定仓库"。
# Zabbix unstable repository
deb https://repo.zabbix.com/zabbix/5.5/debian bullseye main
deb-src https://repo.zabbix.com/zabbix/5.5/debian bullseye main
### Debug
Debug information of executed webhook script. The debug object has the
following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|logs|array|Array of [log entries](/manual/api/reference/script/object#Log entry).|
|ms|string|Script execution duration in milliseconds.|
### 调试
已执行的webhook脚本调试信息。该调试object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| logs | array | [日志条目](/manual/api/reference/script/object#Log entry)的array。 |
| ms | string | 脚本执行时长（毫秒）。 |
#### Debugging Java gateway
In case there are any problems with Java gateway or an error message
that you see about an item in the frontend is not descriptive enough,
you might wish to take a look at Java gateway log file.
By default, Java gateway logs its activities into /tmp/zabbix\_java.log
file with log level "info". Sometimes that information is not enough and
there is a need for information at log level "debug". In order to
increase logging level, modify file lib/logback.xml and change the level
attribute of <root> tag to "debug":
<root level="debug">
<appender-ref ref="FILE" />
</root>
Note that unlike Zabbix server or Zabbix proxy, there is no need to
restart Zabbix Java gateway after changing logback.xml file - changes in
logback.xml will be picked up automatically. When you are done with
debugging, you can return the logging level to "info".
If you wish to log to a different file or a completely different medium
like database, adjust logback.xml file to meet your needs. See [Logback
Manual](http://logback.qos.ch/manual/) for more details.
Sometimes for debugging purposes it is useful to start Java gateway as a
console application rather than a daemon. To do that, comment out
PID\_FILE variable in settings.sh. If PID\_FILE is omitted, startup.sh
script starts Java gateway as a console application and makes Logback
use lib/logback-console.xml file instead, which not only logs to
console, but has logging level "debug" enabled as well.
Finally, note that since Java gateway uses SLF4J for logging, you can
replace Logback with the framework of your choice by placing an
appropriate JAR file in lib directory. See [SLF4J
Manual](http://www.slf4j.org/manual.html) for more details.
#### 调试 Java 网关
若Java网关出现任何问题 或前端显示的监控项错误信息描述不够详细
您可能需要查看Java网关日志file
默认情况下 Java网关将其活动记录到/tmp/zabbix\_java.log
file 日志级别为"info". 有时这些信息不足 需要
"debug"级别的日志信息. 要提高日志级别 请修改file lib/logback.xml
并将<root>标签的level属性改为"debug":
<root level="debug">
<appender-ref ref="FILE" />
</root>
请注意 与Zabbix server或Zabbix proxy不同 修改
logback.xml file后无需重启Zabbix Java网关 -
logback.xml的更改会自动生效. 调试完成后
您可以将日志级别恢复为"info".
如需记录到不同的file或完全不同的介质
如数据库 请调整logback.xml file以满足需求. 详见[Logback
Manual](http://logback.qos.ch/manual/)
有时出于调试目的 将Java网关作为控制台应用程序而非
守护进程启动会很有用. 要实现这一点 请注释掉
settings.sh中的PID\_FILE变量. 如果省略PID\_FILE
startup.sh脚本会将Java网关作为控制台应用程序启动 并使Logback
改用lib/logback-console.xml file 该配置不仅记录到
控制台 还启用了"debug"日志级别.
最后请注意 由于Java网关使用SLF4J进行日志记录 您可以通过
将适当的JAR file放入lib目录来替换Logback为
您选择的框架. 详见[SLF4J
Manual](http://www.slf4j.org/manual.html)
#### Debugging Java gateway
Zabbix Java gateway log file is:
/var/log/zabbix/zabbix_java_gateway.log
If you like to increase the logging, edit the file:
/etc/zabbix/zabbix_java_gateway_logback.xml
and change `level="info"` to "debug" or even "trace" (for deep
troubleshooting):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### 调试 Java 网关
Zabbix Java网关日志file为:
/var/log/zabbix/zabbix_java_gateway.log
如需增加日志记录级别，请编辑file:
/etc/zabbix/zabbix_java_gateway_logback.xml
并将`level="info"`修改为"debug"或"trace"(用于深度故障排查):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### Debugging Java gateway
Zabbix Java gateway log file is:
/var/log/zabbix/zabbix_java_gateway.log
If you like to increase the logging, edit the file:
/etc/zabbix/zabbix_java_gateway_logback.xml
and change `level="info"` to "debug" or even "trace" (for deep
troubleshooting):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### 调试 Java 网关
Zabbix Java 网关的日志路径：
/var/log/zabbix/zabbix_java_gateway.log
如果要增加日志记录，编辑以下文件：
/etc/zabbix/zabbix_java_gateway_logback.xml
并将`level="info"`更改为"debug"或"trace"（深度排错模式）
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### Debugging Java gateway
Zabbix Java gateway log file is:
/var/log/zabbix/zabbix_java_gateway.log
If you like to increase the logging, edit the file:
/etc/zabbix/zabbix_java_gateway_logback.xml
and change `level="info"` to "debug" or even "trace" (for deep
troubleshooting):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
#### 调试 Java 网关
Zabbix Java网关日志file为:
/var/log/zabbix/zabbix_java_gateway.log
如需增加日志级别，请编辑file:
/etc/zabbix/zabbix_java_gateway_logback.xml
并将`level="info"`修改为"debug"或"trace"(用于深度故障排查):
<configuration scan="true" scanPeriod="15 seconds">
[...]
<root level="info">
<appender-ref ref="FILE" />
</root>
</configuration>
### Default authentication
By default, Zabbix uses internal Zabbix authentication for all users. It
is possible to change the default method to [LDAP](#ldap_authentication)
system-wide or enable LDAP authentication only for specific user groups.
To set LDAP as default authentication method for all users, navigate to
the *LDAP* tab and configure authentication parameters, then return to
the *Authentication* tab and switch *Default authentication* selector to
LDAP.
Note that the authentication method can be fine-tuned on the [user
group](/manual/config/users_and_usergroups/usergroup) level. Even if
LDAP authentication is set globally, some user groups can still be
authenticated by Zabbix. These groups must have [frontend
access](/manual/config/users_and_usergroups/usergroup#configuration) set
to Internal. Vice versa, if internal authentication is used globally,
LDAP authentication details can be specified and used for specific user
groups whose [frontend
access](/manual/config/users_and_usergroups/usergroup#configuration) is
set to LDAP. If a user is included into at least one user group with
LDAP authentication, this user will not be able to use internal
authentication method.
[HTTP](#http_authentication) and [SAML 2.0](#saml_authentication)
authentication methods can be used in addition to the default
authentication method.
### 默认认证
默认情况下，Zabbix对所有用户使用内部Zabbix认证。可以将默认方法更改为全系统范围的[LDAP](#ldap_authentication)认证，或仅为特定用户组启用LDAP认证。
要将LDAP设置为所有用户的默认认证方法，请导航至*LDAP*选项卡并配置认证参数，然后返回*Authentication*选项卡并将*Default authentication*选择器切换为LDAP。
请注意，认证方法可以在[user
group](/manual/config/users_and_usergroups/usergroup)级别进行微调。即使全局设置了LDAP认证，某些用户组仍可通过Zabbix进行认证。这些用户组的[配置](/manual/config/users_and_usergroups/usergroup#配置)必须设置为Internal。反之，如果全局使用内部认证，可以为[配置](/manual/config/users_and_usergroups/usergroup#配置)设置为LDAP的特定用户组指定并使用LDAP认证详细信息。如果用户被包含在至少一个使用LDAP认证的用户组中，则该用户将无法使用内部认证方法。
除默认认证方法外，还可使用[HTTP](#http_authentication)和[SAML 2.0](#saml_authentication)认证方法。
### Default authentication
By default, Zabbix uses internal Zabbix authentication for all users. It
is possible to change the default method to [LDAP](#ldap_authentication)
system-wide or enable LDAP authentication only for specific user groups.
To set LDAP as default authentication method for all users, navigate to
the *LDAP* tab and configure authentication parameters, then return to
the *Authentication* tab and switch *Default authentication* selector to
LDAP.
Note that the authentication method can be fine-tuned on the [user
group](/manual/config/users_and_usergroups/usergroup) level. Even if
LDAP authentication is set globally, some user groups can still be
authenticated by Zabbix. These groups must have [frontend
access](/manual/config/users_and_usergroups/usergroup#configuration) set
to Internal. Vice versa, if internal authentication is used globally,
LDAP authentication details can be specified and used for specific user
groups whose [frontend
access](/manual/config/users_and_usergroups/usergroup#configuration) is
set to LDAP. If a user is included into at least one user group with
LDAP authentication, this user will not be able to use internal
authentication method.
[HTTP](#HTTP_authentication) and [SAML 2.0](#SAML_authentication)
authentication methods can be used in addition to the default
authentication method.
##### Internal
使用内部Zabbix认证。
#### Default global regular expressions
Zabbix comes with several global regular expression in its default
dataset.
|Name|Expression|Matches|
|--|------|------|
|*File systems for discovery*|`^(btrfs|ext2|ext3|ext4|jfs|reiser|xfs|ffs|ufs|jfs|jfs2|vxfs|hfs|refs|apfs|ntfs|fat32|zfs)$`|"btrfs" or "ext2" or "ext3" or "ext4" or "jfs" or "reiser" or "xfs" or "ffs" or "ufs" or "jfs" or "jfs2" or "vxfs" or "hfs" or "refs" or "apfs" or "ntfs" or "fat32" or "zfs"|
|*Network interfaces for discovery*|`^Software Loopback Interface`|Strings starting with "Software Loopback Interface".|
| |`^lo$`|"lo"|
| |`^(In)?[Ll]oop[Bb]ack[0-9._]*$`|Strings that optionally start with "In", then have "L" or "l", then "oop", then "B" or "b", then "ack", which can be optionally followed by any number of digits, dots or underscores.|
| |`^NULL[0-9.]*$`|Strings starting with "NULL" optionally followed by any number of digits or dots.|
| |`^[Ll]o[0-9.]*$`|Strings starting with "Lo" or "lo" and optionally followed by any number of digits or dots.|
| |`^[Ss]ystem$`|"System" or "system"|
| |`^Nu[0-9.]*$`|Strings starting with "Nu" optionally followed by any number of digits or dots.|
|*Storage devices for SNMP discovery*|`^(Physical memory|Virtual memory|Memory buffers|Cached memory|Swap space)$`|"Physical memory" or "Virtual memory" or "Memory buffers" or "Cached memory" or "Swap space"|
|*Windows service names for discovery*|`^(MMCSS|gupdate|SysmonLog|clr_optimization_v2.0.50727_32|clr_optimization_v4.0.30319_32)$`|"MMCSS" or "gupdate" or "SysmonLog" or strings like "clr\_optimization\_v2.0.50727\_32" and "clr\_optimization\_v4.0.30319\_32" where instead of dots you can put any character except newline.|
|*Windows service startup states for discovery*|`^(automatic|automatic delayed)$`|"automatic" or "automatic delayed"|
#### 默认全局正则表达式
Zabbix默认数据集包含多个全局正则表达式。
| 名称 | 表达式 | 匹配项 |
|--|------|------|
| *File systems for discovery* | `^(btrfs|ext2|ext3|ext4|jfs|reiser|xfs|ffs|ufs|jfs|jfs2|vxfs|hfs|refs|apfs|ntfs|fat32|zfs)$` | "btrfs" 或 "ext2" 或 "ext3" 或 "ext4" 或 "jfs" 或 "reiser" 或 "xfs" 或 "ffs" 或 "ufs" 或 "jfs" 或 "jfs2" 或 "vxfs" 或 "hfs" 或 "refs" 或 "apfs" 或 "ntfs" 或 "fat32" 或 "zfs" |
| *Network interfaces for discovery* | `^Software Loopback Interface` | 以"Software Loopback Interface"开头的字符串 |
| | `^lo$` | "lo" |
| | `^(In)?[Ll]oop[Bb]ack[0-9._]*$` | 可选以"In"开头，后接"L"或"l"，然后是"oop"，接着"B"或"b"，再接"ack"，最后可跟任意数量的数字、点或下划线 |
| | `^NULL[0-9.]*$` | 以"NULL"开头，可选后接任意数量数字或点的字符串 |
| | `^[Ll]o[0-9.]*$` | 以"Lo"或"lo"开头，可选后接任意数量数字或点的字符串 |
| | `^[Ss]ystem$` | "System" 或 "system" |
| | `^Nu[0-9.]*$` | 以"Nu"开头，可选后接任意数量数字或点的字符串 |
| *Storage devices for SNMP discovery* | `^(Physical memory|Virtual memory|Memory buffers|Cached memory|Swap space)$` | "Physical memory" 或 "Virtual memory" 或 "Memory buffers" 或 "Cached memory" 或 "Swap space" |
| *Windows service names for discovery* | `^(MMCSS|gupdate|SysmonLog|clr_optimization_v2.0.50727_32|clr_optimization_v4.0.30319_32)$` | "MMCSS" 或 "gupdate" 或 "SysmonLog" 或类似"clr\_optimization\_v2.0.50727\_32"和"clr\_optimization\_v4.0.30319\_32"的字符串（其中点可替换为除换行符外的任意字符） |
| *Windows service startup states for discovery* | `^(automatic|automatic delayed)$` | "automatic" 或 "automatic delayed" |
#### Default port numbers
The following list of open ports per component is applicable for default configuration:
|Zabbix component|Port number|Protocol|Type of connection|
|-------|-------|-------|-------|
|Zabbix agent|10050|TCP|on demand|
|Zabbix agent 2|10050|TCP|on demand|
|Zabbix server|10051|TCP|on demand|
|Zabbix proxy|10051|TCP|on demand|
|Zabbix Java gateway|10052|TCP|on demand|
|Zabbix web service|10053|TCP|on demand|
|Zabbix frontend|80|HTTP|on demand|
|^|443|HTTPS|on demand|
|Zabbix trapper|10051 |TCP| on demand|
::: noteclassic
The port numbers should be open in firewall to enable Zabbix communications. Outgoing TCP connections usually do not require explicit firewall settings.
:::
#### 默认端口号
以下为默认配置下各组件开放的端口列表:
| Zabbix组件 | 端口号 | 协议 | 连接类型 |
|-------|-------|-------|-------|
| Zabbix agent | 10050 | TCP | on demand |
| Zabbix agent 2 | 10050 | TCP | on demand |
| Zabbix server | 10051 | TCP | on demand |
| Zabbix proxy | 10051 | TCP | on demand |
| Zabbix Java网关 | 10052 | TCP | on demand |
| Zabbix网页服务 | 10053 | TCP | on demand |
| Zabbix前端 | 80 | HTTP | on demand |
| ^ | 443 | HTTPS | on demand |
| Zabbix trapper | 10051 | TCP | on demand |
::: noteclassic
需在防火墙中开放这些端口以启用Zabbix通信。通常出站TCP连接不需要显式的防火墙设置。
:::
#### Default user roles
By default, Zabbix is configured with four user roles, which have a
pre-defined set of permissions:
- Admin role
- Guest role
- Super admin role
- User role
{width="600"}
::: noteclassic
Default *Super admin role* cannot be modified or deleted,
because at least one Super admin user with unlimited privileges must
exist in Zabbix.
:::
Zabbix users with type Super admins and proper permissions can modify or
delete existing roles or create new custom roles.
To create a new role, click on the *Create user role* button at the top
right corner. To update an existing role, press on the role name to open
the configuration form.
Available permission options along with default permission sets for
pre-existing user roles in Zabbix are described below.
|Parameter|Description|Default user roles|<|<|<|
|---------|-----------|------------------|-|-|-|
| | |Super admin role|Admin role|User role|Guest role|
|Name|Role visible name.|Super admin role|Admin role|User role|Guest role|
|User type|Selected user type determines the list of available permissions.<br>Upon selecting a user type, all available permissions for this user type are granted by default.<br>Uncheck the checkbox(es) to revoke certain permissions for the user role.<br>Checkboxes for permissions not available for this user type are grayed out.|Super admin|Admin|User|User|
|Access to UI elements|<|<|<|<|<|
|*Monitoring*|<|<|<|<|<|
|Dashboard|Enable/disable access to a specific Monitoring menu section and underlying pages.|Yes|Yes|Yes|Yes|
|Problems|^|^|^|^|^|
|Hosts|^|^|^|^|^|
|Latest data|^|^|^|^|^|
|Maps|^|^|^|^|^|
|Discovery|^|^|^|No|No|
|Services|^|^|^|Yes|Yes|
|*Inventory*|<|<|<|<|<|
|Overview|Enable/disable access to a specific Inventory menu section and underlying pages.|Yes|Yes|Yes|Yes|
|Hosts|^|^|^|^|^|
|*Reports*|<|<|<|<|<|
|System information|Enable/disable access to a specific Reports menu section and underlying pages.|Yes|No|No|No|
|Availability report|^|^|Yes|Yes|Yes|
|Triggers top 100|^|^|^|^|^|
|Audit|^|^|No|No|No|
|Action log|^|^|^|^|^|
|Notifications|^|^|Yes|^|^|
|Scheduled reports|^|^|^|^|^|
|*Configuration*|<|<|<|<|<|
|Host groups|Enable/disable access to a specific *Configuration* menu section and underlying pages.|Yes|Yes|No|No|
|Templates|^|^|^|^|^|
|Hosts|^|^|^|^|^|
|Maintenance|^|^|^|^|^|
|Actions|^|^|^|^|^|
|Event correlation|^|^|No|^|^|
|Discovery|^|^|Yes|^|^|
|*Administration*|<|<|<|<|<|
|General|Enable/disable access to a specific *Administration* menu section and underlying pages.|Yes|No|No|No|
|Proxies|^|^|^|^|^|
|Authentication|^|^|^|^|^|
|User groups|^|^|^|^|^|
|User roles|^|^|^|^|^|
|Users|^|^|^|^|^|
|Media types|^|^|^|^|^|
|Scripts|^|^|^|^|^|
|Queue|^|^|^|^|^|
|*Default access to new UI elements*|Enable/disable access to the custom UI elements. Modules, if present, will be listed below.|Yes|Yes|Yes|Yes|
|Access to services|<|<|<|<|<|
|Read-write access to services|Select read-write access to services:<br>**None** - no access at all<br>**All** - access to all services is read-write<br>**Service list** - select services for read-write access<br><br>The read-write access takes precedence over the read-only access and is dynamically inherited by the child services.|Yes|Yes|No|No|
|Read-write access to services with tag|Specify tag name and, optionally, value to additionally grant read-write access to services matching the tag.<br>This option is available if 'Service list' is selected in the *Read-write access to services* parameter.<br>The read-write access takes precedence over the read-only access and is dynamically inherited by the child services.|^|^|^|^|
|Read-only access to services|Select read-only access to services:<br>**None** - no access at all<br>**All** - access to all services is read-only<br>**Service list** - select services for read-only access<br><br>The read-only access does not take precedence over the read-write access and is dynamically inherited by the child services.|^|^|^|^|
|Read-only access to services with tag|Specify tag name and, optionally, value to additionally grant read-only access to services matching the tag.<br>This option is available if 'Service list' is selected in the *Read-only access to services* parameter.<br>The read-only access does not take precedence over the read-write access and is dynamically inherited by the child services.|^|^|^|^|
|Access to modules|<|<|<|<|<|
|<Module name>|Allow/deny access to a specific module. Only enabled modules are shown in this section. It is not possible to grant or restrict access to a module that is currently disabled.|Yes|Yes|Yes|Yes|
|*Default access to new modules*|Enable/disable access to modules that may be added in the future.|^|^|^|^|
|Access to API|<|<|<|<|<|
|*Enabled*|Enable/disable access to API.|Yes|Yes|Yes|No|
|*API methods*|Select *Allow list* to allow only specified API methods or *Deny list* to restrict only specified API methods.<br><br>In the search field, start typing the method name, then select the method from the auto-complete list.<br>You can also press the Select button and select methods from the full list available for this user type. Note, that if certain action from the Access to actions block is unchecked, users will not be able to use API methods related to this action.<br><br>Wildcards are supported. Examples: `dashboard.*` (all methods of 'dashboard.' API service) `*` (any method), `*.export` (methods with '.export' name from all API services).<br><br>If no methods have been specified the Allow/Deny list rule will be ignored.|^|^|^|^|
|Access to actions|<|<|<|<|<|
|Create and edit dashboards|Clearing this checkbox will also revoke the rights to use `.create`, `.update` and `.delete` API methods for the corresponding elements.|Yes|Yes|Yes|No|
|Create and edit maps|^|^|^|^|^|
|Create and edit maintenance|^|^|^|No|^|
|Add problem comments|Clearing this checkbox will also revoke the rights to perform corresponding action via `event.acknowledge` API method.|^|^|Yes|^|
|Change severity|^|^|^|^|^|
|Acknowledge problems|^|^|^|^|^|
|Close problems|^|^|^|^|^|
|Execute scripts|Clearing this checkbox will also revoke the rights to use the `script.execute` API method.|^|^|^|^|
|Manage API tokens|Clearing this checkbox will also revoke the rights to use all `token.` API methods.|^|^|^|^|
|Manage scheduled reports|Clearing this checkbox will also revoke the rights to use all `report.` API methods.|^|^|No|^|
|Default access to new actions|Enable/disable access to new actions.|^|^|Yes|^|
Notes:
- Each user may have only one role assigned.
- If an element is restricted, users will not be able to access it
even by entering a direct URL to this element into the browser.
- Users of type *User* or *Admin* cannot change their own role
settings.
- Users of type *Super admin* can modify settings of their own role
(not available for the default *Super admin role*), but not the user
type.
- Users of all levels cannot change their own user type.
See also:
- [Configuring a user](/manual/config/users_and_usergroups/user)
#### Default user roles
By default, Zabbix is configured with four user roles, which have a
pre-defined set of permissions:
- Admin role
- Guest role
- Super admin role
- User role
{width="600"}
::: noteclassic
Default *Super admin role* cannot be modified or deleted,
because at least one Super admin user with unlimited privileges must
exist in Zabbix.
:::
Zabbix users with type Super admins and proper permissions can modify or
delete existing roles or create new custom roles.
To create a new role, click on the *Create user role* button at the top
right corner. To update an existing role, press on the role name to open
the configuration form.
Available permission options along with default permission sets for
pre-existing user roles in Zabbix are described below.
|Parameter|Description|Default user roles|<|<|<|
|---------|-----------|------------------|-|-|-|
|^|^|Super admin role|Admin role|User role|Guest role|
|Name|Role visible name.|Super admin role|Admin role|User role|Guest role|
|User type|Selected user type determines the list of available permissions.<br>Upon selecting a user type, all available permissions for this user type are granted by default.<br>Uncheck the checkbox(es) to revoke certain permissions for the user role.<br>Checkboxes for permissions not available for this user type are grayed out.|Super admin|Admin|User|User|
|Access to UI elements|<|<|<|<|<|
|*Monitoring*|<|<|<|<|<|
|Dashboard|Enable/disable access to a specific Monitoring menu section and underlying pages.|Yes|Yes|Yes|Yes|
|Problems|^|^|^|^|^|
|Hosts|^|^|^|^|^|
|Latest data|^|^|^|^|^|
|Maps|^|^|^|^|^|
|Discovery|^|^|^|No|No|
|Services|^|^|^|Yes|Yes|
|*Inventory*|<|<|<|<|<|
|Overview|Enable/disable access to a specific Inventory menu section and underlying pages.|Yes|Yes|Yes|Yes|
|Hosts|^|^|^|^|^|
|*Reports*|<|<|<|<|<|
|System information|Enable/disable access to a specific Reports menu section and underlying pages.|Yes|No|No|No|
|Availability report|^|^|Yes|Yes|Yes|
|Triggers top 100|^|^|^|^|^|
|Audit|^|^|No|No|No|
|Action log|^|^|^|^|^|
|Notifications|^|^|Yes|^|^|
|Scheduled reports|^|^|^|^|^|
|*Configuration*|<|<|<|<|<|
|Host groups|Enable/disable access to a specific *Configuration* menu section and underlying pages.|Yes|Yes|No|No|
|Templates|^|^|^|^|^|
|Hosts|^|^|^|^|^|
|Maintenance|^|^|^|^|^|
|Actions|^|^|^|^|^|
|Event correlation|^|^|No|^|^|
|Discovery|^|^|Yes|^|^|
|*Administration*|<|<|<|<|<|
|General|Enable/disable access to a specific *Administration* menu section and underlying pages.|Yes|No|No|No|
|Proxies|^|^|^|^|^|
|Authentication|^|^|^|^|^|
|User groups|^|^|^|^|^|
|User roles|^|^|^|^|^|
|Users|^|^|^|^|^|
|Media types|^|^|^|^|^|
|Scripts|^|^|^|^|^|
|Queue|^|^|^|^|^|
|*Default access to new UI elements*|Enable/disable access to the custom UI elements. Modules, if present, will be listed below.|Yes|Yes|Yes|Yes|
|Access to services|<|<|<|<|<|
|Read-write access to services|Select read-write access to services:<br>**None** - no access at all<br>**All** - access to all services is read-write<br>**Service list** - select services for read-write access<br><br>The read-write access takes precedence over the read-only access and is dynamically inherited by the child services.|Yes|Yes|No|No|
|Read-write access to services with tag|Specify tag name and, optionally, value to additionally grant read-write access to services matching the tag.<br>This option is available if 'Service list' is selected in the *Read-write access to services* parameter.<br>The read-write access takes precedence over the read-only access and is dynamically inherited by the child services.|^|^|^|^|
|Read-only access to services|Select read-only access to services:<br>**None** - no access at all<br>**All** - access to all services is read-only<br>**Service list** - select services for read-only access<br><br>The read-only access does not take precedence over the read-write access and is dynamically inherited by the child services.|^|^|^|^|
|Read-only access to services with tag|Specify tag name and, optionally, value to additionally grant read-only access to services matching the tag.<br>This option is available if 'Service list' is selected in the *Read-only access to services* parameter.<br>The read-only access does not take precedence over the read-write access and is dynamically inherited by the child services.|^|^|^|^|
|Access to modules|<|<|<|<|<|
|<Module name>|Allow/deny access to a specific module. Only enabled modules are shown in this section. It is not possible to grant or restrict access to a module that is currently disabled.|Yes|Yes|Yes|Yes|
|*Default access to new modules*|Enable/disable access to modules that may be added in the future.|^|^|^|^|
|Access to API|<|<|<|<|<|
|*Enabled*|Enable/disable access to API.|Yes|Yes|Yes|No|
|*API methods*|Select *Allow list* to allow only specified API methods or *Deny list* to restrict only specified API methods.<br><br>In the search field, start typing the method name, then select the method from the auto-complete list.<br>You can also press the Select button and select methods from the full list available for this user type. Note, that if certain action from the Access to actions block is unchecked, users will not be able to use API methods related to this action.<br><br>Wildcards are supported. Examples: `dashboard.*` (all methods of 'dashboard.' API service) `*` (any method), `*.export` (methods with '.export' name from all API services).<br><br>If no methods have been specified the Allow/Deny list rule will be ignored.|^|^|^|^|
|Access to actions|<|<|<|<|<|
|Create and edit dashboards|Clearing this checkbox will also revoke the rights to use `.create`, `.update` and `.delete` API methods for the corresponding elements.|Yes|Yes|Yes|No|
|Create and edit maps|^|^|^|^|^|
|Create and edit maintenance|^|^|^|No|^|
|Add problem comments|Clearing this checkbox will also revoke the rights to perform corresponding action via `event.acknowledge` API method.|^|^|Yes|^|
|Change severity|^|^|^|^|^|
|Acknowledge problems|^|^|^|^|^|
|Close problems|^|^|^|^|^|
|Execute scripts|Clearing this checkbox will also revoke the rights to use the `script.execute` API method.|^|^|^|^|
|Manage API tokens|Clearing this checkbox will also revoke the rights to use all `token.` API methods.|^|^|^|^|
|Manage scheduled reports|Clearing this checkbox will also revoke the rights to use all `report.` API methods.|^|^|No|^|
|Default access to new actions|Enable/disable access to new actions.|^|^|Yes|^|
Notes:
- Each user may have only one role assigned.
- If an element is restricted, users will not be able to access it
even by entering a direct URL to this element into the browser.
- Users of type *User* or *Admin* cannot change their own role
settings.
- Users of type *Super admin* can modify settings of their own role
(not available for the default *Super admin role*), but not the user
type.
- Users of all levels cannot change their own user type.
See also:
- [Configuring a user](/manual/config/users_and_usergroups/user)
#### Default user roles
By default, Zabbix is configured with four user roles, which have a
pre-defined set of permissions:
- Admin role
- Guest role
- Super admin role
- User role
{width="600"}
The list of all users assigned the respective role is displayed. The users included in disabled groups are stated in red.
::: noteclassic
Default *Super admin role* cannot be modified or deleted,
because at least one Super admin user with unlimited privileges must
exist in Zabbix.
:::
Zabbix users with type Super admins and proper permissions can modify or
delete existing roles or create new custom roles.
To create a new role, click on the *Create user role* button at the top
right corner. To update an existing role, press on the role name to open
the configuration form.
Available permission options along with default permission sets for
pre-configured user roles in Zabbix are described below.
| | | | | | | |
|-|----------|--------------------------------------|----|----|----|----|
|**Parameter**|<|**Description**|**Default user roles**|<|<|<|
| |<|<|*Super admin role*|*Admin role*|*User role*|*Guest role*|
|User type|<|Selected user type determines the list of available permissions.<br>Upon selecting a user type, all available permissions for this user type are granted by default.<br>Uncheck the checkbox(es) to revoke certain permissions for the user role.<br>Checkboxes for permissions not available for this user type are grayed out.|Super admin|Admin|User|User|
|**Access to UI elements**|<|<|<|<|<|<|
|*Monitoring*|<|<|<|<|<|<|
| |Dashboard|Enable/disable access to a specific Monitoring menu section and underlying pages.|Yes|Yes|Yes|Yes|
|^|Problems|^|^|^|^|^|
|^|Hosts|^|^|^|^|^|
|^|Latest data|^|^|^|^|^|
|^|Maps|^|^|^|^|^|
|^|Discovery|^|^|^|No|No|
|*Services*|<|<|<|<|<|<|
| |Services|Enable/disable access to a specific Services menu section and underlying pages.|Yes|Yes|Yes|Yes|
|^|Service actions|^|^|^|No|No|
|^|SLA|^|^|^|^|^|
|^|SLA report|^|^|^|Yes|Yes|
|*Inventory*|<|<|<|<|<|<|
| |Overview|Enable/disable access to a specific Inventory menu section and underlying pages.|Yes|Yes|Yes|Yes|
|^|Hosts|^|^|^|^|^|
|*Reports*|<|<|<|<|<|<|
| |System information|Enable/disable access to a specific Reports menu section and underlying pages.|Yes|No|No|No|
|^|Availability report|^|^|Yes|Yes|Yes|
|^|Triggers top 100|^|^|^|^|^|
|^|Audit|^|^|No|No|No|
|^|Action log|^|^|^|^|^|
|^|Notifications|^|^|Yes|^|^|
|^|Scheduled reports|^|^|^|^|^|
|*Configuration*|<|<|<|<|<|<|
| |Host groups|Enable/disable access to a specific *Configuration* menu section and underlying pages.|Yes|Yes|No|No|
|^|Templates|^|^|^|^|^|
|^|Hosts|^|^|^|^|^|
|^|Maintenance|^|^|^|^|^|
|^|Actions|^|^|^|^|^|
|^|Event correlation|^|^|No|^|^|
|^|Discovery|^|^|Yes|^|^|
|*Administration*|<|<|<|<|<|<|
| |General|Enable/disable access to a specific *Administration* menu section and underlying pages.|Yes|No|No|No|
|^|Proxies|^|^|^|^|^|
|^|Authentication|^|^|^|^|^|
|^|User groups|^|^|^|^|^|
|^|User roles|^|^|^|^|^|
|^|Users|^|^|^|^|^|
|^|Media types|^|^|^|^|^|
|^|Scripts|^|^|^|^|^|
|^|Queue|^|^|^|^|^|
|*Default access to new UI elements*|<|This option specifies how new menu sections will be accessible after a Zabbix upgrade. Existing menu sections of modules remain unaffected.|Yes|Yes|Yes|Yes|
|**Access to services**|<|<|<|<|<|<|
| |Read-write access to services|Select read-write access to services:<br>**None** - no access at all<br>**All** - access to all services is read-write<br>**Service list** - select services for read-write access<br><br>The read-write access, if granted, takes precedence over the read-only access settings and is dynamically inherited by the child services.|All|All|None|None|
|^|Read-write access to services with tag|Specify tag name and, optionally, value to additionally grant read-write access to services matching the tag.<br>This option is available if 'Service list' is selected in the *Read-write access to services* parameter.<br>The read-write access, if granted, takes precedence over the read-only access settings and is dynamically inherited by the child services.|^|^|^|^|
|^|Read-only access to services|Select read-only access to services:<br>**None** - no access at all<br>**All** - access to all services is read-only<br>**Service list** - select services for read-only access<br><br>The read-only access does not take precedence over the read-write access and is dynamically inherited by the child services.|^|^|All|All|
|^|Read-only access to services with tag|Specify tag name and, optionally, value to additionally grant read-only access to services matching the tag.<br>This option is available if 'Service list' is selected in the *Read-only access to services* parameter.<br>The read-only access does not take precedence over the read-write access and is dynamically inherited by the child services.|^|^|^|^|
|**Access to modules**|<|<|<|<|<|<|
| |<Module name>|Allow/deny access to a specific module. Only enabled modules are shown in this section. It is not possible to grant or restrict access to a module that is currently disabled.|Yes|Yes|Yes|Yes|
|^|*Default access to new modules*|This option specifies how new modules and widgets will be accessible after a Zabbix upgrade. It also applies to modules and widgets added in the *Administration > General > Modules section*.|^|^|^|^|
|**Access to API**|<|<|<|<|<|<|
| |*Enabled*|Enable/disable access to API.|Yes|Yes|Yes|No|
|^|*API methods*|Select *Allow list* to allow only specified API methods or *Deny list* to restrict only specified API methods.<br><br>In the search field, start typing the method name, then select the method from the auto-complete list.<br>You can also press the Select button and select methods from the full list available for this user type. Note that if certain action from the Access to actions block is unchecked, users will not be able to use API methods related to this action.<br><br>Wildcards are supported. Examples: `dashboard.*` (all methods of 'dashboard.' API service) `*` (any method), `*.export` (methods with '.export' name from all API services).<br><br>If no methods have been specified the Allow/Deny list rule will be ignored.|^|^|^|^|
|**Access to actions**|<|<|<|<|<|<|
| |Create and edit dashboards|Clearing this checkbox will also revoke the rights to use `.create`, `.update` and `.delete` API methods for the corresponding elements.|Yes|Yes|Yes|No|
|^|Create and edit maps|^|^|^|^|^|
|^|Create and edit maintenance|^|^|^|No|^|
|^|Add problem comments|Clearing this checkbox will also revoke the rights to perform corresponding action via `event.acknowledge` API method.|^|^|Yes|^|
|^|Change severity|^|^|^|^|^|
|^|Acknowledge problems|^|^|^|^|^|
|^|Close problems|^|^|^|^|^|
|^|Execute scripts|Clearing this checkbox will also revoke the rights to use the `script.execute` API method.|^|^|^|^|
|^|Manage API tokens|Clearing this checkbox will also revoke the rights to use all `token.` API methods.|^|^|^|^|
|^|Manage scheduled reports|Clearing this checkbox will also revoke the rights to use all `report.` API methods.|^|^|No|^|
|^|Manage SLA|Enable/disable the rights to manage [SLA](/manual/web_interface/frontend_sections/services/sla).|^|^|^|^|
|^|Default access to new actions|This option specifies how new actions will be accessible after a Zabbix upgrade.|^|^|Yes|^|
Notes:
- Each user may have only one role assigned.
- If an element is restricted, users will not be able to access it
even by entering a direct URL to this element into the browser.
- Users of type *User* or *Admin* cannot change their own role
settings.
- Users of type *Super admin* can modify settings of their own role
(not available for the default *Super admin role*), but not the user
type.
- Users of all levels cannot change their own user type.
See also:
- [Configuring a user](/manual/config/users_and_usergroups/user)
#### 默认用户角色
默认情况下，Zabbix配置了四种用户角色，这些角色具有预定义的权限集：
- 管理员角色
- 访客角色
- 超级管理员角色
- 用户角色
{width="600"}
显示分配了相应角色的所有用户列表。被禁用组中的用户以红色显示。
::: noteclassic
默认的*超级管理员角色*不能被修改或删除，
因为Zabbix中必须至少存在一个具有无限权限的超级管理员用户。
:::
类型为超级管理员且具有适当权限的Zabbix用户可以修改或
delete现有角色或create新的自定义角色。
要create一个新角色，点击Top
右上角的*创建用户角色*按钮。要update现有角色，点击角色名称打开
配置表单。
以下是Zabbix中预配置用户角色的可用权限选项及默认权限集的描述。
| | | | | | | |
|-|----------|--------------------------------------|----|----|----|----|
| **参数** | < | **描述** | **默认用户角色** | < | < | < |
| | < | < | *超级管理员角色* | *管理员角色* | *用户角色* | *访客角色* |
| 用户类型 | < | 所选用户类型决定了可用权限列表。<br>选择用户类型后，默认授予该用户类型的所有可用权限。<br>取消勾选复选框以撤销用户角色的某些权限。<br>该用户类型不可用的权限复选框显示为灰色。 | 超级管理员 | 管理员 | 用户 | 用户 |
| **访问UI元素** | < | < | < | < | < | < |
| *监控* | < | < | < | < | < | < |
| | 仪表板 | 启用/禁用对特定监控菜单部分及其底层页面的访问。 | 是 | 是 | 是 | 是 |
| ^ | 问题 | ^ | ^ | ^ | ^ | ^ |
| ^ | 主机 | ^ | ^ | ^ | ^ | ^ |
| ^ | 最新数据 | ^ | ^ | ^ | ^ | ^ |
| ^ | 地图 | ^ | ^ | ^ | ^ | ^ |
| ^ | 发现 | ^ | ^ | ^ | 否 | 否 |
| *服务* | < | < | < | < | < | < |
| | 服务 | 启用/禁用对特定服务菜单部分及其底层页面的访问。 | 是 | 是 | 是 | 是 |
| ^ | 服务操作 | ^ | ^ | ^ | 否 | 否 |
| ^ | SLA | ^ | ^ | ^ | ^ | ^ |
| ^ | SLA报告 | ^ | ^ | ^ | 是 | 是 |
| *资产清单* | < | < | < | < | < | < |
| | 概览 | 启用/禁用对特定资产清单菜单部分及其底层页面的访问。 | 是 | 是 | 是 | 是 |
| ^ | 主机 | ^ | ^ | ^ | ^ | ^ |
| *报告* | < | < | < | < | < | < |
| | 系统信息 | 启用/禁用对特定报告菜单部分及其底层页面的访问。 | 是 | 否 | 否 | 否 |
| ^ | 可用性报告 | ^ | ^ | 是 | 是 | 是 |
| ^ | 触发器Top 100 | ^ | ^ | ^ | ^ | ^ |
| ^ | 审计 | ^ | ^ | 否 | 否 | 否 |
| ^ | 操作日志 | ^ | ^ | ^ | ^ | ^ |
| ^ | 通知 | ^ | ^ | 是 | ^ | ^ |
| ^ | 计划报告 | ^ | ^ | ^ | ^ | ^ |
| *配置* | < | < | < | < | < | < |
| | 主机组 | 启用/禁用对特定*配置*菜单部分及其底层页面的访问。 | 是 | 是 | 否 | 否 |
| ^ | 模板 | ^ | ^ | ^ | ^ | ^ |
| ^ | 主机 | ^ | ^ | ^ | ^ | ^ |
| ^ | 维护 | ^ | ^ | ^ | ^ | ^ |
| ^ | 操作 | ^ | ^ | ^ | ^ | ^ |
| ^ | 事件关联 | ^ | ^ | 否 | ^ | ^ |
| ^ | 发现 | ^ | ^ | 是 | ^ | ^ |
| *管理* | < | < | < | < | < | < |
| | 常规 | 启用/禁用对特定*管理*菜单部分及其底层页面的访问。 | 是 | 否 | 否 | 否 |
| ^ | Proxies | ^ | ^ | ^ | ^ | ^ |
| ^ | 认证 | ^ | ^ | ^ | ^ | ^ |
| ^ | 用户组 | ^ | ^ | ^ | ^ | ^ |
| ^ | 用户角色 | ^ | ^ | ^ | ^ | ^ |
| ^ | 用户 | ^ | ^ | ^ | ^ | ^ |
| ^ | 媒介类型 | ^ | ^ | ^ | ^ | ^ |
| ^ | 脚本 | ^ | ^ | ^ | ^ | ^ |
| ^ | 队列 | ^ | ^ | ^ | ^ | ^ |
| *对新UI元素的默认访问* | < | 此选项指定Zabbix升级后新菜单部分的访问方式。模块的现有菜单部分不受影响。 | 是 | 是 | 是 | 是 |
| **访问服务** | < | < | < | < | < | < |
| | 对服务的读写访问 | 选择对服务的读写访问：<br>**无** - 完全无访问<br>**全部** - 对所有服务具有读写访问权限<br>**服务列表** - 选择具有读写访问权限的服务<br><br>如果授予读写访问权限，它将优先于只读访问设置，并动态继承给子服务。 | 全部 | 全部 | 无 | 无 |
| ^ | 对带标签服务的读写访问 | 指定标签名称和可选值，以额外授予对匹配标签服务的读写访问权限。<br>如果在*对服务的读写访问*参数中选择了'服务列表'，则此选项可用。<br>如果授予读写访问权限，它将优先于只读访问设置，并动态继承给子服务。 | ^ | ^ | ^ | ^ |
| ^ | 对服务的只读访问 | 选择对服务的只读访问：<br>**无** - 完全无访问<br>**全部** - 对所有服务具有只读访问权限<br>**服务列表** - 选择具有只读访问权限的服务<br><br>只读访问不优先于读写访问，并动态继承给子服务。 | ^ | ^ | 全部 | 全部 |
| ^ | 对带标签服务的只读访问 | 指定标签名称和可选值，以额外授予对匹配标签服务的只读访问权限。<br>如果在*对服务的只读访问*参数中选择了'服务列表'，则此选项可用。<br>只读访问不优先于读写访问，并动态继承给子服务。 | ^ | ^ | ^ | ^ |
| **访问模块** | < | < | < | < | < | < |
| | <模块名称> | 允许/拒绝访问特定模块。仅显示已启用的模块。无法授予或限制对当前禁用模块的访问。 | 是 | 是 | 是 | 是 |
| ^ | *对新模块的默认访问* | 此选项指定Zabbix升级后新模块和小部件的访问方式。它也适用于在*管理 > 常规 > 模块部分*中添加的模块和小部件。 | ^ | ^ | ^ | ^ |
| **访问API** | < | < | < | < | < | < |
| | *启用* | 启用/禁用对API的访问。 | 是 | 是 | 是 | 否 |
| ^ | *API方法* | 选择*允许列表*以仅允许指定的API方法，或*拒绝列表*以仅限制指定的API方法。<br><br>在搜索字段中，开始输入方法名称，然后从自动完成列表中选择方法。<br>您也可以按选择按钮并从该用户类型可用的完整列表中选择方法。请注意，如果未勾选“访问操作”块中的某些操作，用户将无法使用与该操作相关的API方法。<br><br>支持通配符。示例：`dashboard.*`（'dashboard.' API服务的所有方法） `*`（任何方法），`*.export`（来自所有API服务的'.export'名称的方法）。<br><br>如果未指定任何方法，则允许/拒绝列表规则将被忽略。 | ^ | ^ | ^ | ^ |
| **访问操作** | < | < | < | < | < | < |
| | 创建和编辑仪表板 | 清除此复选框还将撤销使用`.create`、`.update`和`.delete` API方法对应元素的权限。 | 是 | 是 | 是 | 否 |
| ^ | 创建和编辑地图 | ^ | ^ | ^ | ^ | ^ |
| ^ | 创建和编辑维护 | ^ | ^ | ^ | 否 | ^ |
| ^ | 添加问题评论 | 清除此复选框还将撤销通过`event.acknowledge` API方法执行相应操作的权限。 | ^ | ^ | 是 | ^ |
| ^ | 更改严重性 | ^ | ^ | ^ | ^ | ^ |
| ^ | 确认问题 | ^ | ^ | ^ | ^ | ^ |
| ^ | 关闭问题 | ^ | ^ | ^ | ^ | ^ |
| ^ | 执行脚本 | 清除此复选框还将撤销使用`script.execute` API方法的权限。 | ^ | ^ | ^ | ^ |
| ^ | 管理API令牌 | 清除此复选框还将撤销使用所有`token.` API方法的权限。 | ^ | ^ | ^ | ^ |
| ^ | 管理计划报告 | 清除此复选框还将撤销使用所有`report.` API方法的权限。 | ^ | ^ | 否 | ^ |
| ^ | 管理SLA | 启用/禁用管理[SLA](/manual/web_interface/frontend_sections/services/sla)的权限。 | ^ | ^ | ^ | ^ |
| ^ | 对新操作的默认访问 | 此选项指定Zabbix升级后新操作的访问方式。 | ^ | ^ | 是 | ^ |
注意事项：
- 每个用户只能分配一个角色。
- 如果元素被限制，用户即使通过在浏览器中输入该元素的直接URL也无法访问它。
- 类型为*用户*或*管理员*的用户无法更改自己的角色设置。
- 类型为*超级管理员*的用户可以修改自己角色的设置（不适用于默认的*超级管理员角色*），但不能更改用户类型。
- 所有级别的用户都无法更改自己的用户类型。
另请参阅：
- [Configuring a user](/manual/config/users_and_usergroups/user)
### Default values for Zabbix agent 2
Zabbix agent 2 plugins now allow to define default values for connecting to monitoring targets in the configuration file.
If no value is specified in an item key or a named session, the plugin will use the value defined in the corresponding default parameter.
New parameters have the structure `Plugins.<PluginName>.Default.<Parameter>` - for example, `Plugins.MongoDB.Default.Uri=tcp://localhost:27017`.
See for more info:
- [Configuring plugins](/manual/config/items/plugins#configuring-plugins)
- [Plugin configuration file parameters](/manual/appendix/config/zabbix_agent2_plugins)
### Zabbix agent 2 的默认值
Zabbix agent 2插件现在允许在配置file中定义连接监控目标的默认值.
如果在监控项键或命名会话中未指定值, 插件将使用相应默认参数中定义的值.
新参数的结构为`Plugins.<PluginName>.Default.<Parameter>` - 例如`Plugins.MongoDB.Default.Uri=tcp://localhost:27017`.
更多信息请参阅:
- [配置插件](/manual/config/items/plugins#配置插件)
- [Plugin configuration file parameters](/manual/appendix/config/zabbix_agent2_plugins)
##### Default values
Since Zabbix 6.0.18, you can set default values for the connection-related parameters (URI, username, password, etc.) in the configuration file
in the format:
*Plugins.<PluginName>.Default.<Parameter>=<Value>*
For example, *Plugins.Mysql.Default.Username=zabbix*, *Plugins.MongoDB.Default.Uri=tcp://127.0.0.1:27017*, etc.
If a value for such parameter is not provided in an item key or in the [named session](#named-sessions) parameters,
the plugin will use the default value. If a default parameter is also undefined, hardcoded defaults will be used.
::: noteclassic
If an item key does not have any parameters, Zabbix agent 2 will attempt to collect the metric using values defined in the default parameters section.
:::
##### 默认值
自Zabbix 6.0.18起，您可以在配置file中为连接相关参数（URI、用户名、密码等）设置默认值，格式如下：
*Plugins.<PluginName>.Default.<Parameter>=<Value>*
例如，*Plugins.Mysql.Default.Username=zabbix*，*Plugins.MongoDB.Default.Uri=tcp://127.0.0.1:27017*等。
如果在监控项键或[命名会话](#named-sessions)参数中未提供此类参数的值，插件将使用默认值。如果默认参数也未定义，则将使用硬编码的默认值。
::: noteclassic
如果监控项键没有任何参数，Zabbix agent 2将尝试使用默认参数部分中定义的值来收集指标。
:::
#### Definitions
***[host](/manual/config/hosts)***
\- *any physical or virtual device, application, service, or any other logically-related collection of monitored parameters.*
***[host group](/manual/config/hosts)***
\- *a logical grouping of hosts; it may contain hosts and templates.
Hosts and templates within a host group are not in any way linked to
each other. Host groups are used when assigning access rights to hosts
for different user groups.*
***[item](/manual/config/items)***
\- *a particular piece of data that you want to receive from a host, a
metric of data.*
***[value
preprocessing](/manual/config/items/item#item_value_preprocessing)***
\- *a transformation of received metric value* before saving it to the
database.
***[trigger](/manual/config/triggers)***
\- *a logical expression that defines a problem threshold and is used to
"evaluate" data received in items.*
When received data are above the threshold, triggers go from 'Ok' into a
'Problem' state. When received data are below the threshold, triggers
stay in/return to an 'Ok' state.
***[event](/manual/config/events)***
\- *a single occurrence of something that deserves attention such as a
trigger changing state or a discovery/agent autoregistration taking
place.*
***[event tag](/manual/config/tagging)***
\- *a pre-defined marker for the event.* It may be used in event
correlation, permission granulation, etc.
***[event correlation](/manual/config/event_correlation)***
\- *a method of correlating problems to their resolution flexibly and
precisely.*
For example, you may define that a problem reported by one trigger may
be resolved by another trigger, which may even use a different data
collection method.
***[problem](/manual/web_interface/frontend_sections/monitoring/problems)***
\- *a trigger that is in "Problem" state.*
***[problem update](/manual/acknowledges#updating_problems)***
\- *problem management options provided by Zabbix, such as adding
comment, acknowledging, changing severity or closing manually.*
***[action](/manual/config/notifications/action)***
\- *a predefined means of reacting to an event.*
An action consists of operations (e.g. sending a notification) and
conditions (*when* the operation is carried out)
***[escalation](/manual/config/notifications/action/escalations)***
\- *a custom scenario for executing operations within an action; a
sequence of sending notifications/executing remote commands.*
***[media](/manual/config/notifications/media)***
\- *a means of delivering notifications; delivery channel.*
***[notification](/manual/config/notifications/action/operation/message)***
\- *a message about some event sent to a user via the chosen media
channel.*
***[remote
command](/manual/config/notifications/action/operation/remote_command)***
\- *a pre-defined command that is automatically executed on a monitored
host upon some condition.*
***[template](/manual/config/templates)***
\- *a set of entities (items, triggers, graphs, low-level discovery
rules, web scenarios) ready to be applied to one or several hosts.*
The job of templates is to speed up the deployment of monitoring tasks
on a host; also to make it easier to apply mass changes to monitoring
tasks. Templates are linked directly to individual hosts.
***[web scenario](/manual/web_monitoring)***
\- *one or several HTTP requests to check the availability of a web
site.*
***[frontend](/manual/introduction/overview#architecture)***
\- *the web interface provided with Zabbix.*
***[dashboard](/manual/web_interface/frontend_sections/monitoring/dashboard)***
\- *customizable section of the web interface displaying summaries and
visualizations* of important information in visual units called widgets.
***[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)***
\- *visual unit displaying information of a certain kind and source* (a
summary, a map, a graph, the clock, etc.), used in the dashboard.
***[Zabbix API](/manual/api)***
\- *Zabbix API allows you to use the JSON RPC protocol to create, update
and fetch Zabbix objects (like hosts, items, graphs and others) or
perform any other custom tasks.*
***[Zabbix server](/manual/concepts/server)***
\- *a central process of Zabbix software that performs monitoring,
interacts with Zabbix proxies and agents, calculates triggers, sends
notifications; a central repository of data.*
***[Zabbix proxy](/manual/concepts/proxy)***
\- *a process that may collect data on behalf of Zabbix server, taking
some processing load from the server.*
***[Zabbix agent](/manual/concepts/agent)***
\- *a process deployed on monitoring targets to actively monitor local
resources and applications.*
***[Zabbix agent 2](/manual/concepts/agent2)***
\- *a new generation of Zabbix agent to actively monitor local resources
and applications, allowing to use custom plugins for monitoring.*
::: noteimportant
Because Zabbix agent 2 shares much functionality
with Zabbix agent, the term "Zabbix agent" in documentation stands for
both - Zabbix agent and Zabbix agent 2, if the functional behavior is
the same. Zabbix agent 2 is only specifically named where its
functionality differs.
:::
***[encryption](/manual/encryption)***
\- *support of encrypted communications between Zabbix components
(server, proxy, agent, zabbix\_sender and zabbix\_get utilities)* using
Transport Layer Security (TLS) protocol.
***[network discovery](/manual/discovery/network_discovery)***
\- *automated discovery of network devices*.
***[low-level discovery](/manual/discovery/low_level_discovery)***
\- *automated discovery of low-level entities on a particular device*
(e.g. file systems, network interfaces, etc).
***[low-level discovery
rule](/manual/discovery/low_level_discovery#discovery_rule)***
\- *set of definitions for automated discovery of low-level entities* on
a device.
***[item
prototype](/manual/discovery/low_level_discovery#item_prototypes)***
\- *a metric with certain parameters as variables, ready for low-level
discovery*. After low-level discovery the variables are automatically
substituted with the real discovered parameters and the metric
automatically starts gathering data.
***[trigger
prototype](/manual/discovery/low_level_discovery#trigger_prototypes)***
\- *a trigger with certain parameters as variables, ready for low-level
discovery*. After low-level discovery the variables are automatically
substituted with the real discovered parameters and the trigger
automatically starts evaluating data.
*Prototypes* of some other Zabbix entities are also in use in low-level
discovery - graph prototypes, host prototypes, host group prototypes.
***[agent autoregistration](/manual/discovery/auto_registration)***
\- *automated process whereby a Zabbix agent itself is registered* as a
host and started to monitor.
#### 定义
***[host](/manual/config/hosts)***
- *任何物理或虚拟设备、应用程序、服务或其他逻辑相关的监控参数集合。*
***[host group](/manual/config/hosts)***
- *主机的逻辑分组；它可以包含主机和模板。
主机 和 一个主机 组内的模板之间不存在任何关联
相互之间。主机组用于在分配访问权限给主机时使用
针对不同用户组.*
***[item](/manual/config/items)***
- 您希望从一个主机接收的特定数据片段
数据指标
***[监控项-值预处理](/manual/config/items/item#监控项-值预处理)***
- *接收到的指标值转换* 在保存到
database.
[trigger](/manual/config/triggers)
- 一个用于定义问题阈值的逻辑表达式
"评估"在监控项中接收到的数据.*
当接收到的数据超过阈值时，触发器将从'Ok'状态转变为
'问题'状态. 当接收到的数据低于阈值时,触发器
保持在/恢复到'正常'状态。
***[event](/manual/config/events)***
- 值得关注的单一事件，例如
触发器状态变更或发现/agent自动注册发生
位置.*
[event tag](/manual/config/tagging)
- *事件的预定义标记.* 可用于事件
相关性, 权限粒度化, 等
***[event correlation](/manual/config/event_correlation)***
\- *一种灵活地将问题与其解决方案相关联的方法*
精确地
例如，您可以定义一个触发器报告的问题可能
由另一个触发器解决，该触发器甚至可能使用不同的数据
采集方法
***[problem](/manual/web_interface/frontend_sections/monitoring/problems)***
\- *处于"Problem"状态的触发器.*
***[problem update](/manual/acknowledges#updating_problems)***
- Zabbix提供的问题管理选项，例如添加
评论、确认、手动更改严重性或关闭*
***[action](/manual/config/notifications/action)***
- *预定义的事件响应方式。*
一个动作由多个操作组成（例如发送通知）和
条件（*当*执行操作时）
***[escalation](/manual/config/notifications/action/escalations)***
- 一个用于在动作中执行操作的自定义场景
发送通知/执行远程命令的顺序.*
***[media](/manual/config/notifications/media)***
\- *一种通知传递方式；传递渠道。*
***[notification](/manual/config/notifications/action/operation/message)***
- 通过选定媒介发送给用户的关于某事件的消息
通道
***[remote
command](/manual/config/notifications/action/operation/remote_command)***
- 一个预定义的命令，在受监控设备上自动执行
主机 基于某些条件.*
***[template](/manual/config/templates)***
- 一组实体（监控项、触发器、图表、低级发现
规则、Web场景）可应用于一个或多个主机。*
模板的作用是加速监控任务的部署
在 一个主机 上；同时也便于对监控进行批量更改
任务。模板直接链接到单个主机。
***[web scenario](/manual/web_monitoring)***
\- 通过一个或多个HTTP请求来检查网页的可用性
站点.*
***[架构](/manual/introduction/overview#架构)***
- *Zabbix提供的Web界面。*
***[dashboard](/manual/web_interface/frontend_sections/monitoring/dashboard)***
- 可自定义的Web界面部分，用于显示摘要和
重要信息的*可视化*以称为小部件的视觉单元呈现。
***[widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)***
- *用于显示特定类型和来源信息的可视化单元*
摘要、地图、图表、时钟等，用于仪表板。
***[Zabbix API](/manual/api)***
- *Zabbix API 允许您使用 JSON RPC 协议来 create, update
并获取Zabbix objects（如主机、监控项、图表等）或
执行任何其他自定义任务.*
***[Zabbix server](/manual/concepts/server)***
- Zabbix软件的核心进程，负责执行监控
与Zabbix proxies和agents交互，计算触发器，发送
通知; 数据中央存储库.*
***[Zabbix proxy](/manual/concepts/proxy)***
- 一个可能代表Zabbix server收集数据的进程
从服务器上分担一些处理负载
***[Zabbix agent](/manual/concepts/agent)***
- 部署在监控目标上的进程，用于主动监控本地资源
资源和应用程序
***[Zabbix agent 2](/manual/concepts/agent2)***
- 新一代的Zabbix agent用于主动监控本地资源
和应用程序，允许使用自定义插件进行监控。*
::: noteimportant
因为Zabbix agent 2共享了许多功能
使用Zabbix agent时，文档中的术语"Zabbix agent"代表
两者 - Zabbix agent 和 Zabbix agent 2，如果功能行为是
相同。Zabbix agent 2仅在特定命名时
功能存在差异。
:::
***[encryption](/manual/encryption)***
- *支持Zabbix组件之间的加密通信
(服务器, proxy, agent, zabbix\_sender 和 zabbix\_get 工具)* 使用
传输层安全(TLS)协议
***[network discovery](/manual/discovery/network_discovery)***
- *网络设备的自动发现*。
***[low-level discovery](/manual/discovery/low_level_discovery)***
- *自动发现特定设备上的底层实体*
例如 file 系统、网络接口等
***[发现规则](/manual/discovery/low_level_discovery#发现规则)***
- *用于自动发现低级实体的定义集合*
一台设备。
***[监控项原型](/manual/discovery/low_level_discovery#监控项原型)***
- 一个将特定参数作为变量的指标，已准备好进行底层
discovery*. 在低级发现后，变量会自动
替换为实际发现的参数和指标
自动开始收集数据。
***[触发器原型](/manual/discovery/low_level_discovery#触发器原型)***
- 一个带有特定参数作为变量的触发器，已准备好进行低级
discovery*. 在低级发现后，变量会自动
替换为实际发现的参数和触发器
自动开始评估数据。
某些其他Zabbix实体的*原型*也在低级
发现 - 图形原型、主机 原型、主机组 原型。
***[agent autoregistration](/manual/discovery/auto_registration)***
- *自动化流程，其中Zabbix agent自身被注册*为
主机 并开始监控。
#### Delete a host interface
Delete the host interface with ID 30062.
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.delete",
"params": [
"30062"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30062"
]
},
"id": 1
}
```
#### 删除主机接口
删除ID为30062的主机接口。
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostinterface.delete",
"params": [
"30062"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30062"
]
},
"id": 1
}
```
#### Delete multiple actions
Delete two actions.
Request:
```json
{
"jsonrpc": "2.0",
"method": "action.delete",
"params": [
"17",
"18"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"17",
"18"
]
},
"id": 1
}
```
#### 删除多个动作
删除两个动作。
请求:
```json
{
"jsonrpc": "2.0",
"method": "action.delete",
"params": [
"17",
"18"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"17",
"18"
]
},
"id": 1
}
```
#### Delete multiple correlations
Delete two correlations.
Request:
```json
{
"jsonrpc": "2.0",
"method": "correlation.delete",
"params": [
"1",
"2"
],
"auth": "343baad4f88b4106b9b5961e77437688",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"correlationids": [
"1",
"2"
]
},
"id": 1
}
```
#### 删除多个关联
删除两条关联关系。
请求:
```json
{
"jsonrpc": "2.0",
"method": "correlation.delete",
"params": [
"1",
"2"
],
"auth": "343baad4f88b4106b9b5961e77437688",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"correlationids": [
"1",
"2"
]
},
"id": 1
}
```
#### Delete multiple discovery rules
Delete two discovery rules.
Request:
```json
{
"jsonrpc": "2.0",
"method": "drule.delete",
"params": [
"4",
"6"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"druleids": [
"4",
"6"
]
},
"id": 1
}
```
#### 删除多条发现规则
删除两条发现规则.
请求:
```json
{
"jsonrpc": "2.0",
"method": "drule.delete",
"params": [
"4",
"6"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"druleids": [
"4",
"6"
]
},
"id": 1
}
```
#### Delete multiple icon maps
Delete two icon maps.
Request:
```json
{
"jsonrpc": "2.0",
"method": "iconmap.delete",
"params": [
"2",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"iconmapids": [
"2",
"5"
]
},
"id": 1
}
```
#### 删除多个图标映射
删除两个图标映射。
请求:
```json
{
"jsonrpc": "2.0",
"method": "iconmap.delete",
"params": [
"2",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"iconmapids": [
"2",
"5"
]
},
"id": 1
}
```
#### Delete multiple images
Delete two images.
Request:
```json
{
"jsonrpc": "2.0",
"method": "image.delete",
"params": [
"188",
"192"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"imageids": [
"188",
"192"
]
},
"id": 1
}
```
#### 删除多张图片
删除两张图片。
请求:
```json
{
"jsonrpc": "2.0",
"method": "image.delete",
"params": [
"188",
"192"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"imageids": [
"188",
"192"
]
},
"id": 1
}
```
#### Delete multiple maps
Delete two maps.
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.delete",
"params": [
"12",
"34"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"12",
"34"
]
},
"id": 1
}
```
#### 删除多个拓扑图
删除两张地图.
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.delete",
"params": [
"12",
"34"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"12",
"34"
]
},
"id": 1
}
```
#### Delete multiple proxies
Delete two proxies.
Request:
```json
{
"jsonrpc": "2.0",
"method": "proxy.delete",
"params": [
"10286",
"10285"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10286",
"10285"
]
},
"id": 1
}
```
#### 删除多个 proxies
删除两个proxies.
请求:
```json
{
"jsonrpc": "2.0",
"method": "proxy.delete",
"params": [
"10286",
"10285"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"proxyids": [
"10286",
"10285"
]
},
"id": 1
}
```
#### Delete multiple scripts
Delete two scripts.
Request:
```json
{
"jsonrpc": "2.0",
"method": "script.delete",
"params": [
"3",
"4"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"3",
"4"
]
},
"id": 1
}
```
#### 删除多个脚本
删除两个脚本.
请求:
```json
{
"jsonrpc": "2.0",
"method": "script.delete",
"params": [
"3",
"4"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"scriptids": [
"3",
"4"
]
},
"id": 1
}
```
#### Delete multiple tokens
Delete two tokens.
Request:
```json
{
"jsonrpc": "2.0",
"method": "token.delete",
"params": [
"188",
"192"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"188",
"192"
]
},
"id": 1
}
```
#### 删除多个令牌
删除两个令牌。
请求：
```json
{
"jsonrpc": "2.0",
"method": "token.delete",
"params": [
"188",
"192"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"188",
"192"
]
},
"id": 1
}
```
#### Delete multiple triggers
Delete two triggers.
Request:
```json
{
"jsonrpc": "2.0",
"method": "trigger.delete",
"params": [
"12002",
"12003"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"12002",
"12003"
]
},
"id": 1
}
```
#### 删除多个触发器
删除两个触发器.
请求:
```json
{
"jsonrpc": "2.0",
"method": "trigger.delete",
"params": [
"12002",
"12003"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"12002",
"12003"
]
},
"id": 1
}
```
#### Deleting dependencies from multiple triggers
Delete all dependencies from two triggers.
Request:
```json
{
"jsonrpc": "2.0",
"method": "trigger.deleteDependencies",
"params": [
{
"triggerid": "14544"
},
{
"triggerid": "14545"
}
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"14544",
"14545"
]
},
"id": 1
}
```
#### 从多个触发器删除依赖关系
删除两个触发器之间的所有依赖关系。
请求:
```json
{
"jsonrpc": "2.0",
"method": "trigger.deleteDependencies",
"params": [
{
"triggerid": "14544"
},
{
"triggerid": "14545"
}
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"14544",
"14545"
]
},
"id": 1
}
```
#### Deleting multiple dashboards
Delete two dashboards.
Request:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.delete",
"params": [
"2",
"3"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2",
"3"
]
},
"id": 1
}
```
#### 删除多个仪表板
删除两个仪表板。
请求:
```json
{
"jsonrpc": "2.0",
"method": "dashboard.delete",
"params": [
"2",
"3"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2",
"3"
]
},
"id": 1
}
```
#### Deleting multiple global macros
Delete two global macros.
Request:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.deleteglobal",
"params": [
"32",
"11"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"globalmacroids": [
"32",
"11"
]
},
"id": 1
}
```
#### 删除多个全局宏
删除两个全局宏。
请求:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.deleteglobal",
"params": [
"32",
"11"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"globalmacroids": [
"32",
"11"
]
},
"id": 1
}
```
#### Deleting multiple global regular expressions.
Request:
```json
{
"jsonrpc": "2.0",
"method": "regexp.delete",
"params": [
"16",
"17"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"regexpids": [
"16",
"17"
]
},
"id": 1
}
```
#### 删除多条全局正则表达式
请求:
```json
{
"jsonrpc": "2.0",
"method": "regexp.delete",
"params": [
"16",
"17"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"regexpids": [
"16",
"17"
]
},
"id": 1
}
```
#### Deleting multiple graph prototypes
Delete two graph prototypes.
Request:
```json
{
"jsonrpc": "2.0",
"method": "graphprototype.delete",
"params": [
"652",
"653"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652",
"653"
]
},
"id": 1
}
```
#### 删除多个图形原型
删除两个图形原型。
请求:
```json
{
"jsonrpc": "2.0",
"method": "graphprototype.delete",
"params": [
"652",
"653"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652",
"653"
]
},
"id": 1
}
```
#### Deleting multiple graphs
Delete two graphs.
Request:
```json
{
"jsonrpc": "2.0",
"method": "graph.delete",
"params": [
"652",
"653"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652",
"653"
]
},
"id": 1
}
```
#### 删除多个图形
删除两个图形。
请求:
```json
{
"jsonrpc": "2.0",
"method": "graph.delete",
"params": [
"652",
"653"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"graphids": [
"652",
"653"
]
},
"id": 1
}
```
#### Deleting multiple host groups
Delete two host groups.
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostgroup.delete",
"params": [
"107824",
"107825"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"107824",
"107825"
]
},
"id": 1
}
```
#### 删除多个主机组
删除两个主机组.
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostgroup.delete",
"params": [
"107824",
"107825"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"107824",
"107825"
]
},
"id": 1
}
```
#### Deleting multiple host macros
Delete two host macros.
Request:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.delete",
"params": [
"32",
"11"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostmacroids": [
"32",
"11"
]
},
"id": 1
}
```
#### 删除多个主机宏
删除两个主机宏.
请求:
```json
{
"jsonrpc": "2.0",
"method": "usermacro.delete",
"params": [
"32",
"11"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostmacroids": [
"32",
"11"
]
},
"id": 1
}
```
#### Deleting multiple host prototypes
Delete two host prototypes.
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostprototype.delete",
"params": [
"10103",
"10105"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10103",
"10105"
]
},
"id": 1
}
```
#### 删除多个主机原型
删除两个主机原型.
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostprototype.delete",
"params": [
"10103",
"10105"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10103",
"10105"
]
},
"id": 1
}
```
#### Deleting multiple hosts
Delete two hosts.
Request:
```json
{
"jsonrpc": "2.0",
"method": "host.delete",
"params": [
"13",
"32"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"13",
"32"
]
},
"id": 1
}
```
#### 删除多个主机
删除两个主机.
请求:
```json
{
"jsonrpc": "2.0",
"method": "host.delete",
"params": [
"13",
"32"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"13",
"32"
]
},
"id": 1
}
```
#### Deleting multiple LLD rules
Delete two LLD rules.
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.delete",
"params": [
"27665",
"27668"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"ruleids": [
"27665",
"27668"
]
},
"id": 1
}
```
#### 删除多条LLD规则
删除两条LLD规则。
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.delete",
"params": [
"27665",
"27668"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"ruleids": [
"27665",
"27668"
]
},
"id": 1
}
```
#### Deleting multiple maintenance periods
Delete two maintenance periods.
Request:
```json
{
"jsonrpc": "2.0",
"method": "maintenance.delete",
"params": [
"3",
"1"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3",
"1"
]
},
"id": 1
}
```
#### 删除多个维护周期
删除两个维护周期。
请求:
```json
{
"jsonrpc": "2.0",
"method": "maintenance.delete",
"params": [
"3",
"1"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"maintenanceids": [
"3",
"1"
]
},
"id": 1
}
```
#### Deleting multiple media types
Delete two media types.
Request:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.delete",
"params": [
"3",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"3",
"5"
]
},
"id": 1
}
```
#### 删除多个媒介类型
删除两种媒体类型。
请求：
```json
{
"jsonrpc": "2.0",
"method": "mediatype.delete",
"params": [
"3",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"3",
"5"
]
},
"id": 1
}
```
#### Deleting multiple scheduled reports
Delete two scheduled reports.
Request:
```json
{
"jsonrpc": "2.0",
"method": "report.delete",
"params": [
"1",
"2"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1",
"2"
]
},
"id": 1
}
```
#### 删除多个计划报告
删除两个预定的报告。
请求:
```json
{
"jsonrpc": "2.0",
"method": "report.delete",
"params": [
"1",
"2"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1",
"2"
]
},
"id": 1
}
```
#### Deleting multiple services
Delete two services.
Request:
```json
{
"jsonrpc": "2.0",
"method": "service.delete",
"params": [
"4",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"4",
"5"
]
},
"id": 1
}
```
#### 删除多个服务
删除两个服务。
请求:
```json
{
"jsonrpc": "2.0",
"method": "service.delete",
"params": [
"4",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"serviceids": [
"4",
"5"
]
},
"id": 1
}
```
#### Deleting multiple SLAs
Delete two SLA entries.
Request:
```json
{
"jsonrpc": "2.0",
"method": "sla.delete",
"params": [
"4",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"slaids": [
"4",
"5"
]
},
"id": 1
}
```
#### 删除多个 SLA
删除两个SLA条目.
请求:
```json
{
"jsonrpc": "2.0",
"method": "sla.delete",
"params": [
"4",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"slaids": [
"4",
"5"
]
},
"id": 1
}
```
#### Deleting multiple template dashboards
Delete two template dashboards.
Request:
```json
{
"jsonrpc": "2.0",
"method": "templatedashboard.delete",
"params": [
"45",
"46"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"45",
"46"
]
},
"id": 1
}
```
#### 删除多个模板仪表盘
删除两个模板仪表盘。
请求:
```json
{
"jsonrpc": "2.0",
"method": "templatedashboard.delete",
"params": [
"45",
"46"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"45",
"46"
]
},
"id": 1
}
```
#### Deleting multiple templates
Delete two templates.
Request:
```json
{
"jsonrpc": "2.0",
"method": "template.delete",
"params": [
"13",
"32"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"13",
"32"
]
},
"id": 1
}
```
#### 删除多个模板
删除两个模板。
请求:
```json
{
"jsonrpc": "2.0",
"method": "template.delete",
"params": [
"13",
"32"
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"13",
"32"
]
},
"id": 1
}
```
#### Deleting multiple trigger prototypes
Delete two trigger prototypes.
Request:
```json
{
"jsonrpc": "2.0",
"method": "triggerprototype.delete",
"params": [
"12002",
"12003"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"12002",
"12003"
]
},
"id": 1
}
```
#### 删除多个触发器原型
删除两个触发器原型。
请求:
```json
{
"jsonrpc": "2.0",
"method": "triggerprototype.delete",
"params": [
"12002",
"12003"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"12002",
"12003"
]
},
"id": 1
}
```
#### Deleting multiple user groups
Delete two user groups.
Request:
```json
{
"jsonrpc": "2.0",
"method": "usergroup.delete",
"params": [
"20",
"21"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"20",
"21"
]
},
"id": 1
}
```
#### 删除多个用户组
删除两个用户组。
请求:
```json
{
"jsonrpc": "2.0",
"method": "usergroup.delete",
"params": [
"20",
"21"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"20",
"21"
]
},
"id": 1
}
```
#### Deleting multiple user roles
Delete two user roles.
Request:
```json
{
"jsonrpc": "2.0",
"method": "role.delete",
"params": [
"4",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"4",
"5"
]
},
"id": 1
}
```
#### 删除多个用户角色
删除两个用户角色。
请求:
```json
{
"jsonrpc": "2.0",
"method": "role.delete",
"params": [
"4",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"4",
"5"
]
},
"id": 1
}
```
#### Deleting multiple users
Delete two users.
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.delete",
"params": [
"1",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"userids": [
"1",
"5"
]
},
"id": 1
}
```
#### 删除多个用户
删除两个用户。
请求:
```json
{
"jsonrpc": "2.0",
"method": "user.delete",
"params": [
"1",
"5"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"userids": [
"1",
"5"
]
},
"id": 1
}
```
#### Deleting multiple value maps
Delete two value maps.
Request:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.delete",
"params": [
"1",
"2"
],
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"1",
"2"
]
},
"id": 1
}
```
#### 删除多个值映射
删除两个值映射
请求:
```json
{
"jsonrpc": "2.0",
"method": "valuemap.delete",
"params": [
"1",
"2"
],
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"1",
"2"
]
},
"id": 1
}
```
#### Deleting multiple web scenarios
Delete two web scenarios.
Request:
```json
{
"jsonrpc": "2.0",
"method": "httptest.delete",
"params": [
"2",
"3"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"httptestids": [
"2",
"3"
]
},
"id": 1
}
```
#### 删除多个 Web 场景
删除两个Web场景。
请求:
```json
{
"jsonrpc": "2.0",
"method": "httptest.delete",
"params": [
"2",
"3"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"httptestids": [
"2",
"3"
]
},
"id": 1
}
```
##### Deny specific check
- Blacklist a specific check with DenyKey parameter. Matching keys
will be disallowed. All non-matching keys will be allowed, except
system.run\[\] items.
For example:
# Deny secure data access
DenyKey=vfs.file.contents[/etc/passwd,*]
::: noteimportant
A blacklist may not be a good choice, because a
new Zabbix version may have new keys that are not explicitly restricted
by the existing configuration. This could cause a security
flaw.
:::
##### 拒绝特定检查
- 使用DenyKey参数将特定检查项加入黑名单。匹配的键值
will be disallowed. All non-matching keys will be allowed, except
system.run\[\] items.
例如：
# Deny secure data access
DenyKey=vfs.file.contents[/etc/passwd,*]
::: noteimportant
黑名单可能不是最佳选择，因为
新版Zabbix version 可能包含未被现有配置明确限制的
新键值。这可能导致安全
漏洞。
:::
##### Deny specific command, allow others
- Blacklist a specific command with DenyKey parameter. Whitelist all
other commands, with the AllowKey parameter.
```{=html}
<!-- -->
```
# Disallow specific command
DenyKey=system.run[ls -l /]
# Allow other scripts
AllowKey=system.run[*]
##### 拒绝特定命令，允许其他命令
- 使用DenyKey参数将特定命令加入黑名单。允许所有其他命令
other commands, with the AllowKey parameter.
```{=html}
<!-- -->
```
# Disallow specific command
DenyKey=system.run[ls -l /]
# Allow other scripts
AllowKey=system.run[*]
##### Dependent item prototype
Create an item prototype with "Dependent item" type in this LLD rule. As
master item for this prototype select the `ipmi.get` item we created.
Note the use of the {\#SENSOR\_ID} macro in the item prototype name and
key:
- *Name*: IPMI value for sensor {\#SENSOR\_ID}
- *Key*: ipmi\_sensor\[{\#SENSOR\_ID}\]
As type of information, *Numeric (unsigned)*.
In the item prototype "Preprocessing" tab select JSONPath and use the
following JSONPath expression as parameter:
$.[?(@.id=='{#SENSOR_ID}')].value.first()
When discovery starts, one item per each IPMI sensor will be created.
This item will return the integer value of the given sensor.
##### 依赖 监控项 原型
在此LLD规则中创建一个类型为"依赖项监控项"的监控项原型
主 监控项 对于此原型选择我们创建的 `ipmi.get` 监控项
注意在监控项原型名称中使用{\#SENSOR\_ID}宏
键:
- *名称*: 传感器{\#SENSOR\_ID}的IPMI值
- *Key*: ipmi\_sensor\[{\#SENSOR\_ID}\]
作为信息类型，*Numeric (unsigned)*。
在监控项原型中的"预处理"选项卡选择JSONPath并使用
以下JSONPath表达式作为参数:
$.[?(@.id=='{#SENSOR_ID}')].value.first()
当发现开始时，将为每个IPMI传感器创建一个监控项。
这个监控项将返回给定传感器的integer值。
##### Dependent item prototype
Create an item prototype with "Dependent item" type in this LLD rule. As
master item for this prototype select the `vfs.fs.get` item we created.
Note the use of custom macros in the item prototype name and key:
- *Name*: Free disk space on {\#FSNAME}, type: {\#FSTYPE}
- *Key*: Free\[{\#FSNAME}\]
As type of information, use:
- *Numeric (unsigned)* for metrics like 'free', 'total', 'used'
- *Numeric (float)* for metrics like 'pfree', 'pused' (percentage)
In the item prototype "Preprocessing" tab select JSONPath and use the
following JSONPath expression as parameter:
$.[?(@.fsname=='{#FSNAME}')].bytes.free.first()
When discovery starts, one item per each mountpoint will be created.
This item will return the number of free bytes for the given mountpoint.
##### 依赖 监控项 原型
在此LLD规则中创建一个类型为"依赖项监控项"的监控项原型
此原型的主监控项选择我们创建的`vfs.fs.get` 监控项
注意在监控项原型名称和键中使用自定义宏:
- *名称*: {\#FSNAME}上的空闲磁盘空间, 类型: {\#FSTYPE}
- *Key*: Free\[{\#FSNAME}\]
作为信息类型，使用：
- *数值型（无符号）* 适用于诸如'空闲'、'总量'等指标，'使用率'
- *数值型 (float)* 适用于诸如 'pfree'、'pused'（百分比）等指标
在监控项原型机的"预处理"选项卡中选择JSONPath并使用
以下JSONPath表达式作为参数:
$.[?(@.fsname=='{#FSNAME}')].bytes.free.first()
当发现过程开始时，将为每个挂载点创建一个监控项。
此监控项将返回给定挂载点的可用字节数。
##### Dependent LLD rule
Create a low-level discovery rule as "Dependent item" type:
As master item select the `vfs.fs.get` item we created.
In the "LLD macros" tab define custom macros with the corresponding
JSONPath:
##### 依赖式LLD规则
创建一个类型为"依赖监控项"的低级发现规则:
在主监控项中选择我们创建的`vfs.fs.get` 监控项.
在"LLD宏"标签页中定义带有对应JSONPath的自定义宏:
##### Dependent LLD rule
Create a low-level discovery rule as "Dependent item" type:
As master item select the `ipmi.get` item we created.
In the "LLD macros" tab define a custom macro with the corresponding
JSONPath:
##### 依赖式LLD规则
创建类型为"依赖监控项"的低级发现规则:
在主监控项中选择我们创建的`ipmi.get` 监控项.
在"LLD宏"标签页中定义带有对应JSONPath的自定义宏:
##### Deprecated internal items for history/trends
The following internal items are now deprecated and will be removed in a future major release:
- `zabbix[history]`
- `zabbix[history_log]`
- `zabbix[history_str]`
- `zabbix[history_text]`
- `zabbix[history_uint]`
- `zabbix[trends]`
- `zabbix[trends_uint]`
##### 废弃的内部 监控项 用于历史数据/趋势数据
以下内部监控项现已弃用，并将在未来的主要版本中移除：
- `zabbix[history]`
- `zabbix[history_log]`
- `zabbix[history_str]`
- `zabbix[history_text]`
- `zabbix[history_uint]`
- `zabbix[trends]`
- `zabbix[trends_uint]`
Deprecated widgets:
- [Data overview](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/data_overview)
已弃用的小部件：
- [Data overview](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/data_overview)
### Description
`array configuration.importcompare(object parameters)`
This method allows to compare import file with current system elements and shows what will be changed if this import file will be imported.
::: noteclassic
This method is available to users of any type.
Permissions to call the method can be revoked in user role settings.
See [User roles](/manual/web_interface/frontend_sections/administration/user_roles) for more information.
:::
### 描述
`array configuration.importcompare(object parameters)`
此方法允许将import file与当前系统元素进行比较，并显示导入该import file时将发生的变更。
::: noteclassic
该方法对所有类型用户可用。
调用该方法的权限可在用户角色设置中撤销。
更多信息请参阅[User roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`boolean configuration.import(object parameters)`
This method allows to import configuration data from a serialized string.
::: noteclassic
This method is available to users of any type.
Permissions to call the method can be revoked in user role settings.
See [User roles](/manual/web_interface/frontend_sections/administration/user_roles) for more information.
:::
### 描述
`boolean configuration.import(object parameters)`
此方法允许从序列化的string中import配置数据。
::: noteclassic
该方法对任何类型的用户都可用。
调用该方法的权限可以在用户角色设置中撤销。
更多信息请参阅[User roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array action.get(object parameters)`
The method allows to retrieve actions according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array action.get(object parameters)`
该方法允许根据给定参数检索动作.
::: noteclassic
此方法可供任何类型的用户使用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`integer/array alert.get(object parameters)`
The method allows to retrieve alerts according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array alert.get(object parameters)`
该方法允许根据给定参数检索告警信息。
::: noteclassic
该方法对所有类型用户可用。调用权限可通过用户角色设置进行撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array auditlog.get(object parameters)`
The method allows to retrieve audit log records according to the given
parameters.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array auditlog.get(object parameters)`
该方法允许根据给定参数检索审计日志记录。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`integer/array correlation.get(object parameters)`
The method allows to retrieve correlations according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array correlation.get(object parameters)`
该方法允许根据给定参数检索关联关系。
::: noteclassic
该方法对所有类型用户开放。调用权限可通过用户角色设置进行撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array dashboard.get(object parameters)`
The method allows to retrieve dashboards according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array dashboard.get(object parameters)`
该方法允许根据给定参数检索仪表板。
::: noteclassic
该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array dcheck.get(object parameters)`
The method allows to retrieve discovery checks according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array dcheck.get(object parameters)`
该方法允许根据给定参数检索发现检查。
::: noteclassic
该方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array dhost.get(object parameters)`
The method allows to retrieve discovered hosts according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array dhost.get(object parameters)`
该方法允许根据给定参数检索发现的主机。
::: noteclassic
该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array discoveryrule.get(object parameters)`
The method allows to retrieve LLD rules according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array discoveryrule.get(object parameters)`
该方法允许根据给定参数检索LLD规则.
::: noteclassic
此方法可供任何类型的用户使用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`integer/array drule.get(object parameters)`
The method allows to retrieve discovery rules according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array drule.get(object parameters)`
该方法允许根据给定参数检索发现规则。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array dservice.get(object parameters)`
The method allows to retrieve discovered services according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array dservice.get(object parameters)`
该方法允许根据给定参数检索已发现的服务。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array event.get(object parameters)`
The method allows to retrieve events according to the given parameters.
::: noteimportant
This method may return events of a deleted entity
if these events have not been removed by the housekeeper
yet.
:::
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array event.get(object parameters)`
该方法允许根据给定参数检索事件。
::: noteimportant
如果这些事件尚未被管家进程移除，
该方法可能返回已删除实体的事件。
:::
::: noteclassic
该方法可供任何类型的用户使用。调用该方法的权限
可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array graph.get(object parameters)`
The method allows to retrieve graphs according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array graph.get(object parameters)`
该方法允许根据给定参数检索图表。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array graphitem.get(object parameters)`
The method allows to retrieve graph items according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array graphitem.get(object parameters)`
该方法允许根据给定参数检索图表监控项。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可在用户角色设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array graphprototype.get(object parameters)`
The method allows to retrieve graph prototypes according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array graphprototype.get(object parameters)`
该方法允许根据给定参数检索图形原型。
::: noteclassic
该方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array hanode.get(object parameters)`
The method allows to retrieve a list of High availability cluster nodes
according to the given parameters.
::: noteclassic
This method is only available to *Super admin* user types.
See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array hanode.get(object parameters)`
该方法允许根据给定参数检索高可用性集群节点列表
::: noteclassic
此方法仅适用于*超级管理员*用户类型
更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`integer/array history.get(object parameters)`
The method allows to retrieve history data according to the given
parameters.
::: noteimportant
This method may return historical data of a
deleted entity if this data has not been removed by the housekeeper
yet.
:::
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array history.get(object parameters)`
该方法允许根据给定参数检索历史数据。
::: noteimportant
如果管家程序尚未清除相关数据，该方法可能返回已删除实体的历史数据。
:::
::: noteclassic
该方法对所有类型用户开放。调用权限可通过用户角色设置进行撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array host.get(object parameters)`
The method allows to retrieve hosts according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array host.get(object parameters)`
该方法允许根据给定参数检索主机.
::: noteclassic
此方法可供任何类型的用户使用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`integer/array hostgroup.get(object parameters)`
The method allows to retrieve host groups according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array hostgroup.get(object parameters)`
该方法允许根据给定参数检索主机组.
::: noteclassic
此方法可供任何类型的用户使用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`integer/array hostinterface.get(object parameters)`
The method allows to retrieve host interfaces according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array hostinterface.get(object parameters)`
该方法允许根据给定参数检索主机接口.
::: noteclassic
该方法对所有类型用户可用. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`integer/array hostprototype.get(object parameters)`
The method allows to retrieve host prototypes according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array hostprototype.get(object parameters)`
该方法允许根据给定参数检索主机原型。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可在用户角色设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array httptest.get(object parameters)`
The method allows to retrieve web scenarios according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array httptest.get(object parameters)`
该方法允许根据给定参数检索Web场景。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array iconmap.get(object parameters)`
The method allows to retrieve icon maps according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array iconmap.get(object parameters)`
该方法允许根据给定参数检索图标映射。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array image.get(object parameters)`
The method allows to retrieve images according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array image.get(object parameters)`
该方法允许根据给定参数检索图像。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array item.get(object parameters)`
The method allows to retrieve items according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array item.get(object parameters)`
该方法允许根据给定参数检索监控项。
::: noteclassic
此方法适用于所有类型的用户。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array itemprototype.get(object parameters)`
The method allows to retrieve item prototypes according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array itemprototype.get(object parameters)`
该方法允许根据给定参数检索监控项原型.
::: noteclassic
该方法对所有类型的用户可用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`integer/array maintenance.get(object parameters)`
The method allows to retrieve maintenances according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array maintenance.get(object parameters)`
该方法允许根据给定参数检索维护周期。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array map.get(object parameters)`
The method allows to retrieve maps according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array map.get(object parameters)`
该方法允许根据给定参数检索地图。
::: noteclassic
该方法对所有类型的用户可用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array mediatype.get(object parameters)`
The method allows to retrieve media types according to the given
parameters.
::: noteclassic
This method is only available to *Admin* and *Super admin* user types.
Permissions to call the method can be revoked in user role settings.
See [User roles](/manual/web_interface/frontend_sections/administration/user_roles) for more information.
:::
### 描述
`integer/array mediatype.get(object parameters)`
该方法允许根据给定参数检索媒体类型。
::: noteclassic
此方法仅对*管理员*和*超级管理员*用户类型可用。
调用该方法的权限可以在用户角色设置中撤销。
更多信息请参阅[User roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array problem.get(object parameters)`
The method allows to retrieve problems according to the given
parameters.
This method is for retrieving unresolved problems. It is also possible,
if specified, to additionally retrieve recently resolved problems. The
period that determines how old is "recently" is defined in
*Administration* →
*[General](/manual/web_interface/frontend_sections/administration/general#trigger_displaying_options)*.
Problems that were resolved prior to that period are not kept in the
problem table. To retrieve problems that were resolved further back in
the past, use the [event.get](/manual/api/reference/event/get) method.
::: noteimportant
This method may return problems of a deleted
entity if these problems have not been removed by the housekeeper
yet.
:::
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array problem.get(object parameters)`
该方法允许根据给定参数检索问题。
此方法用于检索未解决的问题。如果指定，还可以额外检索最近解决的问题。确定"最近"时间范围的周期定义在
*管理* →
*[触发器显示选项](/manual/web_interface/frontend_sections/administration/general#触发器显示选项)*中。
在该周期之前解决的问题不会保留在问题表中。要检索更早之前解决的问题，请使用[event.get](/manual/api/reference/event/get)方法。
::: noteimportant
如果管家进程尚未清理，此方法可能返回已删除实体的问题。
:::
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array proxy.get(object parameters)`
The method allows to retrieve proxies according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array proxy.get(object parameters)`
该方法允许根据给定参数检索proxies.
::: noteclassic
此方法可供任何类型的用户使用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`integer/array regexp.get(object parameters)`
The method allows to retrieve global regular expressions according to
the given parameters.
::: noteclassic
This method is available only to *Super Admin*. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array regexp.get(object parameters)`
该方法允许根据给定参数检索全局正则表达式。
::: noteclassic
此方法仅限*超级管理员*使用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array report.get(object parameters)`
The method allows to retrieve scheduled reports according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array report.get(object parameters)`
该方法允许根据给定参数检索预定的报告。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array role.get(object parameters)`
The method allows to retrieve roles according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array role.get(object parameters)`
该方法允许根据给定参数检索角色。
::: noteclassic
该方法对所有类型用户可用。调用该方法的权限可通过用户角色设置进行撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array script.get(object parameters)`
The method allows to retrieve scripts according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array script.get(object parameters)`
该方法允许根据给定参数检索脚本。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array service.get(object parameters)`
The method allows to retrieve services according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array service.get(object parameters)`
该方法允许根据给定参数检索服务。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array sla.get(object parameters)`
The method allows to retrieve SLA objects according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array sla.get(object parameters)`
该方法允许根据给定参数检索SLA objects。
::: noteclassic
此方法适用于任何类型的用户。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array task.get(object parameters)`
The method allows to retrieve tasks according to the given parameters.
Method returns details only about 'diagnostic information' tasks.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array task.get(object parameters)`
该方法允许根据给定参数检索任务。
该方法仅返回关于"诊断信息"任务的详细信息。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`integer/array templatedashboard.get(object parameters)`
The method allows to retrieve template dashboards according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array templatedashboard.get(object parameters)`
该方法允许根据给定参数检索模板仪表板。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array template.get(object parameters)`
The method allows to retrieve templates according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array template.get(object parameters)`
该方法允许根据给定参数检索模板。
::: noteclassic
该方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array token.get(object parameters)`
The method allows to retrieve tokens according to the given parameters.
::: noteclassic
Only *Super admin* user type is allowed to view tokens for
other users.
:::
### 描述
`integer/array token.get(object parameters)`
该方法允许根据给定参数检索令牌。
::: noteclassic
仅*超级管理员*用户类型被允许查看其他用户的令牌。
:::
### Description
`integer/array trend.get(object parameters)`
The method allows to retrieve trend data according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array trend.get(object parameters)`
该方法允许根据给定参数检索趋势数据。
::: noteclassic
该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array trigger.get(object parameters)`
The method allows to retrieve triggers according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array trigger.get(object parameters)`
该方法允许根据给定参数检索触发器。
::: noteclassic
该方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array triggerprototype.get(object parameters)`
The method allows to retrieve trigger prototypes according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array triggerprototype.get(object parameters)`
该方法允许根据给定参数检索触发器原型。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array user.get(object parameters)`
The method allows to retrieve users according to the given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array user.get(object parameters)`
该方法允许根据给定参数检索用户。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array usergroup.get(object parameters)`
The method allows to retrieve user groups according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array usergroup.get(object parameters)`
该方法允许根据给定参数检索用户组。
::: noteclassic
该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array usermacro.get(object parameters)`
The method allows to retrieve host and global macros according to the
given parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array usermacro.get(object parameters)`
该方法允许根据给定参数检索主机和全局宏。
::: noteclassic
该方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`integer/array valuemap.get(object parameters)`
The method allows to retrieve value maps according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`integer/array valuemap.get(object parameters)`
该方法允许根据给定参数检索值映射。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object action.create(object/array actions)`
This method allows to create new actions.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object action.create(object/array actions)`
此方法允许create新动作.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object action.delete(array actionIds)`
This method allows to delete actions.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object action.delete(array actionIds)`
此方法允许delete操作.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object action.update(object/array actions)`
This method allows to update existing actions.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object action.update(object/array actions)`
此方法允许update现有操作。
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型。调用该方法的权限可在用户角色
设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object authentication.get(object parameters)`
The method allows to retrieve authentication object according to the
given parameters.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object authentication.get(object parameters)`
该方法允许根据给定参数获取认证object。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object authentication.update(object authentication)`
This method allows to update existing authentication settings.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object authentication.update(object authentication)`
此方法允许update现有的认证设置.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object autoregistration.get(object parameters)`
The method allows to retrieve autoregistration object according to the
given parameters.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object autoregistration.get(object parameters)`
该方法允许根据给定参数检索自动注册object。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object autoregistration.update(object autoregistration)`
This method allows to update existing autoregistration.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object autoregistration.update(object autoregistration)`
此方法允许update现有的自动注册功能。
::: noteclassic
此方法仅限*超级管理员*用户类型使用。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object correlation.create(object/array correlations)`
This method allows to create new correlations.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object correlation.create(object/array correlations)`
此方法允许create新的关联关系.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object correlation.delete(array correlationids)`
This method allows to delete correlations.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object correlation.delete(array correlationids)`
此方法允许delete关联关系.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object correlation.update(object/array correlations)`
This method allows to update existing correlations.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object correlation.update(object/array correlations)`
此方法允许update现有关联性.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object dashboard.create(object/array dashboards)`
This method allows to create new dashboards.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object dashboard.create(object/array dashboards)`
此方法允许create新仪表板.
::: noteclassic
该方法适用于任何类型的用户. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object dashboard.delete(array dashboardids)`
This method allows to delete dashboards.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object dashboard.delete(array dashboardids)`
此方法允许delete仪表板.
::: noteclassic
该方法适用于所有类型的用户. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object dashboard.update(object/array dashboards)`
This method allows to update existing dashboards.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object dashboard.update(object/array dashboards)`
此方法允许update现有仪表板.
::: noteclassic
该方法适用于所有类型的用户. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object discoveryrule.copy(object parameters)`
This method allows to copy LLD rules with all of the prototypes to the
given hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object discoveryrule.copy(object parameters)`
此方法允许将copy LLD规则及其所有原型关联到指定的主机.
::: noteclassic
此方法仅限*管理员*和*超级管理员*用户类型使用. 调用该方法的权限可通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object discoveryrule.create(object/array lldRules)`
This method allows to create new LLD rules.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object discoveryrule.create(object/array lldRules)`
此方法允许create新的LLD规则.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object discoveryrule.delete(array lldRuleIds)`
This method allows to delete LLD rules.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object discoveryrule.delete(array lldRuleIds)`
此方法允许delete LLD规则.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object discoveryrule.update(object/array lldRules)`
This method allows to update existing LLD rules.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object discoveryrule.update(object/array lldRules)`
此方法允许update现有的LLD规则.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object drule.create(object/array discoveryRules)`
This method allows to create new discovery rules.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object drule.create(object/array discoveryRules)`
此方法允许create新的发现规则.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object drule.delete(array discoveryRuleIds)`
This method allows to delete discovery rules.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object drule.delete(array discoveryRuleIds)`
此方法允许delete发现规则.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object drule.update(object/array discoveryRules)`
This method allows to update existing discovery rules.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object drule.update(object/array discoveryRules)`
此方法允许update现有的发现规则.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object graph.create(object/array graphs)`
This method allows to create new graphs.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object graph.create(object/array graphs)`
此方法允许create新图表.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object graph.delete(array graphIds)`
This method allows to delete graphs.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object graph.delete(array graphIds)`
此方法允许delete图表。
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object graphprototype.create(object/array graphPrototypes)`
This method allows to create new graph prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object graphprototype.create(object/array graphPrototypes)`
该方法允许create新的图形原型.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object graphprototype.delete(array graphPrototypeIds)`
This method allows to delete graph prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object graphprototype.delete(array graphPrototypeIds)`
此方法允许delete图形原型.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object graphprototype.update(object/array graphPrototypes)`
This method allows to update existing graph prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object graphprototype.update(object/array graphPrototypes)`
此方法允许update现有的图形原型。
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型。调用该方法的权限可以在用户角色
设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object graph.update(object/array graphs)`
This method allows to update existing graphs.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object graph.update(object/array graphs)`
此方法允许update现有图表。
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型。调用该方法的权限可在用户角色
设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object history.clear(array itemids)`
This method allows to clear item history.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object history.clear(array itemids)`
此方法允许clear 监控项历史记录.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object host.create(object/array hosts)`
This method allows to create new hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object host.create(object/array hosts)`
此方法允许create新的主机.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object host.delete(array hosts)`
This method allows to delete hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object host.delete(array hosts)`
此方法允许delete主机.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型。调用该方法的权限可在用户角色
设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object hostgroup.create(object/array hostGroups)`
This method allows to create new host groups.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostgroup.create(object/array hostGroups)`
此方法允许create新的主机组.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object hostgroup.delete(array hostGroupIds)`
This method allows to delete host groups.
A host group can not be deleted if:
- it contains hosts that belong to this group only;
- it is marked as internal;
- it is used by a host prototype;
- it is used in a global script;
- it is used in a correlation condition.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostgroup.delete(array hostGroupIds)`
该方法允许delete主机组.
一个主机组在以下情况下无法被删除:
- 该组包含仅属于该组的主机;
- 该组被标记为内部组;
- 该组被一个主机原型使用;
- 该组在全局脚本中使用;
- 该组在关联条件中使用.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object hostgroup.massadd(object parameters)`
This method allows to simultaneously add multiple related objects to all
the given host groups.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostgroup.massadd(object parameters)`
此方法允许同时向所有指定的主机组添加多个关联的objects.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object hostgroup.massremove(object parameters)`
This method allows to remove related objects from multiple host groups.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostgroup.massremove(object parameters)`
此方法允许从多个主机组中移除关联的objects。
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object hostgroup.massupdate(object parameters)`
This method allows to replace hosts and templates with the specified
ones in multiple host groups.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostgroup.massupdate(object parameters)`
此方法允许在多个主机组中用指定内容替换主机和模板
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object hostgroup.update(object/array hostGroups)`
This method allows to update existing hosts groups.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostgroup.update(object/array hostGroups)`
此方法允许update现有的主机组.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object hostinterface.create(object/array hostInterfaces)`
This method allows to create new host interfaces.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostinterface.create(object/array hostInterfaces)`
此方法允许create新的主机接口.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object hostinterface.delete(array hostInterfaceIds)`
This method allows to delete host interfaces.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostinterface.delete(array hostInterfaceIds)`
此方法允许delete 主机接口.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object hostinterface.massadd(object parameters)`
This method allows to simultaneously add host interfaces to multiple
hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostinterface.massadd(object parameters)`
该方法允许同时向多个主机添加主机接口。
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object hostinterface.massremove(object parameters)`
This method allows to remove host interfaces from the given hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostinterface.massremove(object parameters)`
此方法允许从给定的主机中移除主机接口。
::: noteclassic
此方法仅对*管理员*和*超级管理员*用户类型可用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object hostinterface.replacehostinterfaces(object parameters)`
This method allows to replace all host interfaces on a given host.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostinterface.replacehostinterfaces(object parameters)`
此方法允许替换指定主机上的所有主机接口。
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object hostinterface.update(object/array hostInterfaces)`
This method allows to update existing host interfaces.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostinterface.update(object/array hostInterfaces)`
此方法允许update现有的主机接口.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object host.massadd(object parameters)`
This method allows to simultaneously add multiple related objects to all
the given hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object host.massadd(object parameters)`
此方法允许同时向所有指定主机添加多个关联objects。
::: noteclassic
此方法仅限*管理员*和*超级管理员*用户类型使用。调用该方法的权限可通过用户角色设置进行撤销。详见[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)获取更多信息。
:::
### Description
`object host.massremove(object parameters)`
This method allows to remove related objects from multiple hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object host.massremove(object parameters)`
该方法允许从多个主机中移除关联的objects.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object host.massupdate(object parameters)`
This method allows to simultaneously replace or remove related objects
and update properties on multiple hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object host.massupdate(object parameters)`
此方法允许同时替换或移除多个主机上的关联objects和update属性.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型. 调用该方法的权限可在用户角色设置中撤销. 详见[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)获取更多信息.
:::
### Description
`object hostprototype.create(object/array hostPrototypes)`
This method allows to create new host prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostprototype.create(object/array hostPrototypes)`
该方法允许create新的主机原型.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object hostprototype.delete(array hostPrototypeIds)`
This method allows to delete host prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostprototype.delete(array hostPrototypeIds)`
此方法允许delete 主机原型.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object hostprototype.update(object/array hostPrototypes)`
This method allows to update existing host prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object hostprototype.update(object/array hostPrototypes)`
此方法允许update现有的主机原型.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object host.update(object/array hosts)`
This method allows to update existing hosts.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object host.update(object/array hosts)`
此方法允许update现有的主机.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object housekeeping.get(object parameters)`
The method allows to retrieve housekeeping object according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object housekeeping.get(object parameters)`
该方法允许根据给定参数检索housekeeping object。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object housekeeping.update(object housekeeping)`
This method allows to update existing housekeeping settings.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object housekeeping.update(object housekeeping)`
此方法允许update现有的housekeeping设置。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object httptest.create(object/array webScenarios)`
This method allows to create new web scenarios.
::: noteclassic
Creating a web scenario will automatically create a set of
[web monitoring items](/manual/web_monitoring/items).
:::
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object httptest.create(object/array webScenarios)`
此方法允许create新的Web场景.
::: noteclassic
创建Web场景将自动create一组
[web monitoring items](/manual/web_monitoring/items).
:::
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object httptest.delete(array webScenarioIds)`
This method allows to delete web scenarios.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object httptest.delete(array webScenarioIds)`
此方法允许delete网页场景.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object httptest.update(object/array webScenarios)`
This method allows to update existing web scenarios.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object httptest.update(object/array webScenarios)`
此方法允许update现有的Web场景.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object iconmap.create(object/array iconMaps)`
This method allows to create new icon maps.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object iconmap.create(object/array iconMaps)`
此方法允许create新的图标映射.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object iconmap.delete(array iconMapIds)`
This method allows to delete icon maps.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object iconmap.delete(array iconMapIds)`
此方法允许delete图标映射.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object iconmap.update(object/array iconMaps)`
This method allows to update existing icon maps.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object iconmap.update(object/array iconMaps)`
此方法允许update现有的图标映射.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object image.create(object/array images)`
This method allows to create new images.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object image.create(object/array images)`
此方法允许create新图像。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object image.delete(array imageIds)`
This method allows to delete images.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object image.delete(array imageIds)`
此方法允许delete图像。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object image.update(object/array images)`
This method allows to update existing images.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object image.update(object/array images)`
此方法允许update现有图像。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object item.create(object/array items)`
This method allows to create new items.
::: noteclassic
Web items cannot be created via the Zabbix API.
:::
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object item.create(object/array items)`
此方法允许create新的监控项.
::: noteclassic
Web 监控项无法通过Zabbix API创建.
:::
::: noteclassic
此方法仅对*Admin*和*Super admin*用户类型可用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object item.delete(array itemIds)`
This method allows to delete items.
::: noteclassic
Web items cannot be deleted via the Zabbix API.
:::
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object item.delete(array itemIds)`
此方法允许delete 监控项.
::: noteclassic
Web 监控项无法通过Zabbix API删除.
:::
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参见[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object itemprototype.create(object/array itemPrototypes)`
This method allows to create new item prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object itemprototype.create(object/array itemPrototypes)`
该方法允许create新的监控项原型.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型。调用该方法的权限可以在用户角色
设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object itemprototype.delete(array itemPrototypeIds)`
This method allows to delete item prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object itemprototype.delete(array itemPrototypeIds)`
此方法允许delete 监控项原型.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object itemprototype.update(object/array itemPrototypes)`
This method allows to update existing item prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object itemprototype.update(object/array itemPrototypes)`
此方法允许update现有的监控项原型.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object item.update(object/array items)`
This method allows to update existing items.
::: noteclassic
Web items cannot be updated via the Zabbix API.
:::
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object item.update(object/array items)`
此方法允许update现有的监控项.
::: noteclassic
Web 监控项无法通过Zabbix API进行更新.
:::
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object maintenance.create(object/array maintenances)`
This method allows to create new maintenances.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object maintenance.create(object/array maintenances)`
此方法允许create新的维护周期.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object maintenance.delete(array maintenanceIds)`
This method allows to delete maintenance periods.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object maintenance.delete(array maintenanceIds)`
此方法允许delete维护周期.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object maintenance.update(object/array maintenances)`
This method allows to update existing maintenances.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object maintenance.update(object/array maintenances)`
此方法允许update现有的维护周期.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object map.create(object/array maps)`
This method allows to create new maps.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object map.create(object/array maps)`
此方法允许create新地图.
::: noteclassic
该方法对所有类型用户开放. 调用权限可通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object map.delete(array mapIds)`
This method allows to delete maps.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object map.delete(array mapIds)`
此方法允许delete映射.
::: noteclassic
此方法适用于所有类型的用户. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object map.update(object/array maps)`
This method allows to update existing maps.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object map.update(object/array maps)`
此方法允许update现有地图.
::: noteclassic
此方法适用于所有类型的用户. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object mediatype.create(object/array mediaTypes)`
This method allows to create new media types.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object mediatype.create(object/array mediaTypes)`
此方法允许create新的媒介类型.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object mediatype.delete(array mediaTypeIds)`
This method allows to delete media types.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object mediatype.delete(array mediaTypeIds)`
此方法允许delete媒体类型.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object mediatype.update(object/array mediaTypes)`
This method allows to update existing media types.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object mediatype.update(object/array mediaTypes)`
此方法允许update现有媒介类型.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object proxy.create(object/array proxies)`
This method allows to create new proxies.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object proxy.create(object/array proxies)`
此方法允许create新的proxies.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object proxy.delete(array proxies)`
This method allows to delete proxies.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object proxy.delete(array proxies)`
此方法允许delete proxies.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object proxy.update(object/array proxies)`
This method allows to update existing proxies.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object proxy.update(object/array proxies)`
此方法允许update现有的proxies.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object regexp.create(object/array regularExpressions)`
This method allows to create new global regular expressions.
::: noteclassic
This method is only available to *Super admin* user types.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object regexp.create(object/array regularExpressions)`
此方法允许create新的全局正则表达式.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object regexp.delete(array regexpids)`
This method allows to delete global regular expressions.
::: noteclassic
This method is only available to *Super admin* user types.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object regexp.delete(array regexpids)`
此方法允许delete全局正则表达式。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object regexp.update(object/array regularExpressions)`
This method allows to update existing global regular expressions.
::: noteclassic
This method is only available to *Super admin* user types.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object regexp.update(object/array regularExpressions)`
此方法允许update现有的全局正则表达式。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object report.create(object/array reports)`
This method allows to create new scheduled reports.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object report.create(object/array reports)`
此方法允许create新的定时报告.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object report.delete(array reportids)`
This method allows to delete scheduled reports.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user type. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object report.delete(array reportids)`
此方法允许delete定时报告.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object report.update(object/array reports)`
This method allows to update existing scheduled reports.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user type. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object report.update(object/array reports)`
此方法允许update现有的定时报告.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object role.create(object/array roles)`
This method allows to create new roles.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object role.create(object/array roles)`
此方法允许create新角色。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object role.delete(array roleids)`
This method allows to delete roles.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object role.delete(array roleids)`
此方法允许delete角色。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object role.update(object/array roles)`
This method allows to update existing roles.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object role.update(object/array roles)`
此方法允许update现有角色。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object script.create(object/array scripts)`
This method allows to create new scripts.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object script.create(object/array scripts)`
此方法允许create新脚本.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object script.delete(array scriptIds)`
This method allows to delete scripts.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object script.delete(array scriptIds)`
此方法允许delete脚本。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object script.execute(object parameters)`
This method allows to run a script on a host or event.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object script.execute(object parameters)`
此方法允许在一个主机或事件上run脚本.
::: noteclassic
此方法对所有类型的用户可用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object script.getscriptsbyhosts(array hostIds)`
This method allows to retrieve scripts available on the given hosts.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object script.getscriptsbyhosts(array hostIds)`
此方法允许检索指定主机上可用的脚本。
::: noteclassic
该方法适用于所有类型的用户。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object script.update(object/array scripts)`
This method allows to update existing scripts.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object script.update(object/array scripts)`
此方法允许update现有脚本.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object service.create(object/array services)`
This method allows to create new services.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object service.create(object/array services)`
此方法允许create新服务.
::: noteclassic
该方法对所有类型用户开放. 调用该方法的权限可通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object service.delete(array serviceIds)`
This method allows to delete services.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object service.delete(array serviceIds)`
此方法允许delete服务.
::: noteclassic
此方法适用于所有用户类型. 调用该方法的权限可通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object service.update(object/array services)`
This method allows to update existing services.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object service.update(object/array services)`
此方法允许update现有服务。
::: noteclassic
该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object settings.get(object parameters)`
The method allows to retrieve settings object according to the given
parameters.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object settings.get(object parameters)`
该方法允许根据给定参数检索设置object。
::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object settings.update(object settings)`
This method allows to update existing common settings.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object settings.update(object settings)`
此方法允许update现有的通用设置.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object sla.create(object/array SLAs)`
This method allows to create new SLA objects.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object sla.create(object/array SLAs)`
此方法允许create新的SLA objects.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object sla.delete(array slaids)`
This method allows to delete SLA entries.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object sla.delete(array slaids)`
此方法允许delete SLA条目.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object sla.getsli(object parameters)`
This method allows to calculate the Service Level Indicator (SLI) data for a Service Level Agreement (SLA).
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object sla.getsli(object parameters)`
该方法用于计算服务等级协议(SLA)中的服务等级指标(SLI)数据。
::: noteclassic
该方法对所有类型用户开放。调用权限可通过用户角色设置进行撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object sla.update(object/array slaids)`
This method allows to update existing SLA entries.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object sla.update(object/array slaids)`
此方法允许update现有的SLA条目。
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型。调用该方法的权限可以在用户角色
设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object task.create(object/array tasks)`
This method allows to create a new task (such as collect diagnostic data
or check items or low-level discovery rules without config reload).
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object task.create(object/array tasks)`
此方法允许create新任务（例如收集诊断数据
或检查监控项或无需重新加载配置的低级发现规则）。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object template.create(object/array templates)`
This method allows to create new templates.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object template.create(object/array templates)`
该方法允许create新模板.
::: noteclassic
此方法仅限*Admin*和*Super admin*用户类型使用. 调用该方法的权限可通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object templatedashboard.create(object/array templateDashboards)`
This method allows to create new template dashboards.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object templatedashboard.create(object/array templateDashboards)`
该方法允许create新的模板仪表板.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object templatedashboard.delete(array templateDashboardIds)`
This method allows to delete template dashboards.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object templatedashboard.delete(array templateDashboardIds)`
此方法允许delete模板仪表板.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object templatedashboard.update(object/array templateDashboards)`
This method allows to update existing template dashboards.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object templatedashboard.update(object/array templateDashboards)`
该方法允许update现有模板仪表板.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 详见[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)获取更多信息.
:::
### Description
`object template.delete(array templateIds)`
This method allows to delete templates.
Deleting a template will cause deletion of all template entities (items,
triggers, graphs, etc.). To leave template entities with the hosts, but
delete the template itself, first unlink the template from required
hosts using one of these methods:
[template.update](/manual/api/reference/template/update),
[template.massupdate](/manual/api/reference/template/massupdate),
[host.update](/manual/api/reference/host/update),
[host.massupdate](/manual/api/reference/host/massupdate).
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object template.delete(array templateIds)`
此方法允许delete模板。
删除模板将导致所有模板实体被删除（监控项、
触发器、图表等）。若需保留模板实体与主机的关联，
但delete模板本身，请先通过以下任一方法
从目标主机取消关联：
[template.update](/manual/api/reference/template/update)、
[template.massupdate](/manual/api/reference/template/massupdate)、
[host.update](/manual/api/reference/host/update)、
[host.massupdate](/manual/api/reference/host/massupdate)。
::: noteclassic
此方法仅限*管理员*和*超级管理员*用户类型使用。
调用权限可通过用户角色设置撤销。详见[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object template.massadd(object parameters)`
This method allows to simultaneously add multiple related objects to the
given templates.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object template.massadd(object parameters)`
此方法允许同时向指定模板添加多个关联的objects
::: noteclassic
此方法仅限*管理员*和*超级管理员*用户类型使用。调用该方法的权限可通过用户角色设置进行撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object template.massremove(object parameters)`
This method allows to remove related objects from multiple templates.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object template.massremove(object parameters)`
此方法允许从多个模板中移除关联的objects
::: noteclassic
此方法仅适用于*Admin*和*Super admin*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object template.massupdate(object parameters)`
This method allows to simultaneously replace or remove related objects
and update properties on multiple templates.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object template.massupdate(object parameters)`
此方法允许同时对多个模板上的相关objects和update属性进行替换或移除操作.
::: noteclassic
此方法仅限*Admin*和*Super admin*用户类型使用. 调用该方法的权限可通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object template.update(object/array templates)`
This method allows to update existing templates.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object template.update(object/array templates)`
此方法允许update现有模板.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object token.create(object/array tokens)`
This method allows to create new tokens.
::: noteclassic
The *Manage API tokens* [permission](/manual/web_interface/frontend_sections/users/user_roles#configuration) is required for the user role to manage tokens for other users.
:::
::: noteimportant
A token created by this method also has
to be [generated](generate) before it is usable.
:::
### 描述
`object token.create(object/array tokens)`
此方法允许create新令牌.
::: noteclassic
用户角色需要*管理API令牌* [配置](/manual/web_interface/frontend_sections/users/user_roles#配置)权限才能为其他用户管理令牌.
:::
::: noteimportant
通过此方法创建的令牌还需[generated](generate)后才能使用.
:::
### Description
`object token.delete(array tokenids)`
This method allows to delete tokens.
::: noteclassic
The *Manage API tokens* [permission](/manual/web_interface/frontend_sections/users/user_roles#configuration) is required for the user role to manage tokens for other users.
:::
### 描述
`object token.delete(array tokenids)`
此方法允许delete令牌.
::: noteclassic
用户角色需具备*管理API令牌* [配置](/manual/web_interface/frontend_sections/users/user_roles#配置)权限才能为其他用户管理令牌.
:::
### Description
`object token.generate(array tokenids)`
This method allows to generate tokens.
::: noteclassic
The *Manage API tokens* [permission](/manual/web_interface/frontend_sections/users/user_roles#configuration) is required for the user role to manage tokens for other users.
:::
::: noteimportant
A token can be generated by this method only if it has been [created](create).
:::
### 描述
`object token.generate(array tokenids)`
此方法允许generate令牌.
::: noteclassic
用户角色需要具备*管理API令牌* [配置](/manual/web_interface/frontend_sections/users/user_roles#配置)权限才能为其他用户管理令牌.
:::
::: noteimportant
只有当令牌已被[created](create)时，才能通过此方法生成.
:::
### Description
`object token.update(object/array tokens)`
This method allows to update existing tokens.
::: noteclassic
The *Manage API tokens* [permission](/manual/web_interface/frontend_sections/users/user_roles#configuration) is required for the user role to manage tokens for other users.
:::
### 描述
`object token.update(object/array tokens)`
此方法允许update现有令牌.
::: noteclassic
用户角色需具备*管理API令牌* [配置](/manual/web_interface/frontend_sections/users/user_roles#配置)权限才能为其他用户管理令牌.
:::
### Description
`object trigger.adddependencies(object/array triggerDependencies)`
This method allows to create new trigger dependencies.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object trigger.adddependencies(object/array triggerDependencies)`
此方法允许create新的触发器依赖关系。
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object trigger.create(object/array triggers)`
This method allows to create new triggers.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object trigger.create(object/array triggers)`
此方法允许create新触发器.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object trigger.delete(array triggerIds)`
This method allows to delete triggers.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object trigger.delete(array triggerIds)`
此方法允许delete触发器.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object trigger.deletedependencies(string/array triggers)`
This method allows to delete all trigger dependencies from the given
triggers.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object trigger.deletedependencies(string/array triggers)`
此方法允许从给定触发器delete所有触发器依赖关系.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object triggerprototype.create(object/array triggerPrototypes)`
This method allows to create new trigger prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object triggerprototype.create(object/array triggerPrototypes)`
此方法允许create新的触发器原型。
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object triggerprototype.delete(array triggerPrototypeIds)`
This method allows to delete trigger prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object triggerprototype.delete(array triggerPrototypeIds)`
此方法允许delete触发器原型。
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。
:::
### Description
`object triggerprototype.update(object/array triggerPrototypes)`
This method allows to update existing trigger prototypes.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object triggerprototype.update(object/array triggerPrototypes)`
此方法允许update现有的触发器原型.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object trigger.update(object/array triggers)`
This method allows to update existing triggers.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object trigger.update(object/array triggers)`
此方法允许update现有触发器.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object user.checkAuthentication`
This method checks and prolongs user session.
::: noteimportant
Calling the **user.checkAuthentication** method with the parameter `sessionid` set
prolongs user session by default.
:::
### 描述
`object user.checkAuthentication`
此方法用于检查并延长用户会话。
::: noteimportant
调用**user.checkAuthentication**方法时，若参数`sessionid`被设置，
默认情况下会延长用户会话。
:::
### Description
`object user.create(object/array users)`
This method allows to create new users.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
::: noteclassic
The strength of user password is validated according the
password policy rules defined by Authentication API. See [Authentication
API](/manual/api/reference/authentication) for more
information.
:::
### 描述
`object user.create(object/array users)`
此方法允许create新用户.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
::: noteclassic
用户密码强度将根据
认证API定义的密码策略规则进行验证. 参见[Authentication
API](/manual/api/reference/authentication)获取
更多信息.
:::
### Description
`object user.delete(array users)`
This method allows to delete users.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object user.delete(array users)`
此方法允许delete用户.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object usergroup.create(object/array userGroups)`
This method allows to create new user groups.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usergroup.create(object/array userGroups)`
此方法允许create新的用户组.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object usergroup.delete(array userGroupIds)`
This method allows to delete user groups.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usergroup.delete(array userGroupIds)`
此方法允许delete用户组.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object usergroup.update(object/array userGroups)`
This method allows to update existing user groups.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usergroup.update(object/array userGroups)`
此方法允许update现有用户组.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object usermacro.createglobal(object/array globalMacros)`
This method allows to create new global macros.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usermacro.createglobal(object/array globalMacros)`
此方法允许create新的全局宏.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object usermacro.create(object/array hostMacros)`
This method allows to create new host macros.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usermacro.create(object/array hostMacros)`
此方法允许create新的主机宏.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object usermacro.delete(array hostMacroIds)`
This method allows to delete host macros.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usermacro.delete(array hostMacroIds)`
该方法允许delete 主机宏.
::: noteclassic
此方法仅适用于*Admin*和*Super admin*
用户类型. 调用该方法的权限可以在用户角色
设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object usermacro.deleteglobal(array globalMacroIds)`
This method allows to delete global macros.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usermacro.deleteglobal(array globalMacroIds)`
此方法允许delete全局宏.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可在用户角色设置中撤销. 详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`object usermacro.updateglobal(object/array globalMacros)`
This method allows to update existing global macros.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usermacro.updateglobal(object/array globalMacros)`
此方法允许update现有的全局宏。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object usermacro.update(object/array hostMacros)`
This method allows to update existing host macros.
::: noteclassic
This method is only available to *Admin* and *Super admin*
user types. Permissions to call the method can be revoked in user role
settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object usermacro.update(object/array hostMacros)`
此方法允许update现有的主机宏.
::: noteclassic
此方法仅适用于*管理员*和*超级管理员*用户类型. 调用该方法的权限可在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`object user.unblock(array userids)`
This method allows to unblock users.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object user.unblock(array userids)`
此方法允许unblock用户。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object user.update(object/array users)`
This method allows to update existing users.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
::: noteclassic
The strength of user password is validated according the
password policy rules defined by Authentication API. See [Authentication
API](/manual/api/reference/authentication) for more
information.
:::
### 描述
`object user.update(object/array users)`
此方法允许update现有用户.
::: noteclassic
此方法适用于所有类型的用户. 调用该方法的权限可以通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
::: noteclassic
用户密码强度将根据认证API定义的密码策略规则进行验证. 更多信息请参阅[Authentication
API](/manual/api/reference/authentication).
:::
### Description
`object valuemap.create(object/array valuemaps)`
This method allows to create new value maps.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object valuemap.create(object/array valuemaps)`
此方法允许create新的值映射。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
### Description
`object valuemap.delete(array valuemapids)`
This method allows to delete value maps.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object valuemap.delete(array valuemapids)`
此方法允许delete值映射。
::: noteclassic
此方法仅适用于*超级管理员*用户类型。
调用该方法的权限可在用户角色设置中撤销。详见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息。
:::
### Description
`object valuemap.update(object/array valuemaps)`
This method allows to update existing value maps.
::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`object valuemap.update(object/array valuemaps)`
此方法允许update现有的值映射.
::: noteclassic
此方法仅适用于*超级管理员*用户类型.
调用该方法的权限可以在用户角色设置中撤销. 参见
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
获取更多信息.
:::
### Description
`string apiinfo.version(array)`
This method allows to retrieve the version of the Zabbix API.
::: noteimportant
This method is only available to unauthenticated
users and must be called without the `auth` parameter in the JSON-RPC
request.
:::
### 描述
`string apiinfo.version(array)`
此方法允许获取Zabbix API的version功能。
::: noteimportant
此方法仅对未认证用户可用
且必须在JSON-RPC请求中不包含`auth`参数的情况下调用。
:::
### Description
`string configuration.export(object parameters)`
This method allows to export configuration data as a serialized string.
::: noteclassic
This method is available to users of any type.
Permissions to call the method can be revoked in user role settings.
See [User roles](/manual/web_interface/frontend_sections/administration/user_roles) for more information.
:::
### 描述
`string configuration.export(object parameters)`
此方法允许将export配置数据序列化为string格式.
::: noteclassic
该方法对所有类型用户开放.
可通过用户角色设置撤销调用权限.
更多信息请参阅[User roles](/manual/web_interface/frontend_sections/administration/user_roles).
:::
### Description
`string/object user.login(object parameters)`
This method allows to log in to the API and generate an authentication
token.
::: notewarning
When using this method, you also need to do
[user.logout](/manual/api/reference/user/logout) to prevent the
generation of a large number of open session records.
:::
::: noteimportant
This method is only available to unauthenticated
users and must be called without the `auth` parameter in the JSON-RPC
request.
:::
### 描述
`string/object user.login(object parameters)`
此方法允许登录到API并generate一个认证令牌。
::: notewarning
使用此方法时，您还需要执行
[user.logout](/manual/api/reference/user/logout)以防止
生成大量开放会话记录。
:::
::: noteimportant
此方法仅适用于未认证用户，
且必须在JSON-RPC请求中不包含`auth`参数的情况下调用。
:::
### Description
`string/object user.logout(array)`
This method allows to log out of the API and invalidates the current
authentication token.
::: noteclassic
This method is available to users of any type. Permissions
to call the method can be revoked in user role settings. See [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::
### 描述
`string/object user.logout(array)`
此方法允许从API注销并使当前认证令牌失效
::: noteclassic
该方法对所有类型用户可用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
:::
##### Description
The following parameters are supported if *Advanced configuration* is set to "Enabled", and *Show* is set to "Description".
|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|*Description*|1|description|Any string value, including macros.<br>Supported macros: {HOST.\*}, {ITEM.\*}, {INVENTORY.\*}, User macros.<br><br>Default: {ITEM.NAME}.|
|*Horizontal position*|0|desc_h_pos|0 - Left;<br>1 - *(default)* Center;<br>2 - Right.<br><br>Two or more elements (Description, Value, Time) cannot share the same *Horizontal position* and *Vertical position*.|
|*Vertical position*|0|desc_v_pos|0 - Top;<br>1 - Middle;<br>2 - *(default)* Bottom.<br><br>Two or more elements (Description, Value, Time) cannot share the same *Horizontal position* and *Vertical position*.|
|*Size*|0|desc_size|Valid values range from 1-100.<br><br>Default: 15.|
|*Bold*|0|desc_bold|0 - *(default)* Disabled;<br>1 - Enabled.|
|*Color*|1|desc_color|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: `""` (empty).|
##### 描述
若*高级配置*设为"启用"且*显示*设为"描述"时，支持以下参数。
| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| *Description* | 1 | description | 任意string值，包括宏。<br>支持的宏：{主机.\*}, {监控项.\*}、{INVENTORY.\*}及用户宏。<br><br>默认：{ITEM.NAME}。 |
| *Horizontal position* | 0 | desc_h_pos | 0 - 左对齐；<br>1 - *(默认)* 居中；<br>2 - 右对齐。<br><br>两个及以上元素（描述、数值、时间）不可共享相同的*水平位置*与*垂直位置*。 |
| *Vertical position* | 0 | desc_v_pos | 0 - Top；<br>1 - 中部；<br>2 - *(默认)* 底部。<br><br>两个及以上元素（描述、数值、时间）不可共享相同的*水平位置*与*垂直位置*。 |
| *Size* | 0 | desc_size | 有效值范围1-100。<br><br>默认：15。 |
| *Bold* | 0 | desc_bold | 0 - *(默认)* 禁用；<br>1 - 启用。 |
| *Color* | 1 | desc_color | 十六进制颜色代码（如`FF0000`）。<br><br>默认：`""`（空值）。 |
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Clock*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/clock) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Clock* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许在`dashboard.create`和`dashboard.update`方法中配置[*Clock*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/clock)小组件.
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证.
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块),但也存在创建或更新小组件不正确的风险.
为确保*Clock*小组件的成功创建或update,请参考下方表格中列出的参数要求.
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Data overview*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/data_overview) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Data overview* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Data overview*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/data_overview)小组件。
::: noteimportant
仪表板创建或update过程中不会验证`fields`小组件的属性。这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。为确保成功创建或update*数据概览*小组件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Geomap*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Geomap* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Geomap*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保*地理地图*小组件的成功创建或update，请参考下方表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Graph (classic)*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph_classic) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Graph (classic)* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值，允许通过`dashboard.create`和`dashboard.update`方法配置[*Graph (classic)*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph_classic)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保成功创建或update*经典图形*小组件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Graph*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Graph* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许在`dashboard.create`和`dashboard.update`方法中配置[*Graph*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也带来了错误创建或更新小组件的风险。
为确保成功创建或update*Graph*小组件，请参考下方表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Graph prototype*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph_prototype) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Graph prototype* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小部件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Graph prototype*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/graph_prototype)小部件。
::: noteimportant
小部件`fields`的属性在仪表板创建或update过程中不会进行验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小部件的风险。
为确保成功创建或update*图形原型*小部件，请参考下方表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Item value*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/item_value) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Item value* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小部件字段objects的可选属性值允许进行配置
`dashboard.create`和`dashboard.update`方法中的[*Item value*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/item_value)部件
::: noteimportant
仪表板小部件`fields`属性在创建或update过程中不会被验证。
这允许用户修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也带来了错误创建或更新小部件的风险。
为确保成功创建或update *监控项值*小部件，请参考以下表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Map*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/map) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Map* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Map*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/map)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保*地图*小组件成功创建或update，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Map navigation tree*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/map_tree) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Map navigation tree* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Map navigation tree*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/map_tree)小组件。
::: noteimportant
仪表板创建或update过程中不会验证`fields`小组件的属性。
这虽然允许用户修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保成功创建或update*地图导航树*小组件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Plain text*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/plain_text) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Plain text* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Plain text*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/plain_text)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会进行验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保成功创建或update*纯文本*小组件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Problem hosts*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problem_hosts) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Problem hosts* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Problem hosts*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problem_hosts)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会进行验证。这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。为确保成功创建或update*问题主机*小组件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Problems by severity*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problems_severity) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Problems by severity* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许在`dashboard.create`和`dashboard.update`方法中配置[*Problems by severity*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problems_severity)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保成功创建或update*按严重程度分类的问题*小组件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Problems*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problems) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Problems* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值，可用于配置`dashboard.create`和`dashboard.update`方法中的[*Problems*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/problems)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保*问题*小组件的成功创建或update，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*SLA report*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/sla_report) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *SLA report* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小部件字段objects的可选属性值允许在`dashboard.create`和`dashboard.update`方法中配置[*SLA report*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/sla_report)小部件。
::: noteimportant
小部件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小部件的风险。
为确保成功创建或update*SLA报告*小部件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Top hosts*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/top_hosts) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Top hosts* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小部件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Top hosts*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/top_hosts)部件。
::: noteimportant
小部件`fields`属性在仪表板创建或update过程中不会进行验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新部件的风险。
为确保成功创建或update*Top 主机*部件，请参考下文表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Trigger overview*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/trigger_overview) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Trigger overview* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Trigger overview*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/trigger_overview)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保成功创建或update*触发器概览*小组件，请参考下方表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*URL*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/url) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *URL* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许在`dashboard.create`和`dashboard.update`方法中配置[*URL*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/url)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保成功创建或update*URL*小组件，请参考下方表格中列出的参数要求。
:::
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Web monitoring*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/web_monitoring) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets) and create [custom widgets](/manual/modules#developing-modules), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Web monitoring* widget, please refer to the parameter requirements outlined in the tables below.
:::
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Web monitoring*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/web_monitoring)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保成功创建或update*Web监测*小组件，请参考下文表格中列出的参数要求。
:::
## DESCRIPTION
**zabbix\_agent2** is an application for monitoring parameters of
various services.\
\
[ ]{#lbAE}
## 描述
**zabbix_agent2** 是一款用于监控各类服务参数的应用程序。
[ ]{#lbAE}
## DESCRIPTION
**zabbix\_agentd** is a daemon for monitoring various server parameters.
[ ]{#lbAE}
## 描述
**zabbix_agentd** 是一个用于监控各类服务器参数的守护进程。
[ ]{#lbAE}
## DESCRIPTION
**zabbix\_get** is a command line utility for getting data from Zabbix
agent. [ ]{#lbAE}
## 描述
**zabbix\_get** 是一个用于从Zabbix agent获取数据的命令行工具。[ ]{#lbAE}
## DESCRIPTION
**zabbix\_js** is a command line utility that can be used for embedded
script testing. [ ]{#lbAE}
## 描述
**zabbix_js** 是一个可用于嵌入式脚本测试的命令行工具。[ ]{#lbAE}
## DESCRIPTION
**zabbix\_proxy** is a daemon that collects monitoring data from devices
and sends it to Zabbix server. [ ]{#lbAE}
## 描述
**zabbix\_proxy** 是一个守护进程，用于从设备收集监控数据并发送至 Zabbix server。[ ]{#lbAE}
## DESCRIPTION
**zabbix\_sender** is a command line utility for sending monitoring data
to Zabbix server or proxy. On the Zabbix server an item of type **Zabbix
trapper** should be created with corresponding key. Note that incoming
values will only be accepted from hosts specified in **Allowed hosts**
field for this item. [ ]{#lbAE}
## 描述
**zabbix_sender** 是一个用于向 Zabbix server 或 proxy 发送监控数据的命令行工具。在 Zabbix server 上需要创建一个类型为 **Zabbix trapper** 的 监控项 并配置对应键值。注意传入的值仅会接受该 监控项 的 **Allowed 主机** 字段中指定的 主机。[ ]{#lbAE}
## DESCRIPTION
**zabbix\_server** is the core daemon of Zabbix software. [ ]{#lbAE}
## 描述
**zabbix\_server** 是Zabbix软件的核心守护进程。[ ]{#lbAE}
## DESCRIPTION
**zabbix\_web\_service** is an application for providing web services to
Zabbix components. [ ]{#lbAE}
## 描述
**zabbix_web_service** 是一个为Zabbix组件提供网络服务的应用程序。[ ]{#lbAE}
#### Details about export
- All supported elements are exported in one file.
- Host and template entities (items, triggers, graphs, discovery
rules) that are inherited from linked templates are not exported.
Any changes made to those entities on a host level (such as changed
item interval, modified regular expression or added prototypes to
the low-level discovery rule) will be lost when exporting; when
importing, all entities from linked templates are re-created as on
the original linked template.
- Entities created by low-level discovery and any entities depending
on them are not exported. For example, a trigger created for an
LLD-rule generated item will not be exported.
#### 导出详情
- 所有支持的元素都会导出到一个file中。
- 从链接模板继承的主机和模板实体（监控项、触发器、图形、发现规则）不会被导出。在一个主机级别对这些实体所做的任何更改（例如更改监控项间隔、修改正则表达式或向低级发现规则添加原型）在导出时都会丢失；导入时，来自链接模板的所有实体都会按照原始链接模板重新创建。
- 由低级发现创建的实体以及任何依赖它们的实体不会被导出。例如，为LLD规则生成的监控项创建的触发器将不会被导出。
#### Details about import
- Import stops at the first error.
- When updating existing images during image import, "imagetype" field
is ignored, i.e. it is impossible to change image type via import.
- When importing hosts/templates using the "Delete missing" option,
host/template macros not present in the import file will be deleted from
the host/template after the import.
- Empty tags for items, triggers, graphs,
discoveryRules, itemPrototypes, triggerPrototypes, graphPrototypes
are meaningless i.e. it's the same as if it was missing.
- Import supports YAML, XML and JSON, the import file must have a
correct file extension: .yaml and .yml for YAML, .xml for XML and
.json for JSON. See [compatibility information](/manual/appendix/compatibility)
about supported XML versions.
- Import supports configuration files only in UTF-8 encoding (with or without [BOM](https://en.wikipedia.org/wiki/Byte_order_mark));
other encodings (UTF16LE, UTF16BE, UTF32LE, UTF32BE, etc.) will result in an import conversion error.
#### 关于导入的详细信息
- 导入会在首个错误处停止
- 在import过程中更新现有镜像时，"imagetype"字段会被忽略，即无法通过import更改镜像类型
- 使用"删除缺失"选项导入主机/模板时，import file中不存在的主机/模板宏将在import后从主机/模板中删除
- 对于监控项、触发器、图表、发现规则、监控项原型、触发器原型、图表原型的空标签无意义，等同于缺失状态
- 导入支持YAML、XML和JSON格式，import file必须具有正确的file扩展名：YAML使用.yaml/.yml，XML使用.xml，JSON使用.json。支持的XML版本请参阅[compatibility information](/manual/appendix/compatibility)
- 导入仅支持UTF-8编码的配置文件（无论是否包含[BOM](https://en.wikipedia.org/wiki/Byte_order_mark)）；其他编码（UTF16LE、UTF16BE、UTF32LE、UTF32BE等）将导致import转换错误
### Details tag
The details object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**version**<br>(required)|integer|SNMP interface version.<br><br>Possible values are:<br>1 - SNMPv1;<br>2 - SNMPv2c;<br>3 - SNMPv3|
|bulk|integer|Whether to use bulk SNMP requests.<br><br>Possible values are:<br>0 - don't use bulk requests;<br>1 - (default) - use bulk requests.|
|community|string|SNMP community (required). Used only by SNMPv1 and SNMPv2 interfaces.|
|securityname|string|SNMPv3 security name. Used only by SNMPv3 interfaces.|
|securitylevel|integer|SNMPv3 security level. Used only by SNMPv3 interfaces.<br><br>Possible values are:<br>0 - (default) - noAuthNoPriv;<br>1 - authNoPriv;<br>2 - authPriv.|
|authpassphrase|string|SNMPv3 authentication passphrase. Used only by SNMPv3 interfaces.|
|privpassphrase|string|SNMPv3 privacy passphrase. Used only by SNMPv3 interfaces.|
|authprotocol|integer|SNMPv3 authentication protocol. Used only by SNMPv3 interfaces.<br><br>Possible values are:<br>0 - (default) - MD5;<br>1 - SHA1;<br>2 - SHA224;<br>3 - SHA256;<br>4 - SHA384;<br>5 - SHA512.|
|privprotocol|integer|SNMPv3 privacy protocol. Used only by SNMPv3 interfaces.<br><br>Possible values are:<br>0 - (default) - DES;<br>1 - AES128;<br>2 - AES192;<br>3 - AES256;<br>4 - AES192C;<br>5 - AES256C.|
|contextname|string|SNMPv3 context name. Used only by SNMPv3 interfaces.|
### 详情标签
该 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **version**<br>(required) | integer | SNMP 接口 version.<br><br>可能值为:<br>1 - SNMPv1;<br>2 - SNMPv2c;<br>3 - SNMPv3 |
| bulk | integer | 是否使用批量 SNMP 请求.<br><br>可能值为:<br>0 - 不使用批量请求;<br>1 - (默认) - 使用批量请求. |
| community | string | SNMP 共同体字符串(必需). 仅用于 SNMPv1 和 SNMPv2 接口. |
| securityname | string | SNMPv3 安全名称. 仅用于 SNMPv3 接口. |
| securitylevel | integer | SNMPv3 安全级别. 仅用于 SNMPv3 接口.<br><br>可能值为:<br>0 - (默认) - 无认证无加密;<br>1 - 认证无加密;<br>2 - 认证加密. |
| authpassphrase | string | SNMPv3 认证密码. 仅用于 SNMPv3 接口. |
| privpassphrase | string | SNMPv3 加密密码. 仅用于 SNMPv3 接口. |
| authprotocol | integer | SNMPv3 认证协议. 仅用于 SNMPv3 接口.<br><br>可能值为:<br>0 - (默认) - MD5;<br>1 - SHA1;<br>2 - SHA224;<br>3 - SHA256;<br>4 - SHA384;<br>5 - SHA512. |
| privprotocol | integer | SNMPv3 加密协议. 仅用于 SNMPv3 接口.<br><br>可能值为:<br>0 - (默认) - DES;<br>1 - AES128;<br>2 - AES192;<br>3 - AES256;<br>4 - AES192C;<br>5 - AES256C. |
| contextname | string | SNMPv3 上下文名称. 仅用于 SNMPv3 接口. |
#### Details
The virtual machine monitoring is done in two steps. First, virtual
machine data is gathered by *vmware collector* Zabbix processes. Those
processes obtain necessary information from VMware web services over the
SOAP protocol, pre-process it and store into Zabbix server shared
memory. Then, this data is retrieved by pollers using Zabbix simple
check [VMware
keys](/manual/config/items/itemtypes/simple_checks/vmware_keys).
Starting with Zabbix version 2.4.4 the collected data is divided into 2
types: VMware configuration data and VMware performance counter data.
Both types are collected independently by *vmware collectors*. Because
of this it is recommended to enable more collectors than the monitored
VMware services. Otherwise retrieval of VMware performance counter
statistics might be delayed by the retrieval of VMware configuration
data (which takes a while for large installations).
Currently only datastore, network interface and disk device statistics
and custom performance counter items are based on the VMware performance
counter information.
#### 详情
虚拟机监控分为两个步骤完成。首先，*vmware collector* Zabbix进程会收集虚拟机数据。这些进程通过SOAP协议从VMware Web服务获取必要信息，进行预处理后存储到Zabbix server共享memory中。随后，轮询器会使用Zabbix简单检查[VMware
keys](/manual/config/items/itemtypes/simple_checks/vmware_keys)来检索这些数据。
从Zabbix version 2.4.4版本开始，采集的数据分为两种类型：VMware配置数据和VMware性能计数器数据。这两种数据都由*vmware collectors*独立采集。因此建议启用的采集器数量应多于被监控的VMware服务数量。否则，VMware性能计数器统计数据的获取可能会因VMware配置数据的采集（在大型部署中耗时较长）而延迟。
目前只有数据存储、网络接口和磁盘设备统计信息以及自定义性能计数器监控项是基于VMware性能计数器信息的。
#### Details
To avoid calculations with huge numbers, we consider the timestamp of the
first value in specified period plus 1 ns as a new zero-time (current
epoch time is of order 10^9^, epoch squared is 10^18^, double precision
is about 10^-16^). 1 ns is added to provide all positive time values for
*logarithmic* and *power* fits which involve calculating log(t). Time
shift does not affect *linear*, *polynomial*, *exponential* (apart from
easier and more precise calculations) but changes the shape of
*logarithmic* and *power* functions.
#### 详情
为避免处理超大数值的计算，我们将指定周期内第一个值的时间戳加上1纳秒作为新的零时基准（当前纪元时间约为10^9^量级，纪元时间的平方达10^18^，而双精度浮点数的精度约为10^-16^）。添加1纳秒的目的是为涉及对数时间计算的*对数*和*幂*拟合提供全正时间值。时间偏移不会影响*线性*、*多项式*、*指数*拟合（除了使计算更简单精确外），但会改变*对数*和*幂*函数的形态。
#### Developing modules
Modules are written in PHP language. Model-view-controller (MVC)
software pattern design is preferred, as it is also used in Zabbix
frontend and will ease the development. PHP strict typing is also
welcome but not mandatory.
Please note that with modules you can easily add new menu items and
respective views and actions to Zabbix frontend. Currently it is not
possible to register new API or create new database tables through
modules.
#### 开发模块
模块采用PHP语言编写。推荐使用模型-视图-控制器(MVC)软件设计模式，这与Zabbix前端架构一致，能简化开发流程。虽然不强制要求，但建议启用PHP严格类型模式。
请注意，通过模块可以轻松为Zabbix前端添加新菜单监控项及对应的视图和操作。但目前无法通过模块注册新的API或create新的数据库表。
#### Devices
List of device families for which templates are available:
|Template name|Vendor|Device family|Known models|OS|MIBs used|**[Tags](/manual/config/templates_out_of_the_box/network_devices#tags)**|
|----|--|--|----|--|----|-----|
|*Alcatel Timetra TiMOS SNMP*|Alcatel|Alcatel Timetra|ALCATEL SR 7750|TiMOS|TIMETRA-SYSTEM-MIB,TIMETRA-CHASSIS-MIB|Certified|
|*Brocade FC SNMP*|Brocade|Brocade FC switches|Brocade 300 SAN Switch-|\-|SW-MIB,ENTITY-MIB|Performance<br>Fault|
|*Brocade\_Foundry Stackable SNMP*|Brocade|Brocade ICX|Brocade ICX6610, Brocade ICX7250-48, Brocade ICX7450-48F| |FOUNDRY-SN-AGENT-MIB, FOUNDRY-SN-STACKING-MIB|Certified|
|*Brocade\_Foundry Nonstackable SNMP*|Brocade, Foundry|Brocade MLX, Foundry|Brocade MLXe, Foundry FLS648, Foundry FWSX424| |FOUNDRY-SN-AGENT-MIB|Performance<br>Fault|
|*Check Point Next Generation Firewall by SNMP*|Check Point|Next Generation Firewall|-|Gaia|HOST-RESOURCES-MIB, CHECKPOINT-MIB, UCD-SNMP-MIB, SNMPv2-MIB, IF-MIB|Certified|
|*Cisco Catalyst 3750<device model> SNMP*|Cisco|Cisco Catalyst 3750|Cisco Catalyst 3750V2-24FS, Cisco Catalyst 3750V2-24PS, Cisco Catalyst 3750V2-24TS, Cisco Catalyst SNMP, Cisco Catalyst SNMP| |CISCO-MEMORY-POOL-MIB, IF-MIB, EtherLike-MIB, SNMPv2-MIB, CISCO-PROCESS-MIB, CISCO-ENVMON-MIB, ENTITY-MIB|Certified|
|*Cisco IOS SNMP*|Cisco|Cisco IOS ver > 12.2 3.5|Cisco C2950|IOS|CISCO-PROCESS-MIB,CISCO-MEMORY-POOL-MIB,CISCO-ENVMON-MIB|Certified|
|*Cisco IOS versions 12.0\_3\_T-12.2\_3.5 SNMP*|Cisco|Cisco IOS > 12.0 3 T and < 12.2 3.5|\-|IOS|CISCO-PROCESS-MIB,CISCO-MEMORY-POOL-MIB,CISCO-ENVMON-MIB|Certified|
|*Cisco IOS prior to 12.0\_3\_T SNMP*|Cisco|Cisco IOS < 12.0 3 T|\-|IOS|OLD-CISCO-CPU-MIB,CISCO-MEMORY-POOL-MIB|Certified|
|*D-Link DES\_DGS Switch SNMP*|D-Link|DES/DGX switches|D-Link DES-xxxx/DGS-xxxx,DLINK DGS-3420-26SC|\-|DLINK-AGENT-MIB,EQUIPMENT-MIB,ENTITY-MIB|Certified|
|*D-Link DES 7200 SNMP*|D-Link|DES-7xxx|D-Link DES 7206|\-|ENTITY-MIB,MY-SYSTEM-MIB,MY-PROCESS-MIB,MY-MEMORY-MIB|Performance<br>Fault<br>Interfaces|
|*Dell Force S-Series SNMP*|Dell|Dell Force S-Series|S4810| |F10-S-SERIES-CHASSIS-MIB|Certified|
|*Extreme Exos SNMP*|Extreme|Extreme EXOS|X670V-48x|EXOS|EXTREME-SYSTEM-MIB,EXTREME-SOFTWARE-MONITOR-MIB|Certified|
|*FortiGate by SNMP*|Fortinet|FortiGate (NGFW)|-|FortiOS|HOST-RESOURCES-MIB<br>FORTINET-FORTIGATE-MIB<br>FORTINET-CORE-MIB<br>SNMPv2-MIB<br>IF-MIB<br>ENTITY-MIB|Performance<br>Inventory|
|*Huawei VRP SNMP*|Huawei|Huawei VRP|S2352P-EI|\-|ENTITY-MIB,HUAWEI-ENTITY-EXTENT-MIB|Certified|
|*Intel\_Qlogic Infiniband SNMP*|Intel/QLogic|Intel/QLogic Infiniband devices|Infiniband 12300| |ICS-CHASSIS-MIB|Fault<br>Inventory|
|*Juniper SNMP*|Juniper|MX,SRX,EX models|Juniper MX240, Juniper EX4200-24F|JunOS|JUNIPER-MIB|Certified|
|*Mellanox SNMP*|Mellanox|Mellanox Infiniband devices|SX1036|MLNX-OS|HOST-RESOURCES-MIB,ENTITY-MIB,ENTITY-SENSOR-MIB,MELLANOX-MIB|Certified|
|*MikroTik CCR<device model> SNMP*|MikroTik|MikroTik Cloud Core Routers (CCR series)|Separate dedicated templates are available for MikroTik CCR1009-7G-1C-1S+, MikroTik CCR1009-7G-1C-1S+PC, MikroTik CCR1009-7G-1C-PC, MikroTik CCR1016-12G, MikroTik CCR1016-12S-1S+, MikroTik CCR1036-12G-4S-EM, MikroTik CCR1036-12G-4S, MikroTik CCR1036-8G-2S+, MikroTik CCR1036-8G-2S+EM, MikroTik CCR1072-1G-8S+, MikroTik CCR2004-16G-2S+, MikroTik CCR2004-1G-12S+2XS|RouterOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik CRS<device model> SNMP*|MikroTik|MikroTik Cloud Router Switches (CRS series)|Separate dedicated templates are available for MikroTik CRS106-1C-5S, MikroTik CRS109-8G-1S-2HnD-IN, MikroTik CRS112-8G-4S-IN, MikroTik CRS112-8P-4S-IN, MikroTik CRS125-24G-1S-2HnD-IN, MikroTik CRS212-1G-10S-1S+IN, MikroTik CRS305-1G-4S+IN, MikroTik CRS309-1G-8S+IN, MikroTik CRS312-4C+8XG-RM, MikroTik CRS317-1G-16S+RM, MikroTik CRS326-24G-2S+IN, MikroTik CRS326-24G-2S+RM, MikroTik CRS326-24S+2Q+RM, MikroTik CRS328-24P-4S+RM, MikroTik CRS328-4C-20S-4S+RM, MikroTik CRS354-48G-4S+2Q+RM, MikroTik CRS354-48P-4S+2Q+RM|RouterOS/SwitchOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik CSS<device model> SNMP*|MikroTik|MikroTik Cloud Smart Switches (CSS series)|Separate dedicated templates are available for MikroTik CSS326-24G-2S+RM, MikroTik CSS610-8G-2S+IN|RouterOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik FiberBox SNMP*|MikroTik|MikroTik FiberBox|MikroTik FiberBox|RouterOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik hEX <device model> SNMP*|MikroTik|MikroTik hEX|Separate dedicated templates are available for MikroTik hEX, MikroTik hEX lite, MikroTik hEX PoE, MikroTik hEX PoE lite, MikroTik hEX S|RouterOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik netPower <device model> SNMP*|MikroTik|MikroTik netPower|Separate dedicated templates are available for MikroTik netPower 15FR, MikroTik netPower 16P SNMP, MikroTik netPower Lite 7R|RouterOS/SwitchOS, SwitchOS Lite|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik PowerBox <device model> SNMP*|MikroTik|MikroTik PowerBox|Separate dedicated templates are available for MikroTik PowerBox, MikroTik PowerBox Pro|RouterOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik RB<device model> SNMP*|MikroTik|MikroTik RB series routers|Separate dedicated templates are available for MikroTik RB1100AHx4, MikroTik RB1100AHx4 Dude Edition, MikroTik RB2011iL-IN, MikroTik RB2011iL-RM, MikroTik RB2011iLS-IN, MikroTik RB2011UiAS-IN, MikroTik RB2011UiAS-RM, MikroTik RB260GS, MikroTik RB3011UiAS-RM, MikroTik RB4011iGS+RM, MikroTik RB5009UG+S+IN|RouterOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*MikroTik SNMP*|MikroTik|MikroTik RouterOS devices|MikroTik CCR1016-12G, MikroTik RB2011UAS-2HnD, MikroTik 912UAG-5HPnD, MikroTik 941-2nD, MikroTik 951G-2HnD, MikroTik 1100AHx2|RouterOS|MIKROTIK-MIB,HOST-RESOURCES-MIB|Certified|
|*QTech QSW SNMP*|QTech|Qtech devices|Qtech QSW-2800-28T|\-|QTECH-MIB,ENTITY-MIB|Performance<br>Inventory|
|*Ubiquiti AirOS SNMP*|Ubiquiti|Ubiquiti AirOS wireless devices|NanoBridge,NanoStation,Unifi|AirOS|FROGFOOT-RESOURCES-MIB,IEEE802dot11-MIB|Performance|
|*HP Comware HH3C SNMP*|HP|HP (H3C) Comware|HP A5500-24G-4SFP HI Switch| |HH3C-ENTITY-EXT-MIB,ENTITY-MIB|Certified|
|*HP Enterprise Switch SNMP*|HP|HP Enterprise Switch|HP ProCurve J4900B Switch 2626, HP J9728A 2920-48G Switch| |STATISTICS-MIB,NETSWITCH-MIB,HP-ICF-CHASSIS,ENTITY-MIB,SEMI-MIB|Certified|
|*TP-LINK SNMP*|TP-LINK|TP-LINK|T2600G-28TS v2.0| |TPLINK-SYSMONITOR-MIB,TPLINK-SYSINFO-MIB|Performance<br>Inventory|
|*Netgear Fastpath SNMP*|Netgear|Netgear Fastpath|M5300-28G| |FASTPATH-SWITCHING-MIB,FASTPATH-BOXSERVICES-PRIVATE-MIB|Fault<br>Inventory|
#### 设备
可用模板的设备系列列表:
| 模板名称 | 厂商 | 设备系列 | 已知型号 | 操作系统 | 使用的MIB | **[标签](/manual/config/templates_out_of_the_box/network_devices#标签)** |
|----|--|--|----|--|----|-----|
| *Alcatel Timetra TiMOS SNMP* | 阿尔卡特 | Alcatel Timetra | ALCATEL SR 7750 | TiMOS | TIMETRA-SYSTEM-MIB,TIMETRA-CHASSIS-MIB | 认证 |
| *Brocade FC SNMP* | 博科 | Brocade FC交换机 | Brocade 300 SAN Switch- | \- | SW-MIB,ENTITY-MIB | 性能<br>故障 |
| *Brocade\_Foundry Stackable SNMP* | 博科 | Brocade ICX | Brocade ICX6610, Brocade ICX7250-48, Brocade ICX7450-48F | | FOUNDRY-SN-Agent-MIB, FOUNDRY-SN-STACKING-MIB | 认证 |
| *Brocade\_Foundry Nonstackable SNMP* | 博科, Foundry | Brocade MLX, Foundry | Brocade MLXe, Foundry FLS648, Foundry FWSX424 | | FOUNDRY-SN-Agent-MIB | 性能<br>故障 |
| *Check Point Next Generation Firewall by SNMP* | Check Point | 下一代防火墙 | - | Gaia | 主机-RESOURCES-MIB, CHECKPOINT-MIB, UCD-SNMP-MIB, SNMPv2-MIB, IF-MIB | 认证 |
| *Cisco Catalyst 3750<device model> SNMP* | 思科 | 思科Catalyst 3750 | 思科Catalyst 3750V2-24FS, 思科Catalyst 3750V2-24PS, 思科Catalyst 3750V2-24TS, 思科Catalyst SNMP, 思科Catalyst SNMP | | CISCO-MEMORY-POOL-MIB, IF-MIB, EtherLike-MIB, SNMPv2-MIB, CISCO-PROCESS-MIB, CISCO-ENVMON-MIB, ENTITY-MIB | 认证 |
| *Cisco IOS SNMP* | 思科 | 思科IOS版本 > 12.2 3.5 | 思科C2950 | IOS | CISCO-PROCESS-MIB,CISCO-MEMORY-POOL-MIB,CISCO-ENVMON-MIB | 认证 |
| *Cisco IOS versions 12.0\_3\_T-12.2\_3.5 SNMP* | 思科 | 思科IOS > 12.0 3 T 且 < 12.2 3.5 | \- | IOS | CISCO-PROCESS-MIB,CISCO-MEMORY-POOL-MIB,CISCO-ENVMON-MIB | 认证 |
| *Cisco IOS prior to 12.0\_3\_T SNMP* | 思科 | 思科IOS < 12.0 3 T | \- | IOS | OLD-CISCO-CPU-MIB,CISCO-MEMORY-POOL-MIB | 认证 |
| *D-Link DES\_DGS Switch SNMP* | D-Link | DES/DGX交换机 | D-Link DES-xxxx/DGS-xxxx,DLINK DGS-3420-26SC | \- | DLINK-Agent-MIB,EQUIPMENT-MIB,ENTITY-MIB | 认证 |
| *D-Link DES 7200 SNMP* | D-Link | DES-7xxx | D-Link DES 7206 | \- | ENTITY-MIB,MY-SYSTEM-MIB,MY-PROCESS-MIB,MY-MEMORY-MIB | 性能<br>故障<br>接口 |
| *Dell Force S-Series SNMP* | 戴尔 | 戴尔Force S系列 | S4810 | | F10-S-SERIES-CHASSIS-MIB | 认证 |
| *Extreme Exos SNMP* | Extreme | Extreme EXOS | X670V-48x | EXOS | EXTREME-SYSTEM-MIB,EXTREME-SOFTWARE-MONITOR-MIB | 认证 |
| *FortiGate by SNMP* | Fortinet | FortiGate (NGFW) | - | FortiOS | 主机-RESOURCES-MIB<br>FORTINET-FORTIGATE-MIB<br>FORTINET-CORE-MIB<br>SNMPv2-MIB<br>IF-MIB<br>ENTITY-MIB | 性能<br>资产清单 |
| *Huawei VRP SNMP* | 华为 | 华为 VRP | S2352P-EI | \- | ENTITY-MIB,华为-ENTITY-EXTENT-MIB | 认证 |
| *Intel\_Qlogic Infiniband SNMP* | Intel/QLogic | Intel/QLogic Infiniband设备 | Infiniband 12300 | | ICS-CHASSIS-MIB | 故障<br>资产清单 |
| *Juniper SNMP* | Juniper | MX,SRX,EX型号 | Juniper MX240, Juniper EX4200-24F | JunOS | JUNIPER-MIB | 认证 |
| *Mellanox SNMP* | Mellanox | Mellanox Infiniband设备 | SX1036 | MLNX-OS | 主机-RESOURCES-MIB,ENTITY-MIB,ENTITY-SENSOR-MIB,MELLANOX-MIB | 认证 |
| *MikroTik CCR<device model> SNMP* | MikroTik | MikroTik云核心路由器(CCR系列) | 为以下型号提供独立专用模板: MikroTik CCR1009-7G-1C-1S+, MikroTik CCR1009-7G-1C-1S+PC, MikroTik CCR1009-7G-1C-PC, MikroTik CCR1016-12G, MikroTik CCR1016-12S-1S+, MikroTik CCR1036-12G-4S-EM, MikroTik CCR1036-12G-4S, MikroTik CCR1036-8G-2S+, MikroTik CCR1036-8G-2S+EM, MikroTik CCR1072-1G-8S+, MikroTik CCR2004-16G-2S+, MikroTik CCR2004-1G-12S+2XS | RouterOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik CRS<device model> SNMP* | MikroTik | MikroTik云路由器交换机(CRS系列) | 为以下型号提供独立专用模板: MikroTik CRS106-1C-5S, MikroTik CRS109-8G-1S-2HnD-IN, MikroTik CRS112-8G-4S-IN, MikroTik CRS112-8P-4S-IN, MikroTik CRS125-24G-1S-2HnD-IN, MikroTik CRS212-1G-10S-1S+IN, MikroTik CRS305-1G-4S+IN, MikroTik CRS309-1G-8S+IN, MikroTik CRS312-4C+8XG-RM, MikroTik CRS317-1G-16S+RM, MikroTik CRS326-24G-2S+IN, MikroTik CRS326-24G-2S+RM, MikroTik CRS326-24S+2Q+RM, MikroTik CRS328-24P-4S+RM, MikroTik CRS328-4C-20S-4S+RM, MikroTik CRS354-48G-4S+2Q+RM, MikroTik CRS354-48P-4S+2Q+RM | RouterOS/SwitchOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik CSS<device model> SNMP* | MikroTik | MikroTik云智能交换机(CSS系列) | 为以下型号提供独立专用模板: MikroTik CSS326-24G-2S+RM, MikroTik CSS610-8G-2S+IN | RouterOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik FiberBox SNMP* | MikroTik | MikroTik FiberBox | MikroTik FiberBox | RouterOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik hEX <device model> SNMP* | MikroTik | MikroTik hEX | 为以下型号提供独立专用模板: MikroTik hEX, MikroTik hEX lite, MikroTik hEX PoE, MikroTik hEX PoE lite, MikroTik hEX S | RouterOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik netPower <device model> SNMP* | MikroTik | MikroTik netPower | 为以下型号提供独立专用模板: MikroTik netPower 15FR, MikroTik netPower 16P SNMP, MikroTik netPower Lite 7R | RouterOS/SwitchOS, SwitchOS Lite | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik PowerBox <device model> SNMP* | MikroTik | MikroTik PowerBox | 为以下型号提供独立专用模板: MikroTik PowerBox, MikroTik PowerBox Pro | RouterOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik RB<device model> SNMP* | MikroTik | MikroTik RB系列路由器 | 为以下型号提供独立专用模板: MikroTik RB1100AHx4, MikroTik RB1100AHx4 Dude Edition, MikroTik RB2011iL-IN, MikroTik RB2011iL-RM, MikroTik RB2011iLS-IN, MikroTik RB2011UiAS-IN, MikroTik RB2011UiAS-RM, MikroTik RB260GS, MikroTik RB3011UiAS-RM, MikroTik RB4011iGS+RM, MikroTik RB5009UG+S+IN | RouterOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *MikroTik SNMP* | MikroTik | MikroTik RouterOS设备 | MikroTik CCR1016-12G, MikroTik RB2011UAS-2HnD, MikroTik 912UAG-5HPnD, MikroTik 941-2nD, MikroTik 951G-2HnD, MikroTik 1100AHx2 | RouterOS | MIKROTIK-MIB,主机-RESOURCES-MIB | 认证 |
| *QTech QSW SNMP* | QTech | Qtech设备 | Qtech QSW-2800-28T | \- | QTECH-MIB,ENTITY-MIB | 性能<br>资产清单 |
| *Ubiquiti AirOS SNMP* | Ubiquiti | Ubiquiti AirOS无线设备 | NanoBridge,NanoStation,Unifi | AirOS | FROGFOOT-RESOURCES-MIB,IEEE802dot11-MIB | 性能 |
| *HP Comware HH3C SNMP* | 惠普 | 惠普(H3C) Comware | 惠普A5500-24G-4SFP HI交换机 | | HH3C-ENTITY-EXT-MIB,ENTITY-MIB | 认证 |
| *HP Enterprise Switch SNMP* | 惠普 | 惠普企业交换机 | 惠普ProCurve J4900B交换机2626, 惠普J9728A 2920-48G交换机 | | STATISTICS-MIB,NETSWITCH-MIB,HP-ICF-CHASSIS,ENTITY-MIB,SEMI-MIB | 认证 |
| *TP-LINK SNMP* | TP-LINK | TP-LINK | T2600G-28TS v2.0 | | TPLINK-SYSMONITOR-MIB,TPLINK-SYSINFO-MIB | 性能<br>资产清单 |
| *Netgear Fastpath SNMP* | Netgear | Netgear Fastpath | M5300-28G | | FASTPATH-SWITCHING-MIB,FASTPATH-BOXSERVICES-PRIVATE-MIB | 故障<br>资产清单 |
# dhost.get
# dhost.get
### 'Diagnostic information' request object
The diagnostic information task request object has the following
properties. Statistic request object for all types of properties is
[described in detail
below](/manual/api/reference/task/object#statistic_request_object).
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|historycache|object|History cache statistic request. Available on server and proxy.|
|valuecache|object|Items cache statistic request. Available on server.|
|preprocessing|object|Preprocessing manager statistic request. Available on server and proxy.|
|alerting|object|Alert manager statistic request. Available on server.|
|lld|object|LLD manager statistic request. Available on server.|
### '诊断信息'请求 object
诊断信息任务请求object具有以下属性。所有类型属性的统计请求object为[统计请求-object](/manual/api/reference/task/object#统计请求-object)。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| historycache | object | history cache统计请求。可在服务器和proxy上使用。 |
| valuecache | object | 监控项缓存统计请求。仅在服务器上可用。 |
| preprocessing | object | 预处理管理器统计请求。可在服务器和proxy上使用。 |
| alerting | object | 告警管理器统计请求。仅在服务器上可用。 |
| lld | object | LLD管理器统计请求。仅在服务器上可用。 |
#### Disable action
Disable an action, that is, set its status to "1".
Request:
```json
{
"jsonrpc": "2.0",
"method": "action.update",
"params": {
"actionid": "2",
"status": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"2"
]
},
"id": 1
}
```
#### 禁用动作
禁用某个动作，即将其状态设置为"1"。
请求：
```json
{
"jsonrpc": "2.0",
"method": "action.update",
"params": {
"actionid": "2",
"status": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"2"
]
},
"id": 1
}
```
#### Disable correlation
Request:
```json
{
"jsonrpc": "2.0",
"method": "correlation.update",
"params": {
"correlationid": "1",
"status": "1"
},
"auth": "343baad4f88b4106b9b5961e77437688",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"correlationids": [
"1"
]
},
"id": 1
}
```
#### 禁用关联
请求:
```json
{
"jsonrpc": "2.0",
"method": "correlation.update",
"params": {
"correlationid": "1",
"status": "1"
},
"auth": "343baad4f88b4106b9b5961e77437688",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"correlationids": [
"1"
]
},
"id": 1
}
```
#### Disable trapping
Disable LLD trapping for discovery rule.
Request:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.update",
"params": {
"itemid": "28336",
"allow_traps": 0
},
"id": 36,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"28336"
]
},
"id": 36
}
```
#### 禁用陷阱
禁用发现规则的LLD陷阱功能
请求:
```json
{
"jsonrpc": "2.0",
"method": "discoveryrule.update",
"params": {
"itemid": "28336",
"allow_traps": 0
},
"id": 36,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"28336"
]
},
"id": 36
}
```
#### Disabling ability to execute scripts
Update role with ID "5", disable ability to execute scripts.
Request:
```json
{
"jsonrpc": "2.0",
"method": "role.update",
"params": [
{
"roleid": "5",
"rules": {
"actions": [
{
"name": "execute_scripts",
"status": "0"
}
]
}
}
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}
```
#### 禁用脚本执行功能
更新ID为"5"的角色，禁用execute脚本功能。
请求:
```json
{
"jsonrpc": "2.0",
"method": "role.update",
"params": [
{
"roleid": "5",
"rules": {
"actions": [
{
"name": "execute_scripts",
"status": "0"
}
]
}
}
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}
```
#### Disabling a host prototype
Disable a host prototype, that is, set its status to 1.
Request:
```json
{
"jsonrpc": "2.0",
"method": "hostprototype.update",
"params": {
"hostid": "10092",
"status": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10092"
]
},
"id": 1
}
```
#### 禁用主机原型
禁用一个主机原型，即将其状态设置为1.
请求:
```json
{
"jsonrpc": "2.0",
"method": "hostprototype.update",
"params": {
"hostid": "10092",
"status": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10092"
]
},
"id": 1
}
```
#### Disabling a user group
Disable a user group.
Request:
```json
{
"jsonrpc": "2.0",
"method": "usergroup.update",
"params": {
"usrgrpid": "17",
"users_status": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"17"
]
},
"id": 1
}
```
#### 禁用用户组
禁用用户组.
请求:
```json
{
"jsonrpc": "2.0",
"method": "usergroup.update",
"params": {
"usrgrpid": "17",
"users_status": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"17"
]
},
"id": 1
}
```
#### Disabling default web server error pages
It is recommended to disable default error pages to avoid information
exposure. Web server is using built-in error pages by default:
Default error pages should be replaced/removed as part of the web server
hardening process. The "ErrorDocument" directive can be used to define a
custom error page/text for Apache web server (used as an example).
Please refer to documentation of your web server to find help on how to
replace/remove default error pages.
#### 禁用默认 Web 服务器错误页面
建议禁用默认错误页面以避免信息泄露。默认情况下，Web服务器使用内置错误页面：
作为Web服务器加固流程的一部分，应替换/移除默认错误页面。对于Apache Web服务器（示例），可使用"ErrorDocument"指令定义自定义错误页面/文本。
请参阅您的Web服务器文档，获取有关如何替换/移除默认错误页面的帮助。
### Disabling high availability
To disable a high availability cluster:
- make backup copies of configuration files
- stop standby nodes
- remove the HANodeName parameter from the active primary server
- restart the primary server (it will start in standalone mode)
### 禁用高可用性
禁用高可用性集群的步骤：
- 备份配置文件副本
- 停止备用节点
- 从活动主服务器移除HANodeName参数
- 重启主服务器（将以独立模式启动）
#### Disabling scheduled report
Request:
```json
{
"jsonrpc": "2.0",
"method": "report.update",
"params": {
"reportid": "1",
"status": "0"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}
```
#### 禁用定时报告
请求:
```json
{
"jsonrpc": "2.0",
"method": "report.update",
"params": {
"reportid": "1",
"status": "0"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}
```
#### Disabling web server information exposure
It is recommended to disable all web server signatures as part of the
web server hardening process. The web server is exposing software
signature by default:
The signature can be disabled by adding two lines to the Apache (used as
an example) configuration file:
```ini
ServerSignature Off
ServerTokens Prod
```
PHP signature (X-Powered-By HTTP header) can be disabled by changing the
php.ini configuration file (signature is disabled by default):
```ini
expose_php = Off
```
Web server restart is required for configuration file changes to be
applied.
Additional security level can be achieved by using the mod\_security
(package libapache2-mod-security2) with Apache. mod\_security allows to
remove server signature instead of only removing version from server
signature. Signature can be altered to any value by changing
"SecServerSignature" to any desired value after installing
mod\_security.
Please refer to documentation of your web server to find help on how to
remove/change software signatures.
#### 禁用Web服务器信息暴露
建议在Web服务器加固过程中禁用所有Web服务器签名。默认情况下Web服务器会暴露软件签名：
可以通过在Apache（示例）配置文件file中添加以下两行来禁用签名：
```ini
ServerSignature Off
ServerTokens Prod
```
PHP签名（X-Powered-By HTTP头）可以通过修改php.ini配置文件file来禁用（默认情况下签名已禁用）：
```ini
expose_php = Off
```
需要重启Web服务器才能使配置文件file的更改生效。
通过使用Apache的mod_security模块（包libapache2-mod-security2）可以实现额外的安全级别。mod_security允许完全移除服务器签名，而不仅仅是移除version服务器签名部分。安装mod_security后，可以通过修改"SecServerSignature"为任意值来更改签名显示内容。
请参考您的Web服务器文档以获取关于如何移除/更改软件签名的帮助。
### Discovered entities
The screenshots below illustrate how discovered items, triggers, and
graphs look like in the host's configuration. Discovered entities are
prefixed with an orange link to a discovery rule they come from.
{width="600"}
Note that discovered entities will not be created in case there are
already existing entities with the same uniqueness criteria, for
example, an item with the same key or graph with the same name. An error
message is displayed in this case in the frontend that the low-level
discovery rule could not create certain entities. The discovery rule
itself, however, will not turn unsupported because some entity could not
be created and had to be skipped. The discovery rule will go on
creating/updating other entities.
Items (similarly, triggers and graphs) created by a low-level discovery
rule will be deleted automatically if a discovered entity (file system,
interface, etc) stops being discovered (or does not pass the filter
anymore). In this case the items, triggers and graphs will be deleted
after the days defined in the *Keep lost resources period* field pass.
When discovered entities become 'Not discovered anymore', a lifetime
indicator is displayed in the item list. Move your mouse pointer over it
and a message will be displayed indicating how many days are left until
the item is deleted.
If entities were marked for deletion, but were not deleted at the
expected time (disabled discovery rule or item host), they will be
deleted the next time the discovery rule is processed.
Entities containing other entities, which are marked for deletion, will
not update if changed on the discovery rule level. For example,
LLD-based triggers will not update if they contain items that are marked
for deletion.
{width="600"}
### 发现的实体
以下截图展示了在主机配置中发现的监控项、触发器和图形的显示方式。发现的实体都带有橙色前缀链接，指向它们来源的发现规则。
{width="600"}
注意：如果已存在具有相同唯一性标准的实体（例如相同键值的监控项或同名图形），则不会创建发现的实体。此时前端会显示错误消息，提示低级发现规则无法create某些实体。但发现规则本身不会因为某些实体无法创建而被标记为不支持状态。发现规则将继续创建/更新其他实体。
由低级发现规则创建的监控项（同理适用于触发器和图形），当被发现实体（file系统、接口等）停止被发现（或不再通过过滤器）时将被自动删除。这种情况下，监控项、触发器和图形将在*保留丢失资源周期*字段定义的天数过后被删除。
当发现的实体变为"不再被发现"状态时，监控项列表会显示生命周期指示器。将鼠标指针悬停其上，会显示消息提示该监控项将在多少天后被删除。
如果实体被标记为待删除但未在预期时间被删除（发现规则被禁用或监控项主机），它们将在下次处理发现规则时被删除。
包含其他待删除实体的实体，如果在发现规则级别发生更改，将不会update。例如，基于LLD的触发器如果包含标记为待删除的监控项，则不会update。
{width="600"}
#### Discovered entities
When server runs, it will create real items, triggers and graphs based
on the values the SNMP discovery rule returns. In the host configuration
they are prefixed with an orange link to a discovery rule they come
from.
{width="600"}
{width="600"}
{width="600"}
#### 发现的实体
当服务器运行时，它将create基于SNMP发现规则返回的值创建真实的监控项、触发器和图形。在主机配置中，它们会带有指向来源发现规则的橙色链接前缀。
{width="600"}
{width="600"}
{width="600"}
### Discovered host
::: noteclassic
Discovered host are created by the Zabbix server and cannot
be modified via the API.
:::
The discovered host object contains information about a host discovered
by a network discovery rule. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dhostid|string|ID of the discovered host.|
|druleid|string|ID of the discovery rule that detected the host.|
|lastdown|timestamp|Time when the discovered host last went down.|
|lastup|timestamp|Time when the discovered host last went up.|
|status|integer|Whether the discovered host is up or down. A host is up if it has at least one active discovered service.<br><br>Possible values:<br>0 - host up;<br>1 - host down.|
### 已发现主机
::: noteclassic
发现的主机由Zabbix server创建，无法通过API进行修改。
:::
发现的主机object包含有关网络发现规则所发现的一个主机信息。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dhostid | string | 发现的主机的ID。 |
| druleid | string | 检测到主机的发现规则的ID。 |
| lastdown | timestamp | 发现的主机最后一次宕机的时间。 |
| lastup | timestamp | 发现的主机最后一次恢复的时间。 |
| status | integer | 发现的主机是运行还是宕机。如果一个主机至少有一个活跃的发现服务，则视为运行。<br><br>可能的值：<br>0 - 主机运行；<br>1 - 主机宕机。 |
### Discovered service
::: noteclassic
Discovered services are created by the Zabbix server and
cannot be modified via the API.
:::
The discovered service object contains information about a service
discovered by a network discovery rule on a host. It has the following
properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dserviceid|string|ID of the discovered service.|
|dcheckid|string|ID of the discovery check used to detect the service.|
|dhostid|string|ID of the discovered host running the service.|
|dns|string|DNS of the host running the service.|
|ip|string|IP address of the host running the service.|
|lastdown|timestamp|Time when the discovered service last went down.|
|lastup|timestamp|Time when the discovered service last went up.|
|port|integer|Service port number.|
|status|integer|Status of the service.<br><br>Possible values:<br>0 - service up;<br>1 - service down.|
|value|string|Value returned by the service when performing a Zabbix agent, SNMPv1, SNMPv2 or SNMPv3 discovery check.|
### 已发现服务
::: noteclassic
已发现服务由Zabbix server创建，
无法通过API进行修改。
:::
已发现服务object包含通过一个主机上的网络发现规则检测到的服务信息。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dserviceid | string | 已发现服务的ID。 |
| dcheckid | string | 用于检测服务的发现检查ID。 |
| dhostid | string | 运行该服务的已发现主机的ID。 |
| dns | string | 运行该服务的主机的DNS名称。 |
| ip | string | 运行该服务的主机的IP地址。 |
| lastdown | timestamp | 已发现服务最后一次宕机的时间。 |
| lastup | timestamp | 已发现服务最后一次恢复的时间。 |
| port | integer | 服务端口号。 |
| status | integer | 服务状态。<br><br>可能的值：<br>0 - 服务正常；<br>1 - 服务宕机。 |
| value | string | 执行Zabbix agent、SNMPv1、SNMPv2或SNMPv3发现检查时服务返回的值。 |
##### Discovering MBean attributes
Discovery item: `jmx.get[attributes,"com.example:type=*,*"]`
Response:
``` {.json}
[
{
"object": "com.example:type=*",
"domain": "com.example",
"properties": {
"type": "Simple"
}
},
{
"object": "com.zabbix:type=yes,domain=zabbix.com,data-source=/dev/rand,ключ=значение,obj=true",
"domain": "com.zabbix",
"properties": {
"type": "Hello",
"domain": "com.example",
"data-source": "/dev/rand",
"ключ": "значение",
"obj": true
}
}
]
```
##### 发现 MBean 属性
发现 监控项: `jmx.get[attributes,"com.example:type=*,*"]`
响应:
```{.json}
[
{
"object": "com.example:type=*",
"domain": "com.example",
"properties": {
"type": "Simple"
}
},
{
"object": "com.zabbix:type=yes,domain=zabbix.com,data-source=/dev/rand,ключ=значение,obj=true",
"domain": "com.zabbix",
"properties": {
"type": "Hello",
"domain": "com.example",
"data-source": "/dev/rand",
"ключ": "значение",
"obj": true
}
}
]
```
##### Discovering MBeans
Discovery item: `jmx.get[beans,"com.example:type=*,*"]`
Response:
``` {.json}
[
{
"object": "com.example:type=Hello,data-src=data-base,ключ=значение",
"domain": "com.example",
"properties": {
"data-src": "data-base",
"ключ": "значение",
"type": "Hello"
}
},
{
"object": "com.example:type=Atomic",
"domain": "com.example",
"properties": {
"type": "Atomic"
}
}
]
```
##### 发现 MBeans
发现 监控项: `jmx.get[beans,"com.example:type=*,*"]`
响应:
```{.json}
[
{
"object": "com.example:type=Hello,data-src=data-base,ключ=значение",
"domain": "com.example",
"properties": {
"data-src": "data-base",
"ключ": "значение",
"type": "Hello"
}
},
{
"object": "com.example:type=Atomic",
"domain": "com.example",
"properties": {
"type": "Atomic"
}
}
]
```
#### Discovery actions
The following conditions can be set for discovery-based events:
|Condition type|Supported operators|Description|
|--------------|-------------------|-----------|
|*Host IP*|equals<br>does not equal|Specify an IP address range or a range to exclude for a discovered host.<br>**equals** - host IP is in the range.<br>**does not equal** - host IP is not in the range.<br>It may have the following formats:<br>Single IP: 192.168.1.33<br>Range of IP addresses: 192.168.1-10.1-254<br>IP mask: 192.168.4.0/24<br>List: 192.168.1.1-254, 192.168.2.1-100, 192.168.2.200, 192.168.4.0/24<br>Support for spaces in the list format is provided since Zabbix 3.0.0.|
|*Service type*|equals<br>does not equal|Specify a service type of a discovered service or a service type to exclude.<br>**equals** - matches the discovered service.<br>**does not equal** - does not match the discovered service.<br>Available service types: SSH, LDAP, SMTP, FTP, HTTP, HTTPS *(available since Zabbix 2.2 version)*, POP, NNTP, IMAP, TCP, Zabbix agent, SNMPv1 agent, SNMPv2 agent, SNMPv3 agent, ICMP ping, telnet *(available since Zabbix 2.2 version)*.|
|*Service port*|equals<br>does not equal|Specify a TCP port range of a discovered service or a range to exclude.<br>**equals** - service port is in the range.<br>**does not equal** - service port is not in the range.|
|*Discovery rule*|equals<br>does not equal|Specify a discovery rule or a discovery rule to exclude.<br>**equals** - using this discovery rule.<br>**does not equal** - using any other discovery rule, except this one.|
|*Discovery check*|equals<br>does not equal|Specify a discovery check or a discovery check to exclude.<br>**equals** - using this discovery check.<br>**does not equal** - using any other discovery check, except this one.|
|*Discovery object*|equals|Specify the discovered object.<br>**equals** - equal to discovered object (a device or a service).|
|*Discovery status*|equals|**Up** - matches 'Host Up' and 'Service Up' events<br>**Down** - matches 'Host Down' and 'Service Down' events<br>**Discovered** - matches 'Host Discovered' and 'Service Discovered' events<br>**Lost** - matches 'Host Lost' and 'Service Lost' events|
|*Uptime/Downtime*|is greater than or equals<br>is less than or equals|Uptime for 'Host Up' and 'Service Up' events. Downtime for 'Host Down' and 'Service Down' events.<br>**is greater than or equals** - is more or equal to. Parameter is given in seconds.<br>**is less than or equals** - is less or equal to. Parameter is given in seconds.|
|*Received value*|equals<br>does not equal<br>is greater than or equals<br>is less than or equals<br>contains<br>does not contain|Specify the value received from an agent (Zabbix, SNMP) check in a discovery rule. String comparison. If several Zabbix agent or SNMP checks are configured for a rule, received values for each of them are checked (each check generates a new event which is matched against all conditions).<br>**equals** - equal to the value.<br>**does not equal** - not equal to the value.<br>**is greater than or equals** - more or equal to the value.<br>**is less than or equals** - less or equal to the value.<br>**contains** - contains the substring. Parameter is given as a string.<br>**does not contain** - does not contain the substring. Parameter is given as a string.|
|*Proxy*|equals<br>does not equal|Specify a proxy or a proxy to exclude.<br>**equals** - using this proxy.<br>**does not equal** - using any other proxy except this one.|
::: noteclassic
Service checks in a discovery rule, which result in
discovery events, do not take place simultaneously. Therefore, if
**multiple** values are configured for `Service type`, `Service port` or
`Received value` conditions in the action, they will be compared to one
discovery event at a time, but **not** to several events simultaneously.
As a result, actions with multiple values for the same check types may
not be executed correctly.
:::
#### 自动发现动作
可以为基于自动注册的事件设置以下条件：
|条件类型|支持的操作符|说明|
|--------------|-------------------|-----------|
|*Host IP*|equals<br>does not equal|要自动发现的主机的IP地址范围或要排除的IP范围。<br>**equals** - 主机IP在该范围内。<br>**does not equal** - 主机IP不在该范围内。<br>它可能具有以下格式：<br>单个IP: 192.168.1.33<br>IP地址段: 192.168.1-10.1-254<br>IP和子网掩码: 192.168.4.0/24<br>IP列表: 192.168.1.1-254, 192.168.2.1-100, 192.168.2.200, 192.168.4.0/24<br>从Zabbix 3.0.0开始，支持列表格式。|
|*Service type*|equals<br>does not equal|自动发现的服务类型或者要排除的服务类型。<br>**equals** - 匹配指定的自动发现服务<br>**does not equal** - 不匹配指定的自动发现服务<br>支持的服务类型如下: SSH, LDAP, SMTP, FTP, HTTP, HTTPS *(从Zabbix2.2版本开始支持)*, POP, NNTP, IMAP, TCP, Zabbix agent, SNMPv1 agent, SNMPv2 agent, SNMPv3 agent, ICMP ping, telnet *(从Zabbix2.2版本开始支持)*。|
|*Service port*|equals<br>does not equal|自动发现的服务端口范围或者要排除的服务端口范围<br>**equals** - 服务端口在指定范围<br>**does not equal** - 服务端口未在指定范围|
|*Discovery rule*|equals<br>does not equal|自动发现规则或要排除的规则。<br>**equals** - 使用此自动发现规则。<br>**does not equal** - 使用除此规则以外的任何其他的自动发现规则。|
|*Discovery check*|equals<br>does not equal|自动发现检查或要排除的自动发现检查<br>**equals** - 使用此自动发现检查。<br>**does not equal** - 使用除此以外的其他任何自动发现检查。|
|*Discovery object*|equals|自动发现的对象。<br>**equals** - 等于发现的对象（设备或服务）。|
|*Discovery status*|equals|**Up** - 匹配'Host Up' 及 'Service Up' 事件<br>**Down** - 匹配'Host Down'或'Service Down'的事件<br>**Discovered** - 匹配 'Host Discovered' 或 'Service Discovered'的事件<br>**Lost** - 匹配 'Host Lost' 或 'Service Lost' 的事件|
|*Uptime/Downtime*|is greater than or equals<br>is less than or equals|'Host Up' 或 'Service Up' 事件的运行事件. 'Host Down' 或 'Service Down' 的故障事件.<br>**is greater than or equals** - 大于或等于，参数单位为秒 <br>**is less than or equals** - 小于或等于，参数单位为秒.|
|*Received value*|equals<br>does not equal<br>is greater than or equals<br>is less than or equals<br>contains<br>does not contain|自动发现规则中指定从agent(Zabbix, SNMP)检查接收到的值。字符串比较。如果一条规则配置了多个Zabbix agent或SNMP检查，则将检查每个接收的值（每次检查都会生成一个新事件，该事件将与所有条件进行匹配）。<br>**equals** - 等于某个值<br>**does not equal** - 不等于某个值<br>**is greater than or equals** - 大于或等于某个值<br>**is less than or equals** - 少于或等于某个值<br>**contains** - 包含子串。参数以字符串形式给出。<br>**does not contain** - 不包含子串。参数以字符串形式给出。|
|*Proxy*|equals<br>does not equal|proxy或要排除的proxy。<br>**equals** - 使用该proxy<br>**does not equal** - 使用除此以外的其它proxy|
::: noteclassic
自动发现规则中的服务检查，会产生自动发现事件，但不会同时发生。因此，如果在动作中为`Service type`, `Service port` 或 `Received value`条件配了多个值，那么它们将每次与一个自动发现事件进行比较，而 **不会** 同时与多个自动发现事件进行比较。因此，具有多个值的同类型检测的动作，可能无法正确地执行。
:::
#### Discovery actions
The following conditions can be used in discovery-based events:
|Condition type|Supported operators|Description|
|--|--|------|
|*Host IP*|equals<br>does not equal|Specify an IP address range or a range to exclude for a discovered host.<br>**equals** - host IP is in the range.<br>**does not equal** - host IP is not in the range.<br>It may have the following formats:<br>Single IP: 192.168.1.33<br>Range of IP addresses: 192.168.1-10.1-254<br>IP mask: 192.168.4.0/24<br>List: 192.168.1.1-254, 192.168.2.1-100, 192.168.2.200, 192.168.4.0/24<br>Support for spaces in the list format is provided since Zabbix 3.0.0.|
|*Service type*|equals<br>does not equal|Specify a service type of a discovered service or a service type to exclude.<br>**equals** - matches the discovered service.<br>**does not equal** - does not match the discovered service.<br>Available service types: SSH, LDAP, SMTP, FTP, HTTP, HTTPS *(available since Zabbix 2.2 version)*, POP, NNTP, IMAP, TCP, Zabbix agent, SNMPv1 agent, SNMPv2 agent, SNMPv3 agent, ICMP ping, telnet *(available since Zabbix 2.2 version)*.|
|*Service port*|equals<br>does not equal|Specify a TCP port range of a discovered service or a range to exclude.<br>**equals** - service port is in the range.<br>**does not equal** - service port is not in the range.|
|*Discovery rule*|equals<br>does not equal|Specify a discovery rule or a discovery rule to exclude.<br>**equals** - using this discovery rule.<br>**does not equal** - using any other discovery rule, except this one.|
|*Discovery check*|equals<br>does not equal|Specify a discovery check or a discovery check to exclude.<br>**equals** - using this discovery check.<br>**does not equal** - using any other discovery check, except this one.|
|*Discovery object*|equals|Specify the discovered object.<br>**equals** - equal to discovered object (a device or a service).|
|*Discovery status*|equals|**Up** - matches 'Host Up' and 'Service Up' events<br>**Down** - matches 'Host Down' and 'Service Down' events<br>**Discovered** - matches 'Host Discovered' and 'Service Discovered' events<br>**Lost** - matches 'Host Lost' and 'Service Lost' events|
|*Uptime/Downtime*|is greater than or equals<br>is less than or equals|Uptime for 'Host Up' and 'Service Up' events. Downtime for 'Host Down' and 'Service Down' events.<br>**is greater than or equals** - is more or equal to. Parameter is given in seconds.<br>**is less than or equals** - is less or equal to. Parameter is given in seconds.|
|*Received value*|equals<br>does not equal<br>is greater than or equals<br>is less than or equals<br>contains<br>does not contain|Specify the value received from an agent (Zabbix, SNMP) check in a discovery rule. String comparison. If several Zabbix agent or SNMP checks are configured for a rule, received values for each of them are checked (each check generates a new event which is matched against all conditions).<br>**equals** - equal to the value.<br>**does not equal** - not equal to the value.<br>**is greater than or equals** - more or equal to the value.<br>**is less than or equals** - less or equal to the value.<br>**contains** - contains the substring. Parameter is given as a string.<br>**does not contain** - does not contain the substring. Parameter is given as a string.|
|*Proxy*|equals<br>does not equal|Specify a proxy or a proxy to exclude.<br>**equals** - using this proxy.<br>**does not equal** - using any other proxy except this one.|
::: noteclassic
Service checks in a discovery rule, which result in
discovery events, do not take place simultaneously. Therefore, if
**multiple** values are configured for `Service type`, `Service port` or
`Received value` conditions in the action, they will be compared to one
discovery event at a time, but **not** to several events simultaneously.
As a result, actions with multiple values for the same check types may
not be executed correctly.
:::
#### 发现动作
基于发现的事件可使用以下条件:
| 条件类型 | 支持的运算符 | 描述 |
|--|--|------|
| *Host IP* | equals<br>does not equal | 为发现的主机指定IP地址范围或排除范围。<br>**equals** - 主机 IP位于该范围内。<br>**does not equal** - 主机 IP不位于该范围内。<br>可采用以下格式：<br>单个IP: 192.168.1.33<br>IP地址范围: 192.168.1-10.1-254<br>IP掩码: 192.168.4.0/24<br>列表: 192.168.1.1-254, 192.168.2.1-100, 192.168.2.200, 192.168.4.0/24<br>自Zabbix 3.0.0起支持列表格式中使用空格。 |
| *Service type* | equals<br>does not equal | 指定要发现的服务类型或要排除的服务类型.<br>**equals** - 匹配发现的服务.<br>**does not equal** - 不匹配发现的服务.<br>可用服务类型: SSH, LDAP, SMTP, FTP, HTTP, HTTPS *(自Zabbix 2.2 version起可用)*, POP, NNTP, IMAP, TCP, Zabbix agent, SNMPv1 agent, SNMPv2 agent, SNMPv3 agent, ICMP ping, telnet *(自Zabbix 2.2 version起可用)*. |
| *Service port* | equals<br>does not equal | 指定发现服务的TCP端口范围或要排除的范围。<br>**equals** - 服务端口位于该范围内。<br>**does not equal** - 服务端口不位于该范围内。 |
| *Discovery rule* | equals<br>does not equal | 指定要包含或排除的发现规则。<br>**equals** - 使用此发现规则。<br>**does not equal** - 使用除此规则外的其他发现规则。 |
| *Discovery check* | equals<br>does not equal | 指定要包含或排除的发现检查项.<br>**equals** - 使用此发现检查项.<br>**does not equal** - 使用除此项外的其他发现检查项. |
| *Discovery object* | equals | 指定发现的object.<br>**equals** - 等于发现的object（设备或服务）. |
| *Discovery status* | equals | **Up** - 匹配 '主机 Up' 和 'Service Up' 事件<br>**Down** - 匹配 '主机 Down' 和 'Service Down' 事件<br>**Discovered** - 匹配 '主机 Discovered' 和 'Service Discovered' 事件<br>**Lost** - 匹配 '主机 Lost' 和 'Service Lost' 事件 |
| *Uptime/Downtime* | is greater than or equals<br>is less than or equals | '主机 运行'与'服务运行'事件的运行时间。'主机 停止'与'服务停止'事件的停机时间。<br>**大于或等于** - 达到或超过指定值。参数以秒为单位。<br>**小于或等于** - 低于或等于指定值。参数以秒为单位。 |
| *Received value* | equals<br>does not equal<br>is greater than or equals<br>is less than or equals<br>contains<br>does not contain | 在发现规则中指定从agent(Zabbix, SNMP)检查接收到的值。string比较。如果为规则配置了多个Zabbix agent或SNMP检查，则对每个检查接收到的值进行验证(每个检查都会生成一个新事件，该事件将与所有条件进行匹配)。<br>**equals** - 等于该值。<br>**does not equal** - 不等于该值。<br>**is greater than or equals** - 大于或等于该值。<br>**is less than or equals** - 小于或等于该值。<br>**contains** - 包含子字符串。参数以string形式给出。<br>**does not contain** - 不包含子字符串。参数以string形式给出。 |
| *Proxy* | equals<br>does not equal | 指定要排除的proxy或proxy.<br>**equals** - 使用此proxy.<br>**does not equal** - 使用除此外的其他proxy. |
::: noteclassic
发现规则中的服务检查，其结果为
发现事件不会同时发生。因此，如果
为`Service type`、`Service port`配置了**多个**值
`Received value` 动作中的条件将被相互比较
一次只能处理一个发现事件，**不能**同时处理多个事件。
因此，对于同一检查类型具有多个值的操作可能会
无法正确执行。
:::
### Discovery check
The discovery check object defines a specific check performed by a
network discovery rule. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|dcheckid|string|*(readonly)* ID of the discovery check.|
|druleid|string|*(readonly)* ID of the discovery rule that the check belongs to.|
|key\_|string|The value of this property differs depending on the type of the check:<br>- key to query for Zabbix agent checks, required;<br>- SNMP OID for SNMPv1, SNMPv2 and SNMPv3 checks, required.|
|ports|string|One or several port ranges to check separated by commas. Used for all checks except for ICMP.<br><br>Default: 0.|
|snmp\_community|string|SNMP community.<br><br>Required for SNMPv1 and SNMPv2 agent checks.|
|snmpv3\_authpassphrase|string|Authentication passphrase used for SNMPv3 agent checks with security level set to *authNoPriv* or *authPriv*.|
|snmpv3\_authprotocol|integer|Authentication protocol used for SNMPv3 agent checks with security level set to *authNoPriv* or *authPriv*.<br><br>Possible values:<br>0 - *(default)* MD5;<br>1 - SHA1;<br>2 - SHA224;<br>3 - SHA256;<br>4 - SHA384;<br>5 - SHA512.|
|snmpv3\_contextname|string|SNMPv3 context name. Used only by SNMPv3 checks.|
|snmpv3\_privpassphrase|string|Privacy passphrase used for SNMPv3 agent checks with security level set to *authPriv*.|
|snmpv3\_privprotocol|integer|Privacy protocol used for SNMPv3 agent checks with security level set to *authPriv*.<br><br>Possible values:<br>0 - *(default)* DES;<br>1 - AES128;<br>2 - AES192;<br>3 - AES256;<br>4 - AES192C;<br>5 - AES256C.|
|snmpv3\_securitylevel|string|Security level used for SNMPv3 agent checks.<br><br>Possible values:<br>0 - noAuthNoPriv;<br>1 - authNoPriv;<br>2 - authPriv.|
|snmpv3\_securityname|string|Security name used for SNMPv3 agent checks.|
|**type**<br>(required)|integer|Type of check.<br><br>Possible values:<br>0 - SSH;<br>1 - LDAP;<br>2 - SMTP;<br>3 - FTP;<br>4 - HTTP;<br>5 - POP;<br>6 - NNTP;<br>7 - IMAP;<br>8 - TCP;<br>9 - Zabbix agent;<br>10 - SNMPv1 agent;<br>11 - SNMPv2 agent;<br>12 - ICMP ping;<br>13 - SNMPv3 agent;<br>14 - HTTPS;<br>15 - Telnet.|
|uniq|integer|Whether to use this check as a device uniqueness criteria. Only a single unique check can be configured for a discovery rule. Used for Zabbix agent, SNMPv1, SNMPv2 and SNMPv3 agent checks.<br><br>Possible values:<br>0 - *(default)* do not use this check as a uniqueness criteria;<br>1 - use this check as a uniqueness criteria.|
|host\_source|integer|Source for host name.<br><br>Possible values:<br>1 - *(default)* DNS;<br>2 - IP;<br>3 - discovery value of this check.|
|name\_source|integer|Source for visible name.<br><br>Possible values:<br>0 - *(default)* not specified;<br>1 - DNS;<br>2 - IP;<br>3 - discovery value of this check.|
### 发现检查
发现检查object定义了由网络发现规则执行的特定检查。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| dcheckid | string | *(只读)* 发现检查的ID。 |
| druleid | string | *(只读)* 检查所属的发现规则的ID。 |
| key\_ | string | 此属性的值根据检查类型而不同：<br>- 对于Zabbix agent检查，需指定query的键值；<br>- 对于SNMPv1、SNMPv2和SNMPv3检查，需指定SNMP OID。 |
| ports | string | 以逗号分隔的一个或多个端口范围，用于除ICMP外的所有检查。<br><br>默认值：0。 |
| snmp\_community | string | SNMP community。<br><br>SNMPv1和SNMPv2 agent检查必需。 |
| snmpv3\_authpassphrase | string | 用于安全级别设置为*authNoPriv*或*authPriv*的SNMPv3 agent检查的身份验证密码。 |
| snmpv3\_authprotocol | integer | 用于安全级别设置为*authNoPriv*或*authPriv*的SNMPv3 agent检查的身份验证协议。<br><br>可能值：<br>0 - *(默认)* MD5；<br>1 - SHA1；<br>2 - SHA224；<br>3 - SHA256；<br>4 - SHA384；<br>5 - SHA512。 |
| snmpv3\_contextname | string | SNMPv3上下文名称。仅用于SNMPv3检查。 |
| snmpv3\_privpassphrase | string | 用于安全级别设置为*authPriv*的SNMPv3 agent检查的隐私密码。 |
| snmpv3\_privprotocol | integer | 用于安全级别设置为*authPriv*的SNMPv3 agent检查的隐私协议。<br><br>可能值：<br>0 - *(默认)* DES；<br>1 - AES128；<br>2 - AES192；<br>3 - AES256；<br>4 - AES192C；<br>5 - AES256C。 |
| snmpv3\_securitylevel | string | 用于SNMPv3 agent检查的安全级别。<br><br>可能值：<br>0 - noAuthNoPriv；<br>1 - authNoPriv；<br>2 - authPriv。 |
| snmpv3\_securityname | string | 用于SNMPv3 agent检查的安全名称。 |
| **type**<br>(required) | integer | 检查类型。<br><br>可能值：<br>0 - SSH；<br>1 - LDAP；<br>2 - SMTP；<br>3 - FTP；<br>4 - HTTP；<br>5 - POP；<br>6 - NNTP；<br>7 - IMAP；<br>8 - TCP；<br>9 - Zabbix agent；<br>10 - SNMPv1 agent；<br>11 - SNMPv2 agent；<br>12 - ICMP ping；<br>13 - SNMPv3 agent；<br>14 - HTTPS；<br>15 - Telnet。 |
| uniq | integer | 是否将此检查用作设备唯一性标准。一个发现规则只能配置一个唯一性检查。用于Zabbix agent、SNMPv1、SNMPv2和SNMPv3 agent检查。<br><br>可能值：<br>0 - *(默认)* 不将此检查用作唯一性标准；<br>1 - 将此检查用作唯一性标准。 |
| host\_source | integer | 主机名的来源。<br><br>可能值：<br>1 - *(默认)* DNS；<br>2 - IP；<br>3 - 此检查的发现值。 |
| name\_source | integer | 可见名称的来源。<br><br>可能值：<br>0 - *(默认)* 未指定；<br>1 - DNS；<br>2 - IP；<br>3 - 此检查的发现值。 |
#### Discovery events
Zabbix periodically scans the IP ranges defined in network discovery
rules. Frequency of the check is configurable for each rule
individually. Once a host or a service is discovered, a discovery event
(or several events) are generated.
Zabbix generates the following events:
|Event|When generated|
|--|--------|
|Service Up|Every time Zabbix detects active service.|
|Service Down|Every time Zabbix cannot detect service.|
|Host Up|If at least one of the services is UP for the IP.|
|Host Down|If all services are not responding.|
|Service Discovered|If the service is back after downtime or discovered for the first time.|
|Service Lost|If the service is lost after being up.|
|Host Discovered|If host is back after downtime or discovered for the first time.|
|Host Lost|If host is lost after being up.|
#### 发现事件
Zabbix会定期扫描网络发现规则中定义的IP范围
每个规则的检查频率可单独配置
当发现一个主机或服务时 会生成一个(或多个)发现事件
Zabbix会生成以下事件:
| 事件 | 生成时机 |
|--|--------|
| 服务可用 | 每次Zabbix检测到活跃服务时 |
| 服务不可用 | 每次Zabbix无法检测到服务时 |
| 主机可用 | 当IP地址至少有一个服务处于UP状态时 |
| 主机不可用 | 当所有服务都无响应时 |
| 服务发现 | 当服务在停机后恢复或首次被发现时 |
| 服务丢失 | 当服务从可用状态变为丢失时 |
| 主机发现 | 当主机在停机后恢复或首次被发现时 |
| 主机丢失 | 当主机从可用状态变为丢失时 |
### Discovery of disabled systemd units
It is now also possible to discover **disabled** systemd units using the *systemd.unit.discovery* item key,
supported by Zabbix agent 2. Note that to have items and triggers created from prototypes for disabled systemd units,
it may be necessary to adjust (or remove) prohibiting LLD filters for the {#UNIT.ACTIVESTATE} and {#UNIT.UNITFILESTATE} macros.
For more details, see [Discovery of systemd services](/manual/discovery/low_level_discovery/examples/systemd).
### 已禁用的 systemd 单元发现
现在还可以通过*Zabbix agent 2*支持的*systemd.unit.discovery* 监控项键发现**已禁用**的systemd单元.
需要注意的是,要为禁用的systemd单元创建监控项和从原型创建的触发器,可能需要调整(或移除)针对{#UNIT.ACTIVESTATE}和{#UNIT.UNITFILESTATE}宏的禁止LLD过滤器.
更多详情,请参阅[Discovery of systemd services](/manual/discovery/low_level_discovery/examples/systemd).
##### Discovery of disabled systemd units
Since Zabbix 6.0.1 it is also possible to discover **disabled** systemd units. In this case
three macros are returned in the resulting JSON:
- {#UNIT.PATH}
- {#UNIT.ACTIVESTATE}
- {#UNIT.UNITFILESTATE}.
::: noteimportant
To have items and triggers created from prototypes for disabled systemd units, make sure to
adjust (or remove) prohibiting LLD filters for {#UNIT.ACTIVESTATE} and {#UNIT.UNITFILESTATE}.
:::
##### 已禁用 systemd 单元的发现
自Zabbix 6.0.1起，还可以发现已禁用的systemd单元。在这种情况下，
返回的JSON结果中包含三个宏：
- {#UNIT.PATH}
- {#UNIT.ACTIVESTATE}
- {#UNIT.UNITFILESTATE}.
::: noteimportant
要为已禁用的systemd单元创建监控项和触发器原型，请确保调整（或移除）
针对{#UNIT.ACTIVESTATE}和{#UNIT.UNITFILESTATE}的禁止LLD过滤器。
:::
### Discovery of Windows services
[Low-level discovery](/manual/discovery/low_level_discovery) provides a
way to automatically create items, triggers, and graphs for different
entities on a computer. Zabbix can automatically start monitoring
Windows services on your machine, without the need to know the exact
name of a service or create items for each service manually. A filter
can be used to generate real items, triggers, and graphs only for
services of interest.
### Windows 服务发现
[Low-level discovery](/manual/discovery/low_level_discovery) 提供了一种自动create监控项、触发器及图表的方法，用于监控计算机上的不同实体。Zabbix可以自动开始监控您机器上的Windows服务，无需手动了解每个服务的具体名称或create监控项。通过使用过滤器，可以generate仅针对感兴趣的服务生成真实的监控项、触发器及图表。
# discoveryrule.copy
# discoveryrule.copy
# discoveryrule.create
# discoveryrule.create
# discoveryrule.delete
# discoveryrule.delete
# discoveryrule.get
# discoveryrule.get
#### Discovery rule
The discovery rule form contains five tabs, representing, from left to
right, the data flow during discovery:
- *Discovery rule* - specifies, most importantly, the built-in item or
custom script to retrieve discovery data
- *Preprocessing* - applies some preprocessing to the discovered data
- *LLD macros* - allows to extract some macro values to use in
discovered items, triggers, etc
- *Filters* - allows to filter the discovered values
- *Overrides* - allows to modify items, triggers, graphs or host
prototypes when applying to specific discovered objects
The **Discovery rule** tab contains the item key to use for discovery
(as well as some general discovery rule attributes):
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Name*|Name of discovery rule.|
|*Type*|The type of check to perform discovery.<br>In this example we are using a *Zabbix agent* item type.<br>The discovery rule can also be a [dependent item](/manual/config/items/itemtypes/dependent_items), depending on a regular item. It cannot depend on another discovery rule. For a dependent item, select the respective type (*Dependent item*) and specify the master item in the 'Master item' field. The master item must exist.|
|*Key*|Enter the discovery item key (up to 2048 characters).<br>For example, you may use the built-in "vfs.fs.discovery" item key to return a JSON string with the list of file systems present on the computer and their types.<br>Note that another option for filesystem discovery is using discovery results by the "vfs.fs.get" agent key, supported since Zabbix 4.4.5 (see [example](/manual/discovery/low_level_discovery/examples/mounted_filesystems)).|
|*Update interval*|This field specifies how often Zabbix performs discovery. In the beginning, when you are just setting up file system discovery, you might wish to set it to a small interval, but once you know it works you can set it to 30 minutes or more, because file systems usually do not change very often.<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 30s, 1m, 2h, 1d, since Zabbix 3.4.0.<br>[User macros](/manual/config/macros/user_macros) are supported, since Zabbix 3.4.0.<br>*Note*: The update interval can only be set to '0' if custom intervals exist with a non-zero value. If set to '0', and a custom interval (flexible or scheduled) exists with a non-zero value, the item will be polled during the custom interval duration.<br>*Note* that for an existing discovery rule the discovery can be performed immediately by pushing the *Check now* [button](#form_buttons).|
|*Custom intervals*|You can create custom rules for checking the item:<br>**Flexible** - create an exception to the *Update interval* (interval with different frequency)<br>**Scheduling** - create a custom polling schedule.<br>For detailed information see [Custom intervals](/manual/config/items/item/custom_intervals). Scheduling is supported since Zabbix 3.0.0.|
|*Keep lost resources period*|This field allows you to specify the duration for how long the discovered entity will be retained (won't be deleted) once its discovery status becomes "Not discovered anymore" (between 1 hour to 25 years; or "0").<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 2h, 1d, since Zabbix 3.4.0.<br>[User macros](/manual/config/macros/user_macros) are supported, since Zabbix 3.4.0.<br>*Note:* If set to "0", entities will be deleted immediately. Using "0" is not recommended, since just wrongly editing the filter may end up in the entity being deleted with all the historical data.|
|*Description*|Enter a description.|
|*Enabled*|If checked, the rule will be processed.|
::: noteclassic
Discovery rule history is not preserved.
:::
#### 发现规则
发现规则表单包含五个标签页，从左至右分别代表发现过程中的数据流：
- *发现规则* - 最重要的是指定用于获取发现数据的内置监控项或自定义脚本
- *预处理* - 对发现的数据应用预处理
- *LLD宏* - 允许提取某些宏值用于发现的监控项、触发器等
- *过滤器* - 允许筛选发现的值
- *覆盖* - 允许修改监控项、触发器、图形或主机
prototypes when applying to specific discovered objects
**发现规则**标签页包含用于发现的监控项键（以及一些常规发现规则属性）：
所有必填字段均以红色星号标记。
| 参数 | 描述 |
|--|--------|
| *Name* | 发现规则的名称。 |
| *Type* | 执行发现的检查类型。<br>本例中使用的是*Zabbix agent* 监控项类型。<br>发现规则也可以是[dependent item](/manual/config/items/itemtypes/dependent_items)，取决于常规监控项。它不能依赖另一个发现规则。对于依赖型监控项，需选择相应类型（*依赖型监控项*）并在'主监控项'字段中指定主监控项。主监控项必须存在。 |
| *Key* | 输入发现监控项键（最多2048字符）。<br>例如，可使用内置的"vfs.fs.discovery" 监控项键返回包含计算机上存在的file系统及其类型的JSON string。<br>注意另一种文件系统发现方式是使用自Zabbix 4.4.5起支持的"vfs.fs.get" agent键的发现结果（参见[example](/manual/discovery/low_level_discovery/examples/mounted_filesystems)）。 |
| *Update interval* | 该字段指定Zabbix执行发现的频率。初始设置file系统发现时，可设为较小间隔，确认工作正常后可设为30分钟或更长，因为file系统通常不会频繁变化。<br>自Zabbix 3.4.0起支持[Time suffixes](/manual/appendix/suffixes)，如30s、1m、2h、1d。<br>自Zabbix 3.4.0起支持[User macros](/manual/config/macros/user_macros)。<br>*注意*：仅当存在非零值的自定义间隔时，update间隔才能设为'0'。若设为'0'且存在非零值的自定义间隔（弹性或计划），将在自定义间隔期间轮询监控项。<br>*注意*对于现有发现规则，可通过点击*立即检查*[按钮](#form_buttons)立即执行发现。 |
| *Custom intervals* | 可为监控项检查create自定义规则：<br>**弹性** - 为*更新间隔*create例外（不同频率的间隔）<br>**调度** - create自定义轮询计划。<br>详情参见[Custom intervals](/manual/config/items/item/custom_intervals)。自Zabbix 3.0.0起支持调度。 |
| *Keep lost resources period* | 该字段可指定发现实体状态变为"不再被发现"后的保留时长（1小时至25年；或"0"）。<br>自Zabbix 3.4.0起支持[Time suffixes](/manual/appendix/suffixes)，如2h、1d。<br>自Zabbix 3.4.0起支持[User macros](/manual/config/macros/user_macros)。<br>*注意*：若设为"0"，实体将立即删除。不建议使用"0"，因为仅错误编辑过滤器就可能导致实体及其历史数据被删除。 |
| *Description* | 输入描述。 |
| *Enabled* | 勾选后规则将被处理。 |
::: noteclassic
发现规则历史不被保留。
:::
### Discovery rule
The discovery rule object defines a network discovery rule. It has the
following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|druleid|string|*(readonly)* ID of the discovery rule.|
|**iprange**<br>(required)|string|One or several IP ranges to check separated by commas.<br><br>Refer to the [network discovery configuration](/manual/discovery/network_discovery/rule) section for more information on supported formats of IP ranges.|
|**name**<br>(required)|string|Name of the discovery rule.|
|delay|string|Execution interval of the discovery rule. Accepts seconds, time unit with suffix and user macro.<br><br>Default: 1h.|
|nextcheck|timestamp|*(readonly)* Time when the discovery rule will be executed next.|
|proxy\_hostid|string|ID of the proxy used for discovery.|
|status|integer|Whether the discovery rule is enabled.<br><br>Possible values:<br>0 - *(default)* enabled;<br>1 - disabled.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 发现规则
发现规则object定义了网络发现规则. 它具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| druleid | string | *(只读)* 发现规则的ID. |
| **iprange**<br>(required) | string | 要检查的一个或多个IP范围, 用逗号分隔.<br><br>有关支持的IP范围格式的更多信息, 请参阅[network discovery configuration](/manual/discovery/network_discovery/rule)部分. |
| **name**<br>(required) | string | 发现规则的名称. |
| delay | string | 发现规则的执行间隔. 接受秒数, 带后缀的时间单位和用户宏.<br><br>默认值: 1h. |
| nextcheck | timestamp | *(只读)* 发现规则下次执行的时间. |
| proxy\_hostid | string | 用于发现的proxy的ID. |
| status | integer | 发现规则是否启用.<br><br>可能的值:<br>0 - *(默认)* 启用;<br>1 - 禁用. |
请注意, 对于某些方法(update, delete), 所需/可选参数的组合是不同的.
# discoveryrule.update
# discoveryrule.update
#### Discovery
Zabbix can use a low-level discovery rule to automatically discover
VMware hypervisors and virtual machines.
All mandatory input fields are marked with a red asterisk.
The discovery rule key in the above screenshot is
*vmware.hv.discovery\[{$VMWARE.URL}\]*.
#### 发现
Zabbix可以通过低级发现规则自动发现
VMware 虚拟机监控程序与虚拟机。
所有必填字段均以红色星号标记。
上述截图中的发现规则键值为
*vmware.hv.discovery\[{$VMWARE.URL}\]*.
#### Discovery
Zabbix periodically scans the IP ranges defined in [network discovery
rules](/manual/discovery/network_discovery/rule). The frequency of the
check is configurable for each rule individually.
Note that one discovery rule will always be processed by a single
discoverer process. The IP range will not be split between multiple
discoverer processes.
Each rule has a set of service checks defined to be performed for the IP
range.
::: noteclassic
Discovery checks are processed independently from the other
checks. If any checks do not find a service (or fail), other checks will
still be processed.
:::
Every check of a service and a host (IP) performed by the network
discovery module generates a discovery event.
|Event|Check of service result|
|--|--------|
|*Service Discovered*|The service is 'up' after it was 'down' or when discovered for the first time.|
|*Service Up*|The service is 'up', after it was already 'up'.|
|*Service Lost*|The service is 'down' after it was 'up'.|
|*Service Down*|The service is 'down', after it was already 'down'.|
|*Host Discovered*|At least one service of a host is 'up' after all services of that host were 'down' or a service is discovered which belongs to a not registered host.|
|*Host Up*|At least one service of a host is 'up', after at least one service was already 'up'.|
|*Host Lost*|All services of a host are 'down' after at least one was 'up'.|
|*Host Down*|All services of a host are 'down', after they were already 'down'.|
#### 发现
Zabbix定期扫描[network discovery
rules](/manual/discovery/network_discovery/rule)中定义的IP范围。扫描的
每个规则可单独配置检查项。
请注意，单个发现规则始终由单一进程处理
发现器进程。IP范围不会在多个进程之间分割。
发现器进程
每个规则都定义了一组要针对IP执行的服务检查
范围
::: noteclassic
发现检查与其他处理过程相互独立
检查。如果任何检查未找到服务（或失败），其他检查将
仍需处理。
:::
每次网络执行的一个主机（IP）和服务检查
发现模块生成一个发现事件。
| 事件 | 服务结果检查 |
|--|--------|
| *服务已发现* | 服务在从'宕机'状态恢复后或首次被发现时处于'运行'状态。 |
| *服务运行中* | 服务状态为'运行中'，此前已处于'运行中'状态。 |
| *服务丢失* | 服务从'运行'状态变为'停止'状态。 |
| *服务宕机* | 服务已处于'宕机'状态后再次出现'宕机'。 |
| *主机 已发现* | 当某个主机的所有服务均处于'down'状态后，至少有一个一个主机服务恢复为'up'，或发现属于未注册主机的服务时触发。 |
| *主机 运行中* | 当至少一个一个主机服务状态为'运行中'，且此前已有至少一个服务处于'运行中'状态时触发。 |
| *主机 丢失* | 在至少一个服务处于'运行'状态后，一个主机的所有服务均变为'停止'状态。 |
| *主机 宕机* | 一个主机 的所有服务在已处于'宕机'状态后再次出现'宕机' |
#### Display
#### 显示
#### Display
Based on acknowledgment information it is possible to configure how the
problem count is displayed in the dashboard or maps. To do that, you
have to make selections in the *Problem display* option, available in
both [map
configuration](/manual/config/visualization/maps/map#creating_a_map) and
the *Problems by severity* [dashboard
widget](/manual/web_interface/frontend_sections/monitoring/dashboard##adding_widgets).
It is possible to display all problem count, unacknowledged problem
count as separated from the total or unacknowledged problem count only.
Based on problem update information (acknowledgment, etc.), it is
possible to configure update operations - send a message or execute
remote commands.
#### 显示
基于确认信息，可以配置仪表板或地图中如何显示问题计数。为此，您需要在*问题显示*选项中进行选择，该选项在[创建地图](/manual/config/visualization/maps/map#创建地图)和*按严重程度分类的问题*[仪表板部件](/manual/web_interface/frontend_sections/monitoring/dashboard##adding_widgets)中均可使用。可以选择显示所有问题计数、未确认问题计数（与总数分开显示）或仅显示未确认问题计数。
基于问题update信息（确认状态等），可以配置update操作 - 发送消息或execute远程命令。
##### Displaying hosts in maintenance
An orange wrench icon
next to the host name indicates that this host is in maintenance in:
- *Monitoring → Dashboard*
- *Monitoring → Problems*
- *Inventory → Hosts → Host inventory details*
- *Configuration → Hosts* (See 'Status' column)
Maintenance details are displayed when the mouse pointer is positioned
over the icon.
Additionally, hosts in maintenance get an orange background in
*Monitoring → Maps*.
##### 显示处于维护模式的主机
一个橙色扳手图标
在主机名称旁边表示此主机处于维护状态于:
- *监控 → 仪表板*
- *监控 → 问题*
- *资产清单 → 主机 → 主机 资产详情*
- *配置 → 主机* (参见 '状态' 列)
当鼠标指针悬停时显示维护详情
图标上方。
此外，主机在维护get中显示橙色背景
*监控 → 地图*
##### Displaying suppressed problems
Normally problems for hosts in maintenance are suppressed, i.e. not
displayed in the frontend. However, it is also possible to configure
that suppressed problems are shown, by selecting the *Show suppressed
problems* option in these locations:
- *Monitoring* → *Dashboard* (in *Problem hosts*, *Problems*,
*Problems by severity*, *Trigger overview* widget configuration)
- *Monitoring* → *Problems* (in the filter)
- *Monitoring* → *Maps* (in map configuration)
- Global
[notifications](/manual/web_interface/user_profile/global_notifications)
(in user profile configuration)
When suppressed problems are displayed, the following icon is displayed:
. Rolling a
mouse over the icon displays more details:
##### 显示被抑制的问题
通常维护期间的主机问题会被抑制，即不会在前端显示。但也可以通过在这些位置选择*显示被抑制的问题*选项来配置显示被抑制的问题：
- *监控* → *仪表板* (在*问题主机*、*问题*、*按严重程度分类的问题*、*触发器概览*小部件配置中)
- *监控* → *问题* (在过滤器中)
- *监控* → *地图* (在地图配置中)
- 全局
[notifications](/manual/web_interface/user_profile/global_notifications)
(in user profile configuration)
当显示被抑制的问题时，会显示以下图标：。将鼠标悬停在图标上会显示更多详细信息：
#### Displaying trigger status
With a trigger defined, you might be interested to see its status.
If the CPU load has exceeded the threshold level you defined in the
trigger, the problem will be displayed in *Monitoring → Problems*.
{width="600"}
The flashing in the status column indicates a recent change of trigger
status, one that has taken place in the last 30 minutes.
#### 显示触发器状态
定义触发器后，您可能想查看其状态。
如果CPU负载超过您在触发器中定义的阈值水平，
问题将显示在*监控 → 问题*中。
{width="600"}
状态列中的闪烁表示触发器状态最近发生了变化，
这种变化发生在过去30分钟内。
##### Display
In the item list dependent items are displayed with their master item
name as prefix.
{width="600"}
If a master item is deleted, so are all its dependent items.
##### 显示
在监控项列表中，依赖的监控项会显示其主监控项名称作为前缀。
{width="600"}
如果主监控项被删除，其所有依赖的监控项也将被删除。
#### Display options
The following parameters are supported for configuring *Display options*.
|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|*History data selection*|0|source|0 - *(default)* Auto;<br>1 - History;<br>2 - Trends.|
#### 显示选项
以下参数可用于配置*显示选项*。
| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| *History data selection* | 0 | source | 0 - *(默认)* 自动;<br>1 - 历史记录;<br>2 - 趋势数据. |
#### Display
The following screen will be displayed when trying to access the Zabbix
frontend while in maintenance mode. The screen is refreshed every 30
seconds in order to return to a normal state without user intervention
when the maintenance is over.
IP addresses defined in ZBX\_GUI\_ACCESS\_IP\_RANGE will be able to
access the frontend as always.
#### 显示
当处于维护模式时尝试访问Zabbix前端将显示以下界面。该界面每30秒自动刷新一次，以便在维护结束后无需用户干预即可恢复正常状态。
在ZBX\_GUI\_ACCESS\_IP\_RANGE中定义的IP地址将始终能够正常访问前端。
##### Display
This is the result in *Monitoring → Latest data*:
{width="600"}
Note that if a single numeric value is sent in, the data graph will show
a horizontal line to the left and to the right of the time point of the
value.
##### 显示
这是在*监控 → 最新数据*中的显示结果:
{width="600"}
请注意 如果传入的是单个数值 数据图表会在该数值时间点的左右两侧显示一条水平线
#### Display
To view web scenarios configured for a host, go to *Monitoring → Hosts*,
locate the host in the list and click on the *Web* hyperlink in the last
column. Click on the scenario name to get detailed information.
{width="600"}
An overview of web scenarios can also be displayed in *Monitoring →
Dashboard* by a Web monitoring widget.
Recent results of the web scenario execution are available in the
*Monitoring → Latest data* section.
#### 显示
要查看为一个主机配置的Web场景，请前往*Monitoring → 主机*，
在列表中找到主机并点击最后一列的*Web*超链接。点击场景名称可get详细信息。
{width="600"}
Web场景的概览也可通过Web监控小部件在*Monitoring → Dashboard*中显示。
Web场景执行的最新结果可在*Monitoring → Latest data*部分查看。
#### Docker base images
Zabbix components are provided on Ubuntu, Alpine Linux and CentOS base
images:
|Image|Version|
|---|---|
|[alpine](https://hub.docker.com/_/alpine/)|3.16|
|[ubuntu](https://hub.docker.com/_/ubuntu/)|22.04 (jammy)|
|[centos](https://hub.docker.com/_/centos/)|8|
All images are configured to rebuild latest images if base images are
updated.
#### Docker 基础镜像
Zabbix组件提供基于Ubuntu、Alpine Linux和CentOS的基础镜像：
| 镜像 | 版本 |
|---|---|
| [alpine](https://hub.docker.com/_/alpine/) | 3.16 |
| [ubuntu](https://hub.docker.com/_/ubuntu/) | 22.04 (jammy) |
| [centos](https://hub.docker.com/_/centos/) | 8 |
所有镜像都配置为在基础镜像更新时自动重建最新镜像。
### Docker Compose
Zabbix provides compose files also for defining and running
multi-container Zabbix components in Docker. These compose files are
available in Zabbix docker official repository on github.com:
<https://github.com/zabbix/zabbix-docker>. These compose files are added
as examples, they are overloaded. For example, they contain proxies with
MySQL and SQLite3 support.
There are a few different versions of compose files:
|File name|Description|
|--|--------|
|`docker-compose_v3_alpine_mysql_latest.yaml`|The compose file runs the latest version of Zabbix 6.0 components on Alpine Linux with MySQL database support.|
|`docker-compose_v3_alpine_mysql_local.yaml`|The compose file locally builds the latest version of Zabbix 6.0 and runs Zabbix components on Alpine Linux with MySQL database support.|
|`docker-compose_v3_alpine_pgsql_latest.yaml`|The compose file runs the latest version of Zabbix 6.0 components on Alpine Linux with PostgreSQL database support.|
|`docker-compose_v3_alpine_pgsql_local.yaml`|The compose file locally builds the latest version of Zabbix 6.0 and runs Zabbix components on Alpine Linux with PostgreSQL database support.|
|`docker-compose_v3_centos_mysql_latest.yaml`|The compose file runs the latest version of Zabbix 6.0 components on CentOS 8 with MySQL database support.|
|`docker-compose_v3_centos_mysql_local.yaml`|The compose file locally builds the latest version of Zabbix 6.0 and runs Zabbix components on CentOS 8 with MySQL database support.|
|`docker-compose_v3_centos_pgsql_latest.yaml`|The compose file runs the latest version of Zabbix 6.0 components on CentOS 8 with PostgreSQL database support.|
|`docker-compose_v3_centos_pgsql_local.yaml`|The compose file locally builds the latest version of Zabbix 6.0 and runs Zabbix components on CentOS 8 with PostgreSQL database support.|
|`docker-compose_v3_ubuntu_mysql_latest.yaml`|The compose file runs the latest version of Zabbix 6.0 components on Ubuntu 20.04 with MySQL database support.|
|`docker-compose_v3_ubuntu_mysql_local.yaml`|The compose file locally builds the latest version of Zabbix 6.0 and runs Zabbix components on Ubuntu 20.04 with MySQL database support.|
|`docker-compose_v3_ubuntu_pgsql_latest.yaml`|The compose file runs the latest version of Zabbix 6.0 components on Ubuntu 20.04 with PostgreSQL database support.|
|`docker-compose_v3_ubuntu_pgsql_local.yaml`|The compose file locally builds the latest version of Zabbix 6.0 and runs Zabbix components on Ubuntu 20.04 with PostgreSQL database support.|
::: noteimportant
Available Docker compose files support version 3
of Docker Compose.
:::
### Docker Compose
Zabbix 还提供了用于在Docker中定义和运行多容器Zabbix组件的compose文件。这些compose文件可在github.com上的Zabbix官方docker仓库获取：
<https://github.com/zabbix/zabbix-docker>。这些compose文件作为示例提供，它们是经过重载的。例如，它们包含同时支持MySQL和SQLite3的proxies。
存在几种不同版本的compose文件：
| 文件名 | 描述 |
|--|--------|
| `docker-compose_v3_alpine_mysql_latest.yaml` | 该composefile在Alpine Linux上运行支持MySQL数据库的Zabbix 6.0组件最新version。 |
| `docker-compose_v3_alpine_mysql_local.yaml` | 该composefile本地构建Zabbix 6.0最新version并在Alpine Linux上运行支持MySQL数据库的Zabbix组件。 |
| `docker-compose_v3_alpine_pgsql_latest.yaml` | 该composefile在Alpine Linux上运行支持PostgreSQL数据库的Zabbix 6.0组件最新version。 |
| `docker-compose_v3_alpine_pgsql_local.yaml` | 该composefile本地构建Zabbix 6.0最新version并在Alpine Linux上运行支持PostgreSQL数据库的Zabbix组件。 |
| `docker-compose_v3_centos_mysql_latest.yaml` | 该composefile在CentOS 8上运行支持MySQL数据库的Zabbix 6.0组件最新version。 |
| `docker-compose_v3_centos_mysql_local.yaml` | 该composefile本地构建Zabbix 6.0最新version并在CentOS 8上运行支持MySQL数据库的Zabbix组件。 |
| `docker-compose_v3_centos_pgsql_latest.yaml` | 该composefile在CentOS 8上运行支持PostgreSQL数据库的Zabbix 6.0组件最新version。 |
| `docker-compose_v3_centos_pgsql_local.yaml` | 该composefile本地构建Zabbix 6.0最新version并在CentOS 8上运行支持PostgreSQL数据库的Zabbix组件。 |
| `docker-compose_v3_ubuntu_mysql_latest.yaml` | 该composefile在Ubuntu 20.04上运行支持MySQL数据库的Zabbix 6.0组件最新version。 |
| `docker-compose_v3_ubuntu_mysql_local.yaml` | 该composefile本地构建Zabbix 6.0最新version并在Ubuntu 20.04上运行支持MySQL数据库的Zabbix组件。 |
| `docker-compose_v3_ubuntu_pgsql_latest.yaml` | 该composefile在Ubuntu 20.04上运行支持PostgreSQL数据库的Zabbix 6.0组件最新version。 |
| `docker-compose_v3_ubuntu_pgsql_local.yaml` | 该composefile本地构建Zabbix 6.0最新version并在Ubuntu 20.04上运行支持PostgreSQL数据库的Zabbix组件。 |
::: noteimportant
可用的Docker compose文件支持Docker Compose的version 3版本。
:::
#### Docker file sources
Everyone can follow Docker file changes using the Zabbix [official
repository](https://github.com/zabbix/zabbix-docker) on
[github.com](https://github.com/). You can fork the project or make your
own images based on official Docker files.
#### Docker 文件源
任何人都可以通过Zabbix [official
repository](https://github.com/zabbix/zabbix-docker)在[github.com](https://github.com/)上追踪Docker file的变更。您可以fork该项目或基于官方Docker文件构建自己的镜像。
### Docker
|Key|<|<|<|
|--|--|------|------|
|**Description**|**Return value**|**Parameters**|**Comments**|
|docker.container\_info\[<ID>,<info>\]|<|<|<|
|Low-level information about a container.|An output of the [ContainerInspect](https://docs.docker.com/engine/api/v1.28/#operation/ContainerInspect) API call serialized as JSON|**ID** - ID or name of the container.<br>**info** - the amount of information returned. Supported values: *short* (default) or *full*.|The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.container\_stats\[<ID>\]|<|<|<|
|Container resource usage statistics.|An output of the [ContainerStats](https://docs.docker.com/engine/api/v1.28/#operation/ContainerStats) API call and CPU usage percentage serialized as JSON|**ID** - ID or name of the container.| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.containers|<|<|<|
|A list of containers.|An output of the [ContainerList](https://docs.docker.com/engine/api/v1.28/#operation/ContainerList) API call serialized as JSON|\-| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.containers.discovery\[<options>\]|<|<|<|
|A list of containers. Used for [low-level discovery](/manual/discovery/low_level_discovery/).|JSON object |**options** - specifies whether all or only running containers should be discovered. Supported values:<br>*true* - return all containers;<br>*false* - return only running containers (default).| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.data\_usage|<|<|<|
|Information about current data usage.|An output of the [SystemDataUsage](https://docs.docker.com/engine/api/v1.28/#operation/SystemDataUsage) API call serialized as JSON|\-| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.images|<|<|<|
|A list of images.|An output of the [ImageList](https://docs.docker.com/engine/api/v1.28/#operation/ImageList) API call serialized as JSON|\-| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.images.discovery|<|<|<|
|A list of images. Used for [low-level discovery](/manual/discovery/low_level_discovery/).|JSON object |\-| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.info|<|<|<|
|System information.|An output of the [SystemInfo](https://docs.docker.com/engine/api/v1.28/#operation/SystemInfo) API call serialized as JSON|\-| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.ping|<|<|<|
|Test if a Docker daemon is alive or not.|1 - connection is alive<br><br>0 - connection is broken|\-| The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
### Docker
| 键 | < | < | < |
|--|--|------|------|
| **描述** | **返回值** | **参数** | **备注** |
| docker.container\_info\[<ID>,<info>\] | < | < | < |
| 关于容器的底层信息 | [ContainerInspect](https://docs.docker.com/engine/api/v1.28/#operation/ContainerInspect) API 调用序列化为JSON的输出 | **ID** - 容器的ID或名称。<br>**info** - 返回的信息量。支持的值：*short*（默认）或*full*。 | Agent2 用户('zabbix')必须被添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) 以获得足够的权限。否则检查将失败。 |
| docker.container\_stats\[<ID>\] | < | < | < |
| 容器资源使用统计 | [ContainerStats](https://docs.docker.com/engine/api/v1.28/#operation/ContainerStats) API 调用输出及CPU使用百分比序列化为JSON | **ID** - 容器的ID或名称 | Agent2 用户('zabbix')必须被添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) 组以获得足够权限，否则检查将失败 |
| docker.containers | < | < | < |
| 容器列表 | [ContainerList](https://docs.docker.com/engine/api/v1.28/#operation/ContainerList) API 调用输出的JSON序列化结果 | \- | 必须将 Agent2 用户('zabbix')添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) 组以获得足够权限，否则检查将失败 |
| docker.containers.discovery\[<options>\] | < | < | < |
| 容器列表。用于[low-level discovery](/manual/discovery/low_level_discovery/)。 | JSON object | **options** - 指定应发现所有容器还是仅发现运行中的容器。支持的取值：<br>*true* - 返回所有容器；<br>*false* - 仅返回运行中的容器（默认值）。 | Agent2用户('zabbix')必须被添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)中以获取足够权限。否则检查将失败。 |
| docker.data_usage | < | < | < |
| 当前数据使用情况的信息。 | [SystemDataUsage](https://docs.docker.com/engine/api/v1.28/#operation/SystemDataUsage) API 调用输出的JSON序列化数据 | \- | 必须将 Agent2 用户('zabbix')添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) 组以获得足够权限，否则检查将失败。 |
| docker.images | < | < | < |
| 镜像列表 | [ImageList](https://docs.docker.com/engine/api/v1.28/#operation/ImageList) API 调用输出的JSON序列化结果 | \- | 必须将 Agent2 用户('zabbix')添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) 组以获得足够权限，否则检查将失败 |
| docker.images.discovery | < | < | < |
| 图片列表。用于[low-level discovery](/manual/discovery/low_level_discovery/)。 | JSON object | \- | 必须将Agent2用户('zabbix')添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)组以获得足够权限。否则检查将失败。 |
| docker.info | < | < | < |
| 系统信息 | 将[SystemInfo](https://docs.docker.com/engine/api/v1.28/#operation/SystemInfo) API调用序列化为JSON的输出 | \- | 必须将Agent2用户('zabbix')添加到'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)组以获得足够权限，否则检查将失败 |
| docker.ping | < | < | < |
测试Docker守护进程是否存活 | 1 - 连接存活<br><br>0 - 连接中断 | \- | Agent2用户('zabbix')必须被添加到'docker'[group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)组以获得足够权限，否则检查将失败。
# drule.create
# drule.create
# drule.delete
# drule.delete
# drule.get
# drule.get
# drule.update
# drule.update
# dservice.get
# dservice.get
#### Dynamic widgets
When
[configuring](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)
some of the widgets:
- Classic graph
- Graph prototype
- Item value
- Plain text
- URL
there is an extra option called *Dynamic item*. You can check this box
to make the widget dynamic - i.e. capable of displaying different
content based on the selected host.
Now, when saving the dashboard, you will notice that a new host
selection field has appeared atop the dashboard for selecting the host
(while the *Select* button allows selecting the host group in a popup):
Thus you have a widget, which can display content that is based on the
data from the host that is selected. The benefit of this is that you do
not need to create extra widgets just because, for example, you want to
see the same graphs containing data from various hosts.
#### 动态部件
当使用
[configuring](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)
以下部分小部件时:
- 经典图形
- 图形原型
- 监控项 值
- 纯文本
- URL
会出现一个名为*动态监控项*的额外选项。勾选此框可使小部件变为动态 - 即能够根据所选主机显示不同内容。
保存仪表板时，您会注意到仪表板顶部出现了一个新的主机选择字段用于选择主机(而*选择*按钮允许在弹出窗口中选择主机组):
这样您就获得了一个能根据所选主机数据显示内容的小部件。这样做的好处是您无需create额外小部件，例如当您需要查看包含来自不同主机数据的相同图形时。
#### Easy Connect
Easy Connect uses the following parameters to connect to the database:
- *Host* - the host name or IP address of the database server computer
(DBHost parameter in the configuration file).
- *Port* - the listening port on the database server (DBPort parameter
in the configuration file; if not set the default 1521 port will be
used).
- <service\_name> - the service name of the database you want to
access (DBName parameter in the configuration file).
**Example:**
Database parameters set in the server or proxy configuration file
(zabbix\_server.conf and zabbix\_proxy.conf):
DBHost=localhost
DBPort=1521
DBUser=myusername
DBName=ORCL
DBPassword=mypassword
Connection string used by Zabbix to establish connection:
DBUser/DBPassword@DBHost:DBPort/DBName
During Zabbix frontend installation, set the corresponding parameters in
the *Configure DB connection* step of the setup wizard:
- Database host: localhost
- Database port: 1521
- Database name: ORCL
- User: myusername
- Password: mypassword
{width="600"}
Alternatively, these parameters can be set in the frontend configuration
file (zabbix.conf.php):
$DB["TYPE"] = 'ORACLE';
$DB["SERVER"] = 'localhost';
$DB["PORT"] = '1521';
$DB["DATABASE"] = 'ORCL';
$DB["USER"] = 'myusername';
$DB["PASSWORD"] = 'mypassword';
#### Easy Connect
Easy Connect 使用以下参数连接到数据库:
- *主机* - 数据库服务器计算机的主机名称或IP地址
(配置中的DBHost参数file)。
- *Port* - 数据库服务器上的监听端口（DBPort参数）
在配置 file 中；如果未设置，将使用默认的1521端口
已使用).
- <service\_name> - 您想要连接的数据库服务名称
access (DBName parameter in the configuration file).
**示例:**
在server 或 proxy配置file中设置的数据库参数
(zabbix\_server.conf 和 zabbix\_proxy.conf):
DBHost=localhost
DBPort=1521
DBUser=myusername
DBName=ORCL
DBPassword=mypassword
Zabbix用于建立连接的连接string
DBUser/DBPassword@DBHost:DBPort/DBName
在Zabbix前端安装过程中，设置相应的参数
安装向导中的*配置数据库连接*步骤:
- 数据库 主机: localhost
- 数据库端口: 1521
- 数据库名称: ORCL
- 用户: myusername
- Password: mypassword
{width="600"}
或者，这些参数可以在前端配置中设置
file (zabbix.conf.php):
$DB["TYPE"] = 'oracle数据库';
$DB["SERVER"] = 'localhost';
$DB["PORT"] = '1521';
$DB["DATABASE"] = 'ORCL';
$DB["USER"] = 'myusername';
$DB["PASSWORD"] = 'mypassword';
##### Editing linked entities
If you try to edit an item or trigger that was linked from the template,
you may realize that many key options are disabled for editing. This
makes sense as the idea of templates is that things are edited in
one-touch manner on the template level. However, you still can, for
example, enable/disable an item on the individual host and set the
update interval, history length and some other parameters.
::: noteimportant
Any customizations to the entities implemented on a template-level will override the previous customizations of the
entities on a host-level.
:::
If you want to edit the entity fully, you have to edit it on the
template level (template level shortcut is displayed in the form name),
keeping in mind that these changes will affect all hosts that have this
template linked to them.
##### 编辑关联实体
如果您尝试编辑从模板链接的监控项或触发器，
您可能会注意到许多关键选项被禁用了编辑功能。
模板的理念在于其内容可在
在模板级别实现一键式操作。不过，您仍然可以，
例如，在单个主机上启用/禁用监控项并设置
update 间隔、历史记录长度及其他一些参数。
::: noteimportant
在模板级别对实体实施的任何自定义将覆盖先前的自定义
一个主机级别的实体
:::
如果你想完整编辑该实体，必须在
模板级别（模板级别快捷方式以表单名称形式显示）
请记住，这些更改将影响所有具有此功能的主机
链接到它们的模板
### Editing services
Click on the *Edit* button to access the edit mode. When in edit mode, the listing
is complemented with checkboxes before the entries and also these additional options:
-  -
add a child service to this service
-  -
edit this service
-  -
delete this service
{width="600"}
To [configure](/manual/it_services/service_tree#service-configuration) a new service, click on the
*Create service* button in the top right-hand corner.
### 编辑服务
点击 *编辑* 按钮进入编辑模式。在编辑模式下，列表条目前会显示复选框，并增加以下选项：
-  -
为此服务添加子服务
-  -
编辑此服务
-  -
delete this service
{width="600"}
要[服务配置](/manual/it_services/service_tree#服务配置)新服务，请点击Top右上角的*创建服务*按钮。
### Editing services
Click on the *Edit* button to access the edit mode. When in edit mode, the listing
is complemented with checkboxes before the entries and also these additional options:
-  -
add a child service to this service
-  -
edit this service
-  -
delete this service
{width="600"}
To [configure](#service_configuration) a new service, click on the
*Create service* button in the top right-hand corner.
Two buttons below the list offer some mass-editing options:
- *Mass update* - mass update service properties
- *Delete* - delete the services
To use these options, mark the checkboxes before the respective
services, then click on the required button.
### 编辑服务
点击*编辑*按钮访问编辑模式。 在编辑模式下，列表会在条目前加上复选框，以及以下附加选项：
-  -
将子服务添加到此服务
-  -
编辑此服务
-  -
删除此服务
{width="600"}
要[配置](/manual/it_services/service) 新服务，请点击右上角的*创建服务*按钮。
##### Element configuration
##### 元素配置
#### Element tags
Element tag values are explained in the table below.
#### 元素标签
元素标签值在下表中进行说明。
#### Element tags
Element tag values are explained in the table below.
#### 元素标签
元素标签值在下表中进行说明。
#### Element tags
Element tag values are explained in the table below.
|Element|Element property|Required|Type|Range^**[1](#footnotes)**^|Description|
|--|--|-|--|----|--------|
|media\_types| |\-| | |Root element for media\_types.|
| |name|x|`string`| |Media type name.|
| |type|x|`string`|0 - EMAIL<br>1 - SMS<br>2 - SCRIPT<br>4 - WEBHOOK|Transport used by the media type.|
| |status|\-|`string`|0 - ENABLED (default)<br>1 - DISABLED|Whether the media type is enabled.|
| |max\_sessions|\-|`integer`|Possible values for SMS: 1 - (default)<br><br>Possible values for other media types: 0-100, 0 - unlimited|The maximum number of alerts that can be processed in parallel.|
| |attempts|\-|`integer`|1-10 (default: 3)|The maximum number of attempts to send an alert.|
| |attempt\_interval|\-|`string`|0-60s (default: 10s)|The interval between retry attempts.<br><br>Accepts seconds and time unit with suffix.|
| |description|\-|`string`| |Media type description.|
|message\_templates| |\-| | |Root element for media type message templates.|
| |event\_source|x|`string`|0 - TRIGGERS<br>1 - DISCOVERY<br>2 - AUTOREGISTRATION<br>3 - INTERNAL<br>4 - SERVICE|Event source.|
| |operation\_mode|x|`string`|0 - PROBLEM<br>1 - RECOVERY<br>2 - UPDATE|Operation mode.|
| |subject|\-|`string`| |Message subject.|
| |message|\-|`string`| |Message body.|
|*Used only by email media type*|<|<|<|<|<|
| |smtp\_server|x|`string`| |SMTP server.|
| |smtp\_port|\-|`integer`|Default: 25|SMTP server port to connect to.|
| |smtp\_helo|x|`string`| |SMTP helo.|
| |smtp\_email|x|`string`| |Email address from which notifications will be sent.|
| |smtp\_security|\-|`string`|0 - NONE (default)<br>1 - STARTTLS<br>2 - SSL\_OR\_TLS|SMTP connection security level to use.|
| |smtp\_verify\_host|\-|`string`|0 - NO (default)<br>1 - YES|SSL verify host for SMTP. Optional if smtp\_security is STARTTLS or SSL\_OR\_TLS.|
| |smtp\_verify\_peer|\-|`string`|0 - NO (default)<br>1 - YES|SSL verify peer for SMTP. Optional if smtp\_security is STARTTLS or SSL\_OR\_TLS.|
| |smtp\_authentication|\-|`string`|0 - NONE (default)<br>1 - PASSWORD|SMTP authentication method to use.|
| |username|\-|`string`| |Username.|
| |password|\-|`string`| |Authentication password.|
| |content\_type|\-|`string`|0 - TEXT<br>1 - HTML (default)|Message format.|
|*Used only by SMS media type*|<|<|<|<|<|
| |gsm\_modem|x|`string`| |Serial device name of the GSM modem.|
|*Used only by script media type*|<|<|<|<|<|
| |script name|x|`string`| |Script name.|
|parameters| |\-| | |Root element for script parameters.|
|*Used only by webhook media type*|<|<|<|<|<|
| |script|x|`string`| |Script.|
| |timeout|\-|`string`|1-60s (default: 30s)|Javascript script HTTP request timeout interval.|
| |process\_tags|\-|`string`|0 - NO (default)<br>1 - YES|Whether to process returned tags.|
| |show\_event\_menu|\-|`string`|0 - NO (default)<br>1 - YES|If {EVENT.TAGS.\*} were successfully resolved in event\_menu\_url and event\_menu\_name fields, this field indicates presence of entry in the event menu.|
| |event\_menu\_url|\-|`string`| |URL of the event menu entry. Supports {EVENT.TAGS.\*} macro.|
| |event\_menu\_name|\-|`string`| |Name of the event menu entry. Supports {EVENT.TAGS.\*} macro.|
|parameters| |\-| | |Root element for webhook media type parameters.|
| |name|x|`string`| |Webhook parameter name.|
| |value|\-|`string`| |Webhook parameter value.|
#### 元素标签
元素标签值在下表中进行说明。
| 元素 | 元素属性 | 必填 | 类型 | 范围^**[1](#footnotes)**^ | 描述 |
|--|--|-|--|----|--------|
| media\_types | | \- | | | 媒体类型的根元素。 |
| | name | x | `string` | | 媒体类型名称。 |
| | type | x | `string` | 0 - EMAIL<br>1 - SMS<br>2 - SCRIPT<br>4 - WEBHOOK | 媒体类型使用的传输方式。 |
| | status | \- | `string` | 0 - ENABLED (default)<br>1 - DISABLED | 媒体类型是否启用。 |
| | max\_sessions | \- | `integer` | Possible values for SMS: 1 - (default)<br><br>Possible values for other media types: 0-100, 0 - unlimited | 可并行处理的最大告警数量。 |
| | attempts | \- | `integer` | 1-10 (default: 3) | 发送告警的最大尝试次数。 |
| | attempt\_interval | \- | `string` | 0-60s (default: 10s) | 重试尝试之间的间隔。<br><br>接受带后缀的秒数和时间单位。 |
| | description | \- | `string` | | 媒体类型描述。 |
| message\_templates | | \- | | | 媒体类型消息模板的根元素。 |
| | event\_source | x | `string` | 0 - TRIGGERS<br>1 - DISCOVERY<br>2 - AUTOREGISTRATION<br>3 - INTERNAL<br>4 - SERVICE | 事件来源。 |
| | operation\_mode | x | `string` | 0 - PROBLEM<br>1 - RECOVERY<br>2 - UPDATE | 操作模式。 |
| | subject | \- | `string` | | 消息主题。 |
| | message | \- | `string` | | 消息正文。 |
| *Used only by email media type* | < | < | < | < | < |
| | smtp\_server | x | `string` | | SMTP服务器。 |
| | smtp\_port | \- | `integer` | Default: 25 | 连接的SMTP服务器端口。 |
| | smtp\_helo | x | `string` | | SMTP helo。 |
| | smtp\_email | x | `string` | | 发送通知的电子邮件地址。 |
| | smtp\_security | \- | `string` | 0 - NONE (default)<br>1 - STARTTLS<br>2 - SSL\_OR\_TLS | 使用的SMTP连接安全级别。 |
| | smtp\_verify\_host | \- | `string` | 0 - NO (default)<br>1 - YES | SMTP的SSL验证主机。如果smtp\_security为STARTTLS或SSL\_OR\_TLS则为可选。 |
| | smtp\_verify\_peer | \- | `string` | 0 - NO (default)<br>1 - YES | SMTP的SSL验证对等端。如果smtp\_security为STARTTLS或SSL\_OR\_TLS则为可选。 |
| | smtp\_authentication | \- | `string` | 0 - NONE (default)<br>1 - PASSWORD | 使用的SMTP认证方法。 |
| | username | \- | `string` | | 用户名。 |
| | password | \- | `string` | | 认证密码。 |
| | content\_type | \- | `string` | 0 - TEXT<br>1 - HTML (default) | 消息格式。 |
| *Used only by SMS media type* | < | < | < | < | < |
| | gsm\_modem | x | `string` | | GSM调制解调器的串行设备名称。 |
| *Used only by script media type* | < | < | < | < | < |
| | script name | x | `string` | | 脚本名称。 |
| parameters | | \- | | | 脚本参数的根元素。 |
| *Used only by webhook media type* | < | < | < | < | < |
| | script | x | `string` | | 脚本。 |
| | timeout | \- | `string` | 1-60s (default: 30s) | Javascript脚本HTTP请求超时间隔。 |
| | process\_tags | \- | `string` | 0 - NO (default)<br>1 - YES | 是否处理返回的标签。 |
| | show\_event\_menu | \- | `string` | 0 - NO (default)<br>1 - YES | 如果{EVENT.TAGS.\*}在event\_menu\_url和event\_menu\_name字段中成功解析，此字段表示事件菜单中是否存在条目。 |
| | event\_menu\_url | \- | `string` | | 事件菜单条目的URL。支持{EVENT.TAGS.\*}宏。 |
| | event\_menu\_name | \- | `string` | | 事件菜单条目的名称。支持{EVENT.TAGS.\*}宏。 |
| parameters | | \- | | | Webhook媒体类型参数的根元素。 |
| | name | x | `string` | | Webhook参数名称。 |
| | value | \- | `string` | | Webhook参数值。 |
#### Element tags
Element tag values are explained in the table below.
|Element|Element property|Type|Range|Description|
|--|--|--|----|--------|
|images| | | |Root element for images.|
| |name|`string`| |Unique image name.|
| |imagetype|`integer`|1 - image<br>2 - background|Image type.|
| |encodedImage| | |Base64 encoded image.|
|maps| | | |Root element for maps.|
| |name|`string`| |Unique map name.|
| |width|`integer`| |Map width, in pixels.|
| |height|`integer`| |Map height, in pixels.|
| |label\_type|`integer`|0 - label<br>1 - host IP address<br>2 - element name<br>3 - status only<br>4 - nothing|Map element label type.|
| |label\_location|`integer`|0 - bottom<br>1 - left<br>2 - right<br>3 - top|Map element label location by default.|
| |highlight|`integer`|0 - no<br>1 - yes|Enable icon highlighting for active triggers and host statuses.|
| |expandproblem|`integer`|0 - no<br>1 - yes|Display problem trigger for elements with a single problem.|
| |markelements|`integer`|0 - no<br>1 - yes|Highlight map elements that have recently changed their status.|
| |show\_unack|`integer`|0 - count of all problems<br>1 - count of unacknowledged problems<br>2 - count of acknowledged and unacknowledged problems separately|Problem display.|
| |severity\_min|`integer`|0 - not classified<br>1 - information<br>2 - warning<br>3 - average<br>4 - high<br>5 - disaster|Minimum trigger severity to show on the map by default.|
| |show\_suppressed|`integer`|0 - no<br>1 - yes|Display problems which would otherwise be suppressed (not shown) because of host maintenance.|
| |grid\_size|`integer`|20, 40, 50, 75 or 100|Cell size of a map grid in pixels, if "grid\_show=1"|
| |grid\_show|`integer`|0 - yes<br>1 - no|Display a grid in map configuration.|
| |grid\_align|`integer`|0 - yes<br>1 - no|Automatically align icons in map configuration.|
| |label\_format|`integer`|0 - no<br>1 - yes|Use advanced label configuration.|
| |label\_type\_host|`integer`|0 - label<br>1 - host IP address<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label|Display as host label, if "label\_format=1"|
| |label\_type\_hostgroup|`integer`|0 - label<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label|Display as host group label, if "label\_format=1"|
| |label\_type\_trigger|`integer`|0 - label<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label|Display as trigger label, if "label\_format=1"|
| |label\_type\_map|`integer`|0 - label<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label|Display as map label, if "label\_format=1"|
| |label\_type\_image|`integer`|0 - label<br>2 - element name<br>4 - nothing<br>5 - custom label|Display as image label, if "label\_format=1"|
| |label\_string\_host|`string`| |Custom label for host elements, if "label\_type\_host=5"|
| |label\_string\_hostgroup|`string`| |Custom label for host group elements, if "label\_type\_hostgroup=5"|
| |label\_string\_trigger|`string`| |Custom label for trigger elements, if "label\_type\_trigger=5"|
| |label\_string\_map|`string`| |Custom label for map elements, if "label\_type\_map=5"|
| |label\_string\_image|`string`| |Custom label for image elements, if "label\_type\_image=5"|
| |expand\_macros|`integer`|0 - no<br>1 - yes|Expand macros in labels in map configuration.|
| |background|`id`| |ID of the background image (if any), if "imagetype=2"|
| |iconmap|`id`| |ID of the icon mapping (if any).|
|urls| | | |Used by maps or each map element.|
| |name|`string`| |Link name.|
| |url|`string`| |Link URL.|
| |elementtype|`integer`|0 - host<br>1 - map<br>2 - trigger<br>3 - host group<br>4 - image|Map item type the link belongs to.|
|selements| | | | |
| |elementtype|`integer`|0 - host<br>1 - map<br>2 - trigger<br>3 - host group<br>4 - image|Map element type.|
| |label|`string`| |Icon label.|
| |label\_location|`integer`|-1 - use map default<br>0 - bottom<br>1 - left<br>2 - right<br>3 - top| |
| |x|`integer`| |Location on the X axis.|
| |y|`integer`| |Location on the Y axis.|
| |elementsubtype|`integer`|0 - single host group<br>1 - all host groups|Element subtype, if "elementtype=3"|
| |areatype|`integer`|0 - same as whole map<br>1 - custom size|Area size, if "elementsubtype=1"|
| |width|`integer`| |Width of area, if "areatype=1"|
| |height|`integer`| |Height of area, if "areatype=1"|
| |viewtype|`integer`|0 - place evenly in the area|Area placement algorithm, if "elementsubtype=1"|
| |use\_iconmap|`integer`|0 - no<br>1 - yes|Use icon mapping for this element. Relevant only if iconmapping is activated on map level.|
| |selementid|`id`| |Unique element record ID.|
| |evaltype|`integer`| |Evaluation type for tags.|
|tags| | | |Problem tags (for host and host group elements). If tags are given, only problems with these tags will be displayed on the map.|
| |tag|`string`| |Tag name.|
| |value|`string`| |Tag value.|
| |operator|`integer`| |Operator.|
|elements| | | |Zabbix entities that are represented on the map (host, host group, map etc).|
| |host| | | |
|icon\_off| | | |Image to use when element is in 'OK' status.|
|icon\_on| | | |Image to use when element is in 'Problem' status.|
|icon\_disabled| | | |Image to use when element is disabled.|
|icon\_maintenance| | | |Image to use when element is in maintenance.|
| |name|`string`| |Unique image name.|
|shapes| | | | |
| |type|`integer`|0 - rectangle<br>1 - ellipse|Shape type.|
| |x|`integer`| |X coordinates of the shape in pixels.|
| |y|`integer`| |Y coordinates of the shape in pixels.|
| |width|`integer`| |Shape width.|
| |height|`integer`| |Shape height.|
| |border\_type|`integer`|0 - none<br>1 - bold line<br>2 - dotted line<br>3 - dashed line|Type of the border for the shape.|
| |border\_width|`integer`| |Width of the border in pixels.|
| |border\_color|`string`| |Border color represented in hexadecimal code.|
| |text|`string`| |Text inside of shape.|
| |font|`integer`|0 - Georgia, serif<br>1 - "Palatino Linotype", "Book Antiqua", Palatino, serif<br>2 - "Times New Roman", Times, serif<br>3 - Arial, Helvetica, sans-serif<br>4 - "Arial Black", Gadget, sans-serif<br>5 - "Comic Sans MS", cursive, sans-serif<br>6 - Impact, Charcoal, sans-serif<br>7 - "Lucida Sans Unicode", "Lucida Grande", sans-serif<br>8 - Tahoma, Geneva, sans-serif<br>9 - "Trebuchet MS", Helvetica, sans-serif<br>10 - Verdana, Geneva, sans-serif<br>11 - "Courier New", Courier, monospace<br>12 - "Lucida Console", Monaco, monospace|Text font style.|
| |font\_size|`integer`| |Font size in pixels.|
| |font\_color|`string`| |Font color represented in hexadecimal code.|
| |text\_halign|`integer`|0 - center<br>1 - left<br>2 - right|Horizontal alignment of text.|
| |text\_valign|`integer`|0 - middle<br>1 - top<br>2 - bottom|Vertical alignment of text.|
| |background\_color|`string`| |Background (fill) color represented in hexadecimal code.|
| |zindex|`integer`| |Value used to order all shapes and lines (z-index).|
|lines| | | | |
| |x1|`integer`| |X coordinates of the line point 1 in pixels.|
| |y1|`integer`| |Y coordinates of the line point 1 in pixels.|
| |x2|`integer`| |X coordinates of the line point 2 in pixels.|
| |y2|`integer`| |Y coordinates of the line point 2 in pixels.|
| |line\_type|`integer`|0 - none<br>1 - bold line<br>2 - dotted line<br>3 - dashed line|Line type.|
| |line\_width|`integer`| |Line width in pixels.|
| |line\_color|`string`| |Line color represented in hexadecimal code.|
| |zindex|`integer`| |Value used to order all shapes and lines (z-index).|
|links| | | |Links between map elements.|
| |drawtype|`integer`|0 - line<br>2 - bold line<br>3 - dotted line<br>4 - dashed line|Link style.|
| |color|`string`| |Link color (6 symbols, hex).|
| |label|`string`| |Link label.|
| |selementid1|`id`| |ID of one element to connect.|
| |selementid2|`id`| |ID of the other element to connect.|
|linktriggers| | | |Link status indicators.|
| |drawtype|`integer`|0 - line<br>2 - bold line<br>3 - dotted line<br>4 - dashed line|Link style when trigger is in the 'Problem' state.|
| |color|`string`| |Link color (6 symbols, hex) when trigger is in the 'Problem' state.|
|trigger| | | |Trigger used for indicating link status.|
| |description|`string`| |Trigger name.|
| |expression|`string`| |Trigger expression.|
| |recovery\_expression|`string`| |Trigger recovery expression.|
#### 元素标签
下表解释了元素标签值的含义。
| 元素 | 元素属性 | 类型 | 范围 | 描述 |
|--|--|--|----|--------|
| images | | | | 图像的根元素。 |
| | name | `string` | | 唯一的图像名称。 |
| | imagetype | `integer` | 1 - image<br>2 - background | 图像类型。 |
| | encodedImage | | | Base64编码的图像。 |
| maps | | | | 地图的根元素。 |
| | name | `string` | | 唯一的地图名称。 |
| | width | `integer` | | 地图宽度，以像素为单位。 |
| | height | `integer` | | 地图高度，以像素为单位。 |
| | label\_type | `integer` | 0 - label<br>1 - host IP address<br>2 - element name<br>3 - status only<br>4 - nothing | 地图元素标签类型。 |
| | label\_location | `integer` | 0 - bottom<br>1 - left<br>2 - right<br>3 - top | 默认情况下地图元素标签的位置。 |
| | highlight | `integer` | 0 - no<br>1 - yes | 为活动触发器和主机状态启用图标高亮。 |
| | expandproblem | `integer` | 0 - no<br>1 - yes | 为具有单个问题的元素显示问题触发器。 |
| | markelements | `integer` | 0 - no<br>1 - yes | 高亮显示最近更改状态的地图元素。 |
| | show\_unack | `integer` | 0 - count of all problems<br>1 - count of unacknowledged problems<br>2 - count of acknowledged and unacknowledged problems separately | 问题显示。 |
| | severity\_min | `integer` | 0 - not classified<br>1 - information<br>2 - warning<br>3 - average<br>4 - high<br>5 - disaster | 默认情况下在地图上显示的最小触发器严重性。 |
| | show\_suppressed | `integer` | 0 - no<br>1 - yes | 显示由于主机维护而被抑制（不显示）的问题。 |
| | grid\_size | `integer` | 20, 40, 50, 75 or 100 | 如果"grid\_show=1"，地图网格的单元格大小（以像素为单位）。 |
| | grid\_show | `integer` | 0 - yes<br>1 - no | 在地图配置中显示网格。 |
| | grid\_align | `integer` | 0 - yes<br>1 - no | 在地图配置中自动对齐图标。 |
| | label\_format | `integer` | 0 - no<br>1 - yes | 使用高级标签配置。 |
| | label\_type\_host | `integer` | 0 - label<br>1 - host IP address<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label | 如果"label\_format=1"，显示为主机标签。 |
| | label\_type\_hostgroup | `integer` | 0 - label<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label | 如果"label\_format=1"，显示为主机组标签。 |
| | label\_type\_trigger | `integer` | 0 - label<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label | 如果"label\_format=1"，显示为触发器标签。 |
| | label\_type\_map | `integer` | 0 - label<br>2 - element name<br>3 - status only<br>4 - nothing<br>5 - custom label | 如果"label\_format=1"，显示为地图标签。 |
| | label\_type\_image | `integer` | 0 - label<br>2 - element name<br>4 - nothing<br>5 - custom label | 如果"label\_format=1"，显示为图像标签。 |
| | label\_string\_host | `string` | | 如果"label\_type\_host=5"，主机元素的自定义标签。 |
| | label\_string\_hostgroup | `string` | | 如果"label\_type\_hostgroup=5"，主机组元素的自定义标签。 |
| | label\_string\_trigger | `string` | | 如果"label\_type\_trigger=5"，触发器元素的自定义标签。 |
| | label\_string\_map | `string` | | 如果"label\_type\_map=5"，地图元素的自定义标签。 |
| | label\_string\_image | `string` | | 如果"label\_type\_image=5"，图像元素的自定义标签。 |
| | expand\_macros | `integer` | 0 - no<br>1 - yes | 在地图配置中展开标签中的宏。 |
| | background | `id` | | 背景图像的ID（如果有），如果"imagetype=2"。 |
| | iconmap | `id` | | 图标映射的ID（如果有）。 |
| urls | | | | 由地图或每个地图元素使用。 |
| | name | `string` | | 链接名称。 |
| | url | `string` | | 链接URL。 |
| | elementtype | `integer` | 0 - host<br>1 - map<br>2 - trigger<br>3 - host group<br>4 - image | 链接所属的地图监控项类型。 |
| selements | | | | |
| | elementtype | `integer` | 0 - host<br>1 - map<br>2 - trigger<br>3 - host group<br>4 - image | 地图元素类型。 |
| | label | `string` | | 图标标签。 |
| | label\_location | `integer` | -1 - use map default<br>0 - bottom<br>1 - left<br>2 - right<br>3 - top | |
| | x | `integer` | | X轴上的位置。 |
| | y | `integer` | | Y轴上的位置。 |
| | elementsubtype | `integer` | 0 - single host group<br>1 - all host groups | 元素子类型，如果"elementtype=3"。 |
| | areatype | `integer` | 0 - same as whole map<br>1 - custom size | 区域大小，如果"elementsubtype=1"。 |
| | width | `integer` | | 区域的宽度，如果"areatype=1"。 |
| | height | `integer` | | 区域的高度，如果"areatype=1"。 |
| | viewtype | `integer` | 0 - place evenly in the area | 区域放置算法，如果"elementsubtype=1"。 |
| | use\_iconmap | `integer` | 0 - no<br>1 - yes | 为此元素使用图标映射。仅在地图级别激活图标映射时相关。 |
| | selementid | `id` | | 唯一的元素记录ID。 |
| | evaltype | `integer` | | 标签的评估类型。 |
| tags | | | | 问题标签（用于主机和主机组元素）。如果提供了标签，只有带有这些标签的问题会显示在地图上。 |
| | tag | `string` | | 标签名称。 |
| | value | `string` | | 标签值。 |
| | operator | `integer` | | 操作符。 |
| elements | | | | 在地图上表示的Zabbix实体（主机、主机组、地图等）。 |
| | host | | | |
| icon\_off | | | | 元素处于'OK'状态时使用的图像。 |
| icon\_on | | | | 元素处于'Problem'状态时使用的图像。 |
| icon\_disabled | | | | 元素被禁用时使用的图像。 |
| icon\_maintenance | | | | 元素处于维护状态时使用的图像。 |
| | name | `string` | | 唯一的图像名称。 |
| shapes | | | | |
| | type | `integer` | 0 - rectangle<br>1 - ellipse | 形状类型。 |
| | x | `integer` | | 形状的X坐标（以像素为单位）。 |
| | y | `integer` | | 形状的Y坐标（以像素为单位）。 |
| | width | `integer` | | 形状宽度。 |
| | height | `integer` | | 形状高度。 |
| | border\_type | `integer` | 0 - none<br>1 - bold line<br>2 - dotted line<br>3 - dashed line | 形状边框的类型。 |
| | border\_width | `integer` | | 边框宽度（以像素为单位）。 |
| | border\_color | `string` | | 边框颜色（十六进制代码表示）。 |
| | text | `string` | | 形状内的文本。 |
| | font | `integer` | 0 - Georgia, serif<br>1 - "Palatino Linotype", "Book Antiqua", Palatino, serif<br>2 - "Times New Roman", Times, serif<br>3 - Arial, Helvetica, sans-serif<br>4 - "Arial Black", Gadget, sans-serif<br>5 - "Comic Sans MS", cursive, sans-serif<br>6 - Impact, Charcoal, sans-serif<br>7 - "Lucida Sans Unicode", "Lucida Grande", sans-serif<br>8 - Tahoma, Geneva, sans-serif<br>9 - "Trebuchet MS", Helvetica, sans-serif<br>10 - Verdana, Geneva, sans-serif<br>11 - "Courier New", Courier, monospace<br>12 - "Lucida Console", Monaco, monospace | 文本字体样式。 |
| | font\_size | `integer` | | 字体大小（以像素为单位）。 |
| | font\_color | `string` | | 字体颜色（十六进制代码表示）。 |
| | text\_halign | `integer` | 0 - center<br>1 - left<br>2 - right | 文本的水平对齐方式。 |
| | text\_valign | `integer` | 0 - middle<br>1 - top<br>2 - bottom | 文本的垂直对齐方式。 |
| | background\_color | `string` | | 背景（填充）颜色（十六进制代码表示）。 |
| | zindex | `integer` | | 用于排序所有形状和线条的值（z-index）。 |
| lines | | | | |
| | x1 | `integer` | | 线条点1的X坐标（以像素为单位）。 |
| | y1 | `integer` | | 线条点1的Y坐标（以像素为单位）。 |
| | x2 | `integer` | | 线条点2的X坐标（以像素为单位）。 |
| | y2 | `integer` | | 线条点2的Y坐标（以像素为单位）。 |
| | line\_type | `integer` | 0 - none<br>1 - bold line<br>2 - dotted line<br>3 - dashed line | 线条类型。 |
| | line\_width | `integer` | | 线条宽度（以像素为单位）。 |
| | line\_color | `string` | | 线条颜色（十六进制代码表示）。 |
| | zindex | `integer` | | 用于排序所有形状和线条的值（z-index）。 |
| links | | | | 地图元素之间的链接。 |
| | drawtype | `integer` | 0 - line<br>2 - bold line<br>3 - dotted line<br>4 - dashed line | 链接样式。 |
| | color | `string` | | 链接颜色（6位十六进制）。 |
| | label | `string` | | 链接标签。 |
| | selementid1 | `id` | | 要连接的一个元素的ID。 |
| | selementid2 | `id` | | 要连接的另一个元素的ID。 |
| linktriggers | | | | 链接状态指示器。 |
| | drawtype | `integer` | 0 - line<br>2 - bold line<br>3 - dotted line<br>4 - dashed line | 触发器处于'Problem'状态时的链接样式。 |
| | color | `string` | | 触发器处于'Problem'状态时的链接颜色（6位十六进制）。 |
| trigger | | | | 用于指示链接状态的触发器。 |
| | description | `string` | | 触发器名称。 |
| | expression | `string` | | 触发器表达式。 |
| | recovery\_expression | `string` | | 触发器恢复表达式。 |
#### Ember+
A new plugin for direct monitoring of Ember+ by Zabbix agent 2 has been added.
For more information, see:
- [Ember+ plugin readme](https://git.zabbix.com/projects/AP/repos/ember-plus/browse?at=refs%2Fheads%2Frelease%2F6.0)
- [Agent 2 items](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#ember)
- [Ember+ plugin parameters](/manual/appendix/config/zabbix_agent2_plugins/ember_plus_plugin)
- [Agent 2 installation](/manual/concepts/agent2#installation)
#### Ember+
新增了一个用于通过Zabbix agent 2直接监控Ember+的插件。
更多信息，请参阅：
- [Ember+ plugin readme](https://git.zabbix.com/projects/AP/repos/ember-plus/browse?at=refs%2Fheads%2Frelease%2F6.0)
- [ember](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#ember)
- [Ember+ plugin parameters](/manual/appendix/config/zabbix_agent2_plugins/ember_plus_plugin)
- [安装](/manual/concepts/agent2#安装)
### Ember+
|Key|<|<|<|
|--|--|------|------|
|**Description**|**Return value**|**Parameters**|**Comments**|
|ember.get\[<uri>,<path>\]|<|<|<|
|Returns the result of the required device.|JSON object|**uri** - Ember+ device URI. Default: 127.0.0.1:9998<br>**path** - OID path to device. Empty by default, returns root collection data.| |
### Ember+
| 键 | < | < | < |
|--|--|------|------|
| **描述** | **返回值** | **参数** | **备注** |
| ember.get\[<uri>,<path>\] | < | < | < |
| 返回所需设备的结果。 | JSON object | **uri** - Ember+设备URI。默认值: 127.0.0.1:9998<br>**path** - 设备的OID路径。默认为空，返回根集合数据。 | |
#### Enabling a host
Enable host monitoring, i.e. set its status to 0.
Request:
```json
{
"jsonrpc": "2.0",
"method": "host.update",
"params": {
"hostid": "10126",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10126"
]
},
"id": 1
}
```
#### 启用主机
启用 主机 监控，即将其状态设置为0.
请求:
```json
{
"jsonrpc": "2.0",
"method": "host.update",
"params": {
"hostid": "10126",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"10126"
]
},
"id": 1
}
```
#### Enabling a media type
Enable a media type, that is, set its status to "0".
Request:
```json
{
"jsonrpc": "2.0",
"method": "mediatype.update",
"params": {
"mediatypeid": "6",
"status": "0"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"6"
]
},
"id": 1
}
```
#### 启用媒介类型
启用媒体类型，即将其状态设置为"0"。
请求：
```json
{
"jsonrpc": "2.0",
"method": "mediatype.update",
"params": {
"mediatypeid": "6",
"status": "0"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"6"
]
},
"id": 1
}
```
#### Enabling an item
Enable an item, that is, set its status to "0".
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.update",
"params": {
"itemid": "10092",
"status": 0
},
"auth": "700ca65537074ec963db7efabda78259",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"10092"
]
},
"id": 1
}
```
#### 启用 监控项
启用一个监控项，即将其状态设置为"0".
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.update",
"params": {
"itemid": "10092",
"status": 0
},
"auth": "700ca65537074ec963db7efabda78259",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"itemids": [
"10092"
]
},
"id": 1
}
```
#### Enabling a trigger
Enable a trigger, that is, set its status to 0.
Request:
```json
{
"jsonrpc": "2.0",
"method": "trigger.update",
"params": {
"triggerid": "13938",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}
```
#### 启用触发器
启用触发器，即将其状态设置为0。
请求：
```json
{
"jsonrpc": "2.0",
"method": "trigger.update",
"params": {
"triggerid": "13938",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}
```
#### Enabling a trigger prototype
Enable a trigger prototype, that is, set its status to 0.
Request:
```json
{
"jsonrpc": "2.0",
"method": "triggerprototype.update",
"params": {
"triggerid": "13938",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}
```
#### 启用触发器原型
启用触发器原型，即将其状态设置为0。
请求：
```json
{
"jsonrpc": "2.0",
"method": "triggerprototype.update",
"params": {
"triggerid": "13938",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}
```
#### Enabling a web scenario
Enable a web scenario, that is, set its status to "0".
Request:
```json
{
"jsonrpc": "2.0",
"method": "httptest.update",
"params": {
"httptestid": "5",
"status": 0
},
"auth": "700ca65537074ec963db7efabda78259",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"httptestids": [
"5"
]
},
"id": 1
}
```
#### 启用 Web 场景
启用Web场景，即将其状态设置为"0"。
请求：
```json
{
"jsonrpc": "2.0",
"method": "httptest.update",
"params": {
"httptestid": "5",
"status": 0
},
"auth": "700ca65537074ec963db7efabda78259",
"id": 1
}
```
响应：
```json
{
"jsonrpc": "2.0",
"result": {
"httptestids": [
"5"
]
},
"id": 1
}
```
#### Enabling Content Security Policy (CSP) on the web server
To protect Zabbix frontend against Cross Site Scripting (XSS), data injection, and similar attacks, we recommend enabling Content Security Policy on the web server.
To do so, configure the web server to return the [HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy).
::: noteimportant
The following CSP header configuration is only for the default Zabbix frontend installation and for cases when all content originates from the site's domain (excluding subdomains).
A different CSP header configuration may be required if you are, for example, configuring the [*URL*](/manual/web_interface/frontend_sections/dashboards/widgets/url) widget to display content from the site's subdomains or external domains, switching from *OpenStreetMap* to another map engine, or adding external CSS or widgets.
:::
To enable CSP for your Zabbix frontend in Apache configuration, follow these steps:
1\. Locate your virtual host's configuration file:
- `/etc/httpd/conf/httpd.conf` on RHEL-based systems
- `/etc/apache2/sites-available/000-default.conf` on Debian/Ubuntu
2\. Add the following directive to your virtual host's configuration file:
```ini
<VirtualHost *:*>
Header set Content-Security-Policy: "default-src 'self' *.openstreetmap.org; script-src 'self' 'unsafe-inline' 'unsafe-eval'; connect-src 'self'; img-src 'self' data: *.openstreetmap.org; style-src 'self' 'unsafe-inline'; base-uri 'self'; form-action 'self';"
</VirtualHost>
```
3\. Restart the Apache service to apply the changes:
```bash
# On RHEL-based systems:
systemctl restart httpd.service
# On Debian/Ubuntu
systemctl restart apache2.service
```
#### 启用内容安全策略(CSP)
为保护Zabbix前端免受跨站脚本(XSS)、数据注入及类似攻击，我们建议在Web服务器上启用内容安全策略。
为此，需配置Web服务器返回[HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy)。
::: noteimportant
以下CSP头部配置仅适用于默认Zabbix前端安装，且所有内容源自站点主域名(不含子域名)的情况。
若需配置[*URL*](/manual/web_interface/frontend_sections/dashboards/widgets/url)部件显示子域名/外部域名内容、从*OpenStreetMap*切换至其他地图引擎、或添加外部CSS/部件时，可能需要不同的CSP头部配置。
:::
在Apache配置中为Zabbix前端启用CSP的步骤如下：
1\. 定位虚拟主机的配置file：
- RHEL系系统：`/etc/httpd/conf/httpd.conf`
- Debian/Ubuntu系统：`/etc/apache2/sites-available/000-default.conf`
2\. 在虚拟主机的配置file中添加以下指令：
```ini
<VirtualHost *:*>
Header set Content-Security-Policy: "default-src 'self' *.openstreetmap.org; script-src 'self' 'unsafe-inline' 'unsafe-eval'; connect-src 'self'; img-src 'self' data: *.openstreetmap.org; style-src 'self' 'unsafe-inline'; base-uri 'self'; form-action 'self';"
</VirtualHost>
```
3\. 重启Apache服务使更改生效：
```bash
# On RHEL-based systems:
systemctl restart httpd.service
# On Debian/Ubuntu
systemctl restart apache2.service
```
### Enabling high availability
### 启用高可用性
#### Enabling HTTP Strict Transport Security (HSTS) on the web server
To protect Zabbix frontend against protocol downgrade attacks, we recommend enabling [HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) policy on the web server.
To enable HSTS policy for your Zabbix frontend in Apache configuration, follow these steps:
1\. Locate your virtual host's configuration file:
- `/etc/httpd/conf/httpd.conf` on RHEL-based systems
- `/etc/apache2/sites-available/000-default.conf` on Debian/Ubuntu
2\. Add the following directive to your virtual host's configuration file:
```ini
<VirtualHost *:*>
Header set Strict-Transport-Security "max-age=31536000"
</VirtualHost>
```
3\. Restart the Apache service to apply the changes:
```bash
# On RHEL-based systems:
systemctl restart httpd.service
# On Debian/Ubuntu
systemctl restart apache2.service
```
#### 启用HTTP严格传输安全(HSTS)
为防范协议降级攻击，建议在Web服务器上启用[HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security)策略以保护Zabbix前端。
在Apache配置中为Zabbix前端启用HSTS策略，请按以下步骤操作：
1\. 定位虚拟主机的配置file：
- RHEL系系统：`/etc/httpd/conf/httpd.conf`
- Debian/Ubuntu系统：`/etc/apache2/sites-available/000-default.conf`
2\. 在虚拟主机的配置file中添加以下指令：
```ini
<VirtualHost *:*>
Header set Strict-Transport-Security "max-age=31536000"
</VirtualHost>
```
3\. 重启Apache服务使配置生效：
```bash
# On RHEL-based systems:
systemctl restart httpd.service
# On Debian/Ubuntu
systemctl restart apache2.service
```
#### Enabling MIB files
On RedHat-based systems, MIB files should be enabled by default.
On Debian-based systems, you have to edit the file `/etc/snmp/snmp.conf` and comment out the line that says `mibs :`
# As the snmp packages come without MIB files due to license reasons, loading
# of MIBs is disabled by default. If you added the MIBs you can re-enable
# loading them by commenting out the following line.
mibs :
#### 启用 MIB 文件
在基于RedHat的系统上，MIB文件默认应已启用。
在基于Debian的系统上，您需要编辑file `/etc/snmp/snmp.conf`并注释掉包含`mibs :`的行
# As the snmp packages come without MIB files due to license reasons, loading
# MIB默认被禁用。如果您已添加MIB，可以通过取消注释以下行来重新启用加载
# loading them by commenting out the following line.
mibs :
#### Enabling multiple hosts
Enable monitoring of two hosts, i.e., set their status to 0.
Request:
```json
{
"jsonrpc": "2.0",
"method": "host.massupdate",
"params": {
"hosts": [
{
"hostid": "69665"
},
{
"hostid": "69666"
}
],
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"69665",
"69666"
]
},
"id": 1
}
```
#### 启用多台主机
启用对两个主机的监控，即将它们的状态设置为0.
请求:
```json
{
"jsonrpc": "2.0",
"method": "host.massupdate",
"params": {
"hosts": [
{
"hostid": "69665"
},
{
"hostid": "69666"
}
],
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hostids": [
"69665",
"69666"
]
},
"id": 1
}
```
#### Enabling remote JMX monitoring for Java application
A Java application does not need any additional software installed, but
it needs to be started with the command-line options specified below to
have support for remote JMX monitoring.
As a bare minimum, if you just wish to get started by monitoring a
simple Java application on a local host with no security enforced, start
it with these options:
java \
-Dcom.sun.management.jmxremote \
-Dcom.sun.management.jmxremote.port=12345 \
-Dcom.sun.management.jmxremote.authenticate=false \
-Dcom.sun.management.jmxremote.ssl=false \
-Dcom.sun.management.jmxremote.registry.ssl=false \
-jar /usr/share/doc/openjdk-6-jre-headless/demo/jfc/Notepad/Notepad.jar
This makes Java listen for incoming JMX connections on port 12345, from
local host only, and tells it not to require authentication or SSL.
If you want to allow connections on another interface, set the
-Djava.rmi.server.hostname parameter to the IP of that interface.
If you wish to be more stringent about security, there are many other
Java options available to you. For instance, the next example starts the
application with a more versatile set of options and opens it to a wider
network, not just local host.
java \
-Djava.rmi.server.hostname=192.168.3.14 \
-Dcom.sun.management.jmxremote \
-Dcom.sun.management.jmxremote.port=12345 \
-Dcom.sun.management.jmxremote.authenticate=true \
-Dcom.sun.management.jmxremote.password.file=/etc/java-6-openjdk/management/jmxremote.password \
-Dcom.sun.management.jmxremote.access.file=/etc/java-6-openjdk/management/jmxremote.access \
-Dcom.sun.management.jmxremote.ssl=true \
-Dcom.sun.management.jmxremote.registry.ssl=true \
-Djavax.net.ssl.keyStore=$YOUR_KEY_STORE \
-Djavax.net.ssl.keyStorePassword=$YOUR_KEY_STORE_PASSWORD \
-Djavax.net.ssl.trustStore=$YOUR_TRUST_STORE \
-Djavax.net.ssl.trustStorePassword=$YOUR_TRUST_STORE_PASSWORD \
-Dcom.sun.management.jmxremote.ssl.need.client.auth=true \
-jar /usr/share/doc/openjdk-6-jre-headless/demo/jfc/Notepad/Notepad.jar
Most (if not all) of these settings can be specified in
`/etc/java-6-openjdk/management/management.properties` (or wherever that
file is on your system).
Note that if you wish to use SSL, you have to modify startup.sh script
by adding `-Djavax.net.ssl.*` options to Java gateway, so that it knows
where to find key and trust stores.
See [Monitoring and Management Using
JMX](http://download.oracle.com/javase/1.5.0/docs/guide/management/agent.html)
for a detailed description.
#### 为Java应用启用远程JMX监控
Java应用程序无需安装额外软件，但需要通过下方指定的命令行参数启动以支持远程JMX监控。
最低配置要求：若仅需get通过监控本地主机上的简单Java应用（不启用安全机制），请使用以下参数启动：
java \
-Dcom.sun.management.jmxremote \
-Dcom.sun.management.jmxremote.port=12345 \
-Dcom.sun.management.jmxremote.authenticate=false \
-Dcom.sun.management.jmxremote.ssl=false \
-Dcom.sun.management.jmxremote.registry.ssl=false \
-jar /usr/share/doc/openjdk-6-jre-headless/demo/jfc/Notepad/Notepad.jar
该配置使Java仅在12345端口监听来自本地主机的JMX连接，且不要求身份验证或SSL加密。
如需允许其他网络接口连接，需将-Djava.rmi.server.hostname参数设置为该接口的IP地址。
若需加强安全管控，Java提供更多可选参数。例如下列配置通过更全面的参数组合启动应用，并开放至更广域网络（不限于本地主机）：
java \
-Djava.rmi.server.hostname=192.168.3.14 \
-Dcom.sun.management.jmxremote \
-Dcom.sun.management.jmxremote.port=12345 \
-Dcom.sun.management.jmxremote.authenticate=true \
-Dcom.sun.management.jmxremote.password.file=/etc/java-6-openjdk/management/jmxremote.password \
-Dcom.sun.management.jmxremote.access.file=/etc/java-6-openjdk/management/jmxremote.access \
-Dcom.sun.management.jmxremote.ssl=true \
-Dcom.sun.management.jmxremote.registry.ssl=true \
-Djavax.net.ssl.keyStore=$YOUR_KEY_STORE \
-Djavax.net.ssl.keyStorePassword=$YOUR_KEY_STORE_PASSWORD \
-Djavax.net.ssl.trustStore=$YOUR_TRUST_STORE \
-Djavax.net.ssl.trustStorePassword=$YOUR_TRUST_STORE_PASSWORD \
-Dcom.sun.management.jmxremote.ssl.need.client.auth=true \
-jar /usr/share/doc/openjdk-6-jre-headless/demo/jfc/Notepad/Notepad.jar
这些参数大多（若非全部）可配置于`/etc/java-6-openjdk/management/management.properties`文件（或您系统中file所在位置）。
注意：若需启用SSL，需修改startup.sh脚本，向Java网关添加`-Djavax.net.ssl.*`参数以指定密钥库和信任库路径。
详见[Monitoring and Management Using
JMX](http://download.oracle.com/javase/1.5.0/docs/guide/management/agent.html)获取完整说明。
#### Enabling Zabbix on root directory of URL
On RHEL-based systems, add a virtual host to Apache configuration (`/etc/httpd/conf/httpd.conf`) and set permanent redirect for document root to Zabbix SSL URL.
Note that *example.com* should be replaced with the actual name of the server.
```ini
# Add lines:
<VirtualHost *:*>
ServerName example.com
Redirect permanent / https://example.com
</VirtualHost>
```
Restart the Apache service to apply the changes:
```bash
systemctl restart httpd.service
```
#### 在URL根目录启用Zabbix
在基于RHEL的系统上，向Apache配置(`/etc/httpd/conf/httpd.conf`)添加虚拟主机，并为文档根目录设置永久重定向到Zabbix SSL URL。
注意*example.com*应替换为服务器的实际名称。
```ini
# Add lines:
<VirtualHost *:*>
ServerName example.com
Redirect permanent / https://example.com
</VirtualHost>
```
重启Apache服务以应用更改：
```bash
systemctl restart httpd.service
```
#### Encoding settings
To make sure that the acquired data are not corrupted you may specify
the correct encoding for processing the check (e.g. 'vfs.file.contents')
in the `encoding` parameter. The list of supported encodings (code page
identifiers) may be found in documentation for
[libiconv](http://www.gnu.org/software/libiconv/) (GNU Project) or in
Microsoft Windows SDK documentation for "Code Page Identifiers".
If no encoding is specified in the `encoding` parameter the following
resolution strategies are applied:
- If encoding is not specified (or is an empty string) it is assumed to be UTF-8, the data is processed "as-is";
- BOM analysis - applicable for items 'vfs.file.contents',
'vfs.file.regexp', 'vfs.file.regmatch'. An attempt is made to
determine the correct encoding by using the byte order mark (BOM) at
the beginning of the file. If BOM is not present - standard
resolution (see above) is applied instead.
#### 编码设置
为确保获取的数据未被损坏，您可以指定
处理检查的正确编码（例如'vfs.file.contents'）
在`encoding`参数中。支持的编码列表（代码页
标识符）可在文档中找到
[libiconv](http://www.gnu.org/software/libiconv/) (GNU项目) 或位于
Microsoft Windows SDK文档中的"代码页标识符"部分
如果未在`encoding`参数中指定编码，则以下
应用的解决策略包括：
- 如果未指定编码（或为空string），则默认采用UTF-8编码，数据将按"原样"处理；
- BOM分析 - 适用于监控项 'vfs.file.contents'
'vfs.file.regexp', 'vfs.file.regmatch'. 系统会尝试
通过使用字节顺序标记（BOM）确定正确的编码
file的开头。如果BOM不存在 - 标准
分辨率（见上文）将被替代应用。
##### Encryption
The **Encryption** tab allows you to require
[encrypted](/manual/encryption) connections with the host.
|Parameter|Description|
|--|--------|
|*Connections to host*|How Zabbix server or proxy connects to Zabbix agent on a host: no encryption (default), using PSK (pre-shared key) or certificate.|
|*Connections from host*|Select what type of connections are allowed from the host (i.e. from Zabbix agent and Zabbix sender). Several connection types can be selected at the same time (useful for testing and switching to other connection type). Default is "No encryption".|
|*Issuer*|Allowed issuer of certificate. Certificate is first validated with CA (certificate authority). If it is valid, signed by the CA, then the *Issuer* field can be used to further restrict allowed CA. This field is intended to be used if your Zabbix installation uses certificates from multiple CAs. If this field is empty then any CA is accepted.|
|*Subject*|Allowed subject of certificate. Certificate is first validated with CA. If it is valid, signed by the CA, then the *Subject* field can be used to allow only one value of *Subject* string. If this field is empty then any valid certificate signed by the configured CA is accepted.|
|*PSK identity*|Pre-shared key identity string.<br>Do not put sensitive information in the PSK identity, it is transmitted unencrypted over the network to inform a receiver which PSK to use.|
|*PSK*|Pre-shared key (hex-string). Maximum length: 512 hex-digits (256-byte PSK) if Zabbix uses GnuTLS or OpenSSL library, 64 hex-digits (32-byte PSK) if Zabbix uses mbed TLS (PolarSSL) library. Example: 1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952|
##### 加密
**加密**选项卡允许您要求
[encrypted](/manual/encryption)与主机建立连接。
| 参数 | 描述 |
|--|--------|
| *Connections to host* | Zabbix server或proxy如何连接到一个主机上的Zabbix agent：不加密（默认）、使用PSK（预共享密钥）或证书。 |
| *Connections from host* | 选择允许从主机（即从Zabbix agent和Zabbix发送器）建立的连接类型。可以同时选择多种连接类型（适用于测试和切换到其他连接类型）。默认为"不加密"。 |
| *Issuer* | 允许的证书颁发者。证书首先由CA（证书颁发机构）验证。如果有效且由CA签名，则可以使用*颁发者*字段进一步限制允许的CA。如果您的Zabbix安装使用来自多个CA的证书，则此字段非常有用。如果此字段为空，则接受任何CA。 |
| *Subject* | 允许的证书主题。证书首先由CA验证。如果有效且由CA签名，则可以使用*主题*字段仅允许*主题*string的一个值。如果此字段为空，则接受由配置的CA签名的任何有效证书。 |
| *PSK identity* | 预共享密钥标识string。<br>不要在PSK标识中放置敏感信息，它通过网络以未加密的方式传输，以告知接收方使用哪个PSK。 |
| *PSK* | 预共享密钥（十六进制-string）。最大长度：如果Zabbix使用GnuTLS或OpenSSL库，则为512个十六进制数字（256字节PSK）；如果Zabbix使用mbed TLS（PolarSSL）库，则为64个十六进制数字（32字节PSK）。示例：1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952 |
### Encryption with certificate authority verification
### 带CA验证的加密
### Encryption with certificate authority verification
Copy required MySQL CA to the Zabbix frontend server, assign proper
permissions to allow the webserver to read this file.
::: noteclassic
This mode doesn't work on SLES 12 and RHEL 7 due to
older MySQL libraries.
:::
### 带CA验证的加密
将所需的MySQL CA证书复制到Zabbix前端服务器，并分配适当权限以允许web服务器读取该file。
::: noteclassic
由于MySQL库版本较旧，此模式在SLES 12和RHEL 7上无法工作。
:::
### Encryption with full verification
### 完全验证加密
### Encryption with full verification
### 完全验证加密
#### Enforcing Secure and SameSite session cookies in Zabbix
When configuring Zabbix, it is essential to enforce secure and SameSite attributes for session cookies to enhance security and prevent cross-site request forgery (CSRF) attacks. However, enforcing ``SameSite=Strict`` may cause issues in certain scenarios, such as:
- Dashboard URL widgets displaying "user not logged in" when embedding same-domain iframes.
- Users accessing the dashboard via HTTP instead of HTTPS may face login issues.
- Inability to share URLs to specific Zabbix menu sections or hosts.
To mitigate these issues, users should have a way to adjust the SameSite policy.
1\. Secure cookies
Setting the ``secure`` flag ensures that cookies are only transmitted over HTTPS, preventing exposure over unencrypted connections.
To enable secure cookies in Zabbix, add or modify the following setting in the web server configuration:
For Apache:
Header always edit Set-Cookie ^(.*)$ $1;Secure
For Nginx:
proxy_cookie_path / "/; Secure";
Ensure that your Zabbix frontend is accessed via HTTPS; otherwise, cookies with the ``Secure`` flag will not be sent.
2\. Configuring the SameSite attribute
Web server settings can also enforce the SameSite attribute:
For Apache:
<IfModule mod_headers.c>
Header onsuccess edit Set-Cookie (.*) "$1; SameSite=Strict"
</IfModule>
For Nginx (version 1.19.3+):
proxy_cookie_flags ~ samesite=Strict; # Replace ~ with 'zbx_session' for specificity
#### 强制安全与SameSite会话Cookie
在配置Zabbix时，必须为会话cookie强制执行Secure和SameSite属性以增强安全性并防止跨站请求伪造(CSRF)攻击。然而，强制执行``SameSite=Strict``可能导致问题，例如：
- 当嵌入同域iframe时，仪表板URL小部件显示"用户未登录"
- 通过HTTP而非HTTPS访问仪表板的用户可能遇到login 问题
- 无法共享指向特定Zabbix菜单部分或主机的URL
为缓解这些问题，用户应能调整SameSite策略。
1\. 安全cookie
设置``secure`` flag可确保cookie仅通过HTTPS传输，防止在未加密连接中暴露。
要在Zabbix中启用安全cookie，需在Web服务器配置中添加或修改以下设置：
Apache配置：
Header always edit Set-Cookie ^(.*)$ $1;Secure
对于nginx：
proxy_cookie_path / "/; Secure";
确保通过HTTPS访问Zabbix前端，否则带有``Secure`` flag的cookie将不会被发送。
2\. 配置SameSite属性
Web服务器设置也可强制执行SameSite属性：
Apache配置：
<IfModule mod_headers.c>
Header onsuccess edit Set-Cookie (.*) "$1; SameSite=Strict"
</IfModule>
对于nginx (version 1.19.3+)：
proxy_cookie_flags ~ samesite=Strict; # 将~替换为'zbx_session'以指定特定cookie
#### Entity count
New [functions](/manual/appendix/functions) have been added to simplify the counting of specific hosts, items, or
values, returned by [foreach functions](/manual/appendix/functions/aggregate/foreach).
Aggregate functions:
- **count** - total number of values in an array returned by a foreach
function (returns an integer);
- **item\_count** - total number of currently enabled items that match
filter criteria (returns an integer).
Foreach function:
- **exists\_foreach** - number of currently enabled items that match
filter criteria (returns an array).
#### 实体计数
新增[functions](/manual/appendix/functions)用于简化特定主机、监控项或[foreach functions](/manual/appendix/functions/aggregate/foreach)返回值的计数操作。
聚合函数：
- **count** - foreach函数返回的array中值的总数（返回integer类型）；
- **监控项\_count** - 当前启用的监控项中符合匹配条件的总数
filter criteria (returns an integer).
Foreach函数：
- **exists\_foreach** - 当前启用的监控项中符合筛选条件的数量（返回array类型）。
##### Entity count
New [functions](/manual/appendix/functions) have been added to simplify
the counting of specific hosts, items, or values, returned by [foreach
functions](/manual/appendix/functions/aggregate/foreach).
Aggregate functions:
- **count** - total number of values in an array returned by a foreach
function (returns an integer);
- **item\_count** - total number of currently enabled items that match
filter criteria (returns an integer).
Foreach function:
- **exists\_foreach** - number of currently enabled items that match
filter criteria (returns an array).
### Anomaly detection
Zabbix 5.2 introduced new trend functions useful for baseline monitoring. However, they still require defining relative thresholds (e.g. check that web traffic in September, 2021 is less than 2x higher compared to September, 2020). There are use cases when such thresholds are hard to define. For instance, the web traffic of a new but highly popular web site can organically grow many times over a year but the growth rate is unknown. Yet, a sudden traffic spike due to DDOS attack must generate an alert regardless of organic traffic growth.
Anomaly detection algorithms do exactly this - find data that don't look normal (outliers) in a context of other values.
New [history function](/manual/appendix/functions/history) trendstl() has been added which uses 'decomposition' method to calculate the anomaly rate. It splits a single time series sequence into three other sequences:
- trend sequence that only contains big changes in the original data (e.g. website traffic shows growth)
- season sequence that only contains seasonal changes (e.g. less website traffic in summer, more in autumn)
- remainder sequence that only contains residual values that can not be interpreted as parts of trend or season
Anomaly detection works with remainder sequence and checks if there are values that are too far from the majority of remainder values. "Far" means that the absolute value from the remainder sequence is N times greater than the standard or mean deviation.
### Zabbix agent 2 plugins
Each Zabbix agent 2 plugin now has a separate [configuration
file](/manual/appendix/config/zabbix_agent2_plugins). By default, these
files are located in the `./zabbix_agent2.d/plugins.d/` directory. The
path is specified in the `Include` parameter of the agent 2
configuration file and can be relative to the
[zabbix\_agent2.conf](/manual/appendix/config/zabbix_agent2) or
[zabbix\_agent2.win.conf](/manual/appendix/config/zabbix_agent2_win)
file location.
##### Entity uniqueness criteria
When adding entities (items, triggers, graphs etc.) from a template it
is important to know what of those entities already exist on the host
and need to be updated and what entities differ. The uniqueness criteria
for deciding upon the sameness/difference are:
- for items - the item key
- for triggers - trigger name and expression
- for custom graphs - graph name and its items
##### 实体唯一性标准
从模板添加实体（监控项、触发器、图表等）时，了解哪些实体已存在于主机并需要更新，以及哪些实体存在差异非常重要。用于判断相同性/差异性的唯一性标准包括：
- 对于监控项 - 监控项键
- 对于触发器 - 触发器名称和表达式
- 对于自定义图表 - 图表名称及其监控项
#### Environment files
In the same directory with compose files on github.com you can find
files with default environment variables for each component in compose
file. These environment files are named like `.env_<type of component>`.
#### 环境文件
在github.com上包含compose文件的同一目录中，您可以找到
每个compose组件file的默认环境变量文件。
这些环境文件命名格式为`.env_<type of component>`。
#### Error handling
Up to that point everything we've tried has worked fine. But what
happens if we try to make an incorrect call to the API? Let's try to
create another host by calling
[host.create](/manual/api/reference/host/create) but omitting the
mandatory `groups` parameter.
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "Linux server",
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050"
}
]
},
"id": 7,
"auth": "0424bd59b807674191e7d77572075f33"
}
```
The response will then contain an error message:
```json
{
"jsonrpc": "2.0",
"error": {
"code": -32602,
"message": "Invalid params.",
"data": "No groups for host \"Linux server\"."
},
"id": 7
}
```
If an error occurred, instead of the `result` property, the response
object will contain an `error` property with the following data:
- `code` - an error code;
- `message` - a short error summary;
- `data` - a more detailed error message.
Errors can occur in different cases, such as, using incorrect input
values, a session timeout or trying to access unexisting objects. Your
application should be able to gracefully handle these kinds of errors.
#### 错误处理
到目前为止我们尝试的所有操作都运行良好。但如果尝试错误调用API会发生什么？让我们通过调用[host.create](/manual/api/reference/host/create)但省略必需的`groups`参数来create另一个主机。
```json
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "Linux server",
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050"
}
]
},
"id": 7,
"auth": "0424bd59b807674191e7d77572075f33"
}
```
响应将包含错误信息：
```json
{
"jsonrpc": "2.0",
"error": {
"code": -32602,
"message": "Invalid params.",
"data": "No groups for host \"Linux server\"."
},
"id": 7
}
```
如果发生错误，响应object将不再包含`result`属性，而是包含带有以下数据的`error`属性：
- `code` - 错误代码；
- `message` - 简短的错误摘要；
- `data` - 更详细的错误信息。
错误可能发生在不同场景中，例如使用错误的输入值、会话超时或尝试访问不存在的objects。您的应用程序应能妥善处理这类错误。
#### Error messages
ODBC error messages are structured into fields to provide detailed information.
For example, an error message might look like this:
Cannot execute ODBC query: [SQL_ERROR]:[42601][7][ERROR: syntax error at or near ";"; Error while executing the query]
- "`Cannot execute ODBC query`" - Zabbix message
- "`[SQL_ERROR]`" - ODBC return code
- "`[42601]`" - SQLState
- "`[7]`" - Native error code
- "`[ERROR: syntax error at or near ";"; Error while executing the query]`" - Native error message
Note that the error message length is limited to 2048 bytes, so the
message can be truncated. If there is more than one ODBC diagnostic
record Zabbix tries to concatenate them (separated with `|`) as far as
the length limit allows.
#### 错误消息
ODBC错误消息被结构化为多个字段以提供详细信息。
例如，错误消息可能如下所示：
Cannot execute ODBC query: [SQL_ERROR]:[42601][7][ERROR: syntax error at or near ";"; Error while executing the query]
- "`Cannot execute ODBC query`" - Zabbix消息
- "`[SQL_ERROR]`" - ODBC返回码
- "`[42601]`" - SQL状态
- "`[7]`" - 原生错误码
- "`[ERROR: syntax error at or near ";"; Error while executing the query]`" - 原生错误消息
请注意错误消息长度限制为2048字节，因此
消息可能会被截断。如果存在多个ODBC诊断记录，
Zabbix会尝试在长度限制允许范围内将它们连接起来（用`|`分隔）。
#### Errors with fping execution in rootless containers
When containers are running in rootless mode or in a specific-restrictions environment, you may face errors related to fping execution when performing ICMP checks, such as `fping: Operation not permitted` or all packets to all resources lost.
To fix this problem add `--cap-add=net_raw` to "docker run" or "podman run" commands.
Additionally fping execution in non-root environments may require sysctl modification, i.e.:
sudo sysctl -w "net.ipv4.ping_group_range=0 1995"
where "1995" is the zabbix GID. For more details, see [ZBX-22833](https://support.zabbix.com/browse/ZBX-22833).
#### 无 root 权限容器中 fping 执行的错误
当容器以非root模式运行或在特定限制环境中时，执行ICMP检查时可能会遇到与fping执行相关的错误，例如`fping: Operation not permitted`或所有数据包丢失的情况。
要解决此问题，请在"docker run"或"podman run"命令中添加`--cap-add=net_raw`。
此外，在非root环境下执行fping可能需要修改sysctl参数，例如：
sudo sysctl -w "net.ipv4.ping_group_range=0 1995"
其中"1995"是zabbix的GID。更多详情请参阅[ZBX-22833](https://support.zabbix.com/browse/ZBX-22833)。
#### Escalation examples
#### 升级示例
#### Evaluation period
An evaluation period is used in functions referencing the item history.
It allows to specify the interval we are interested in. It can be
specified as time period (30s, 10m, 1h) or as a value range (\#5 - for
five latest values).
The evaluation period is measured up to "now" - where "now" is the
latest recalculation time of the trigger (see [Calculation
time](#calculation_time) above); "now" is not the "now" time of the
server.
The evaluation period specifies either:
- To consider all values between "now-time period" and "now" (or, with
time shift, between "now-time shift-time period" and
"now-time\_shift")
- To consider no more than the num count of values from the past, up
to "now"
- If there are 0 available values for the time period or num count
specified - then the trigger or calculated item that uses this
function becomes unsupported
Note that:
- If only a single function (referencing data history) is used in the
trigger, "now" is always the latest received value. For example, if
the last value was received an hour ago, the evaluation period will
be regarded as up to the latest value an hour ago.
- A new trigger is calculated as soon as the first value is received
(history functions); it will be calculated within 30 seconds for
[date and time](/manual/appendix/functions/time) and nodata()
functions. Thus the trigger will be calculated even
though perhaps the set evaluation period (for example, one hour) has
not yet passed since the trigger was created. The trigger will also
be calculated after the first value, even though the evaluation
range was set, for example, to ten latest values.
#### 评估周期
评估周期用于引用监控项历史数据的函数中。
它允许指定我们关注的时间区间。可以
表示为时间段（30s、10m、1h）或数值范围（\#5 - 表示
最近的五个值）。
评估周期计算至"当前时刻" - 这里的"当前时刻"指
触发器最近重新计算的时间（参见上文[计算时间](#calculation_time)）；
"当前时刻"并非服务器的实时时间。
评估周期可指定以下两种方式：
- 考虑"当前时刻-时间段"到"当前时刻"之间的所有值（或应用时间偏移时，
计算"当前时刻-时间偏移-时间段"到"当前时刻-时间偏移"之间的值）
- 最多考虑过去指定数量的值（不超过num个）
to "now"
- If there are 0 available values for the time period or num count
specified - then the trigger or calculated item that uses this
function becomes unsupported
需注意：
- 若触发器中仅使用单个（引用历史数据的）函数时，"当前时刻"始终是最近接收的值。
例如，若最后一个值是一小时前接收的，评估周期将计算至一小时前的最新值。
- 新触发器在收到第一个值时立即计算（历史函数类）；对于[date and time](/manual/appendix/functions/time)和nodata()
函数将在30秒内完成计算。因此即使自触发器创建后尚未达到
设定的评估周期（例如一小时），触发器仍会被计算。即使评估范围设置为
例如最近十个值，触发器也会在收到第一个值后立即计算。
# event.acknowledge
# event.acknowledge
#### Event correlation
Create custom event correlation rules.
[Correlation API](/manual/api/reference/correlation)
#### 事件关联
创建自定义事件关联规则.
[Correlation API](/manual/api/reference/correlation)
##### Event correlation
Event correlation (also called global event correlation) is a way to set
up custom event closing (resulting in OK event generation) rules.
The rules define how the new problem events are paired with existing
problem events and allow to close the new event or the matched events by
generating corresponding OK events.
However, event correlation must be configured very carefully, as it can
negatively affect event processing performance or, if misconfigured,
close more events than intended (in the worst case even all problem
events could be closed). A few configuration tips:
1. always reduce the correlation scope by setting a unique tag for the
control event (the event that is paired with old events) and use the
'new event tag' correlation condition
2. don't forget to add a condition based on the old event when using
'close old event' operation, or all existing problems could be
closed
3. avoid using common tag names used by different correlation
configurations
##### 事件关联
事件关联（也称为全局事件关联）是一种设置自定义事件关闭（生成OK事件）规则的方法。
这些规则定义了如何将新问题事件与现有问题事件配对，并通过生成相应的OK事件来关闭新事件或匹配的事件。
然而，事件关联必须非常谨慎地配置，因为它可能会对事件处理性能产生负面影响，或者如果配置不当，可能会关闭比预期更多的事件（在最坏的情况下甚至可能关闭所有问题事件）。以下是一些配置建议：
1. 始终通过为控制事件（与旧事件配对的事件）设置唯一标签来缩小关联范围，并使用'新事件标签'关联条件
2. 在使用'关闭旧事件'操作时，不要忘记添加基于旧事件的条件，否则可能会关闭所有现有问题
3. 避免使用不同关联配置共用的标签名称
# event.get
# event.get
#### Event menu
Clicking on the problem name brings up the event menu:
The event menu allows to:
- filter the problems of the trigger
- access the trigger configuration
- access a simple graph/item history of the underlying item(s)
- access an external ticket of the problem (if configured, see the
*Include event menu entry* option when configuring
[webhooks](/manual/config/notifications/media/webhook))
- execute global
[scripts](/manual/web_interface/frontend_sections/administration/scripts)
(these scripts need to have their scope defined as 'Manual event
action'). This feature may be handy for running scripts used for
managing problem tickets in external systems.
#### 事件菜单
点击问题名称将弹出事件菜单:
事件菜单允许您:
- 筛选该触发器的问题
- 访问触发器配置
- 访问底层监控项的简单图表/监控项历史记录
- 访问问题的外部工单(如已配置，参见配置[webhooks](/manual/config/notifications/media/webhook)时的*包含事件菜单项*选项)
- execute全局
[scripts](/manual/web_interface/frontend_sections/administration/scripts)
(这些脚本需要将其作用域定义为'手动事件操作')。此功能可用于运行管理外部系统问题工单的脚本。
### Event
::: noteclassic
Events are created by the Zabbix server and cannot be
modified via the API.
:::
The event object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|eventid|string|ID of the event.|
|source|integer|Type of the event.<br><br>Possible values:<br>0 - event created by a trigger;<br>1 - event created by a discovery rule;<br>2 - event created by active agent autoregistration;<br>3 - internal event;<br>4 - event created on service status update.|
|object|integer|Type of object that is related to the event.<br><br>Possible values for trigger events:<br>0 - trigger.<br><br>Possible values for discovery events:<br>1 - discovered host;<br>2 - discovered service.<br><br>Possible values for autoregistration events:<br>3 - auto-registered host.<br><br>Possible values for internal events:<br>0 - trigger;<br>4 - item;<br>5 - LLD rule.<br><br>Possible values for service events:<br>6 - service.|
|objectid|string|ID of the related object.|
|acknowledged|integer|Whether the event has been acknowledged.|
|clock|timestamp|Time when the event was created.|
|ns|integer|Nanoseconds when the event was created.|
|name|string|Resolved event name.|
|value|integer|State of the related object.<br><br>Possible values for trigger and service events:<br>0 - OK;<br>1 - problem.<br><br>Possible values for discovery events:<br>0 - host or service up;<br>1 - host or service down;<br>2 - host or service discovered;<br>3 - host or service lost.<br><br>Possible values for internal events:<br>0 - "normal" state;<br>1 - "unknown" or "not supported" state.<br><br>This parameter is not used for active agent autoregistration events.|
|severity|integer|Event current severity.<br><br>Possible values:<br>0 - not classified;<br>1 - information;<br>2 - warning;<br>3 - average;<br>4 - high;<br>5 - disaster.|
|r\_eventid|string|Recovery event ID|
|c\_eventid|string|ID of the event that was used to override (close) current event under global correlation rule. See `correlationid` to identify exact correlation rule.<br>This parameter is only defined when the event is closed by global correlation rule.|
|correlationid|string|ID of the correlation rule that generated closing of the problem.<br>This parameter is only defined when the event is closed by global correlation rule.|
|userid|string|User ID if the event was manually closed.|
|suppressed|integer|Whether the event is suppressed.<br><br>Possible values:<br>0 - event is in normal state;<br>1 - event is suppressed.|
|opdata|string|Operational data with expanded macros.|
|urls|array|Active [media type URLs](/manual/api/reference/problem/object#media-type-url).|
### 事件
::: noteclassic
事件由Zabbix server创建，无法通过API修改。
:::
事件object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| eventid | string | 事件ID。 |
| source | integer | 事件类型。<br><br>可能值：<br>0 - 由触发器创建的事件；<br>1 - 由发现规则创建的事件；<br>2 - 由主动agent自动注册创建的事件；<br>3 - 内部事件；<br>4 - 服务状态update创建的事件。 |
| object | integer | 与事件相关的object类型。<br><br>触发器事件的可能值：<br>0 - 触发器。<br><br>发现事件的可能值：<br>1 - 发现的主机；<br>2 - 发现的服务。<br><br>自动注册事件的可能值：<br>3 - 自动注册的主机。<br><br>内部事件的可能值：<br>0 - 触发器；<br>4 - 监控项；<br>5 - LLD规则。<br><br>服务事件的可能值：<br>6 - 服务。 |
| objectid | string | 相关object的ID。 |
| acknowledged | integer | 事件是否已被确认。 |
| clock | timestamp | 事件创建时间。 |
| ns | integer | 事件创建的纳秒时间。 |
| name | string | 已解决的事件名称。 |
| value | integer | 相关object的状态。<br><br>触发器和服务事件的可能值：<br>0 - 正常；<br>1 - 问题。<br><br>发现事件的可能值：<br>0 - 主机或服务在线；<br>1 - 主机或服务离线；<br>2 - 主机或服务已发现；<br>3 - 主机或服务丢失。<br><br>内部事件的可能值：<br>0 - "正常"状态；<br>1 - "未知"或"不支持"状态。<br><br>此参数不用于主动agent自动注册事件。 |
| severity | integer | 事件当前严重性。<br><br>可能值：<br>0 - 未分类；<br>1 - 信息；<br>2 - 警告；<br>3 - 一般；<br>4 - 高；<br>5 - 灾难。 |
| r\_eventid | string | 恢复事件ID |
| c\_eventid | string | 在全局关联规则下用于覆盖（关闭）当前事件的事件ID。参见`correlationid`以识别具体的关联规则。<br>此参数仅在事件被全局关联规则关闭时定义。 |
| correlationid | string | 生成问题关闭的关联规则ID。<br>此参数仅在事件被全局关联规则关闭时定义。 |
| userid | string | 如果事件被手动关闭，则为用户ID。 |
| suppressed | integer | 事件是否被抑制。<br><br>可能值：<br>0 - 事件处于正常状态；<br>1 - 事件被抑制。 |
| opdata | string | 包含扩展宏的操作数据。 |
| urls | array | 活跃[媒介类型-url](/manual/api/reference/problem/object#媒介类型-url)。 |
#### Events
Retrieve events generated by triggers, network discovery and other
Zabbix systems for more flexible situation management or third-party
tool integration.
[Event API](/manual/api/reference/event)
#### 事件
获取由触发器、网络发现及其他Zabbix系统生成的事件，以实现更灵活的状况管理或第三方工具集成。
[Event API](/manual/api/reference/event)
### Event tag
The event tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|tag|string|Event tag name.|
|value|string|Event tag value.|
### 事件标签
事件标签object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| tag | string | 事件标签名称. |
| value | string | 事件标签值. |
### Example
### 示例
##### Example 10
CPU activity at any time with exception.
Use of function time() and **not** operator:
min(/zabbix/system.cpu.load[all,avg1],5m)>2
and not (dayofweek()=7 and time()>230000)
and not (dayofweek()=1 and time()<010000)
The trigger may change its state to problem at any time,
except for 2 hours on a week change (Sunday, 23:00 - Monday, 01:00).
##### 示例 10
CPU活动在任何时间都可能出现异常。
使用time()函数和**not**运算符的情况：
min(/zabbix/system.cpu.load[all,avg1],5m)>2
and not (dayofweek()=7 and time()>230000)
and not (dayofweek()=1 and time()<010000)
触发器可能在任何时间改变状态为问题状态，
除了一周交替时的2小时（周日23:00至周一01:00）。
##### Example 11
Check if client local time is in sync with Zabbix server time.
Use of function fuzzytime():
fuzzytime(/MySQL_DB/system.localtime,10s)=0
The trigger will change to the problem state in case when local time on
server MySQL\_DB and Zabbix server differs by more than 10 seconds. Note
that 'system.localtime' must be configured as a [passive
check](/manual/appendix/items/activepassive#passive_checks).
##### 示例 11
检查客户端本地时间是否与Zabbix server时间同步.
使用fuzzytime()函数:
fuzzytime(/MySQL_DB/system.localtime,10s)=0
当MySQL\_DB服务器本地时间与Zabbix server时间相差超过10秒时，触发器将切换至问题状态。注意'system.localtime'必须配置为[被动检查](/manual/appendix/items/activepassive#被动检查).
##### Example 12
Comparing average load today with average load of the same time
yesterday (using time shift as `now-1d`).
avg(/server/system.cpu.load,1h)/avg(/server/system.cpu.load,1h:now-1d)>2
This trigger will fire if the average load of the last hour tops the
average load of the same hour yesterday more than two times.
##### 示例 12
将今日平均负载与昨日同一时刻的平均负载进行比较（使用时间偏移`now-1d`）。
avg(/server/system.cpu.load,1h)/avg(/server/system.cpu.load,1h:now-1d)>2
如果最近一小时的平均负载超过昨日同一小时平均负载的两倍以上，此触发器将触发。
##### Example 13
Using the value of another item to get a trigger threshold:
last(/Template PfSense/hrStorageFree[{#SNMPVALUE}])<last(/Template PfSense/hrStorageSize[{#SNMPVALUE}])*0.1
The trigger will fire if the free storage drops below 10 percent.
##### 示例 13
使用另一个监控项的值来get触发器阈值:
last(/Template PfSense/hrStorageFree[{#SNMPVALUE}])<last(/Template PfSense/hrStorageSize[{#SNMPVALUE}])*0.1
如果空闲存储空间降至10%以下，触发器将触发。
##### Example 14
Using [evaluation result](#operators) to get the number of triggers over
a threshold:
(last(/server1/system.cpu.load[all,avg1])>5) + (last(/server2/system.cpu.load[all,avg1])>5) + (last(/server3/system.cpu.load[all,avg1])>5)>=2
The trigger will fire if at least two of the triggers in the expression
are in a problem state.
##### 示例 14
使用[评估结果](#operators)来get超过阈值的触发器数量：
(last(/server1/system.cpu.load[all,avg1])>5) + (last(/server2/system.cpu.load[all,avg1])>5) + (last(/server3/system.cpu.load[all,avg1])>5)>=2
如果表达式中至少有两个触发器处于问题状态，该触发器将会触发。
##### Example 15
Comparing string values of two items - operands here are functions that
return strings.
Problem: create an alert if Ubuntu version is different on different
hosts
last(/NY Zabbix server/vfs.file.contents[/etc/os-release])<>last(/LA Zabbix server/vfs.file.contents[/etc/os-release])
##### 示例 15
比较两个string的监控项值 - 此处操作数为返回字符串的函数
问题: 当Ubuntuversion在不同主机上不一致时create警报
last(/NY Zabbix server/vfs.file.contents[/etc/os-release])<>last(/LA Zabbix server/vfs.file.contents[/etc/os-release])
##### Example 16
Comparing two string values - operands are:
- a function that returns a string
- a combination of macros and strings
Problem: detect changes in the DNS query
The item key is:
net.dns.record[8.8.8.8,{$WEBSITE_NAME},{$DNS_RESOURCE_RECORD_TYPE},2,1]
with macros defined as
{$WEBSITE_NAME} = example.com
{$DNS_RESOURCE_RECORD_TYPE} = MX
and normally returns:
example.com MX 0 mail.example.com
So our trigger expression to detect if the DNS query result deviated
from the expected result is:
last(/Zabbix server/net.dns.record[8.8.8.8,{$WEBSITE_NAME},{$DNS_RESOURCE_RECORD_TYPE},2,1])<>"{$WEBSITE_NAME} {$DNS_RESOURCE_RECORD_TYPE} 0 mail.{$WEBSITE_NAME}"
Notice the quotes around the second operand.
##### 示例 16
比较两个string值 - 操作数为:
- 返回string的函数
- 宏与字符串的组合
问题: 检测DNS query中的变更
监控项键为:
net.dns.record[8.8.8.8,{$WEBSITE_NAME},{$DNS_RESOURCE_RECORD_TYPE},2,1]
宏定义为
{$WEBSITE_NAME} = example.com
{$DNS_RESOURCE_RECORD_TYPE} = MX
通常返回:
example.com MX 0 mail.example.com
因此我们检测DNS query结果是否偏离预期结果的触发器表达式为:
last(/Zabbix server/net.dns.record[8.8.8.8,{$WEBSITE_NAME},{$DNS_RESOURCE_RECORD_TYPE},2,1])<>"{$WEBSITE_NAME} {$DNS_RESOURCE_RECORD_TYPE} 0 mail.{$WEBSITE_NAME}"
注意第二个操作数周围的引号
##### Example 17
Comparing two string values - operands are:
- a function that returns a string
- a string constant with special characters \\ and "
Problem: detect if the `/tmp/hello` file content is equal to:
\" //hello ?\"
Option 1) write the string directly
last(/Zabbix server/vfs.file.contents[/tmp/hello])="\\\" //hello ?\\\""
Notice how \\ and " characters are escaped when the string gets compared
directly.
Option 2) use a macro
{$HELLO_MACRO} = \" //hello ?\"
in the expression:
last(/Zabbix server/vfs.file.contents[/tmp/hello])={$HELLO_MACRO}
##### 示例 17
比较两个string值 - 操作数为:
- 返回string的函数
- 包含特殊字符\\和"的string常量
问题: 检测`/tmp/hello` file内容是否等于:
\" //hello ?\"
选项1) 直接写入string
last(/Zabbix server/vfs.file.contents[/tmp/hello])="\\\" //hello ?\\\""
注意当直接比较string时，\\和"字符是如何被转义的
选项2) 使用宏
{$HELLO_MACRO} = \" //hello ?\"
在表达式中:
last(/Zabbix server/vfs.file.contents[/tmp/hello])={$HELLO_MACRO}
##### Example 18
Comparing long-term periods.
Problem: Load of Exchange server increased by more than 10% last month
trendavg(/Exchange/system.cpu.load,1M:now/M)>1.1*trendavg(/Exchange/system.cpu.load,1M:now/M-1M)
You may also use the [Event
name](/manual/config/triggers/trigger#configuration) field in trigger
configuration to build a meaningful alert message, for example to
receive something like
`"Load of Exchange server increased by 24% in July (0.69) comparing to June (0.56)"`
the event name must be defined as:
Load of {HOST.HOST} server increased by {{?100*trendavg(//system.cpu.load,1M:now/M)/trendavg(//system.cpu.load,1M:now/M-1M)}.fmtnum(0)}% in {{TIME}.fmttime(%B,-1M)} ({{?trendavg(//system.cpu.load,1M:now/M)}.fmtnum(2)}) comparing to {{TIME}.fmttime(%B,-2M)} ({{?trendavg(//system.cpu.load,1M:now/M-1M)}.fmtnum(2)})
It is also useful to allow manual closing in trigger configuration for
this kind of problem.
##### 示例 18
对比长期时间段.
问题: 上个月Exchange服务器负载增长超过10%
trendavg(/Exchange/system.cpu.load,1M:now/M)>1.1*trendavg(/Exchange/system.cpu.load,1M:now/M-1M)
您也可以在触发器配置中使用[配置](/manual/config/triggers/trigger#配置)字段来构建有意义的告警消息, 例如接收类似
`"Load of Exchange server increased by 24% in July (0.69) comparing to June (0.56)"`
的事件名称必须定义为:
Load of {HOST.HOST} server increased by {{?100*trendavg(//system.cpu.load,1M:now/M)/trendavg(//system.cpu.load,1M:now/M-1M)}.fmtnum(0)}% in {{TIME}.fmttime(%B,-1M)} ({{?trendavg(//system.cpu.load,1M:now/M)}.fmtnum(2)}) comparing to {{TIME}.fmttime(%B,-2M)} ({{?trendavg(//system.cpu.load,1M:now/M-1M)}.fmtnum(2)})
对于这类问题, 在触发器配置中允许手动关闭也很有用.
##### Example 1
Calculating percentage of free disk space on '/'.
Use of function **last**:
100*last(//vfs.fs.size[/,free])/last(//vfs.fs.size[/,total])
Zabbix will take the latest values for free and total disk spaces and
calculate percentage according to the given formula.
##### 示例1
计算'/'分区剩余磁盘空间百分比
使用**last**函数:
100*last(//vfs.fs.size[/,free])/last(//vfs.fs.size[/,total])
Zabbix将获取磁盘剩余空间和总空间的最新值
并根据给定公式计算百分比
##### Example 1: Discovering MBeans
This rule will return 3 objects: the top row of the column: MBean1,
MBean2, MBean3.
For more information about objects please refer to [supported
macros](/manual/discovery/low_level_discovery/examples/jmx#supported_macros)
table, *Discovery of MBeans* section.
Discovery rule configuration collecting MBeans (without the attributes)
looks like the following:
The key used here:
jmx.discovery[beans,"*:type=GarbageCollector,name=*"]
All the garbage collectors without attributes will be discovered. As
Garbage collectors have the same attribute set, we can use desired
attributes in item prototypes the following way:
The keys used here:
jmx[{#JMXOBJ},CollectionCount]
jmx[{#JMXOBJ},CollectionTime]
jmx[{#JMXOBJ},Valid]
LLD discovery rule will result in something close to this (items are
discovered for two Garbage collectors):
{width="600"}
##### 示例 1: 发现 MBean
此规则将返回3个objects: 列的Top行: MBean1,
MBean2, MBean3.
有关objects的更多信息，请参阅[支持的宏](/manual/discovery/low_level_discovery/examples/jmx#支持的宏)
表格中的*MBeans发现*部分。
收集MBeans(不含属性)的发现规则配置如下所示:
此处使用的键:
jmx.discovery[beans,"*:type=GarbageCollector,name=*"]
所有不带属性的垃圾收集器都将被发现。由于
垃圾收集器具有相同的属性集，我们可以通过以下方式在监控项原型中使用所需属性:
此处使用的键:
jmx[{#JMXOBJ},CollectionCount]
jmx[{#JMXOBJ},CollectionTime]
jmx[{#JMXOBJ},Valid]
LLD发现规则将产生类似以下的结果(为两个垃圾收集器发现了监控项):
{width="600"}
##### Example 1
General example:
|Parameter|Description|
|--|--------|
|**OID**|1.2.3.45.6.7.8.0 (or .1.2.3.45.6.7.8.0)|
|**Key**|<Unique string to be used as reference to triggers><br>For example, "my\_param".|
Note that OID can be given in either numeric or string form. However, in
some cases, string OID must be converted to numeric representation.
Utility snmpget may be used for this purpose:
snmpget -On localhost public enterprises.ucdavis.memory.memTotalSwap.0
##### 示例1
通用示例:
| 参数 | 描述 |
|--|--------|
| **OID** | 1.2.3.45.6.7.8.0 (或 .1.2.3.45.6.7.8.0) |
| **Key** | <用作触发器引用的唯一string><br>例如 "my\_param". |
注意OID可以以数字或string形式给出。然而在某些情况下，string OID必须转换为数字表示形式。
可以使用snmpget工具实现此目的:
snmpget -On localhost public enterprises.ucdavis.memory.memTotalSwap.0
##### Example 1
Message subject:
Problem: {TRIGGER.NAME}
When you receive the message, the message subject will be replaced by
something like:
Problem: Processor load is too high on Zabbix server
##### 示例1
邮件主题：
Problem: {TRIGGER.NAME}
当您收到消息时，邮件主题将被替换为类似以下内容：
问题：Zabbix server上的处理器负载过高
##### Example 1
Monitoring of two instances “MySQL1” and “MySQL2”.
Configuration parameters:
```bash
Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
Plugins.Mysql.Sessions.MySQL1.User=mysql1_user
Plugins.Mysql.Sessions.MySQL1.Password=unique_password
Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.0:3306
Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
Plugins.Mysql.Sessions.MySQL2.Password=different_password
```
As a result of this configuration, each session name may be used as a connString in an [item key](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2), e.g., `mysql.ping[MySQL1]` or `mysql.ping[MySQL2]`.
##### 示例1
监控两个实例 "MySQL1" 和 "MySQL2".
配置参数:
```bash
Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
Plugins.Mysql.Sessions.MySQL1.User=mysql1_user
Plugins.Mysql.Sessions.MySQL1.Password=unique_password
Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.0:3306
Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
Plugins.Mysql.Sessions.MySQL2.Password=different_password
```
通过此配置，每个会话名称可作为 [item key](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2) 中的 connString 使用，例如 `mysql.ping[MySQL1]` 或 `mysql.ping[MySQL2]`。
**Example 1**
Restart of Windows on certain condition.
In order to automatically restart Windows upon a problem detected by
Zabbix, define the following script:
|Script parameter|Value|
|--|--------|
|*Scope*|'Action operation'|
|*Type*|'Script'|
|*Command*|c:\\windows\\system32\\shutdown.exe -r -f|
**示例1**
在特定条件下重启Windows.
为了在Zabbix检测到问题时自动重启Windows，请定义以下脚本：
| 脚本参数 | 值 |
|--|--------|
| *Scope* | '操作动作' |
| *Type* | '脚本' |
| *Command* | c:\\windows\\system32\\shutdown.exe -r -f |
##### Example 1
Sending a repeated notification once every 30 minutes (5 times in total)
to a 'MySQL Administrators' group. To configure:
- in Operations tab, set the *Default operation step duration* to
'30m' (30 minutes)
- Set the escalation steps to be *From* '1' *To* '5'
- Select the 'MySQL Administrators' group as recipients of the message
{width="600"}
Notifications will be sent at 0:00, 0:30, 1:00, 1:30, 2:00 hours after
the problem starts (unless, of course, the problem is resolved sooner).
If the problem is resolved and a recovery message is configured, it will
be sent to those who received at least one problem message within this
escalation scenario.
::: noteclassic
If the trigger that generated an active escalation is
disabled, Zabbix sends an informative message about it to all those that
have already received notifications.
:::
##### 示例1
向'MySQL管理员'组发送重复通知，每30分钟一次（共5次）。配置方法：
- 在操作选项卡中，将*默认操作步骤持续时间*设置为'30m'（30分钟）
- 将升级步骤设置为*从*'1'*到*'5'
- 选择'MySQL管理员'组作为消息接收者
{width="600"}
通知将在问题开始后的0:00、0:30、1:00、1:30、2:00时间点发送（当然，如果问题提前解决则不会发送）。
如果问题解决且配置了恢复消息，该消息将发送给在此升级场景中至少收到过一条问题消息的接收者。
::: noteclassic
如果生成活动升级的触发器被禁用，Zabbix会向所有已收到通知的人员发送相关信息通知。
:::
##### Example 1
Send simple GET requests to retrieve data from services such as
Elasticsearch:
- Create a GET item with URL: `localhost:9200/?pretty`
- Notice the response:
```{=html}
<!-- -->
```
{
"name" : "YQ2VAY-",
"cluster_name" : "elasticsearch",
"cluster_uuid" : "kH4CYqh5QfqgeTsjh2F9zg",
"version" : {
"number" : "6.1.3",
"build_hash" : "af51318",
"build_date" : "2018-01-26T18:22:55.523Z",
"build_snapshot" : false,
"lucene_version" : "7.1.0",
"minimum_wire_compatibility_version" : "5.6.0",
"minimum_index_compatibility_version" : "5.0.0"
},
"tagline" : "You know, for search"
}
- Now extract the version number using a JSONPath preprocessing step:
`$.version.number`
##### 示例1
发送简单的GET请求以从服务中检索数据
Elasticsearch:
- 创建一个GET 监控项请求，URL为：`localhost:9200/?pretty`
- 注意响应：
```{=html}
<!-- -->
```
{
"name" : "YQ2VAY-",
"cluster_name" : "elasticsearch",
"cluster_uuid" : "kH4CYqh5QfqgeTsjh2F9zg",
"version" : {
"number" : "6.1.3",
"build_hash" : "af51318",
"build_date" : "2018-01-26T18:22:55.523Z",
"build_snapshot" : false,
"lucene_version" : "7.1.0",
"minimum_wire_compatibility_version" : "5.6.0",
"minimum_index_compatibility_version" : "5.0.0"
},
"tagline" : "您知道的，专为搜索而生"
}
- 现在通过JSONPath预处理步骤提取version数值:
`$.version.number`
##### Example 1
Something very simple:
UserParameter=ping[*],echo $1
We may define unlimited number of items for monitoring all having format
ping\[something\].
- ping\[0\] - will always return '0'
- ping\[aaa\] - will always return 'aaa'
##### 示例1
一个非常简单的示例:
UserParameter=ping[*],echo $1
我们可以定义无限数量的监控项用于监控 所有监控项都遵循
ping\[something\]格式.
- ping\[0\] - 将始终返回'0'
- ping\[aaa\] - 将始终返回'aaa'
##### Example 1
Temperature in server room is too high.
Problem expression:
last(/server/temp)>20
Recovery expression:
last(/server/temp)<=15
##### 示例1
服务器机房温度过高
问题表达式:
last(/server/temp)>20
恢复表达式:
last(/server/temp)<=15
##### Example 1
The processor load is too high on Zabbix server.
last(/Zabbix server/system.cpu.load[all,avg1])>5
By using the function 'last()', we are referencing the most recent
value. `/Zabbix server/system.cpu.load[all,avg1]` gives a short name of
the monitored parameter. It specifies that the host is 'Zabbix server'
and the key being monitored is 'system.cpu.load\[all,avg1\]'. Finally,
`>5` means that the trigger is in the PROBLEM state whenever the most
recent processor load measurement from Zabbix server is greater than 5.
##### 示例1
Zabbix server上的处理器负载过高。
last(/Zabbix server/system.cpu.load[all,avg1])>5
通过使用函数'last()'，我们引用最近的值。`/Zabbix server/system.cpu.load[all,avg1]`给出被监控参数的简称。它指定主机为'Zabbix server'，且被监控的键是'system.cpu.load\[all,avg1\]'。最后，`>5`表示当Zabbix server最近的处理器负载测量值大于5时，触发器将处于PROBLEM状态。
##### Example 1
To create a "Web scenario failed" trigger, you can define a trigger
expression:
last(/host/web.test.fail[Scenario])<>0
Make sure to replace 'Scenario' with the real name of your scenario.
##### 示例1
要create一个"Web场景失败"触发器，您可以定义如下触发器表达式：
last(/host/web.test.fail[Scenario])<>0
请确保将'Scenario'替换为您实际的场景名称。
##### Example 1
Total disk space of host group 'MySQL Servers'.
sum(last_foreach(/*/vfs.fs.size[/,total]?[group="MySQL Servers"]))
##### 示例1
MySQL服务器组主机组的总磁盘空间.
sum(last_foreach(/*/vfs.fs.size[/,total]?[group="MySQL Servers"]))
##### Example 1
Use of host-level macro in the "Status of SSH daemon" item key:
`net.tcp.service[ssh,,{$SSH_PORT}]`
This item can be assigned to multiple hosts, providing that the value of
**{$SSH\_PORT}** is defined on those hosts.
##### 示例1
在"SSH守护进程状态"监控项监控项键值中使用主机级别宏:
`net.tcp.service[ssh,,{$SSH_PORT}]`
该监控项可分配给多个主机，前提是这些主机上已定义**{$SSH\_PORT}**的值。
##### Example 1
Use of the following expression in low-level discovery to discover
databases except a database with a specific name:
^TESTDATABASE$
Chosen *Expression type*: "Result is FALSE". Doesn't match name,
containing string "*TESTDATABASE*".
##### 示例1
在低级发现中使用以下表达式来发现除特定名称数据库之外的所有数据库:
^TESTDATABASE$
选择的*表达式类型*: "结果为FALSE"。不匹配包含string "*TESTDATABASE*"的名称。
##### Example 1
Using host metadata to distinguish between Linux and Windows hosts.
Say you would like the hosts to be autoregistered by the Zabbix server.
You have active Zabbix agents (see "Configuration" section above) on
your network. There are Windows hosts and Linux hosts on your network
and you have "Linux by Zabbix agent" and "Windows by Zabbix agent"
templates available in your Zabbix frontend. So at host registration,
you would like the appropriate Linux/Windows template to be applied to
the host being registered. By default, only the hostname is sent to the
server at autoregistration, which might not be enough. In order to make
sure the proper template is applied to the host you should use host
metadata.
##### 示例1
利用主机元数据区分Linux与Windows主机.
假设您希望主机通过Zabbix server自动注册.
您的网络中已启用Zabbix agents(参见上方"配置"章节).
网络中存在Windows主机和Linux主机,
且Zabbix前端提供"Linux by Zabbix agent"和"Windows by Zabbix agent"模板.
在主机注册时,您希望为注册的主机应用对应的Linux/Windows模板.
默认情况下,自动注册时仅向服务器发送主机名,这可能不够充分.
为确保正确的模板应用于主机,应使用主机元数据.
##### Example 2
Calculating a 10-minute average of the number of values processed by
Zabbix.
Use of function **avg**:
avg(/Zabbix Server/zabbix[wcache,values],10m)
Note that extensive use of calculated items with long time periods may
affect performance of Zabbix server.
##### 示例2
计算10分钟内处理值的数量平均值
Zabbix
使用函数 **avg**：
avg(/Zabbix Server/zabbix[wcache,values],10m)
请注意，大量使用具有长时间周期的计算型监控项可能会
影响Zabbix server的性能
##### Example 2: Discovering MBean attributes
This rule will return 9 objects with the following fields:
MBean1Attribute1, MBean2Attribute1, MBean3Attribute1,
MBean1Attribute2, MBean2Attribute2, MBean3Attribute2,
MBean1Attribute3, MBean2Attribute3, MBean3Attribute3.
For more information about objects please refer to [supported
macros](/manual/discovery/low_level_discovery/examples/jmx#supported_macros)
table, *Discovery of MBean attributes* section.
Discovery rule configuration collecting MBean attributes looks like the
following:
The key used here:
jmx.discovery[attributes,"*:type=GarbageCollector,name=*"]
All the garbage collectors with a single item attribute will be
discovered.
In this particular case an item will be created from prototype for every
MBean attribute. The main drawback of this configuration is that trigger
creation from trigger prototypes is impossible as there is only one item
prototype for all attributes. So this setup can be used for data
collection, but is not recommended for automatic monitoring.
##### 示例 2：发现 MBean 属性
此规则将返回包含以下字段的9个objects:
MBean1Attribute1, MBean2Attribute1, MBean3Attribute1,
MBean1Attribute2, MBean2Attribute2, MBean3Attribute2,
MBean1Attribute3, MBean2Attribute3, MBean3Attribute3.
有关objects的更多信息，请参阅[支持的宏](/manual/discovery/low_level_discovery/examples/jmx#支持的宏)
表格中的*MBean属性发现*部分。
收集MBean属性的发现规则配置如下所示:
此处使用的键:
jmx.discovery[attributes,"*:type=GarbageCollector,name=*"]
所有具有单个监控项属性的垃圾收集器都将被
发现。
在此特定情况下，将为每个
MBean属性从原型创建一个监控项。此配置的主要缺点是
由于所有属性只有一个监控项原型，因此无法从触发器原型创建触发器。
因此此设置可用于数据
收集，但不推荐用于自动监控。
##### Example 2
Free disk space is too low.
Problem expression: it is less than 10GB for last 5 minutes
max(/server/vfs.fs.size[/,free],5m)<10G
Recovery expression: it is more than 40GB for last 10 minutes
min(/server/vfs.fs.size[/,free],10m)>40G
##### 示例2
磁盘剩余空间过低。
问题表达式：过去5分钟内小于10GB
max(/server/vfs.fs.size[/,free],5m)<10G
恢复表达式：过去10分钟内大于40GB
min(/server/vfs.fs.size[/,free],10m)>40G
##### Example 2
Let's add more sense!
UserParameter=mysql.ping[*],mysqladmin -u$1 -p$2 ping | grep -c alive
This parameter can be used for monitoring availability of MySQL
database. We can pass user name and password:
mysql.ping[zabbix,our_password]
##### 示例2
让我们增添更多意义!
UserParameter=mysql.ping[*],mysqladmin -u$1 -p$2 ping | grep -c alive
此参数可用于监测MySQL数据库的可用性。我们可以传递用户名和密码:
mysql.ping[zabbix,our_password]
##### Example 2
Message:
Processor load is: {?last(/zabbix.zabbix.com/system.cpu.load[,avg1])}
When you receive the message, the message will be replaced by something
like:
Processor load is: 1.45
##### 示例2
消息:
Processor load is: {?last(/zabbix.zabbix.com/system.cpu.load[,avg1])}
当您收到该消息时，消息内容将被替换为类似以下内容:
处理器负载为: 1.45
##### Example 2
Monitoring of uptime:
|Parameter|Description|
|--|--------|
|**OID**|MIB::sysUpTime.0|
|**Key**|router.uptime|
|**Value type**|Float|
|**Units**|uptime|
|**Preprocessing step: Custom multiplier**|0.01|
##### 示例2
运行时间监控:
| 参数 | 描述 |
|--|--------|
| **OID** | MIB::sysUpTime.0 |
| **Key** | router.uptime |
| **Value type** | float |
| **Units** | uptime |
| **Preprocessing step: Custom multiplier** | 0.01 |
##### Example 2
Providing some of the parameters in the item key (supported since Zabbix 6.0.17).
Configuration parameters:
```bash
Plugins.PostgreSQL.Sessions.Session1.Uri=tcp://192.0.2.234:5432
Plugins.PostgreSQL.Sessions.Session1.User=old_username
Plugins.PostgreSQL.Sessions.Session1.Password=session_password
```
[Item key](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2): `pgsql.ping[session1,new_username,,postgres]`
As a result of this configuration, the agent will connect to PostgreSQL using the following parameters:
- URI from session parameter: *192.0.2.234:5432*
- Username from the item key: *new_username*
- Password from session parameter (since it is omitted in the item key): *session_password*
- Database name from the item key: *postgres*
##### 示例2
在监控项键中提供部分参数（自Zabbix 6.0.17起支持）
配置参数：
```bash
Plugins.PostgreSQL.Sessions.Session1.Uri=tcp://192.0.2.234:5432
Plugins.PostgreSQL.Sessions.Session1.User=old_username
Plugins.PostgreSQL.Sessions.Session1.Password=session_password
```
[Item key](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2): `pgsql.ping[session1,new_username,,postgres]`
此配置的结果是，agent将使用以下参数连接到PostgreSQL：
- 会话参数中的URI：*192.0.2.234:5432*
- 监控项键中的用户名：*new_username*
- 会话参数中的密码（因为在监控项键中省略）：*session_password*
- 监控项键中的数据库名：*postgres*
**Example 2**
Restart the host by using IPMI control.
|Script parameter|Value|
|--|--------|
|*Scope*|'Action operation'|
|*Type*|'IPMI'|
|*Command*|reset|
**示例 2**
通过IPMI控制重启主机.
| 脚本参数 | 值 |
|--|--------|
| *Scope* | '操作动作' |
| *Type* | 'IPMI' |
| *Command* | reset |
##### Example 2
Sending a delayed notification about a long-standing problem. To
configure:
- In Operations tab, set the *Default operation step duration* to
'10h' (10 hours)
- Set the escalation steps to be *From* '2' *To* '2'
{width="600"}
A notification will only be sent at Step 2 of the escalation scenario,
or 10 hours after the problem starts.
You can customize the message text to something like 'The problem is
more than 10 hours old'.
##### 示例2
发送关于长期存在问题的延迟通知。配置方法：
- 在操作选项卡中，将*默认操作步骤持续时间*设置为'10h'（10小时）
- 将升级步骤设置为*从*'2'*到*'2'
{width="600"}
通知仅会在升级场景的第2步发送，或在问题开始10小时后发送。
您可以将消息文本自定义为类似'该问题已存在超过10小时'的内容。
##### Example 2
Send simple POST requests to retrieve data from services such as
Elasticsearch:
- Create a POST item with URL:
`http://localhost:9200/str/values/_search?scroll=10s`
- Configure the following POST body to obtain the processor load (1
min average per core)
```{=html}
<!-- -->
```
{
"query": {
"bool": {
"must": [{
"match": {
"itemid": 28275
}
}],
"filter": [{
"range": {
"clock": {
"gt": 1517565836,
"lte": 1517566137
}
}
}]
}
}
}
- Received:
```{=html}
<!-- -->
```
{
"_scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAAAkFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAJRZZUTJWQVktVFNacU5nRHhlcEI0QUxRAAAAAAAAACYWWVEyVkFZLVRTWnFOZ0R4ZXBCNEFMUQAAAAAAAAAnFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAKBZZUTJWQVktVFNacU5nRHhlcEI0QUxR",
"took": 18,
"timed_out": false,
"_shards": {
"total": 5,
"successful": 5,
"skipped": 0,
"failed": 0
},
"hits": {
"total": 1,
"max_score": 1.0,
"hits": [{
"_index": "dbl",
"_type": "values",
"_id": "dqX9VWEBV6sEKSMyk6sw",
"_score": 1.0,
"_source": {
"itemid": 28275,
"value": "0.138750",
"clock": 1517566136,
"ns": 25388713,
"ttl": 604800
}
}]
}
}
- Now use a JSONPath preprocessing step to get the item value:
`$.hits.hits[0]._source.value`
##### 示例2
发送简单POST请求以从服务中检索数据
Elasticsearch:
- 创建一个POST 监控项请求，URL为：
`http://localhost:9200/str/values/_search?scroll=10s`
- 配置以下POST请求体以获取处理器负载(1
min average per core)
```{=html}
<!-- -->
```
{
"query": {
"bool": {
"must": [{
"match": {
"itemid": 28275
}
}],
"filter": [{
"range": {
"clock": {
"gt": 1517565836,
"lte": 1517566137
}
}
}]
}
}
}
- 已接收:
```{=html}
<!-- -->
```
{
"_scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAAAkFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAJRZZUTJWQVktVFNacU5nRHhlcEI0QUxRAAAAAAAAACYWWVEyVkFZLVRTWnFOZ0R4ZXBCNEFMUQAAAAAAAAAnFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAKBZZUTJWQVktVFNacU5nRHhlcEI0QUxR"
"耗时": 18,
"timed_out": false,
"_shards": {
"total": 5,
"successful": 5,
"skipped": 0,
"failed": 0
},
"hits": {
"total": 1,
"max_score": 1.0,
"hits": [{
"_index": "dbl"
"_type": "values",
"_id": "dqX9VWEBV6sEKSMyk6sw"
"_score": 1.0,
"_source": {
"itemid": 28275,
"value": "0.138750",
"clock": 1517566136,
"ns": 25388713,
"ttl": 604800
}
}]
}
}
- 现在使用JSONPath预处理步骤来get监控项值:
`$.hits.hits[0]._source.value`
##### Example 2
***Step 1***
Using host metadata to allow some basic protection against unwanted
hosts registering.
##### 示例2
***步骤1***
使用主机元数据提供基础防护机制，防止未经授权的主机注册行为。
##### Example 2
Sum of latest values of all items matching net.if.in\[\*\] on the host.
sum(last_foreach(/host/net.if.in[*]))
##### 示例2
匹配主机上net.if.in[*]的所有监控项最新值之和。
sum(last_foreach(/主机/net.if.in[*]))
##### Example 2
To create a "Web scenario failed" trigger with a useful problem
description in the trigger name, you can define a trigger with name:
Web scenario "Scenario" failed: {ITEM.VALUE}
and trigger expression:
length(last(/host/web.test.error[Scenario]))>0 and last(/host/web.test.fail[Scenario])>0
Make sure to replace 'Scenario' with the real name of your scenario.
##### 示例2
要为create一个具有实用问题描述的"Web场景失败"触发器，您可以使用以下名称定义触发器：
Web scenario "Scenario" failed: {ITEM.VALUE}
以及触发器表达式：
length(last(/host/web.test.error[Scenario]))>0 and last(/host/web.test.fail[Scenario])>0
请确保将'Scenario'替换为您场景的实际名称。
##### Example 2
Use of host-level macro in the "CPU load is too high" trigger:
`last(/ca_001/system.cpu.load[,avg1])>{$MAX_CPULOAD}`
Such a trigger would be created on the template, not edited in
individual hosts.
::: notetip
If you want to use the amount of values as the function
parameter (for example, **max(/host/key,\#3)**), include hash mark in
the macro definition like this: SOME\_PERIOD => \#3
:::
##### 示例2
在"CPU负载过高"触发器中使用主机级别宏:
`last(/ca_001/system.cpu.load[,avg1])>{$MAX_CPULOAD}`
此类触发器应在模板上创建，而非在单个主机中编辑。
::: notetip
若需将数值数量作为函数参数使用(例如**max(/主机/key,\#3)**)，请在宏定义中包含井号标记，如: SOME\_PERIOD => \#3
:::
##### Example 2
www.example.com is overloaded.
last(/www.example.com/system.cpu.load[all,avg1])>5 or min(/www.example.com/system.cpu.load[all,avg1],10m)>2
The expression is true when either the current processor load is more
than 5 or the processor load was more than 2 during last 10 minutes.
##### 示例2
www.example.com 已过载.
last(/www.example.com/system.cpu.load[all,avg1])>5 or min(/www.example.com/system.cpu.load[all,avg1],10m)>2
当当前处理器负载超过5或过去10分钟内处理器负载超过2时,表达式为真.
##### Example 3
Average processor load of host group 'MySQL Servers'.
avg(last_foreach(/*/system.cpu.load[,avg1]?[group="MySQL Servers"]))
##### 示例3
MySQL服务器组主机组的平均处理器负载
avg(last_foreach(/*/system.cpu.load[,avg1]?[group="MySQL Servers"]))
##### Example 3
Calculating total bandwidth on eth0.
Sum of two functions:
last(//net.if.in[eth0,bytes])+last(//net.if.out[eth0,bytes])
##### 示例3
计算eth0接口的总带宽
两个函数之和:
last(//net.if.in[eth0,bytes])+last(//net.if.out[eth0,bytes])
##### Example 3
Checking if Zabbix API is alive, using
[apiinfo.version](/manual/api/reference/apiinfo/version).
- Item configuration:
Note the use of the POST method with JSON data, setting request headers
and asking to return headers only:
- Item value preprocessing with regular expression to get HTTP code:
- Checking the result in *Latest data*:
{width="600"}
##### 示例3
检查Zabbix API是否存活，使用
[apiinfo.version](/manual/api/reference/apiinfo/version).
- 监控项配置：
注意使用POST方法携带JSON数据，设置请求头
并仅要求返回头部信息：
- 使用正则表达式对监控项值进行预处理以getHTTP状态码：
- 在*最新数据*中检查结果：
{width="600"}
##### Example 3
Collecting a metric using default configuration parameters.
Configuration parameters:
```bash
Plugins.PostgreSQL.Default.Uri=tcp://192.0.2.234:5432
Plugins.PostgreSQL.Default.User=zabbix
Plugins.PostgreSQL.Default.Password=password
```
[Item key](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2): `pgsql.ping[,,,postgres]`
As a result of this configuration, the agent will connect to PostgreSQL using the parameters:
- Default URI: *192.0.2.234:5432*
- Default username: *zabbix*
- Default password: *password*
- Database name from the item key: *postgres*
##### 示例3
使用默认配置参数收集指标。
配置参数：
```bash
Plugins.PostgreSQL.Default.Uri=tcp://192.0.2.234:5432
Plugins.PostgreSQL.Default.User=zabbix
Plugins.PostgreSQL.Default.Password=password
```
[Item key](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2): `pgsql.ping[,,,postgres]`
此配置的结果是，agent将使用以下参数连接到PostgreSQL：
- 默认URI: *192.0.2.234:5432*
- 默认用户名: *zabbix*
- 默认密码: *password*
- 来自监控项键的数据库名称: *postgres*
##### Example 3
Escalating the problem to the Boss.
In the first example above we configured periodical sending of messages
to MySQL administrators. In this case, the administrators will get four
messages before the problem will be escalated to the Database manager.
Note that the manager will get a message only in case the problem is not
acknowledged yet, supposedly no one is working on it.
{width="600"}
Details of Operation 2:
Note the use of {ESC.HISTORY} macro in the customized message. The macro
will contain information about all previously executed steps on this
escalation, such as notifications sent and commands executed.
##### 示例3
将问题升级上报给主管
在上述第一个示例中，我们配置了定期向MySQL管理员发送消息。在这种情况下，管理员将get四条消息，之后问题将升级上报给数据库经理。请注意，经理仅会在问题尚未被确认时get消息，即假设无人正在处理该问题。
{width="600"}
操作2的详细信息：
注意在自定义消息中使用{ESC.HISTORY}宏。该宏将包含此升级过程中所有先前执行步骤的信息，例如已发送的通知和已执行的命令。
##### Example 3
/etc/passwd has been changed.
last(/www.example.com/vfs.file.cksum[/etc/passwd],#1)<>last(/www.example.com/vfs.file.cksum[/etc/passwd],#2)
The expression is true when the previous value of /etc/passwd checksum
differs from the most recent one.
Similar expressions could be useful to monitor changes in important
files, such as /etc/passwd, /etc/inetd.conf, /kernel, etc.
##### 示例3
/etc/passwd 文件已被修改.
last(/www.example.com/vfs.file.cksum[/etc/passwd],#1)<>last(/www.example.com/vfs.file.cksum[/etc/passwd],#2)
当 /etc/passwd 校验和的前一个值与最新值不同时,该表达式为真.
类似的表达式可用于监控重要文件的变更,例如 /etc/passwd, /etc/inetd.conf, /kernel 等.
##### Example 3
How many lines matching a regular expression in a file?
UserParameter=wc[*],grep -c "$2" $1
This parameter can be used to calculate number of lines in a file.
wc[/etc/passwd,root]
wc[/etc/services,zabbix]
##### 示例3
统计file中匹配正则表达式的行数？
UserParameter=wc[*],grep -c "$2" $1
此参数可用于计算file中的行数。
wc[/etc/passwd,root]
wc[/etc/services,zabbix]
##### Example 3
Message:
Latest value: {?last(/{HOST.HOST}/{ITEM.KEY})}
MAX for 15 minutes: {?max(/{HOST.HOST}/{ITEM.KEY},15m)}
MIN for 15 minutes: {?min(/{HOST.HOST}/{ITEM.KEY},15m)}
When you receive the message, the message will be replaced by something
like:
Latest value: 1.45
MAX for 15 minutes: 2.33
MIN for 15 minutes: 1.01
##### 示例3
消息:
Latest value: {?last(/{HOST.HOST}/{ITEM.KEY})}
MAX for 15 minutes: {?max(/{HOST.HOST}/{ITEM.KEY},15m)}
MIN for 15 minutes: {?min(/{HOST.HOST}/{ITEM.KEY},15m)}
当您收到该消息时，消息内容将被替换为类似以下格式:
最新值: 1.45
15分钟内最大值: 2.33
15分钟内最小值: 1.01
**Example 3**
Power off the host by using IPMI control.
|Script parameter|Value|
|--|--------|
|*Scope*|'Action operation'|
|*Type*|'IPMI'|
|*Command*|power off|
**示例 3**
通过IPMI控制关闭主机.
| 脚本参数 | 值 |
|--|--------|
| *Scope* | '操作动作' |
| *Type* | 'IPMI' |
| *Command* | 关闭电源 |
##### Example 3
To create a "Web application is slow" trigger, you can define a trigger
expression:
last(/host/web.test.in[Scenario,,bps])<10000
Make sure to replace 'Scenario' with the real name of your scenario.
##### 示例3
要create一个"Web应用程序运行缓慢"的触发器，您可以定义如下触发器表达式：
last(/host/web.test.in[Scenario,,bps])<10000
请确保将'Scenario'替换为您实际的场景名称。
##### Example 3
Use of two macros in the "CPU load is too high" trigger:
`min(/ca_001/system.cpu.load[,avg1],{$CPULOAD_PERIOD})>{$MAX_CPULOAD}`
Note that a macro can be used as a parameter of trigger function, in
this example function **min()**.
##### 示例3
在"CPU负载过高"触发器中使用两个宏:
`min(/ca_001/system.cpu.load[,avg1],{$CPULOAD_PERIOD})>{$MAX_CPULOAD}`
请注意，宏可以作为触发器函数的参数使用，
在此示例中为**min()**函数。
##### Example 4
5-minute average of the number of queries per second for host group
'MySQL Servers'.
avg(avg_foreach(/*/mysql.qps?[group="MySQL Servers"],5m))
##### 示例4
每秒queries数的5分钟平均值（针对主机组）
MySQL服务器
avg(avg_foreach(/*/mysql.qps?[group="MySQL Servers"],5m))
##### Example 4
A more complex scenario. After multiple messages to MySQL administrators
and escalation to the manager, Zabbix will try to restart the MySQL
database. It will happen if the problem exists for 2:30 hours and it
hasn't been acknowledged.
If the problem still exists, after another 30 minutes Zabbix will send a
message to all guest users.
If this does not help, after another hour Zabbix will reboot server with
the MySQL database (second remote command) using IPMI commands.
{width="600"}
##### 示例4
一个更复杂的场景. 在多次向MySQL管理员发送消息并升级至经理后, Zabbix将尝试重启MySQL数据库. 如果问题持续存在2小时30分钟且未被确认, 就会执行此操作.
如果问题仍然存在, 再过30分钟后Zabbix将向所有访客用户发送消息.
如果这仍无济于事, 再过1小时后Zabbix将使用IPMI命令重启装有MySQL数据库的服务器(第二个远程命令).
{width="600"}
##### Example 4
Calculating percentage of incoming traffic.
More complex expression:
100*last(//net.if.in[eth0,bytes])/(last(//net.if.in[eth0,bytes])+last(//net.if.out[eth0,bytes]))
See also: [Examples of aggregate
calculations](/manual/config/items/itemtypes/calculated/aggregate#usage_examples)
##### 示例4
计算入站流量的百分比。
更复杂的表达式：
100*last(//net.if.in[eth0,bytes])/(last(//net.if.in[eth0,bytes])+last(//net.if.out[eth0,bytes]))
另请参阅：[使用示例](/manual/config/items/itemtypes/calculated/aggregate#使用示例)
##### Example 4
Message:
http://<server_ip_or_name>/zabbix/tr_events.php?triggerid={TRIGGER.ID}&eventid={EVENT.ID}
When you receive the message, it will contain a link to the *Event
details* page, which provides information about the event, its trigger,
and a list of latest events generated by the same trigger.
##### 示例4
消息:
http://<server_ip_or_name>/zabbix/tr_events.php?triggerid={TRIGGER.ID}&eventid={EVENT.ID}
当您收到该消息时，其中将包含指向*事件详情*页面的链接，该页面提供有关事件、其触发器以及由同一触发器生成的最新事件列表的信息。
##### Example 4
Retrieving weather information by connecting to the Openweathermap
public service.
- Configure a master item for bulk data collection in a single JSON:
Note the usage of macros in query fields. Refer to the [Openweathermap
API](https://openweathermap.org/current) for how to fill them.
Sample JSON returned in response to HTTP agent:
``` {.json}
{
"body": {
"coord": {
"lon": 40.01,
"lat": 56.11
},
"weather": [{
"id": 801,
"main": "Clouds",
"description": "few clouds",
"icon": "02n"
}],
"base": "stations",
"main": {
"temp": 15.14,
"pressure": 1012.6,
"humidity": 66,
"temp_min": 15.14,
"temp_max": 15.14,
"sea_level": 1030.91,
"grnd_level": 1012.6
},
"wind": {
"speed": 1.86,
"deg": 246.001
},
"clouds": {
"all": 20
},
"dt": 1526509427,
"sys": {
"message": 0.0035,
"country": "RU",
"sunrise": 1526432608,
"sunset": 1526491828
},
"id": 487837,
"name": "Stavrovo",
"cod": 200
}
}
```
The next task is to configure dependent items that extract data from the
JSON.
- Configure a sample dependent item for humidity:
Other weather metrics such as 'Temperature' are added in the same
manner.
- Sample dependent item value preprocessing with JSONPath:
- Check the result of weather data in *Latest data*:
{width="600"}
##### 示例4
通过连接Openweathermap公共服务获取天气信息。
- 配置主监控项以单次JSON批量收集数据：
注意query字段中宏的使用。参考[Openweathermap
API](https://openweathermap.org/current)了解如何填充它们。
HTTPagent返回的示例JSON：
```{.json}
{
"body": {
"coord": {
"lon": 40.01,
"lat": 56.11
},
"weather": [{
"id": 801,
"main": "Clouds",
"description": "few clouds",
"icon": "02n"
}],
"base": "stations",
"main": {
"temp": 15.14,
"pressure": 1012.6,
"humidity": 66,
"temp_min": 15.14,
"temp_max": 15.14,
"sea_level": 1030.91,
"grnd_level": 1012.6
},
"wind": {
"speed": 1.86,
"deg": 246.001
},
"clouds": {
"all": 20
},
"dt": 1526509427,
"sys": {
"message": 0.0035,
"country": "RU",
"sunrise": 1526432608,
"sunset": 1526491828
},
"id": 487837,
"name": "Stavrovo",
"cod": 200
}
}
```
下一步是配置从JSON提取数据的依赖监控项。
- 配置湿度指标的示例依赖监控项：
其他天气指标如'温度'以相同方式添加。
- 使用JSONPath的示例依赖监控项值预处理：
- 在*最新数据*中检查天气数据结果：
{width="600"}
##### Example 4
Someone is downloading a large file from the Internet.
Use of function min:
min(/www.example.com/net.if.in[eth0,bytes],5m)>100K
The expression is true when number of received bytes on eth0 is more
than 100 KB within last 5 minutes.
##### 示例4
有人正在从互联网下载大型file.
函数min的使用:
min(/www.example.com/net.if.in[eth0,bytes],5m)>100K
当eth0网卡在过去5分钟内接收的字节数超过100KB时，该表达式为真.
##### Example 4
Synchronize the agent unavailability condition with the item update
interval:
- define {$INTERVAL} macro and use it in the item update interval;
- use {$INTERVAL} as parameter of the agent unavailability trigger:
`nodata(/ca_001/agent.ping,{$INTERVAL})=1`
##### 示例4
将agent不可用状态与监控项update间隔同步:
- 定义{$INTERVAL}宏并在监控项update间隔中使用;
- 将{$INTERVAL}作为agent不可用触发器的参数:
`nodata(/ca_001/agent.ping,{$INTERVAL})=1`
##### Example 5
An escalation with several operations assigned to one step and custom
intervals used. The default operation step duration is 30 minutes.
{width="600"}
Notifications will be sent as follows:
- to MySQL administrators at 0:00, 0:30, 1:00, 1:30 after the problem
starts
- to Database manager at 2:00 and 2:10 (and not at 3:00; seeing that
steps 5 and 6 overlap with the next operation, the shorter custom
step duration of 10 minutes in the next operation overrides the
longer step duration of 1 hour tried to set here)
- to Zabbix administrators at 2:00, 2:10, 2:20 after the problem
starts (the custom step duration of 10 minutes working)
- to guest users at 4:00 hours after the problem start (the default
step duration of 30 minutes returning between steps 8 and 11)
##### 示例5
一个包含多个操作分配到单个步骤并使用自定义间隔的升级流程。默认操作步骤持续时间为30分钟。
{width="600"}
通知将按以下方式发送：
- 在问题开始后的0:00、0:30、1:00、1:30向MySQL管理员发送
- 在2:00和2:10向数据库经理发送（不会在3:00发送；由于步骤5和6与下一个操作重叠，下一个操作中设置的10分钟较短自定义步骤持续时间会覆盖此处尝试设置的1小时较长步骤持续时间）
- 在问题开始后的2:00、2:10、2:20向Zabbix管理员发送（10分钟的自定义步骤持续时间生效）
- 在问题开始4小时后向访客用户发送（在步骤8和11之间恢复默认的30分钟步骤持续时间）
##### Example 5
Average CPU load on all hosts in multiple host groups that have the
specific tags.
avg(last_foreach(/*/system.cpu.load?[(group="Servers A" or group="Servers B" or group="Servers C") and (tag="Service:" or tag="Importance:High")]))
##### 示例5
多个主机组中具有特定标签的所有主机的平均CPU负载。
avg(last_foreach(/*/system.cpu.load?[(group="Servers A" or group="Servers B" or group="Servers C") and (tag="Service:" or tag="Importance:High")]))
##### Example 5
Both nodes of clustered SMTP server are down.
Note use of two different hosts in one expression:
last(/smtp1.example.com/net.tcp.service[smtp])=0 and last(/smtp2.example.com/net.tcp.service[smtp])=0
The expression is true when both SMTP servers are down on both
smtp1.example.com and smtp2.example.com.
##### 示例5
集群SMTP服务器的两个节点均宕机.
注意在一个表达式中使用了两个不同的主机:
last(/smtp1.example.com/net.tcp.service[smtp])=0 and last(/smtp2.example.com/net.tcp.service[smtp])=0
当smtp1.example.com和smtp2.example.com上的两个SMTP服务器都宕机时，该表达式为真.
##### Example 5
Centralize configuration of working hours:
- create a global {$WORKING\_HOURS} macro equal to `1-5,09:00-18:00`;
- use it in the *Working time* field in *Administration* → *General* →
*GUI*;
- use it in the *When active* field in *Administration* → *Users* →
*Media*;
- use it to set up more frequent item polling during working hours:
- use it in the *Time period* action condition;
- adjust the working time in *Administration* → *General* → *Macros*,
if needed.
##### 示例5
集中配置工作时间:
- create 全局宏 {$WORKING\_HOURS} 等于 `1-5,09:00-18:00`;
- 在*管理* → *常规* → *工作时间*字段中使用它
*GUI*;
- 在*Administration* → *Users* → *When active*字段中使用它
*媒体*;
- 使用它来在工作时间内设置更频繁的监控项轮询:
- 在*时间段*操作条件中使用它;
- 在*管理* → *通用* → *宏*中调整工作时间,
如果需要。
##### Example 5
Connecting to Nginx status page and getting its metrics in bulk.
- Configure Nginx following the [official
guide](https://nginx.ru/en/docs/http/ngx_http_stub_status_module.html).
```{=html}
<!-- -->
```
- Configure a master item for bulk data collection:
Sample Nginx stub status output:
Active connections: 1 Active connections:
server accepts handled requests
52 52 52
Reading: 0 Writing: 1 Waiting: 0
The next task is to configure dependent items that extract data.
- Configure a sample dependent item for requests per second:
- Sample dependent item value preprocessing with regular expression
`server accepts handled requests\s+([0-9]+) ([0-9]+) ([0-9]+)`:
{width="600"}
- Check the complete result from stub module in *Latest data*:
{width="600"}
##### 示例5
连接到nginx状态页面并批量获取其指标
- 按照[official
guide](https://nginx.ru/en/docs/http/ngx_http_stub_status_module.html).
```{=html}
<!-- -->
```
- Configure a master item for bulk data collection:
配置nginx
示例 nginx 存根状态输出:
Active connections: 1 Active connections:
server accepts handled requests
52 52 52
Reading: 0 Writing: 1 Waiting: 0
下一个任务是配置用于提取数据的依赖监控项
- 配置一个示例依赖的监控项用于每秒请求数:
- 基于正则表达式的样本依赖监控项值预处理
`server accepts handled requests\s+([0-9]+) ([0-9]+) ([0-9]+)`:
`server accepts handled requests\s+([0-9]+) ([0-9]+) ([0-9]+)`:
{width="600"}
- 在*最新数据*中检查存根模块的完整结果:
{width="600"}
##### Example 5
Informing about values from several hosts in a trigger expression.
Message:
Problem name: {TRIGGER.NAME}
Trigger expression: {TRIGGER.EXPRESSION}
1. Item value on {HOST.NAME1}: {ITEM.VALUE1} ({ITEM.NAME1})
2. Item value on {HOST.NAME2}: {ITEM.VALUE2} ({ITEM.NAME2})
When you receive the message, the message will be replaced by something
like:
Problem name: Processor load is too high on a local host
Trigger expression: last(/Myhost/system.cpu.load[percpu,avg1])>5 or last(/Myotherhost/system.cpu.load[percpu,avg1])>5
1. Item value on Myhost: 0.83 (Processor load (1 min average per core))
2. Item value on Myotherhost: 5.125 (Processor load (1 min average per core))
##### 示例5
在触发器表达式中通报多个主机的取值情况
消息内容:
Problem name: {TRIGGER.NAME}
Trigger expression: {TRIGGER.EXPRESSION}
1. Item value on {HOST.NAME1}: {ITEM.VALUE1} ({ITEM.NAME1})
2. Item value on {HOST.NAME2}: {ITEM.VALUE2} ({ITEM.NAME2})
当您收到该消息时，消息将被替换为类似以下内容:
Problem name: Processor load is too high on a local host
Trigger expression: last(/Myhost/system.cpu.load[percpu,avg1])>5 or last(/Myotherhost/system.cpu.load[percpu,avg1])>5
1. Myhost上的监控项值: 0.83 (处理器负载(每核1分钟平均值))
2. Myotherhost上的监控项值: 5.125 (处理器负载(每核1分钟平均值))
##### Example 6
Calculation used on the latest item value sums of a whole host group.
sum(last_foreach(/*/net.if.out[eth0,bytes]?[group="video"])) / sum(last_foreach(/*/nginx_stat.sh[active]?[group="video"]))
##### 示例6
基于最新监控项值对整个主机组求和的计算方法。
sum(last_foreach(/*/net.if.out[eth0,bytes]?[group="video"])) / sum(last_foreach(/*/nginx_stat.sh[active]?[group="video"]))
##### Example 6
Receiving details of both the problem event and recovery event in a
[recovery](/manual/config/notifications/action/recovery_operations)
message:
Message:
Problem:
Event ID: {EVENT.ID}
Event value: {EVENT.VALUE}
Event status: {EVENT.STATUS}
Event time: {EVENT.TIME}
Event date: {EVENT.DATE}
Event age: {EVENT.AGE}
Event acknowledgment: {EVENT.ACK.STATUS}
Event update history: {EVENT.UPDATE.HISTORY}
Recovery:
Event ID: {EVENT.RECOVERY.ID}
Event value: {EVENT.RECOVERY.VALUE}
Event status: {EVENT.RECOVERY.STATUS}
Event time: {EVENT.RECOVERY.TIME}
Event date: {EVENT.RECOVERY.DATE}
Operational data: {EVENT.OPDATA}
When you receive the message, the macros will be replaced by something
like:
Problem:
Event ID: 21874
Event value: 1
Event status: PROBLEM
Event time: 13:04:30
Event date: 2018.01.02
Event age: 5m
Event acknowledgment: Yes
Event update history: 2018.01.02 13:05:51 "John Smith (Admin)"
Actions: acknowledged.
Recovery:
Event ID: 21896
Event value: 0
Event status: OK
Event time: 13:10:07
Event date: 2018.01.02
Operational data: Current value is 0.83
::: noteimportant
Separate notification macros for the original
problem event and recovery event are supported since Zabbix
2.2.0.
:::
##### 示例6
在[recovery](/manual/config/notifications/action/recovery_operations)消息中同时接收问题事件和恢复事件的详细信息:
消息内容:
Problem:
事件ID: {EVENT.ID}
Event value: {EVENT.VALUE}
Event status: {EVENT.STATUS}
Event time: {EVENT.TIME}
Event date: {EVENT.DATE}
Event age: {EVENT.AGE}
Event acknowledgment: {EVENT.ACK.STATUS}
Event update history: {EVENT.UPDATE.HISTORY}
恢复状态:
Event ID: {EVENT.RECOVERY.ID}
Event value: {EVENT.RECOVERY.VALUE}
Event status: {EVENT.RECOVERY.STATUS}
Event time: {EVENT.RECOVERY.TIME}
Event date: {EVENT.RECOVERY.DATE}
Operational data: {EVENT.OPDATA}
当您收到消息时，宏将被替换为类似以下内容:
Problem:
事件ID: 21874
Event value: 1
Event status: PROBLEM
Event time: 13:04:30
Event date: 2018.01.02
Event age: 5m
Event acknowledgment: Yes
Event update history: 2018.01.02 13:05:51 "John Smith (Admin)"
Actions: acknowledged.
恢复状态:
Event ID: 21896
Event value: 0
Event status: OK
Event time: 13:10:07
Event date: 2018.01.02
Operational data: Current value is 0.83
::: noteimportant
自Zabbix 2.2.0版本起支持对原始问题事件和恢复事件使用独立的通知宏。
:::
##### Example 6
Use host prototype macro to configure items for discovered hosts:
- on a host prototype define user macro {$SNMPVALUE} with
{\#SNMPVALUE} [low-level
discovery](/manual/config/macros/lld_macros) macro as a value:
- assign *Generic SNMPv2* template to the host prototype;
- use {$SNMPVALUE} in the *SNMP OID* field of *Generic SNMPv2*
template items.
##### 示例6
使用主机原型宏为发现的主机配置监控项:
- 在一个主机原型上定义用户宏{$SNMPVALUE}并设置
{\#SNMPVALUE} [low-level
discovery](/manual/config/macros/lld_macros) macro as a value:
- 将*Generic SNMPv2*模板分配给主机原型;
- 在*Generic SNMPv2*模板的*SNMP OID*字段中使用{$SNMPVALUE}来配置监控项.
##### Example 6
Zabbix agent needs to be upgraded.
Use of function find():
find(/example.example.com/agent.version,,"like","beta8")=1
The expression is true if Zabbix agent has version beta8.
##### 示例6
Zabbix agent 需要升级。
函数 find() 的使用：
find(/example.example.com/agent.version,,"like","beta8")=1
如果 Zabbix agent 具有 version beta8，则表达式为真。
##### Example 7
Server is unreachable.
count(/example.example.com/icmpping,30m,,"0")>5
The expression is true if host "example.example.com" is unreachable more
than 5 times in the last 30 minutes.
##### 示例 7
服务器不可达。
count(/example.example.com/icmpping,30m,,"0")>5
如果主机 "example.example.com"在过去30分钟内超过5次不可达，则该表达式为真。
##### Example 7
The total number of unsupported items in host group 'Zabbix servers'.
sum(last_foreach(/*/zabbix[host,,items_unsupported]?[group="Zabbix servers"]))
##### 示例 7
主机组 'Zabbix servers'中不支持的监控项总数.
sum(last_foreach(/*/zabbix[主机,,items_unsupported]?[group="Zabbix servers"]))
##### Example 8
No heartbeats within last 3 minutes.
Use of function nodata():
nodata(/example.example.com/tick,3m)=1
To make use of this trigger, 'tick' must be defined as a Zabbix
[trapper](/manual/config/items/itemtypes/trapper) item. The host should
periodically send data for this item using zabbix\_sender. If no data is
received within 180 seconds, the trigger value becomes PROBLEM.
*Note* that 'nodata' can be used for any item type.
##### 示例 8
过去3分钟内无心跳信号。
函数nodata()的用法：
nodata(/example.example.com/tick,3m)=1
要使此触发器生效，必须将'tick'定义为Zabbix
[trapper](/manual/config/items/itemtypes/trapper) 监控项。主机应
定期使用zabbix\_sender为此监控项发送数据。如果在180秒内未收到任何数据，
触发器值将变为PROBLEM。
*注意*：'nodata'可用于任何监控项类型。
##### Example 9
CPU activity at night time.
Use of function time():
min(/Zabbix server/system.cpu.load[all,avg1],5m)>2 and time()<060000
The trigger may change its state to problem only at night time (00:00 - 06:00).
##### 示例 9
夜间CPU活动情况
使用time()函数:
min(/Zabbix server/system.cpu.load[all,avg1],5m)>2 and time()<060000
该触发器仅在夜间时段(00:00 - 06:00)可能将其状态更改为问题状态
##### Example configuration for Apache
# ..
ProxyPass "/" http://host/zabbix/
ProxyPassReverse "/" http://host/zabbix/
ProxyPassReverseCookiePath /zabbix /
ProxyPassReverseCookieDomain host zabbix.example.com
# ..
##### Apache 配置示例
# ..
ProxyPass "/" http://主机/zabbix/
ProxyPassReverse "/" http://主机/zabbix/
ProxyPassReverseCookiePath /zabbix /
ProxyPassReverseCookieDomain 主机 zabbix.example.com
# ..
##### Example configuration for nginx
# ..
location / {
# ..
proxy_cookie_path /zabbix /;
proxy_pass http://192.168.0.94/zabbix/;
# ..
##### nginx 的示例配置
# ..
location / {
# ..
proxy_cookie_path /zabbix /;
proxy_pass http://192.168.0.94/zabbix/;
# ..
#### Example
Getting memory usage of *apache* process.
If using this OID syntax:
HOST-RESOURCES-MIB::hrSWRunPerfMem["index","HOST-RESOURCES-MIB::hrSWRunPath", "/usr/sbin/apache2"]
the index number will be looked up here:
...
HOST-RESOURCES-MIB::hrSWRunPath.5376 = STRING: "/sbin/getty"
HOST-RESOURCES-MIB::hrSWRunPath.5377 = STRING: "/sbin/getty"
HOST-RESOURCES-MIB::hrSWRunPath.5388 = STRING: "/usr/sbin/apache2"
HOST-RESOURCES-MIB::hrSWRunPath.5389 = STRING: "/sbin/sshd"
...
Now we have the index, 5388. The index will be appended to the data OID
in order to receive the value we are interested in:
HOST-RESOURCES-MIB::hrSWRunPerfMem.5388 = INTEGER: 31468 KBytes
#### 示例
获取*apache*进程的memory使用情况
如果使用此OID语法:
HOST-RESOURCES-MIB::hrSWRunPerfMem["index","HOST-RESOURCES-MIB::hrSWRunPath", "/usr/sbin/apache2"]
索引号将在此处查找:
...
HOST-RESOURCES-MIB::hrSWRunPath.5376 = STRING: "/sbin/getty"
HOST-RESOURCES-MIB::hrSWRunPath.5377 = STRING: "/sbin/getty"
HOST-RESOURCES-MIB::hrSWRunPath.5388 = STRING: "/usr/sbin/apache2"
HOST-RESOURCES-MIB::hrSWRunPath.5389 = STRING: "/sbin/sshd"
...
现在我们获得了索引号5388。该索引将被附加到数据OID后
以获取我们需要的值:
主机-RESOURCES-MIB::hrSWRunPerfMem.5388 = integer: 31468 KBytes
##### Example of several dependencies
For example, the Host is behind the Router2 and the Router2 is behind
the Router1.
Zabbix - Router1 - Router2 - Host
If the Router1 is down, then obviously the Host and the Router2 are also unreachable,
yet receiving three notifications about the Host, the Router1 and
the Router2 all being down is excessive.
So in this case we define two dependencies:
the 'Host is down' trigger depends on the 'Router2 is down' trigger
the 'Router2 is down' trigger depends on the 'Router1 is down' trigger
Before changing the status of the 'Host is down' trigger, Zabbix will
check for the corresponding trigger dependencies. If such are found and one of those
triggers is in the 'Problem' state, then the trigger status will not be
changed, the actions will not be executed and no notifications will
be sent.
Zabbix performs this check recursively. If the Router1 or the Router2 is
unreachable, the Host trigger won't be updated.
##### 多个依赖项示例
例如，主机位于Router2之后，而Router2又位于Router1之后。
Zabbix - Router1 - Router2 - Host
如果Router1宕机，显然主机和Router2也将不可达，
但收到关于主机、Router1和Router2全部宕机的三个通知则显得冗余。
因此在这种情况下，我们定义两个依赖关系：
the 'Host is down' trigger depends on the 'Router2 is down' trigger
the 'Router2 is down' trigger depends on the 'Router1 is down' trigger
在更改"主机已宕机"触发器状态前，Zabbix会
检查对应的触发器依赖关系。若发现此类依赖且其中一个触发器
处于"问题"状态，则该触发器状态将不会
被更改，关联操作不会执行，且不会发送
任何通知。
Zabbix会递归执行此检查。若Router1或Router2
不可达，主机触发器将不会被更新。
Example of using runtime control to reload the server configuration
cache:
zabbix_server -c /usr/local/etc/zabbix_server.conf -R config_cache_reload
Examples of using runtime control to gather diagnostic information:
# Gather all available diagnostic information in the server log file:
zabbix_server -R diaginfo
# Gather history cache statistics in the server log file:
zabbix_server -R diaginfo=historycache
Example of using runtime control to reload the SNMP cache:
zabbix_server -R snmp_cache_reload
Example of using runtime control to trigger execution of housekeeper:
zabbix_server -c /usr/local/etc/zabbix_server.conf -R housekeeper_execute
Examples of using runtime control to change log level:
# Increase log level of all processes:
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_increase
# Increase log level of second poller process:
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_increase=poller,2
# Increase log level of process with PID 1234:
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_increase=1234
# Decrease log level of all http poller processes:
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_decrease="http poller"
Example of setting the HA failover delay to the minimum of 10 seconds:
zabbix_server -R ha_set_failover_delay=10s
使用运行时控制重载服务器配置缓存的示例：
zabbix_server -c /usr/local/etc/zabbix_server.conf -R config_cache_reload
使用运行时控制收集诊断信息的示例：
# Gather all available diagnostic information in the server log file:
zabbix_server -R diaginfo
# 在服务器日志file中收集history cache统计信息：
zabbix_server -R diaginfo=historycache
使用运行时控制重载SNMP缓存的示例：
zabbix_server -R snmp_cache_reload
使用运行时控制触发管家进程执行的示例：
zabbix_server -c /usr/local/etc/zabbix_server.conf -R housekeeper_execute
使用运行时控制更改日志级别的示例：
# Increase log level of all processes:
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_increase
# 提高第二个轮询器进程的日志级别：
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_increase=poller,2
# 提高PID为1234的进程的日志级别：
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_increase=1234
# 降低所有HTTP轮询器进程的日志级别：
zabbix_server -c /usr/local/etc/zabbix_server.conf -R log_level_decrease="http poller"
将HA故障转移延迟设置为最小10秒的示例：
zabbix_server -R ha_set_failover_delay=10s
*Example:*
Problem *Web camera 3 is down* has tags `type:video surveillance`, `floor:1st` and `name:webcam 3` and status *Warning*
The service **Web camera 3** has the only problem tag specified: `name:webcam 3`
{width=600}
Service status will change from *OK* to *Warning* when this problem is detected.
If the service **Web camera 3** had problem tags `name:webcam 3` and `floor:2nd`, its status would not be changed, when the problem is detected, because the conditions are only partially met.
*示例：*
问题 *网络摄像头3宕机* 包含标签 `type:video surveillance`、`floor:1st` 和 `name:webcam 3`，状态为 *警告*
服务 **网络摄像头3** 仅配置了问题标签：`name:webcam 3`
{width=600}
当检测到该问题时，服务状态将从 *正常* 变更为 *警告*
若服务 **网络摄像头3** 配置的问题标签为 `name:webcam 3` 和 `floor:2nd`，则检测到问题时不会变更状态，因为仅部分条件满足
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
### Examples
### 示例
#### Examples
#### 示例
#### Examples
#### 示例
#### Examples
#### 示例
#### Examples
#### 示例
#### Examples
#### 示例
#### Examples and dealing with errors
To get a warning when you are about to run out of free disk space on
your host, you may use a trigger expression like this:
timeleft(/host/vfs.fs.size[/,free],1h,0)}<1h
However, error code -1 may come into play and put your trigger in a
problem state. Generally it's good because you get a warning that your
predictions don't work correctly and you should look at them more
thoroughly to find out why. But sometimes it's bad because -1 can simply
mean that there was no data about the host free disk space obtained in
the last hour. If you are getting too many false positive alerts,
consider using more complicated trigger expression ^[5](#footnotes)^:
timeleft(/host/vfs.fs.size[/,free],1h,0)<1h and timeleft(/host/vfs.fs.size[/,free],1h,0)<>-1
The situation is a bit more difficult with **forecast**. First of all,
-1 may or may not put the trigger in a problem state depending on
whether you have expression like `forecast(/host/item,(...))<...` or
like `forecast(/host/item,(...))>...`
Furthermore, -1 may be a valid forecast if it's normal for the item
value to be negative. But probability of this situation in the real
world situation is negligible (see
[how](/manual/config/triggers/expression) the operator **=** works). So
add `... or forecast(/host/item,(...))=-1` or
`... and forecast(/host/item,(...))<>-1` if you want or don't want to
treat -1 as a problem respectively.
#### Footnotes
^**1**^ For example, a simple trigger like
`timeleft(/host/item,1h,X) < 1h` may go into problem state when the
item value approaches X and then suddenly recover once value X is
reached. If the problem is item value being below X, use:
`last(/host/item) < X or timeleft(/host/item,1h,X) < 1h` If the
problem is item value being above X, use:
`last(/host/item) > X or timeleft(/host/item,1h,X) < 1h`
^**2**^ Polynomial degree can be from 1 to 6, *polynomial1* is equivalent
to *linear*. However, use higher degree polynomials [with
caution](https://en.wikipedia.org/wiki/Runge's_phenomenon). If the
evaluation period contains less points than needed to determine
polynomial coefficients, polynomial degree will be lowered (e.g.,
*polynomial5* is requested, but there are only 4 points, therefore
*polynomial3* will be fitted).
^**3**^ For example, fitting *exponential* or *power* functions involves
calculating log() of item values. If data contains zeros or negative
numbers, you will get an error since log() is defined for positive
values only.
^**4**^ For *linear*, *exponential*, *logarithmic* and *power* fits all
necessary calculations can be written explicitly. For *polynomial*
only *value* can be calculated without any additional steps.
Calculating *avg* involves computing polynomial antiderivative
(analytically). Computing *max*, *min* and *delta* involves
computing polynomial derivative (analytically) and finding its roots
(numerically). Solving f(t) = 0 involves finding polynomial roots
(numerically).
^**5**^ But in this case -1 can cause your trigger to recover from the
problem state. To be fully protected use:
`timeleft(/host/vfs.fs.size[/,free],1h,0)<1h and ({TRIGGER.VALUE}=0 and timeleft(/host/vfs.fs.size[/,free],1h,0)<>-1 or {TRIGGER.VALUE}=1)`
#### 示例与错误处理
当您即将run磁盘空间不足时get警告
您的 主机，您可以使用如下触发器表达式：
timeleft(/host/vfs.fs.size[/,free],1h,0)}<1h
然而，错误代码-1可能会出现并将您的触发器置于
问题状态。通常这是好事，因为你get了一个关于你的警告
预测功能运行不正常，您需要更仔细地检查它们
彻底调查以找出原因。但有时这很糟糕，因为-1可能仅仅
意味着没有获取到关于主机空闲磁盘空间的数据
最近一小时。如果您收到过多的误报警报，
考虑使用更复杂的触发器表达式^[5](#footnotes)^:
timeleft(/host/vfs.fs.size[/,free],1h,0)<1h and timeleft(/host/vfs.fs.size[/,free],1h,0)<>-1
**预测**的情况稍微复杂一些。首先，
-1 可能会也可能不会将触发器置于问题状态，具体取决于
您是否有类似 `forecast(/host/item,(...))<...` 的表达式
像 `forecast(/host/item,(...))>...`
此外，如果对于监控项来说-1是正常值，那么它也可能是一个有效的预测值
值为负数。但这种情况在现实中的概率
世界局势的影响可以忽略不计（参见
[how](/manual/config/triggers/expression) 操作符 **=** 有效). 因此
添加 `... or forecast(/host/item,(...))=-1` 或
`... and forecast(/host/item,(...))<>-1` 如果你想或不想
将-1视为问题。
#### 脚注
^**1**^ 例如，一个简单的触发器如
`timeleft(/host/item,1h,X) < 1h` may go into problem state when the
item value approaches X and then suddenly recover once value X is
reached. If the problem is item value being below X, use:
`last(/host/item) < X or timeleft(/host/item,1h,X) < 1h` If the
problem is item value being above X, use:
`last(/host/item) > X or timeleft(/host/item,1h,X) < 1h`
`timeleft(/host/item,1h,X) < 1h` 可能在以下情况下进入问题状态
监控项 值接近X后突然在达到X值时恢复
达到。如果问题在于监控项值低于X，请使用：
`last(/host/item) < X or timeleft(/host/item,1h,X) < 1h` 如果
问题在于监控项值超过X，使用：
`last(/host/item) > X or timeleft(/host/item,1h,X) < 1h`
^**2**^ 多项式次数可从1到6，*polynomial1* 等同于
to *linear*. However, use higher degree polynomials [with
caution](https://en.wikipedia.org/wiki/Runge's_phenomenon). If the
evaluation period contains less points than needed to determine
polynomial coefficients, polynomial degree will be lowered (e.g.,
*polynomial5* is requested, but there are only 4 points, therefore
*polynomial3* will be fitted).
^**3**^ 例如，拟合*指数*或*幂*函数涉及
calculating log() of item values. If data contains zeros or negative
numbers, you will get an error since log() is defined for positive
values only.
^**4**^ 对于*线性*、*指数*、*对数*和*幂*拟合
necessary calculations can be written explicitly. For *polynomial*
only *value* can be calculated without any additional steps.
Calculating *avg* involves computing polynomial antiderivative
(analytically). Computing *max*, *min* and *delta* involves
computing polynomial derivative (analytically) and finding its roots
(numerically). Solving f(t) = 0 involves finding polynomial roots
(numerically).
^**5**^ 但在这种情况下，-1可能导致触发器从
问题状态。要获得全面保护，请使用：
`timeleft(/host/vfs.fs.size[/,free],1h,0)<1h and ({TRIGGER.VALUE}=0 and timeleft(/host/vfs.fs.size[/,free],1h,0)<>-1 or {TRIGGER.VALUE}=1)`
#### Examples
Examples here illustrate how you can use macros in messages.
#### 示例
以下示例展示了如何在消息中使用宏。
#### Examples
Examples of [global
scripts](/manual/web_interface/frontend_sections/administration/scripts#configuring_a_global_script)
that may be used as remote commands in action operations.
#### 示例
可作为动作操作中远程命令使用的[配置全局脚本](/manual/web_interface/frontend_sections/administration/scripts#配置全局脚本)示例。
#### Examples
Here are some code snippets showing how to add Zabbix protocol header to the data you want to send in order
to obtain the packet you should send to Zabbix so that it is interpreted correctly. These code snippets
assume that the data is not larger than 1GB, thus the large packet format is not used.
##### Python
```python
packet = b"ZBXD\1" + struct.pack("<II", len(data), 0) + data
```
or
```python
def zbx_create_header(plain_data_size, compressed_data_size=None):
protocol = b"ZBXD"
flags = 0x01
if compressed_data_size is None:
datalen = plain_data_size
reserved = 0
else:
flags |= 0x02
datalen = compressed_data_size
reserved = plain_data_size
return protocol + struct.pack("<BII", flags, datalen, reserved)
packet = zbx_create_header(len(data)) + data
```
##### Perl
```perl
my $packet = "ZBXD\1" . pack("(II)<", length($data), 0) . $data;
```
or
```perl
sub zbx_create_header($;$)
{
my $plain_data_size = shift;
my $compressed_data_size = shift;
my $protocol = "ZBXD";
my $flags = 0x01;
my $datalen;
my $reserved;
if (!defined($compressed_data_size))
{
$datalen = $plain_data_size;
$reserved = 0;
}
else
{
$flags |= 0x02;
$datalen = $compressed_data_size;
$reserved = $plain_data_size;
}
return $protocol . chr($flags) . pack("(II)<", $datalen, $reserved);
}
my $packet = zbx_create_header(length($data)) . $data;
```
##### PHP
```php
$packet = "ZBXD\1" . pack("VV", strlen($data), 0) . $data;
```
or
```php
function zbx_create_header($plain_data_size, $compressed_data_size = null)
{
$protocol = "ZBXD";
$flags = 0x01;
if (is_null($compressed_data_size))
{
$datalen = $plain_data_size;
$reserved = 0;
}
else
{
$flags |= 0x02;
$datalen = $compressed_data_size;
$reserved = $plain_data_size;
}
return $protocol . chr($flags) . pack("VV", $datalen, $reserved);
}
$packet = zbx_create_header(strlen($data)) . $data;
```
##### Bash
```bash
datalen=$(printf "%08x" ${#data})
datalen="\\x${datalen:6:2}\\x${datalen:4:2}\\x${datalen:2:2}\\x${datalen:0:2}"
printf "ZBXD\1${datalen}\0\0\0\0%s" "$data"
```
#### 示例
以下代码片段展示了如何向待发送数据添加Zabbix协议头，以生成可被Zabbix正确解析的数据包。这些代码片段假设数据量不超过1GB，因此未使用大数据包格式。
##### Python
```python
packet = b"ZBXD\1" + struct.pack("<II", len(data), 0) + data
```
或
```python
def zbx_create_header(plain_data_size, compressed_data_size=None):
protocol = b"ZBXD"
flags = 0x01
if compressed_data_size is None:
datalen = plain_data_size
reserved = 0
else:
flags |= 0x02
datalen = compressed_data_size
reserved = plain_data_size
return protocol + struct.pack("<BII", flags, datalen, reserved)
packet = zbx_create_header(len(data)) + data
```
##### Perl
```perl
my $packet = "ZBXD\1" . pack("(II)<", length($data), 0) . $data;
```
或
```perl
sub zbx_create_header($;$)
{
my $plain_data_size = shift;
my $compressed_data_size = shift;
my $protocol = "ZBXD";
my $flags = 0x01;
my $datalen;
my $reserved;
if (!defined($compressed_data_size))
{
$datalen = $plain_data_size;
$reserved = 0;
}
else
{
$flags |= 0x02;
$datalen = $compressed_data_size;
$reserved = $plain_data_size;
}
return $protocol . chr($flags) . pack("(II)<", $datalen, $reserved);
}
my $packet = zbx_create_header(length($data)) . $data;
```
##### PHP
```php
$packet = "ZBXD\1" . pack("VV", strlen($data), 0) . $data;
```
或
```php
function zbx_create_header($plain_data_size, $compressed_data_size = null)
{
$protocol = "ZBXD";
$flags = 0x01;
if (is_null($compressed_data_size))
{
$datalen = $plain_data_size;
$reserved = 0;
}
else
{
$flags |= 0x02;
$datalen = $compressed_data_size;
$reserved = $plain_data_size;
}
return $protocol . chr($flags) . pack("VV", $datalen, $reserved);
}
$packet = zbx_create_header(strlen($data)) . $data;
```
##### Bash
```bash
datalen=$(printf "%08x" ${#data})
datalen="\\x${datalen:6:2}\\x${datalen:4:2}\\x${datalen:2:2}\\x${datalen:0:2}"
printf "ZBXD\1${datalen}\0\0\0\0%s" "$data"
```
##### Examples
Let's review two more practical examples of an LLD rule creation with the
use of MBean. To understand the difference between an LLD rule collecting
MBeans and an LLD rule collecting MBean attributes better please take a
look at following table:
| | | |
|---|---|---|
|**MBean1**|**MBean2**|**MBean3**|
|MBean1Attribute1|MBean2Attribute1|MBean3Attribute1|
|MBean1Attribute2|MBean2Attribute2|MBean3Attribute2|
|MBean1Attribute3|MBean2Attribute3|MBean3Attribute3|
##### 示例
让我们再回顾两个使用MBean创建LLD规则的实际示例。为了更好地理解收集MBeans的LLD规则与收集MBean属性的LLD规则之间的区别，请查看以下表格：
| | | |
|---|---|---|
| **MBean1** | **MBean2** | **MBean3** |
| MBean1Attribute1 | MBean2Attribute1 | MBean3Attribute1 |
| MBean1Attribute2 | MBean2Attribute2 | MBean3Attribute2 |
| MBean1Attribute3 | MBean2Attribute3 | MBean3Attribute3 |
#### Examples
:::noteclassic
The commands listed below are for Docker Compose V2.
If you are using Docker Compose V1, replace `docker compose -f` with `docker-compose -f`
:::
**Example 1**
# git checkout 6.0
# docker compose -f ./docker-compose_v3_alpine_mysql_latest.yaml up -d
The command will download latest Zabbix 6.0 images for each Zabbix
component and run them in detach mode.
::: noteimportant
Do not forget to download
`.env_<type of component>` files from github.com official Zabbix
repository with compose files.
:::
**Example 2**
# git checkout 6.0
# docker compose -f ./docker-compose_v3_ubuntu_mysql_local.yaml up -d
The command will download base image Ubuntu 20.04 (focal), then build
Zabbix 6.0 components locally and run them in detach mode.
#### 示例
:::noteclassic
以下列出的命令适用于Docker Compose V2.
若您使用Docker Compose V1，请将`docker compose -f`替换为`docker-compose -f`
:::
**示例1**
# git checkout 6.0
# docker compose -f ./docker-compose_v3_alpine_mysql_latest.yaml up -d
该命令将下载Zabbix 6.0各组件的最新镜像，并以守护进程模式run它们。
::: noteimportant
请勿忘记从github.com官方Zabbix仓库下载包含compose文件的
`.env_<type of component>`文件。
:::
**示例2**
# git checkout 6.0
# docker compose -f ./docker-compose_v3_ubuntu_mysql_local.yaml up -d
该命令将下载Ubuntu 20.04 (focal)基础镜像，然后在本地构建Zabbix 6.0组件并以守护进程模式run它们。
##### Examples
Numeric (unsigned) value:
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":3,"name":"Agent availability","clock":1519304285,"ns":123456789,"value":1,"type":3}
Numeric (float) value:
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":4,"name":"CPU Load","clock":1519304285,"ns":123456789,"value":0.1,"type":0}
Character, text value:
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":2,"name":"Agent version","clock":1519304285,"ns":123456789,"value":"3.4.4","type":4}
Log value:
{"host":{"host":"Host A","name":"Host A visible"},"groups":["Group X","Group Y","Group Z"],"itemid":1,"name":"Messages in log file","clock":1519304285,"ns":123456789,"timestamp":1519304285,"source":"","severity":0,"eventid":0,"value":"log file message","type":2}
##### 示例
数值（无符号）值：
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":3,"name":"Agent availability","clock":1519304285,"ns":123456789,"value":1,"type":3}
数值 (float) 值:
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":4,"name":"CPU Load","clock":1519304285,"ns":123456789,"value":0.1,"type":0}
字符, 文本值:
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":2,"name":"Agent version","clock":1519304285,"ns":123456789,"value":"3.4.4","type":4}
日志值:
{"主机":{"主机":"主机 A","name":"主机 A 可见"},"groups":["组X","组Y","组Z"],"itemid":1,"name":"日志中的消息 file","clock":1519304285,"ns":123456789,"timestamp":1519304285,"source":"","severity":0,"eventid":0,"value":"日志 file 消息","type":2}
##### Examples
Numeric (unsigned) value:
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":3,"name":"Agent availability","clock":1519311600,"count":60,"min":1,"avg":1,"max":1,"type":3}
Numeric (float) value:
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":4,"name":"CPU Load","clock":1519311600,"count":60,"min":0.01,"avg":0.15,"max":1.5,"type":0}
##### 示例
数值（无符号）值：
{"host":{"host":"Host B","name":"Host B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":3,"name":"Agent availability","clock":1519311600,"count":60,"min":1,"avg":1,"max":1,"type":3}
数值（float）值：
{"主机":{"主机":"主机 B","name":"主机 B visible"},"groups":["Group X","Group Y","Group Z"],"itemid":4,"name":"CPU Load","clock":1519311600,"count":60,"min":0.01,"avg":0.15,"max":1.5,"type":0}
##### Examples of correct/incorrect syntax
Expressions (including function calls) cannot be used as history, trend, or foreach [function](/manual/appendix/functions) parameters. However, those functions themselves can be used in other (non-historical) function parameters.
|Expression|Example|
|-|---------|
|Valid|`avg(last(/host/key1),last(/host/key2)*10,last(/host/key1)*100)`<br>`max(avg(avg_foreach(/*/system.cpu.load?[group="Servers A"],5m)),avg(avg_foreach(/*/system.cpu.load?[group="Servers B"],5m)),avg(avg_foreach(/*/system.cpu.load?[group="Servers C"],5m)))`|
|Invalid|`sum(/host/key,10+2)`<br>`sum(/host/key, avg(10,2))`<br>`sum(/host/key,last(/host/key2))`|
Note that in an expression like:
sum(sum_foreach(//resptime[*],5m))/sum(count_foreach(//resptime[*],5m))
it cannot be guaranteed that both parts of the equation will always have the same set of values.
While one part of the expression is evaluated, a new value for the requested period may arrive and
then the other part of the expression will have a different set of values.
##### 正确/错误语法示例
表达式（包括函数调用）不能作为历史数据、趋势数据或foreach [function](/manual/appendix/functions)参数使用。不过，这些函数本身可以用于其他（非历史相关的）函数参数中。
| 表达式 | 示例 |
|-|---------|
| 有效 | `avg(last(/host/key1),last(/host/key2)*10,last(/host/key1)*100)`<br>`max(avg(avg_foreach(/*/system.cpu.load?[group="Servers A"],5m)),avg(avg_foreach(/*/system.cpu.load?[group="Servers B"],5m)),avg(avg_foreach(/*/system.cpu.load?[group="Servers C"],5m)))` |
| 无效 | `sum(/host/key,10+2)`<br>`sum(/host/key, avg(10,2))`<br>`sum(/host/key,last(/host/key2))` |
需要注意的是，在如下表达式中：
sum(sum_foreach(//resptime[*],5m))/sum(count_foreach(//resptime[*],5m))
无法保证等式两边的值集始终保持一致。当表达式的一部分正在计算时，请求周期内可能会收到新值，从而导致表达式的另一部分具有不同的值集。
#### Examples of hardware configuration
The table provides examples of hardware configuration, assuming a **Linux/BSD/Unix** platform.
These are size and hardware configuration examples to start with. Each Zabbix installation is unique.
Make sure to benchmark the performance of your Zabbix system in a staging or development environment,
so that you can fully understand your requirements before deploying the Zabbix installation to its
production environment.
|Installation size|Monitored metrics^**1**^|CPU/vCPU cores|Memory<br>(GiB)|Database|Amazon EC2^**2**^|
|-|-|-|-|-|-|
|Small|1 000|2|8|MySQL Server,<br>Percona Server,<br>MariaDB Server,<br>PostgreSQL|m6i.large/m6g.large|
|Medium|10 000|4|16|MySQL Server,<br>Percona Server,<br>MariaDB Server,<br>PostgreSQL|m6i.xlarge/m6g.xlarge|
|Large|100 000|16|64|MySQL Server,<br>Percona Server,<br>MariaDB Server,<br>PostgreSQL,<br>Oracle|m6i.4xlarge/m6g.4xlarge|
|Very large|1 000 000|32|96|MySQL Server,<br>Percona Server,<br>MariaDB Server,<br>PostgreSQL,<br>Oracle|m6i.8xlarge/m6g.8xlarge|
^**1**^ 1 metric = 1 item + 1 trigger + 1 graph<br>
^**2**^ Example with Amazon general purpose EC2 instances, using ARM64 or x86_64 architecture, a
proper instance type like Compute/Memory/Storage optimised should be selected during Zabbix
installation evaluation and testing before installing in its production environment.
::: noteclassic
Actual configuration depends on the number of active items
and refresh rates very much (see [database size](#database-size) section of this page for details).
It is highly recommended to run the database on a separate server for large installations.
:::
#### 硬件配置示例
该表格提供了基于**Linux/BSD/Unix**平台的硬件配置示例。
这些是初始参考的规模与硬件配置示例。每个Zabbix部署环境都具有独特性。
务必在预发布或开发环境中对Zabbix系统进行性能基准测试，
以便在将Zabbix部署至生产环境前充分理解实际需求。
| 部署规模 | 监控指标^**1**^ | CPU/vCPU核心数 | 内存<br>(GiB) | 数据库 | Amazon EC2^**2**^ |
|-|-|-|-|-|-|
| 小型 | 1 000 | 2 | 8 | MySQL Server,<br>Percona Server,<br>mariadb Server,<br>PostgreSQL | m6i.large/m6g.large |
| 中型 | 10 000 | 4 | 16 | MySQL Server,<br>Percona Server,<br>mariadb Server,<br>PostgreSQL | m6i.xlarge/m6g.xlarge |
| 大型 | 100 000 | 16 | 64 | MySQL Server,<br>Percona Server,<br>mariadb Server,<br>PostgreSQL,<br>Oracle | m6i.4xlarge/m6g.4xlarge |
| 超大型 | 1 000 000 | 32 | 96 | MySQL Server,<br>Percona Server,<br>mariadb Server,<br>PostgreSQL,<br>Oracle | m6i.8xlarge/m6g.8xlarge |
^**1**^ 1个指标 = 1个监控项 + 1个触发器 + 1个图形<br>
^**2**^ 以Amazon通用型EC2实例为例（采用ARM64或x86_64架构），在Zabbix部署评估阶段应选择计算型/内存型/存储优化型等合适的实例类型，并通过生产环境前的测试验证。
::: noteclassic
实际配置很大程度上取决于活跃监控项的数量
及刷新频率（详见本页[数据库容量](#database-size)章节）。
对于大型部署，强烈建议将数据库run到独立服务器上。
:::
##### Examples of hardware configuration
The table provides several examples of hardware configurations:
|Name|Platform|CPU/Memory|Database|Monitored hosts|
|----|--------|----------|--------|---------------|
|*Small*|CentOS|Virtual Appliance|MySQL InnoDB|100|
|*Medium*|CentOS|2 CPU cores/2GB|MySQL InnoDB|500|
|*Large*|RedHat Enterprise Linux|4 CPU cores/8GB|RAID10 MySQL InnoDB or PostgreSQL|>1000|
|*Very large*|RedHat Enterprise Linux|8 CPU cores/16GB|Fast RAID10 MySQL InnoDB or PostgreSQL|>10000|
::: noteclassic
Actual configuration depends on the number of active items
and refresh rates very much (see [database
size](/manual/installation/requirements#Database_size) section of this
page for details). It is highly recommended to run the database on a
separate box for large installations.
:::
##### 硬件资源配置参考
下表提供了几个硬件配置参考：
|名称|平台|CPU/内存|数据库|监控主机数|
|----|--------|----------|--------|---------------|
|*小*|CentOS|Virtual Appliance|MySQL InnoDB|100|
|*中*|CentOS|2 CPU cores/2GB|MySQL InnoDB|500|
|*大*|RedHat Enterprise Linux|4 CPU cores/8GB|RAID10 MySQL InnoDB or PostgreSQL|>1000|
|*非常大*|RedHat Enterprise Linux|8 CPU cores/16GB|Fast RAID10 MySQL InnoDB or PostgreSQL|>10000|
::: noteclassic
实际上，Zabbix 环境的配置非常依赖于监控项（主动）和更新间隔。 （查看这个页面的 [数据库大小](/manual/installation/requirements#Database_size) 章节以了解详情）。如果是进行大规模部署，强烈建议将数据库独立部署。
:::
##### Examples of simple user parameters
A simple command:
UserParameter=ping,echo 1
The agent will always return '1' for an item with 'ping' key.
A more complex example:
UserParameter=mysql.ping,mysqladmin -uroot ping | grep -c alive
The agent will return '1', if MySQL server is alive, '0' - otherwise.
##### 简单用户参数示例
一个简单命令：
UserParameter=ping,echo 1
对于带有'ping'键的监控项，agent将始终返回'1'。
一个更复杂的示例：
UserParameter=mysql.ping,mysqladmin -uroot ping | grep -c alive
如果MySQL服务器存活，agent将返回'1'，否则返回'0'。
#### Examples of triggers
#### 触发器示例
##### Examples
Problem:
{"clock":1519304285,"ns":123456789,"value":1,"name":"Either Zabbix agent is unreachable on Host B or pollers are too busy on Zabbix Server","severity":3,"eventid":42, "hosts":[{"host":"Host B", "name":"Host B visible"},{"host":"Zabbix Server","name":"Zabbix Server visible"}],"groups":["Group X","Group Y","Group Z","Zabbix servers"],"tags":[{"tag":"availability","value":""},{"tag":"data center","value":"Riga"}]}
Recovery:
{"clock":1519304345,"ns":987654321,"value":0,"eventid":43,"p_eventid":42}
Problem (multiple problem event generation):
{"clock":1519304286,"ns":123456789,"value":1,"eventid":43,"name":"Either Zabbix agent is unreachable on Host B or pollers are too busy on Zabbix Server","severity":3,"hosts":[{"host":"Host B", "name":"Host B visible"},{"host":"Zabbix Server","name":"Zabbix Server visible"}],"groups":["Group X","Group Y","Group Z","Zabbix servers"],"tags":[{"tag":"availability","value":""},{"tag":"data center","value":"Riga"}]}
{"clock":1519304286,"ns":123456789,"value":1,"eventid":43,"name":"Either Zabbix agent is unreachable on Host B or pollers are too busy on Zabbix Server","severity":3,"hosts":[{"host":"Host B", "name":"Host B visible"},{"host":"Zabbix Server","name":"Zabbix Server visible"}],"groups":["Group X","Group Y","Group Z","Zabbix servers"],"tags":[{"tag":"availability","value":""},{"tag":"data center","value":"Riga"}]}
Recovery:
{"clock":1519304346,"ns":987654321,"value":0,"eventid":44,"p_eventid":43}
{"clock":1519304346,"ns":987654321,"value":0,"eventid":44,"p_eventid":42}
##### 示例
问题：
{"clock":1519304285,"ns":123456789,"value":1,"name":"Either Zabbix agent is unreachable on Host B or pollers are too busy on Zabbix Server","severity":3,"eventid":42, "hosts":[{"host":"Host B", "name":"Host B visible"},{"host":"Zabbix Server","name":"Zabbix Server visible"}],"groups":["Group X","Group Y","Group Z","Zabbix servers"],"tags":[{"tag":"availability","value":""},{"tag":"data center","value":"Riga"}]}
恢复：
{"clock":1519304345,"ns":987654321,"value":0,"eventid":43,"p_eventid":42}
问题（多次问题事件生成）：
{"clock":1519304286,"ns":123456789,"value":1,"eventid":43,"name":"Either Zabbix agent is unreachable on Host B or pollers are too busy on Zabbix Server","severity":3,"hosts":[{"host":"Host B", "name":"Host B visible"},{"host":"Zabbix Server","name":"Zabbix Server visible"}],"groups":["Group X","Group Y","Group Z","Zabbix servers"],"tags":[{"tag":"availability","value":""},{"tag":"data center","value":"Riga"}]}
{"clock":1519304286,"ns":123456789,"value":1,"eventid":43,"name":"Zabbix agent在主机 B上不可达或Zabbix server上的轮询程序过于繁忙","severity":3,"主机":[{"主机":"主机 B", "name":"主机 B可见"},{"主机":"Zabbix server","name":"Zabbix server可见"}],"groups":["Group X","Group Y","Group Z","Zabbix servers"],"tags":[{"tag":"availability","value":""},{"tag":"data center","value":"Riga"}]}
恢复：
{"clock":1519304346,"ns":987654321,"value":0,"eventid":44,"p_eventid":43}
{"clock":1519304346,"ns":987654321,"value":0,"eventid":44,"p_eventid":42}
### Examples
Request:
``` {.java}
{
"jsonrpc": "2.0",
"method": "autoregistration.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"tls_accept": "3"
},
"id": 1
}
```
### 示例
请求:
```{.java}
{
"jsonrpc": "2.0",
"method": "autoregistration.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"tls_accept": "3"
},
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "authentication.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"authentication_type": "0",
"http_auth_enabled": "0",
"http_login_form": "0",
"http_strip_domains": "",
"http_case_sensitive": "1",
"ldap_configured": "0",
"ldap_host": "",
"ldap_port": "389",
"ldap_base_dn": "",
"ldap_search_attribute": "",
"ldap_bind_dn": "",
"ldap_case_sensitive": "1",
"ldap_bind_password": "",
"saml_auth_enabled": "0",
"saml_idp_entityid": "",
"saml_sso_url": "",
"saml_slo_url": "",
"saml_username_attribute": "",
"saml_sp_entityid": "",
"saml_nameid_format": "",
"saml_sign_messages": "0",
"saml_sign_assertions": "0",
"saml_sign_authn_requests": "0",
"saml_sign_logout_requests": "0",
"saml_sign_logout_responses": "0",
"saml_encrypt_nameid": "0",
"saml_encrypt_assertions": "0",
"saml_case_sensitive": "0",
"passwd_min_length": "8",
"passwd_check_rules": "8"
},
"id": 1
}
```
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "authentication.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"authentication_type": "0",
"http_auth_enabled": "0",
"http_login_form": "0",
"http_strip_domains": "",
"http_case_sensitive": "1",
"ldap_configured": "0",
"ldap_host": "",
"ldap_port": "389",
"ldap_base_dn": "",
"ldap_search_attribute": "",
"ldap_bind_dn": "",
"ldap_case_sensitive": "1",
"ldap_bind_password": "",
"saml_auth_enabled": "0",
"saml_idp_entityid": "",
"saml_sso_url": "",
"saml_slo_url": "",
"saml_username_attribute": "",
"saml_sp_entityid": "",
"saml_nameid_format": "",
"saml_sign_messages": "0",
"saml_sign_assertions": "0",
"saml_sign_authn_requests": "0",
"saml_sign_logout_requests": "0",
"saml_sign_logout_responses": "0",
"saml_encrypt_nameid": "0",
"saml_encrypt_assertions": "0",
"saml_case_sensitive": "0",
"passwd_min_length": "8",
"passwd_check_rules": "8"
},
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "authentication.update",
"params": {
"http_auth_enabled": 1,
"http_case_sensitive": 0,
"http_login_form": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
"http_auth_enabled",
"http_case_sensitive",
"http_login_form"
],
"id": 1
}
```
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "authentication.update",
"params": {
"http_auth_enabled": 1,
"http_case_sensitive": 0,
"http_login_form": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
"http_auth_enabled",
"http_case_sensitive",
"http_login_form"
],
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "autoregistration.update",
"params": {
"tls_accept": "3",
"tls_psk_identity": "PSK 001",
"tls_psk": "11111595725ac58dd977beef14b97461a7c1045b9a1c923453302c5473193478"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "autoregistration.update",
"params": {
"tls_accept": "3",
"tls_psk_identity": "PSK 001",
"tls_psk": "11111595725ac58dd977beef14b97461a7c1045b9a1c923453302c5473193478"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "housekeeping.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"hk_events_mode": "1",
"hk_events_trigger": "365d",
"hk_events_service": "1d",
"hk_events_internal": "1d",
"hk_events_discovery": "1d",
"hk_events_autoreg": "1d",
"hk_services_mode": "1",
"hk_services": "365d",
"hk_audit_mode": "1",
"hk_audit": "365d",
"hk_sessions_mode": "1",
"hk_sessions": "365d",
"hk_history_mode": "1",
"hk_history_global": "0",
"hk_history": "90d",
"hk_trends_mode": "1",
"hk_trends_global": "0",
"hk_trends": "365d",
"db_extension": "",
"compression_status": "0",
"compress_older": "7d"
},
"id": 1
}
```
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "housekeeping.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"hk_events_mode": "1",
"hk_events_trigger": "365d",
"hk_events_service": "1d",
"hk_events_internal": "1d",
"hk_events_discovery": "1d",
"hk_events_autoreg": "1d",
"hk_services_mode": "1",
"hk_services": "365d",
"hk_audit_mode": "1",
"hk_audit": "365d",
"hk_sessions_mode": "1",
"hk_sessions": "365d",
"hk_history_mode": "1",
"hk_history_global": "0",
"hk_history": "90d",
"hk_trends_mode": "1",
"hk_trends_global": "0",
"hk_trends": "365d",
"db_extension": "",
"compression_status": "0",
"compress_older": "7d"
},
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "housekeeping.update",
"params": {
"hk_events_mode": "1",
"hk_events_trigger": "200d",
"hk_events_internal": "2d",
"hk_events_discovery": "2d"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
"hk_events_mode",
"hk_events_trigger",
"hk_events_internal",
"hk_events_discovery"
],
"id": 1
}
```
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "housekeeping.update",
"params": {
"hk_events_mode": "1",
"hk_events_trigger": "200d",
"hk_events_internal": "2d",
"hk_events_discovery": "2d"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
"hk_events_mode",
"hk_events_trigger",
"hk_events_internal",
"hk_events_discovery"
],
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "settings.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"default_theme": "blue-theme",
"search_limit": "1000",
"max_in_table": "50",
"server_check_interval": "10",
"work_period": "1-5,09:00-18:00",
"show_technical_errors": "0",
"history_period": "24h",
"period_default": "1h",
"max_period": "2y",
"severity_color_0": "97AAB3",
"severity_color_1": "7499FF",
"severity_color_2": "FFC859",
"severity_color_3": "FFA059",
"severity_color_4": "E97659",
"severity_color_5": "E45959",
"severity_name_0": "Not classified",
"severity_name_1": "Information",
"severity_name_2": "Warning",
"severity_name_3": "Average",
"severity_name_4": "High",
"severity_name_5": "Disaster",
"custom_color": "0",
"ok_period": "5m",
"blink_period": "2m",
"problem_unack_color": "CC0000",
"problem_ack_color": "CC0000",
"ok_unack_color": "009900",
"ok_ack_color": "009900",
"problem_unack_style": "1",
"problem_ack_style": "1",
"ok_unack_style": "1",
"ok_ack_style": "1",
"discovery_groupid": "5",
"default_inventory_mode": "-1",
"alert_usrgrpid": "7",
"snmptrap_logging": "1",
"default_lang": "en_US",
"default_timezone": "system",
"login_attempts": "5",
"login_block": "30s",
"validate_uri_schemes": "1",
"uri_valid_schemes": "http,https,ftp,file,mailto,tel,ssh",
"x_frame_options": "SAMEORIGIN",
"iframe_sandboxing_enabled": "1",
"iframe_sandboxing_exceptions": "",
"max_overview_table_size": "50",
"connect_timeout": "3s",
"socket_timeout": "3s",
"media_type_test_timeout": "65s",
"script_timeout": "60s",
"item_test_timeout": "60s",
"url": "",
"report_test_timeout": "60s",
"auditlog_enabled": "1",
"ha_failover_delay": "1m",
"geomaps_tile_provider": "OpenStreetMap.Mapnik",
"geomaps_tile_url": "",
"geomaps_max_zoom": "0",
"geomaps_attribution": ""
},
"id": 1
}
```
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "settings.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"default_theme": "blue-theme",
"search_limit": "1000",
"max_in_table": "50",
"server_check_interval": "10",
"work_period": "1-5,09:00-18:00",
"show_technical_errors": "0",
"history_period": "24h",
"period_default": "1h",
"max_period": "2y",
"severity_color_0": "97AAB3",
"severity_color_1": "7499FF",
"severity_color_2": "FFC859",
"severity_color_3": "FFA059",
"severity_color_4": "E97659",
"severity_color_5": "E45959",
"severity_name_0": "Not classified",
"severity_name_1": "Information",
"severity_name_2": "Warning",
"severity_name_3": "Average",
"severity_name_4": "High",
"severity_name_5": "Disaster",
"custom_color": "0",
"ok_period": "5m",
"blink_period": "2m",
"problem_unack_color": "CC0000",
"problem_ack_color": "CC0000",
"ok_unack_color": "009900",
"ok_ack_color": "009900",
"problem_unack_style": "1",
"problem_ack_style": "1",
"ok_unack_style": "1",
"ok_ack_style": "1",
"discovery_groupid": "5",
"default_inventory_mode": "-1",
"alert_usrgrpid": "7",
"snmptrap_logging": "1",
"default_lang": "en_US",
"default_timezone": "system",
"login_attempts": "5",
"login_block": "30s",
"validate_uri_schemes": "1",
"uri_valid_schemes": "http,https,ftp,file,mailto,tel,ssh",
"x_frame_options": "SAMEORIGIN",
"iframe_sandboxing_enabled": "1",
"iframe_sandboxing_exceptions": "",
"max_overview_table_size": "50",
"connect_timeout": "3s",
"socket_timeout": "3s",
"media_type_test_timeout": "65s",
"script_timeout": "60s",
"item_test_timeout": "60s",
"url": "",
"report_test_timeout": "60s",
"auditlog_enabled": "1",
"ha_failover_delay": "1m",
"geomaps_tile_provider": "OpenStreetMap.Mapnik",
"geomaps_tile_url": "",
"geomaps_max_zoom": "0",
"geomaps_attribution": ""
},
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "settings.update",
"params": {
"login_attempts": "1",
"login_block": "1m"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
"login_attempts",
"login_block"
],
"id": 1
}
```
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "settings.update",
"params": {
"login_attempts": "1",
"login_block": "1m"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
"login_attempts",
"login_block"
],
"id": 1
}
```
### Examples
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"sessionid": "673b8ba11562a35da902c66cf5c23fa2"
},
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "ru_RU",
"refresh": "0",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "127.0.0.1",
"attempt_clock": "1355919038",
"rows_per_page": "50",
"timezone": "Europe/Riga",
"roleid": "3",
"type": 3,
"sessionid": "673b8ba11562a35da902c66cf5c23fa2",
"debug_mode": 0,
"userip": "127.0.0.1",
"gui_access": 0
},
"id": 1
}
```
::: noteclassic
Response is similar to
[User.login](/manual/api/reference/user/login) call response with
"userData" parameter set to true (the difference is that user data is
retrieved by session id and not by username / password).
:::
### 示例
请求:
```json
{
"jsonrpc": "2.0",
"method": "user.checkAuthentication",
"params": {
"sessionid": "673b8ba11562a35da902c66cf5c23fa2"
},
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"userid": "1",
"username": "Admin",
"name": "Zabbix",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "ru_RU",
"refresh": "0",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "127.0.0.1",
"attempt_clock": "1355919038",
"rows_per_page": "50",
"timezone": "Europe/Riga",
"roleid": "3",
"type": 3,
"sessionid": "673b8ba11562a35da902c66cf5c23fa2",
"debug_mode": 0,
"userip": "127.0.0.1",
"gui_access": 0
},
"id": 1
}
```
::: noteclassic
响应类似于
[User.login](/manual/api/reference/user/login) 调用响应，其中
"userData" 参数设置为 true（区别在于用户数据是通过会话ID而非用户名/密码获取）。
:::
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Clock* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅描述*时钟*小部件的仪表板小部件字段objects的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Data overview* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*数据概览*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Geomap* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅旨在描述*地理地图*小部件的仪表板小部件字段objects的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Graph (classic)* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*图表(经典)*小部件的仪表板小部件字段objects的配置进行说明。
有关仪表板配置的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Graph prototype* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*图形原型*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Graph* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅描述*图形*小部件的仪表板小部件字段objects的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Item value* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅描述仪表板小部件字段objects针对*监控项值*小部件的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Map navigation tree* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*地图导航树*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Map* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅描述*地图*小部件的仪表板小部件字段objects的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Plain text* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*纯文本*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Problem hosts* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*问题主机*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Problems by severity* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*按严重程度分类的问题*小部件的仪表板小部件字段objects配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Problems* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*问题*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *SLA report* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*SLA报告*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Top hosts* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*Top 主机*小部件的仪表板小部件字段objects配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Trigger overview* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*触发器概览*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *URL* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅描述仪表板小部件字段objects针对*URL*小部件的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Web monitoring* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
### 示例
以下示例仅针对*Web监控*小部件的仪表板小部件字段objects的配置进行说明。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
#### Examples
The ways in which macro functions can be used to customize macro values
is illustrated in the following examples on received values:
|Received value|Macro|Output|
|----|----|----|
|`24.3413523`|`{{ITEM.VALUE}.fmtnum(2)}`|`24.34`|
|`24.3413523`|`{{ITEM.VALUE}.fmtnum(0)}`|`24`|
|`12:36:01`|`{{TIME}.fmttime(%B)}`|`October`|
|`12:36:01`|`{{TIME}.fmttime(%d %B,-1M/M)}`|`1 September`|
|`123Log line`|`{{ITEM.VALUE}.regsub(^[0-9]+, Problem)}`|`Problem`|
|`123 Log line`|`{{ITEM.VALUE}.regsub("^([0-9]+)", "Problem")}`|`Problem`|
|`123 Log line`|`{{ITEM.VALUE}.regsub("^([0-9]+)", Problem ID: \1)}`|`Problem ID: 123`|
|`Log line`|`{{ITEM.VALUE}.regsub(".*", "Problem ID: \1")}`|''Problem ID: ''|
|`MySQL crashed errno 123`|`{{ITEM.VALUE}.regsub("^(\w+).*?([0-9]+)", " Problem ID: \1_\2 ")}`|'' Problem ID: MySQL\_123 ''|
|`123 Log line`|`{{ITEM.VALUE}.regsub("([1-9]+", "Problem ID: \1")}`|`*UNKNOWN*` (invalid regular expression)|
|`customername_1`|`{{#IFALIAS}.regsub("(.*)_([0-9]+)", \1)}`|`customername`|
|`customername_1`|`{{#IFALIAS}.regsub("(.*)_([0-9]+)", \2)}`|`1`|
|`customername_1`|`{{#IFALIAS}.regsub("(.*)_([0-9]+", \1)}`|`{{#IFALIAS}.regsub("(.*)_([0-9]+", \1)}` (invalid regular expression)|
|`customername_1`|`{$MACRO:"{{#IFALIAS}.regsub(\"(.*)_([0-9]+)\", \1)}"}`|`{$MACRO:"customername"}`|
|`customername_1`|`{$MACRO:"{{#IFALIAS}.regsub(\"(.*)_([0-9]+)\", \2)}"}`|`{$MACRO:"1"}`|
|`customername_1`|`{$MACRO:"{{#IFALIAS}.regsub(\"(.*)_([0-9]+\", \1)}"}`|`{$MACRO:"{{#M}.regsub(\"(.*)_([0-9]+\", \1)}"}` (invalid regular expression)|
|`customername_1`|`"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+)\\", \1)}\"}"`|`"{$MACRO:\"customername\"}"`|
|`customername_1`|`"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+)\\", \2)}\"}"`|`"{$MACRO:\"1\"}")`|
|`customername_1`|`"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+\\", \1)}\"}"`|`"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+\\", \1)}\"}")` (invalid regular expression)|
##### Seeing full item values
Long values of resolved {ITEM.VALUE} and {ITEM.LASTVALUE} macros for text/log items are truncated to 20 characters in some frontend locations.
To see the full values of these macros you may use macro functions, e.g.:
`{{ITEM.VALUE}.regsub("(.*)", \1)}`<br>
`{{ITEM.LASTVALUE}.regsub("(.*)", \1)}`
See also: {ITEM.VALUE} and {ITEM.LASTVALUE} [macro details](/manual/appendix/macros/supported_by_location).
#### 示例
以下示例展示了如何使用宏函数自定义接收值的宏值:
| 接收值 | 宏 | 输出 |
|----|----|----|
| `24.3413523` | `{{ITEM.VALUE}.fmtnum(2)}` | `24.34` |
| `24.3413523` | `{{ITEM.VALUE}.fmtnum(0)}` | `24` |
| `12:36:01` | `{{TIME}.fmttime(%B)}` | `October` |
| `12:36:01` | `{{TIME}.fmttime(%d %B,-1M/M)}` | `1 September` |
| `123Log line` | `{{ITEM.VALUE}.regsub(^[0-9]+, Problem)}` | `Problem` |
| `123 Log line` | `{{ITEM.VALUE}.regsub("^([0-9]+)", "Problem")}` | `Problem` |
| `123 Log line` | `{{ITEM.VALUE}.regsub("^([0-9]+)", Problem ID: \1)}` | `Problem ID: 123` |
| `Log line` | `{{ITEM.VALUE}.regsub(".*", "Problem ID: \1")}` | ''Problem ID: '' |
| `MySQL crashed errno 123` | `{{ITEM.VALUE}.regsub("^(\w+).*?([0-9]+)", " Problem ID: \1_\2 ")}` | '' Problem ID: MySQL\_123 '' |
| `123 Log line` | `{{ITEM.VALUE}.regsub("([1-9]+", "Problem ID: \1")}` | `*UNKNOWN*` (无效正则表达式) |
| `customername_1` | `{{#IFALIAS}.regsub("(.*)_([0-9]+)", \1)}` | `customername` |
| `customername_1` | `{{#IFALIAS}.regsub("(.*)_([0-9]+)", \2)}` | `1` |
| `customername_1` | `{{#IFALIAS}.regsub("(.*)_([0-9]+", \1)}` | `{{#IFALIAS}.regsub("(.*)_([0-9]+", \1)}` (无效正则表达式) |
| `customername_1` | `{$MACRO:"{{#IFALIAS}.regsub(\"(.*)_([0-9]+)\", \1)}"}` | `{$MACRO:"customername"}` |
| `customername_1` | `{$MACRO:"{{#IFALIAS}.regsub(\"(.*)_([0-9]+)\", \2)}"}` | `{$MACRO:"1"}` |
| `customername_1` | `{$MACRO:"{{#IFALIAS}.regsub(\"(.*)_([0-9]+\", \1)}"}` | `{$MACRO:"{{#M}.regsub(\"(.*)_([0-9]+\", \1)}"}` (无效正则表达式) |
| `customername_1` | `"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+)\\", \1)}\"}"` | `"{$MACRO:\"customername\"}"` |
| `customername_1` | `"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+)\\", \2)}\"}"` | `"{$MACRO:\"1\"}")` |
| `customername_1` | `"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+\\", \1)}\"}"` | `"{$MACRO:\"{{#IFALIAS}.regsub(\\"(.*)_([0-9]+\\", \1)}\"}")` (无效正则表达式) |
##### 查看完整监控项值
在某些前端位置，解析后的{ITEM.VALUE}和{ITEM.LASTVALUE}宏的文本/日志监控项长值会被截断为20个字符。
要查看这些宏的完整值，可以使用宏函数，例如:
`{{ITEM.VALUE}.regsub("(.*)", \1)}`<br>
`{{ITEM.LASTVALUE}.regsub("(.*)", \1)}`
另请参阅: {ITEM.VALUE}和{ITEM.LASTVALUE}[macro details](/manual/appendix/macros/supported_by_location)。
#### Example
Stop repetitive problem events from the same network port.
This global correlation rule will correlate problems if *Host* and
*Port* tag values exist on the trigger and they are the same in the
original event and the new one.
The operation will close new problem events on the same network port,
keeping only the original problem open.
#### 示例
阻止来自同一网络端口的重复问题事件.
如果触发器上存在*主机*和
*Port*标签值且原始事件与新事件中的这些值相同，
此全局关联规则将关联问题.
该操作将关闭同一网络端口上的新问题事件，
仅保持原始问题处于开启状态.
#### Examples
**User macro with context**
Regular expression: `\.+\"[a-z]+`<br>
User macro with context: `{$MACRO:regex:"\.+\\"[a-z]+"}`
Notice:
- backslashes are [not escaped](/manual/config/macros/user_macros_context#important-notes);
- quotation marks are escaped.
**Macro function inside item key parameter**
Regular expression: `.+:(\d+)$`<br>
Item key: `net.tcp.service[tcp,,"{{ITEM.VALUE}.regsub(\".+:(\d+)$\",\1)}"]`
Notice:
- regular expression inside the `regsub` macro function is double-quoted (because of contains closing parenthesis);
- quotation marks around the regular expression are escaped (because the whole third item parameter is double-quoted);
- third item key parameter is double-quoted because it contains a comma.
**LLD macro function**
Regular expression: `\.+\"([a-z]+)`<br>
LLD macro: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`
Notice:
- backslashes are not escaped;
- quotation marks are escaped.
**LLD macro function inside user macro context**
Regular expression: `\.+\"([a-z]+)`<br>
LLD macro: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
User macro with context: `{$MACRO:"{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}"}`
Notice:
- backslash escaping for LLD does not change;
- upon inserting the LLD macro into user macro context, we need to put it into string:
1. Quotation marks are added around the macro expression;
2. Quotation marks get escaped; in total, 3 new backslashes are introduced.
**String parameter of non-history function**
String content: `\.+\"[a-z]+`<br>
Expression: `concat("abc", "\\.\\\"[a-z]+")`
Notice:
- String parameters require escaping both for backslashes and quotation marks.
**String parameter of history function**
String content: `\.+\"[a-z]+`<br>
Expression: `find(__ITEM_KEY__,,"regexp","\.+\\"[a-z]+")`
Notice:
- backslashes are not escaped;
- quotation marks are escaped.
**LLD macro function inside string parameter of non-history function**
Regular expression: `\.+\"([a-z]+)`<br>
LLD macro: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
Expression: `concat("abc, "{{#MACRO}.iregsub(\"\\.+\\\\\"([a-z]+)\", \\1)}")`
Notice:
- String parameters require escaping both for backslashes and quotation marks;
- Another layer of escaping is added, because the macro will be resolved only after string is unquoted;
**LLD macro function inside string parameter of history function**
Regular expression: `\.+\"([a-z]+)`<br>
LLD macro: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
Expression: `find(__ITEM_KEY__,,"eq","{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}")`
Notice:
- backslashes are not escaped;
- quotation marks are escaped.
**User macro with context inside string parameter of non-history function**
Regular expression: `\.+\"[a-z]+`<br>
User macro with context: `{$MACRO:regex:"\.+\\"[a-z]+"}`<br>
Expression: `concat("abc, "{$MACRO:regex:\"\\.+\\\\\"[a-z]+\"}")`
Notice:
- Same as in the previous example an additional layer of escaping is needed;
- Backslashes and quotation marks are escaped only for the top-level escaping (by virtue of it being a string parameter).
**User macro with context inside string parameter of history function**
Regular expression: `\.+\"[a-z]+`<br>
User macro with context: `{$MACRO:regex:"\.+\\"[a-z]+"}`<br>
Expression: `find(__ITEM_KEY__,,"eq","{$MACRO:regex:\"\.+\\\"[a-z]+\"}")`
Notice:
- backslashes are not escaped;
- quotation marks are escaped.
**LLD macro function inside user macro context inside non-history function**
Regular expression: `\.+\"([a-z]+)`<br>
LLD macro: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
User macro with context: `{$MACRO:"{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}"}`<br>
Expression: `concat("abc, "{$MACRO:\"{{#MACRO}.iregsub(\\\"\.+\\\\\\\"([a-z])+\\\", \\1)}\"}")`
Notice the three layers of escaping:
1. For LLD macro function, without escaping of backslashes;
2. For User macro with context, without escaping of backslashes;
3. For the string parameter of a function, with escaping of backslashes.
**LLD macro function inside user macro context inside history function**
Regular expression: `\.+\"([a-z])+`<br>
LLD macro: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
User macro with context: `{$MACRO:"{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}"}`<br>
Expression: `find(__ITEM_KEY__,,"eq","{$MACRO:\"{{#MACRO}.iregsub(\\"\.+\\\\"([a-z])+\\", \1)}\"}")`
Notice:
- backslashes are not escaped;
- quotation marks are escaped.
**User macro with context just inside string**
Regular expression: `\.+\"[a-z]+`<br>
User macro with context: `{$MACRO:regex:"\.+\\"[a-z]+"}`<br>
Inside string of some expression, for example: `func(arg1, arg2, arg3)="{$MACRO:regex:\"\\.+\\\\\"[a-z]+\"}"`
Notice:
- Strings also require backslash escaping;
- Strings also require quotation mark escaping;
- Again a case with 2 levels of escaping:
1. Escaping for user macro context without backslash escaping;
2. Escaping for it being a string with backslash escaping.
#### 示例
**带上下文的自定义宏**
正则表达式: `\.+\"[a-z]+`<br>
带上下文的自定义宏: `{$MACRO:regex:"\.+\\"[a-z]+"}`
注意:
- 反斜杠需要[重要说明](/manual/config/macros/user_macros_context#重要说明);
- 引号需要转义.
**宏函数在监控项键参数内部**
正则表达式: `.+:(\d+)$`<br>
监控项键: `net.tcp.service[tcp,,"{{ITEM.VALUE}.regsub(\".+:(\d+)$\",\1)}"]`
注意:
- `regsub`宏函数内部的正则表达式使用双引号(因为包含右括号);
- 正则表达式周围的引号需要转义(因为整个第三个监控项参数是双引号包裹的);
- 第三个监控项键参数使用双引号是因为包含逗号.
**LLD宏函数**
正则表达式: `\.+\"([a-z]+)`<br>
LLD宏: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`
注意:
- 反斜杠不需要转义;
- 引号需要转义.
**LLD宏函数在自定义宏上下文中**
正则表达式: `\.+\"([a-z]+)`<br>
LLD宏: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
带上下文的自定义宏: `{$MACRO:"{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}"}`
注意:
- LLD的反斜杠转义规则不变;
- 将LLD宏插入自定义宏上下文时,需要放入string:
1. 在宏表达式周围添加引号;
2. 引号get需要转义; 总共引入了3个新的反斜杠.
**非历史函数的string参数**
string内容: `\.+\"[a-z]+`<br>
表达式: `concat("abc", "\\.\\\"[a-z]+")`
注意:
- string参数需要对反斜杠和引号都进行转义.
**历史函数的string参数**
string内容: `\.+\"[a-z]+`<br>
表达式: `find(__ITEM_KEY__,,"regexp","\.+\\"[a-z]+")`
注意:
- 反斜杠不需要转义;
- 引号需要转义.
**LLD宏函数在非历史函数的string参数内部**
正则表达式: `\.+\"([a-z]+)`<br>
LLD宏: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
表达式: `concat("abc, "{{#MACRO}.iregsub(\"\\.+\\\\\"([a-z]+)\", \\1)}")`
注意:
- string参数需要对反斜杠和引号都进行转义;
- 由于宏只在string解引用后才会解析,因此需要额外增加一层转义;
**LLD宏函数在历史函数的string参数内部**
正则表达式: `\.+\"([a-z]+)`<br>
LLD宏: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
表达式: `find(__ITEM_KEY__,,"eq","{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}")`
注意:
- 反斜杠不需要转义;
- 引号需要转义.
**带上下文的自定义宏在非历史函数的string参数内部**
正则表达式: `\.+\"[a-z]+`<br>
带上下文的自定义宏: `{$MACRO:regex:"\.+\\"[a-z]+"}`<br>
表达式: `concat("abc, "{$MACRO:regex:\"\\.+\\\\\"[a-z]+\"}")`
注意:
- 与前例相同,需要额外增加一层转义;
- 反斜杠和引号仅因作为string参数而需要为Top级别转义.
**带上下文的自定义宏在历史函数的string参数内部**
正则表达式: `\.+\"[a-z]+`<br>
带上下文的自定义宏: `{$MACRO:regex:"\.+\\"[a-z]+"}`<br>
表达式: `find(__ITEM_KEY__,,"eq","{$MACRO:regex:\"\.+\\\"[a-z]+\"}")`
注意:
- 反斜杠不需要转义;
- 引号需要转义.
**LLD宏函数在自定义宏上下文中且位于非历史函数内部**
正则表达式: `\.+\"([a-z]+)`<br>
LLD宏: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
带上下文的自定义宏: `{$MACRO:"{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}"}`<br>
表达式: `concat("abc, "{$MACRO:\"{{#MACRO}.iregsub(\\\"\.+\\\\\\\"([a-z])+\\\", \\1)}\"}")`
注意三层转义:
1. 对于LLD宏函数,反斜杠不需要转义;
2. 对于带上下文的自定义宏,反斜杠不需要转义;
3. 对于函数的string参数,反斜杠需要转义.
**LLD宏函数在自定义宏上下文中且位于历史函数内部**
正则表达式: `\.+\"([a-z])+`<br>
LLD宏: `{{#MACRO}.iregsub("\.+\\"([a-z]+)", \1)}`<br>
带上下文的自定义宏: `{$MACRO:"{{#MACRO}.iregsub(\"\.+\\\"([a-z]+)\", \1)}"}`<br>
表达式: `find(__ITEM_KEY__,,"eq","{$MACRO:\"{{#MACRO}.iregsub(\\"\.+\\\\"([a-z])+\\", \1)}\"}")`
注意:
- 反斜杠不需要转义;
- 引号需要转义.
**带上下文的自定义宏仅位于string内部**
正则表达式: `\.+\"[a-z]+`<br>
带上下文的自定义宏: `{$MACRO:regex:"\.+\\"[a-z]+"}`<br>
在某些表达式的string内部,例如: `func(arg1, arg2, arg3)="{$MACRO:regex:\"\\.+\\\\\"[a-z]+\"}"`
注意:
- 字符串也需要反斜杠转义;
- 字符串也需要引号转义;
- 再次出现两层转义的情况:
1. 对于自定义宏上下文的反斜杠不转义;
2. 对于作为string的反斜杠需要转义.
#### Examples
Working hours. Monday - Friday from 9:00 till 18:00:
1-5,09:00-18:00
Working hours plus weekend. Monday - Friday from 9:00 till 18:00 and
Saturday, Sunday from 10:00 till 16:00:
1-5,09:00-18:00;6-7,10:00-16:00
#### 示例
工作时间. 周一至周五 9:00-18:00:
1-5,09:00-18:00
工作时间含周末. 周一至周五 9:00-18:00 及
周六、周日 10:00-16:00:
1-5,09:00-18:00;6-7,10:00-16:00
## EXAMPLES
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"**\
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-agent-cert-issuer "CN=Signing CA,OU=IT operations,O=Example
Corp,DC=example,DC=com" --tls-agent-cert-subject "CN=server1,OU=IT
operations,O=Example Corp,DC=example,DC=com" --tls-cert-file
/home/zabbix/zabbix\_get.crt --tls-key-file
/home/zabbix/zabbix\_get.key\
zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk** [ ]{#lbAH}
## 示例
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"**\
**zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-agent-cert-issuer "CN=Signing CA,OU=IT operations,O=Example
Corp,DC=example,DC=com" --tls-agent-cert-subject "CN=server1,OU=IT
operations,O=Example Corp,DC=example,DC=com" --tls-cert-file
/home/zabbix/zabbix\_get.crt --tls-key-file
/home/zabbix/zabbix\_get.key\
zabbix\_get -s 127.0.0.1 -p 10050 -k "system.cpu.load\[all,avg1\]"
--tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk** [ ]{#lbAH}
## EXAMPLES
**zabbix\_js -s script-file.js -p example** [ ]{#lbAG}
## 示例
**zabbix\_js -s script-file.js -p example** [ ]{#lbAG}
## EXAMPLES
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -k mysql.queries -o
342.45**\
Send **342.45** as the value for **mysql.queries** item of monitored
host. Use monitored host and Zabbix server defined in agent
configuration file.
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -s "Monitored Host"
-k mysql.queries -o 342.45**\
Send **342.45** as the value for **mysql.queries** item of **Monitored
Host** host using Zabbix server defined in agent configuration file.
\
**zabbix\_sender -z 192.168.1.113 -i data\_values.txt**
\
Send values from file **data\_values.txt** to Zabbix server with IP
**192.168.1.113**. Host names and keys are defined in the file.
\
**echo "- hw.serial.number 1287872261 SQ4321ASDF" | zabbix\_sender -c
/usr/local/etc/zabbix\_agentd.conf -T -i -**\
Send a timestamped value from the commandline to Zabbix server,
specified in the agent configuration file. Dash in the input data
indicates that hostname also should be used from the same configuration
file.
\
**echo '"Zabbix server" trapper.item ""' | zabbix\_sender -z
192.168.1.113 -p 10000 -i -**\
Send empty value of an item to the Zabbix server with IP address
**192.168.1.113** on port **10000** from the commandline. Empty values
must be indicated by empty double quotes.
**zabbix\_sender -z 192.168.1.113 -s "Monitored Host" -k mysql.queries
-o 342.45 --tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-cert-file /home/zabbix/zabbix\_agentd.crt --tls-key-file
/home/zabbix/zabbix\_agentd.key**\
Send **342.45** as the value for **mysql.queries** item in **Monitored
Host** host to server with IP **192.168.1.113** using TLS with
certificate.
**zabbix\_sender -z 192.168.1.113 -s "Monitored Host" -k mysql.queries
-o 342.45 --tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk**\
Send **342.45** as the value for **mysql.queries** item in **Monitored
Host** host to server with IP **192.168.1.113** using TLS with
pre-shared key (PSK).
[ ]{#lbAI}
## 示例
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -k mysql.queries -o
342.45**\
将**342.45**作为**mysql.queries** 监控项的值发送到被监控主机。使用在agent配置file中定义的被监控主机和Zabbix server。
**zabbix\_sender -c /etc/zabbix/zabbix\_agentd.conf -s "Monitored 主机"
-k mysql.queries -o 342.45**\
将**342.45**作为**mysql.queries** 监控项的值发送到**Monitored 主机** 主机，使用在agent配置file中定义的Zabbix server。
\
**zabbix\_sender -z 192.168.1.113 -i data\_values.txt**
\
将file **data\_values.txt**中的值发送到IP为**192.168.1.113**的Zabbix server。主机名称和键在file中定义。
\
**echo "- hw.serial.number 1287872261 SQ4321ASDF" | zabbix\_sender -c
/usr/local/etc/zabbix\_agentd.conf -T -i -**\
从命令行发送带时间戳的值到Zabbix server，该服务器在agent配置file中指定。输入数据中的破折号表示主机名也应从同一配置file中使用。
\
**echo '"Zabbix server" trapper.监控项 ""' | zabbix\_sender -z
192.168.1.113 -p 10000 -i -**\
从命令行发送监控项的空值到IP地址为**192.168.1.113**、端口为**10000**的Zabbix server。空值必须用空双引号表示。
**zabbix\_sender -z 192.168.1.113 -s "Monitored 主机" -k mysql.queries
-o 342.45 --tls-connect cert --tls-ca-file /home/zabbix/zabbix\_ca\_file
--tls-cert-file /home/zabbix/zabbix\_agentd.crt --tls-key-file
/home/zabbix/zabbix\_agentd.key**\
将**342.45**作为**mysql.queries** 监控项的值发送到IP为**192.168.1.113**的服务器上的**Monitored 主机** 主机，使用带证书的TLS。
**zabbix\_sender -z 192.168.1.113 -s "Monitored 主机" -k mysql.queries
-o 342.45 --tls-connect psk --tls-psk-identity "PSK ID Zabbix agentd"
--tls-psk-file /home/zabbix/zabbix\_agentd.psk**\
将**342.45**作为**mysql.queries** 监控项的值发送到IP为**192.168.1.113**的服务器上的**Monitored 主机** 主机，使用预共享密钥(PSK)的TLS。
[ ]{#lbAI}
#### Example
The following example demonstrates how to quickly setup VMware
monitoring on Zabbix:
- make sure that Zabbix server has been compiled with the required options (--with-libxml2 and
--with-libcurl): the log file must contain "VMware monitoring: YES" during server startup.
- set the StartVMwareCollectors option in Zabbix server configuration
file to 2 or more
- create a new host
- set the host macros required for VMware authentication:
- link the host to the VMware service template:
- click on the **Add** button to save the host.
#### 示例
以下示例演示如何在Zabbix上快速设置VMware监控:
- 确保Zabbix server已使用所需选项(--with-libxml2和--with-libcurl)编译: 服务器启动时日志file必须包含"VMware monitoring: YES"
- 在Zabbix server配置file中将StartVMwareCollectors选项设置为2或更大值
- create一个新的主机
- 设置VMware认证所需的主机宏:
- 将主机链接到VMware服务模板:
- 点击**Add**按钮保存主机
### Example
The required JSON string format is best illustrated with an example. Suppose we
are running an old Zabbix 1.8 agent (one that does not support
"vfs.fs.discovery"), but we still need to discover file systems. Here is
a simple Perl script for Linux that discovers mounted file systems and
outputs in JSON, which includes both file system name and type. One way to
use it would be as a UserParameter with key "vfs.fs.discovery\_perl":
``` {.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"{#FSNAME}\":\"$fsname\",\n";
print "\t\t\"{#FSTYPE}\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
::: noteimportant
Allowed symbols for LLD macro names are **0-9** , **A-Z** , **\_** , **.**
Lowercase letters are not supported in the names.
:::
An example of its output (reformatted for clarity) is shown below. JSON
for custom discovery checks has to follow the same format.
``` {.javascript}
[
{ "{#FSNAME}":"/", "{#FSTYPE}":"rootfs" },
{ "{#FSNAME}":"/sys", "{#FSTYPE}":"sysfs" },
{ "{#FSNAME}":"/proc", "{#FSTYPE}":"proc" },
{ "{#FSNAME}":"/dev", "{#FSTYPE}":"devtmpfs" },
{ "{#FSNAME}":"/dev/pts", "{#FSTYPE}":"devpts" },
{ "{#FSNAME}":"/lib/init/rw", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/dev/shm", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/home", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/tmp", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/usr", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/var", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/sys/fs/fuse/connections", "{#FSTYPE}":"fusectl" }
]
```
In the previous example it is required that the keys match the LLD macro
names used in prototypes, the alternative is to extract LLD macro values
using JSONPath `{#FSNAME}` → `$.fsname` and `{#FSTYPE}` → `$.fstype`,
thus making such script possible:
``` {.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"fsname\":\"$fsname\",\n";
print "\t\t\"fstype\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
An example of its output (reformatted for clarity) is shown below. JSON
for custom discovery checks has to follow the same format.
``` {.javascript}
[
{ "fsname":"/", "fstype":"rootfs" },
{ "fsname":"/sys", "fstype":"sysfs" },
{ "fsname":"/proc", "fstype":"proc" },
{ "fsname":"/dev", "fstype":"devtmpfs" },
{ "fsname":"/dev/pts", "fstype":"devpts" },
{ "fsname":"/lib/init/rw", "fstype":"tmpfs" },
{ "fsname":"/dev/shm", "fstype":"tmpfs" },
{ "fsname":"/home", "fstype":"ext3" },
{ "fsname":"/tmp", "fstype":"ext3" },
{ "fsname":"/usr", "fstype":"ext3" },
{ "fsname":"/var", "fstype":"ext3" },
{ "fsname":"/sys/fs/fuse/connections", "fstype":"fusectl" }
]
```
Then, in the discovery rule's "Filter" field, we could specify
"{\#FSTYPE}" as a macro and "rootfs|ext3" as a regular expression.
::: noteclassic
You don't have to use macro names FSNAME/FSTYPE with custom
LLD rules, you are free to use whatever names you like. In case JSONPath
is used then LLD row will be an array element that can be an object, but
it can be also another array or a value.
:::
Note that, if using a user parameter, the return value is limited to 16MB.
For more details, see [data limits for LLD return values](/manual/discovery/low_level_discovery/notes#data-limits-for-return-values).
### 示例
所需的JSON string格式通过示例最能说明。假设我们
正在运行一个旧的Zabbix 1.8 agent（不支持
"vfs.fs.discovery"的版本），但我们仍需要发现file系统。以下是
一个简单的Perl脚本，用于Linux系统发现已挂载的file系统并
以JSON格式输出，其中包含file系统名称和类型。一种使用方式
是将其作为键为"vfs.fs.discovery\_perl"的UserParameter：
```{.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"{#FSNAME}\":\"$fsname\",\n";
print "\t\t\"{#FSTYPE}\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
::: noteimportant
LLD宏名称允许使用的符号为**0-9**、**A-Z**、**\_**、**.**
名称中不支持小写字母。
:::
其输出示例如下（为清晰起见已重新格式化）。自定义发现检查的JSON
必须遵循相同的格式。
```{.javascript}
[
{ "{#FSNAME}":"/", "{#FSTYPE}":"rootfs" },
{ "{#FSNAME}":"/sys", "{#FSTYPE}":"sysfs" },
{ "{#FSNAME}":"/proc", "{#FSTYPE}":"proc" },
{ "{#FSNAME}":"/dev", "{#FSTYPE}":"devtmpfs" },
{ "{#FSNAME}":"/dev/pts", "{#FSTYPE}":"devpts" },
{ "{#FSNAME}":"/lib/init/rw", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/dev/shm", "{#FSTYPE}":"tmpfs" },
{ "{#FSNAME}":"/home", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/tmp", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/usr", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/var", "{#FSTYPE}":"ext3" },
{ "{#FSNAME}":"/sys/fs/fuse/connections", "{#FSTYPE}":"fusectl" }
]
```
在前面的示例中，要求键必须与原型中使用的LLD宏名称匹配，
另一种方法是使用JSONPath提取LLD宏值`{#FSNAME}` → `$.fsname`和`{#FSTYPE}` → `$.fstype`，
从而使此类脚本成为可能：
```{.perl}
#!/usr/bin/perl
$first = 1;
print "[\n";
for (`cat /proc/mounts`)
{
($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
print "\t,\n" if not $first;
$first = 0;
print "\t{\n";
print "\t\t\"fsname\":\"$fsname\",\n";
print "\t\t\"fstype\":\"$fstype\"\n";
print "\t}\n";
}
print "]\n";
```
其输出示例如下（为清晰起见已重新格式化）。自定义发现检查的JSON
必须遵循相同的格式。
```{.javascript}
[
{ "fsname":"/", "fstype":"rootfs" },
{ "fsname":"/sys", "fstype":"sysfs" },
{ "fsname":"/proc", "fstype":"proc" },
{ "fsname":"/dev", "fstype":"devtmpfs" },
{ "fsname":"/dev/pts", "fstype":"devpts" },
{ "fsname":"/lib/init/rw", "fstype":"tmpfs" },
{ "fsname":"/dev/shm", "fstype":"tmpfs" },
{ "fsname":"/home", "fstype":"ext3" },
{ "fsname":"/tmp", "fstype":"ext3" },
{ "fsname":"/usr", "fstype":"ext3" },
{ "fsname":"/var", "fstype":"ext3" },
{ "fsname":"/sys/fs/fuse/connections", "fstype":"fusectl" }
]
```
然后，在发现规则的"Filter"字段中，我们可以指定
"{\#FSTYPE}"作为宏，"rootfs|ext3"作为正则表达式。
::: noteclassic
使用自定义LLD规则时，不必使用FSNAME/FSTYPE作为宏名称，
可以自由使用任何喜欢的名称。如果使用JSONPath，
则LLD行将是一个array元素，可以是object，
但也可以是另一个array或值。
:::
请注意，如果使用用户参数，返回值限制为16MB。
更多详情，请参阅[返回值数据限制](/manual/discovery/low_level_discovery/notes#返回值数据限制)。
##### Example with an inline regex modifier
Use of the following regular expression including an inline modifier
(?i) to match the characters "error":
(?i)error
Chosen *Expression type*: "Result is TRUE". Characters "error" are
matched.
##### 带内联正则修饰符的示例
使用包含内联修饰符(?i)的以下正则表达式
来匹配字符"error":
(?i)error
选择的*表达式类型*: "结果为TRUE"。字符"error"被
匹配。
### Example workflow
The following section will walk you through some usage examples in more
detail.
### 示例工作流
以下部分将更详细地介绍一些使用示例。
#### Execution steps
:::noteclassic
By default, all scripts in Zabbix are executed using the *sh* shell,
and it is not possible to modify the default shell. To utilize a different shell,
you can employ a workaround: create a script file and invoke that script during command execution.
:::
The command/script is executed similarly on both Unix and Windows
platforms:
1. Zabbix (the parent process) creates a pipe for communication
2. Zabbix sets the pipe as the output for the to-be-created child
process
3. Zabbix creates the child process (runs the command/script)
4. A new process group (in Unix) or a job (in Windows) is created for
the child process
5. Zabbix reads from the pipe until timeout occurs or no one is writing
to the other end (ALL handles/file descriptors have been closed).
Note that the child process can create more processes and exit
before they exit or close the handle/file descriptor.
6. If the timeout has not been reached, Zabbix waits until the initial
child process exits or timeout occurs
7. If the initial child process exited and the timeout has not been
reached, Zabbix checks exit code of the initial child process and
compares it to 0 (non-zero value is considered as execution failure,
only for custom alert scripts, remote commands and user scripts
executed on Zabbix server and Zabbix proxy)
8. At this point it is assumed that everything is done and the whole
process tree (i.e. the process group or the job) is terminated
::: noteimportant
Zabbix assumes that a command/script has done
processing when the initial child process has exited AND no other
process is still keeping the output handle/file descriptor open. When
processing is done, ALL created processes are terminated.
:::
All double quotes and backslashes in the command are escaped with
backslashes and the command is enclosed in double quotes.
#### 执行步骤
:::noteclassic
默认情况下，Zabbix中的所有脚本都使用*sh* shell执行，
且无法修改默认shell。要使用不同的shell，
可以采用变通方法：create一个脚本file并在命令执行期间调用该脚本。
:::
命令/脚本在Unix和Windows平台上的执行方式类似：
1. Zabbix（父进程）创建一个用于通信的管道
2. Zabbix将管道设置为待创建子进程的输出
3. Zabbix创建子进程（运行命令/脚本）
4. 为子进程创建一个新的进程组（Unix）或作业（Windows）
5. Zabbix从管道读取数据，直到超时发生或另一端无人写入
（所有句柄/file描述符已关闭）。
注意子进程可以create更多进程并在它们退出或关闭句柄/file描述符前先行退出。
6. 如果未达到超时，Zabbix会等待初始子进程退出或超时发生
7. 如果初始子进程已退出且未达到超时，Zabbix检查初始子进程的退出代码
并与0比较（非零值视为执行失败，仅适用于在Zabbix server和Zabbix proxy上执行的
自定义告警脚本、远程命令和用户脚本）
8. 此时假定所有操作已完成且整个
process tree (i.e. the process group or the job) is terminated
::: noteimportant
Zabbix假定当初始子进程已退出
且没有其他进程仍保持输出句柄/file描述符打开时，命令/脚本已完成
处理。当处理完成时，所有创建的进程都将被终止。
:::
命令中的所有双引号和反斜杠都会用反斜杠转义，
且命令会被包裹在双引号中。
#### Exit code
Before version 2.2 Zabbix agent returned 0 in case of successful exit
and 255 in case of failure. Starting from version 2.2 and higher Zabbix
agent returns 0 in case of successful exit and 1 in case of failure.
#### 退出代码
在version 2.2版本之前，Zabbix agent会在成功退出时返回0，失败时返回255。从version 2.2及更高版本开始，Zabbix agent会在成功退出时返回0，失败时返回1。
#### Exit code checking
Exit code are checked with the following conditions:
- Only for custom alert scripts, remote commands and user scripts
executed on Zabbix server and Zabbix proxy.
- Any exit code that is different from 0 is considered as execution
failure.
- Contents of standard error and standard output for failed executions
are collected and available in frontend (where execution result is
displayed).
- Additional log entry may be created for remote commands executed on Zabbix agent/proxy
by enabling the LogRemoteCommands parameter on [agent](/manual/appendix/config/zabbix_agentd)/[proxy](/manual/appendix/config/zabbix_proxy).
Possible frontend messages and log entries for failed commands/scripts:
- Contents of standard error and standard output for failed executions
(if any).
- "Process exited with code: N." (for empty output, and exit code not
equal to 0).
- "Process killed by signal: N." (for process terminated by a signal,
on Linux only).
- "Process terminated unexpectedly." (for process terminated for
unknown reasons).
#### 退出码检查
退出码通过以下条件进行检查:
- 仅适用于自定义告警脚本、远程命令以及在Zabbix server和Zabbix proxy上执行的用户脚本
- 任何非0的退出码均被视为执行失败
- 失败执行的标准错误和标准输出内容会被收集并显示在前端(执行结果展示处)
- 对于在Zabbix agent/proxy上执行的远程命令，可能会创建额外的日志条目
by enabling the LogRemoteCommands parameter on [agent](/manual/appendix/config/zabbix_agentd)/[proxy](/manual/appendix/config/zabbix_proxy).
失败命令/脚本可能产生的前端消息和日志条目:
- 失败执行的标准错误和标准输出内容(如果有)
- "进程退出代码: N." (当输出为空且退出码非0时)
- "进程被信号终止: N." (当进程被信号终止时，仅限Linux系统)
- "进程意外终止." (当进程因未知原因终止时)
#### Exit codes
Starting from version 4.4.8 Zabbix agent 2 can also be compiled with
older OpenSSL versions (1.0.1, 1.0.2).
In this case Zabbix provides mutexes for locking in OpenSSL. If a mutex
lock or unlock fails then an error message is printed to the standard
error stream (STDERR) and Agent 2 exits with return code 2 or 3,
respectively.
#### 退出代码
自version 4.4.8版本起，Zabbix agent 2也可使用较旧的OpenSSL版本(1.0.1, 1.0.2)进行编译。
在此情况下，Zabbix会为OpenSSL提供互斥锁机制。若互斥锁加锁或解锁失败，系统会将错误信息输出至标准错误流(STDERR)，且Agent 2会分别以返回码2或3退出。
## EXIT STATUS
The exit status is 0 if the values were sent and all of them were
successfully processed by server. If data was sent, but processing of at
least one of the values failed, the exit status is 2. If data sending
failed, the exit status is 1.
[ ]{#lbAH}
## 退出状态
如果数值成功发送且服务器全部处理成功，则退出状态为0。若数据已发送但至少有一个数值处理失败，则退出状态为2。若数据发送失败，则退出状态为1。
[ ]{#lbAH}
### Expandable lists in latest data subfilter
Expandable lists have been introduced in the [latest data](/manual/web_interface/frontend_sections/monitoring/latest_data) subfilter:
- For each entity group (e.g. tags, hosts) up to 10 rows of entities are now displayed. If there are more entities,
this list can be expanded to a maximum of 1000 entries (the value of SUBFILTER_VALUES_PER_GROUP in [frontend definitions](/manual/web_interface/definitions))
by clicking on a three-dot icon displayed at the end. Previously a non-expandable maximum of 100 entries was the limit.
- In the list of *Tag values* up to 10 rows of tag names are now displayed. If there are more tag names with values,
this list can be expanded to a maximum of 200 tag names by clicking on a three-dot icon displayed at the bottom.
Previously, a non-expandable maximum of 20 rows with tag names was the limit.
For each tag name up to 10 rows of values are displayed (expandable to 1000 entries
(the value of SUBFILTER_VALUES_PER_GROUP in [frontend definitions](/manual/web_interface/definitions))).
### 最新数据子筛选器中的可扩展列表
可展开列表已在[latest data](/manual/web_interface/frontend_sections/monitoring/latest_data)子过滤器中引入:
- 对于每个实体组(例如标签、主机)，现在最多显示10行实体。如果有更多实体，
可通过点击末尾显示的三点图标将列表扩展至最多1000条条目([frontend definitions](/manual/web_interface/definitions)中的SUBFILTER_VALUES_PER_GROUP值)。
之前不可扩展的限制为最多100条条目。
- 在*标签值*列表中，现在最多显示10行标签名称。如果有更多带值的标签名称，
可通过点击底部显示的三点图标将列表扩展至最多200个标签名称。
之前不可扩展的限制为最多20行标签名称。
对于每个标签名称，最多显示10行值(可扩展至1000条条目
([frontend definitions](/manual/web_interface/definitions)中的SUBFILTER_VALUES_PER_GROUP值))。
#### Expired signing key for RHEL packages
When upgrading Zabbix on [Red Hat Enterprise Linux](/manual/installation/upgrade/packages/rhel#update-repository-configuration-package), you may encounter an expired signing key issue for packages on [Zabbix repository](https://repo.zabbix.com/zabbix/6.0/).
When a signing key expires, attempts to verify package signatures will result in an error indicating that the certificate or key is no longer valid. For example:
```bash
error: Verifying a signature using certificate D9AA84C2B617479C6E4FCF4D19F2475308EFA7DD (Zabbix LLC (Jul 2022) <packager@zabbix.com>):
1. Certificate 19F2475308EFA7DD invalid: certificate is not alive
because: The primary key is not live
because: Expired on 2024-07-04T11:41:23Z
2. Key 19F2475308EFA7DD invalid: key is not alive
because: The primary key is not live
because: Expired on 2024-07-04T11:41:23Z
```
To resolve such issues, manually reinstall the latest `zabbix-release` package for your specific variant of RHEL
(replace the link below with the correct one from [Zabbix repository](https://repo.zabbix.com/zabbix/6.0/)).
For example, on **RHEL 9**, run:
```bash
rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/9/x86_64/zabbix-release-latest.el9.noarch.rpm
```
Then, update the repository information:
```bash
dnf update
```
For more information, see [ZBX-24761](https://support.zabbix.com/browse/ZBX-24761).
#### RHEL包签名密钥过期
在[Red Hat Enterprise Linux](/manual/installation/upgrade/packages/rhel#update-repository-configuration-package)上升级Zabbix时，您可能会遇到[Zabbix repository](https://repo.zabbix.com/zabbix/6.0/)上软件包的签名密钥问题过期问题。
当签名密钥过期时，尝试验证软件包签名会导致错误，提示证书或密钥不再有效。例如：
```bash
error: Verifying a signature using certificate D9AA84C2B617479C6E4FCF4D19F2475308EFA7DD (Zabbix LLC (Jul 2022) <packager@zabbix.com>):
1. Certificate 19F2475308EFA7DD invalid: certificate is not alive
because: The primary key is not live
because: Expired on 2024-07-04T11:41:23Z
2. Key 19F2475308EFA7DD invalid: key is not alive
because: The primary key is not live
because: Expired on 2024-07-04T11:41:23Z
```
要解决此类问题，请手动重新安装适用于您特定RHEL变体的最新`zabbix-release`软件包
(将以下链接替换为[Zabbix repository](https://repo.zabbix.com/zabbix/6.0/)中的正确链接)。
例如，在**RHEL 9**上，run：
```bash
rpm -Uvh https://repo.zabbix.com/zabbix/6.0/rhel/9/x86_64/zabbix-release-latest.el9.noarch.rpm
```
然后，update仓库信息：
```bash
dnf update
```
更多信息请参阅[ZBX-24761](https://support.zabbix.com/browse/ZBX-24761)。
#### Export and import
Export and import Zabbix configuration data for configuration backups,
migration or large-scale configuration updates.
[Configuration API](/manual/api/reference/configuration)
#### 导出与导入
导出并importZabbix配置数据，用于配置备份、
迁移或大规模配置更新。
[Configuration API](/manual/api/reference/configuration)
##### Export format
Data can be exported using the Zabbix web frontend or [Zabbix
API](/manual/api/reference/configuration). Supported export formats are
YAML, XML and JSON.
##### 导出格式
数据可以通过Zabbix前端或[Zabbix
API](/manual/api/reference/configuration)导出。支持的export格式包括
YAML、XML和JSON。
#### Export format
Export format in YAML:
``` {.yaml}
zabbix_export:
version: '6.0'
date: '2021-08-31T12:40:55Z'
groups:
- uuid: a571c0d144b14fd4a87a9d9b2aa9fcd6
name: Templates/Applications
templates:
- uuid: 56079badd056419383cc26e6a4fcc7e0
template: VMware
name: VMware
description: |
You can discuss this template or leave feedback on our forum https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/
Template tooling version used: 0.38
templates:
- name: 'VMware macros'
groups:
- name: Templates/Applications
items:
- uuid: 5ce209f4d94f460488a74a92a52d92b1
name: 'VMware: Event log'
type: SIMPLE
key: 'vmware.eventlog[{$VMWARE.URL},skip]'
history: 7d
trends: '0'
value_type: LOG
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Collect VMware event log. See also: https://www.zabbix.com/documentation/6.0/manual/config/items/preprocessing/examples#filtering_vmware_event_log_records'
tags:
- tag: Application
value: VMware
- uuid: ee2edadb8ce943ef81d25dbbba8667a4
name: 'VMware: Full name'
type: SIMPLE
key: 'vmware.fullname[{$VMWARE.URL}]'
delay: 1h
history: 7d
trends: '0'
value_type: CHAR
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware service full name.'
preprocessing:
- type: DISCARD_UNCHANGED_HEARTBEAT
parameters:
- 1d
tags:
- tag: Application
value: VMware
- uuid: a0ec9145f2234fbea79a28c57ebdb44d
name: 'VMware: Version'
type: SIMPLE
key: 'vmware.version[{$VMWARE.URL}]'
delay: 1h
history: 7d
trends: '0'
value_type: CHAR
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware service version.'
preprocessing:
- type: DISCARD_UNCHANGED_HEARTBEAT
parameters:
- 1d
tags:
- tag: Application
value: VMware
discovery_rules:
- uuid: 16ffc933cce74cf28a6edf306aa99782
name: 'Discover VMware clusters'
type: SIMPLE
key: 'vmware.cluster.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Discovery of clusters'
item_prototypes:
- uuid: 46111f91dd564a459dbc1d396e2e6c76
name: 'VMware: Status of "{#CLUSTER.NAME}" cluster'
type: SIMPLE
key: 'vmware.cluster.status[{$VMWARE.URL},{#CLUSTER.NAME}]'
history: 7d
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware cluster status.'
valuemap:
name: 'VMware status'
tags:
- tag: Application
value: VMware
- uuid: 8fb6a45cbe074b0cb6df53758e2c6623
name: 'Discover VMware datastores'
type: SIMPLE
key: 'vmware.datastore.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
item_prototypes:
- uuid: 4b61838ba4c34e709b25081ae5b059b5
name: 'VMware: Average read latency of the datastore {#DATASTORE}'
type: SIMPLE
key: 'vmware.datastore.read[{$VMWARE.URL},{#DATASTORE},latency]'
history: 7d
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Amount of time for a read operation from the datastore (milliseconds).'
tags:
- tag: Application
value: VMware
- uuid: 5355c401dc244bc588ccd18767577c93
name: 'VMware: Free space on datastore {#DATASTORE} (percentage)'
type: SIMPLE
key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE},pfree]'
delay: 5m
history: 7d
value_type: FLOAT
units: '%'
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware datastore space in percentage from total.'
tags:
- tag: Application
value: VMware
- uuid: 84f13c4fde2d4a17baaf0c8c1eb4f2c0
name: 'VMware: Total size of datastore {#DATASTORE}'
type: SIMPLE
key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE}]'
delay: 5m
history: 7d
units: B
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware datastore space in bytes.'
tags:
- tag: Application
value: VMware
- uuid: 540cd0fbc56c4b8ea19f2ff5839ce00d
name: 'VMware: Average write latency of the datastore {#DATASTORE}'
type: SIMPLE
key: 'vmware.datastore.write[{$VMWARE.URL},{#DATASTORE},latency]'
history: 7d
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Amount of time for a write operation to the datastore (milliseconds).'
tags:
- tag: Application
value: VMware
- uuid: a5bc075e89f248e7b411d8f960897a08
name: 'Discover VMware hypervisors'
type: SIMPLE
key: 'vmware.hv.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Discovery of hypervisors.'
host_prototypes:
- uuid: 051a1469d4d045cbbf818fcc843a352e
host: '{#HV.UUID}'
name: '{#HV.NAME}'
group_links:
- group:
name: Templates/Applications
group_prototypes:
- name: '{#CLUSTER.NAME}'
- name: '{#DATACENTER.NAME}'
templates:
- name: 'VMware Hypervisor'
macros:
- macro: '{$VMWARE.HV.UUID}'
value: '{#HV.UUID}'
description: 'UUID of hypervisor.'
custom_interfaces: 'YES'
interfaces:
- ip: '{#HV.IP}'
- uuid: 9fd559f4e88c4677a1b874634dd686f5
name: 'Discover VMware VMs'
type: SIMPLE
key: 'vmware.vm.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Discovery of guest virtual machines.'
host_prototypes:
- uuid: 23b9ae9d6f33414880db1cb107115810
host: '{#VM.UUID}'
name: '{#VM.NAME}'
group_links:
- group:
name: Templates/Applications
group_prototypes:
- name: '{#CLUSTER.NAME} (vm)'
- name: '{#DATACENTER.NAME}/{#VM.FOLDER} (vm)'
- name: '{#HV.NAME}'
templates:
- name: 'VMware Guest'
macros:
- macro: '{$VMWARE.VM.UUID}'
value: '{#VM.UUID}'
description: 'UUID of guest virtual machine.'
custom_interfaces: 'YES'
interfaces:
- ip: '{#VM.IP}'
valuemaps:
- uuid: 3c59c22905054d42ac4ee8b72fe5f270
name: 'VMware status'
mappings:
- value: '0'
newvalue: gray
- value: '1'
newvalue: green
- value: '2'
newvalue: yellow
- value: '3'
newvalue: red
```
#### 导出格式
YAML导出格式:
```{.yaml}
zabbix_export:
version: '6.0'
date: '2021-08-31T12:40:55Z'
groups:
- uuid: a571c0d144b14fd4a87a9d9b2aa9fcd6
name: Templates/Applications
templates:
- uuid: 56079badd056419383cc26e6a4fcc7e0
template: VMware
name: VMware
description: |
You can discuss this template or leave feedback on our forum https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/
Template tooling version used: 0.38
templates:
- name: 'VMware macros'
groups:
- name: Templates/Applications
items:
- uuid: 5ce209f4d94f460488a74a92a52d92b1
name: 'VMware: Event log'
type: SIMPLE
key: 'vmware.eventlog[{$VMWARE.URL},skip]'
history: 7d
trends: '0'
value_type: LOG
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Collect VMware event log. See also: https://www.zabbix.com/documentation/6.0/manual/config/items/preprocessing/examples#filtering_vmware_event_log_records'
tags:
- tag: Application
value: VMware
- uuid: ee2edadb8ce943ef81d25dbbba8667a4
name: 'VMware: Full name'
type: SIMPLE
key: 'vmware.fullname[{$VMWARE.URL}]'
delay: 1h
history: 7d
trends: '0'
value_type: CHAR
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware service full name.'
preprocessing:
- type: DISCARD_UNCHANGED_HEARTBEAT
parameters:
- 1d
tags:
- tag: Application
value: VMware
- uuid: a0ec9145f2234fbea79a28c57ebdb44d
name: 'VMware: Version'
type: SIMPLE
key: 'vmware.version[{$VMWARE.URL}]'
delay: 1h
history: 7d
trends: '0'
value_type: CHAR
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware service version.'
preprocessing:
- type: DISCARD_UNCHANGED_HEARTBEAT
parameters:
- 1d
tags:
- tag: Application
value: VMware
discovery_rules:
- uuid: 16ffc933cce74cf28a6edf306aa99782
name: 'Discover VMware clusters'
type: SIMPLE
key: 'vmware.cluster.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Discovery of clusters'
item_prototypes:
- uuid: 46111f91dd564a459dbc1d396e2e6c76
name: 'VMware: Status of "{#CLUSTER.NAME}" cluster'
type: SIMPLE
key: 'vmware.cluster.status[{$VMWARE.URL},{#CLUSTER.NAME}]'
history: 7d
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware cluster status.'
valuemap:
name: 'VMware status'
tags:
- tag: Application
value: VMware
- uuid: 8fb6a45cbe074b0cb6df53758e2c6623
name: 'Discover VMware datastores'
type: SIMPLE
key: 'vmware.datastore.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
item_prototypes:
- uuid: 4b61838ba4c34e709b25081ae5b059b5
name: 'VMware: Average read latency of the datastore {#DATASTORE}'
type: SIMPLE
key: 'vmware.datastore.read[{$VMWARE.URL},{#DATASTORE},latency]'
history: 7d
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Amount of time for a read operation from the datastore (milliseconds).'
tags:
- tag: Application
value: VMware
- uuid: 5355c401dc244bc588ccd18767577c93
name: 'VMware: Free space on datastore {#DATASTORE} (percentage)'
type: SIMPLE
key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE},pfree]'
delay: 5m
history: 7d
value_type: FLOAT
units: '%'
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware datastore space in percentage from total.'
tags:
- tag: Application
value: VMware
- uuid: 84f13c4fde2d4a17baaf0c8c1eb4f2c0
name: 'VMware: Total size of datastore {#DATASTORE}'
type: SIMPLE
key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE}]'
delay: 5m
history: 7d
units: B
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'VMware datastore space in bytes.'
tags:
- tag: Application
value: VMware
- uuid: 540cd0fbc56c4b8ea19f2ff5839ce00d
name: 'VMware: Average write latency of the datastore {#DATASTORE}'
type: SIMPLE
key: 'vmware.datastore.write[{$VMWARE.URL},{#DATASTORE},latency]'
history: 7d
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Amount of time for a write operation to the datastore (milliseconds).'
tags:
- tag: Application
value: VMware
- uuid: a5bc075e89f248e7b411d8f960897a08
name: 'Discover VMware hypervisors'
type: SIMPLE
key: 'vmware.hv.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Discovery of hypervisors.'
host_prototypes:
- uuid: 051a1469d4d045cbbf818fcc843a352e
host: '{#HV.UUID}'
name: '{#HV.NAME}'
group_links:
- group:
name: Templates/Applications
group_prototypes:
- name: '{#CLUSTER.NAME}'
- name: '{#DATACENTER.NAME}'
templates:
- name: 'VMware Hypervisor'
macros:
- macro: '{$VMWARE.HV.UUID}'
value: '{#HV.UUID}'
description: 'UUID of hypervisor.'
custom_interfaces: 'YES'
interfaces:
- ip: '{#HV.IP}'
- uuid: 9fd559f4e88c4677a1b874634dd686f5
name: 'Discover VMware VMs'
type: SIMPLE
key: 'vmware.vm.discovery[{$VMWARE.URL}]'
delay: 1h
username: '{$VMWARE.USERNAME}'
password: '{$VMWARE.PASSWORD}'
description: 'Discovery of guest virtual machines.'
host_prototypes:
- uuid: 23b9ae9d6f33414880db1cb107115810
host: '{#VM.UUID}'
name: '{#VM.NAME}'
group_links:
- group:
name: Templates/Applications
group_prototypes:
- name: '{#CLUSTER.NAME} (vm)'
- name: '{#DATACENTER.NAME}/{#VM.FOLDER} (vm)'
- name: '{#HV.NAME}'
templates:
- name: 'VMware Guest'
macros:
- macro: '{$VMWARE.VM.UUID}'
value: '{#VM.UUID}'
description: 'UUID of guest virtual machine.'
custom_interfaces: 'YES'
interfaces:
- ip: '{#VM.IP}'
valuemaps:
- uuid: 3c59c22905054d42ac4ee8b72fe5f270
name: 'VMware status'
mappings:
- value: '0'
newvalue: gray
- value: '1'
newvalue: green
- value: '2'
newvalue: yellow
- value: '3'
newvalue: red
```
#### Export format
Export format in YAML:
``` {.yaml}
zabbix_export:
version: '6.0'
date: '2023-05-03T11:24:04Z'
groups:
- uuid: dc579cd7a1a34222933f24f52a68bcd8
name: 'Linux servers'
hosts:
- host: Example_host
name: Example_host
templates:
- name: 'Zabbix server health'
groups:
- name: 'Linux servers'
items:
- name: Test_item1
type: ZABBIX_ACTIVE
key: kernel.maxproc
inventory_mode: DISABLED
```
#### 导出格式
YAML导出格式:
```{.yaml}
zabbix_export:
version: '6.0'
date: '2023-05-03T11:24:04Z'
groups:
- uuid: dc579cd7a1a34222933f24f52a68bcd8
name: 'Linux servers'
hosts:
- host: Example_host
name: Example_host
templates:
- name: 'Zabbix server health'
groups:
- name: 'Linux servers'
items:
- name: Test_item1
type: ZABBIX_ACTIVE
key: kernel.maxproc
inventory_mode: DISABLED
```
#### Export format
Export to YAML:
``` {.yaml}
zabbix_export:
version: '6.0'
date: '2021-08-31T12:55:10Z'
images:
- name: Zabbix_server_3D_(128)
imagetype: '1'
encodedImage: iVBOR...5CYII=
maps:
- name: 'Local network'
width: '680'
height: '200'
label_type: '0'
label_location: '0'
highlight: '1'
expandproblem: '1'
markelements: '1'
show_unack: '0'
severity_min: '0'
show_suppressed: '0'
grid_size: '50'
grid_show: '1'
grid_align: '1'
label_format: '0'
label_type_host: '2'
label_type_hostgroup: '2'
label_type_trigger: '2'
label_type_map: '2'
label_type_image: '2'
label_string_host: ''
label_string_hostgroup: ''
label_string_trigger: ''
label_string_map: ''
label_string_image: ''
expand_macros: '1'
background: { }
iconmap: { }
urls: { }
selements:
- elementtype: '0'
elements:
- host: 'Zabbix server'
label: |
{HOST.NAME}
{HOST.CONN}
label_location: '0'
x: '111'
'y': '61'
elementsubtype: '0'
areatype: '0'
width: '200'
height: '200'
viewtype: '0'
use_iconmap: '0'
selementid: '1'
icon_off:
name: Zabbix_server_3D_(128)
icon_on: { }
icon_disabled: { }
icon_maintenance: { }
urls: { }
evaltype: '0'
shapes:
- type: '0'
x: '0'
'y': '0'
width: '680'
height: '15'
text: '{MAP.NAME}'
font: '9'
font_size: '11'
font_color: '000000'
text_halign: '0'
text_valign: '0'
border_type: '0'
border_width: '0'
border_color: '000000'
background_color: ''
zindex: '0'
lines: { }
links: { }
```
#### 导出格式
导出为YAML格式:
```{.yaml}
zabbix_export:
version: '6.0'
date: '2021-08-31T12:55:10Z'
images:
- name: Zabbix_server_3D_(128)
imagetype: '1'
encodedImage: iVBOR...5CYII=
maps:
- name: 'Local network'
width: '680'
height: '200'
label_type: '0'
label_location: '0'
highlight: '1'
expandproblem: '1'
markelements: '1'
show_unack: '0'
severity_min: '0'
show_suppressed: '0'
grid_size: '50'
grid_show: '1'
grid_align: '1'
label_format: '0'
label_type_host: '2'
label_type_hostgroup: '2'
label_type_trigger: '2'
label_type_map: '2'
label_type_image: '2'
label_string_host: ''
label_string_hostgroup: ''
label_string_trigger: ''
label_string_map: ''
label_string_image: ''
expand_macros: '1'
background: { }
iconmap: { }
urls: { }
selements:
- elementtype: '0'
elements:
- host: 'Zabbix server'
label: |
{HOST.NAME}
{HOST.CONN}
label_location: '0'
x: '111'
'y': '61'
elementsubtype: '0'
areatype: '0'
width: '200'
height: '200'
viewtype: '0'
use_iconmap: '0'
selementid: '1'
icon_off:
name: Zabbix_server_3D_(128)
icon_on: { }
icon_disabled: { }
icon_maintenance: { }
urls: { }
evaltype: '0'
shapes:
- type: '0'
x: '0'
'y': '0'
width: '680'
height: '15'
text: '{MAP.NAME}'
font: '9'
font_size: '11'
font_color: '000000'
text_halign: '0'
text_valign: '0'
border_type: '0'
border_width: '0'
border_color: '000000'
background_color: ''
zindex: '0'
lines: { }
links: { }
```
#### Export format
Export to YAML:
```yaml
zabbix_export:
version: '6.0'
date: '2021-08-31T13:34:17Z'
media_types:
- name: Pushover
type: WEBHOOK
parameters:
- name: endpoint
value: 'https://api.pushover.net/1/messages.json'
- name: eventid
value: '{EVENT.ID}'
- name: event_nseverity
value: '{EVENT.NSEVERITY}'
- name: event_source
value: '{EVENT.SOURCE}'
- name: event_value
value: '{EVENT.VALUE}'
- name: expire
value: '1200'
- name: message
value: '{ALERT.MESSAGE}'
- name: priority_average
value: '0'
- name: priority_default
value: '0'
- name: priority_disaster
value: '0'
- name: priority_high
value: '0'
- name: priority_information
value: '0'
- name: priority_not_classified
value: '0'
- name: priority_warning
value: '0'
- name: retry
value: '60'
- name: title
value: '{ALERT.SUBJECT}'
- name: token
value: '<PUSHOVER TOKEN HERE>'
- name: triggerid
value: '{TRIGGER.ID}'
- name: url
value: '{$ZABBIX.URL}'
- name: url_title
value: Zabbix
- name: user
value: '{ALERT.SENDTO}'
max_sessions: '0'
script: |
try {
var params = JSON.parse(value),
request = new HttpRequest(),
data,
response,
severities = [
{name: 'not_classified', color: '#97AAB3'},
{name: 'information', color: '#7499FF'},
{name: 'warning', color: '#FFC859'},
{name: 'average', color: '#FFA059'},
{name: 'high', color: '#E97659'},
{name: 'disaster', color: '#E45959'},
{name: 'resolved', color: '#009900'},
{name: 'default', color: '#000000'}
],
priority;
if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
request.setProxy(params.HTTPProxy);
}
if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) {
throw 'Incorrect "event_source" parameter given: "' + params.event_source + '".\nMust be 0-3.';
}
if (params.event_value !== '0' && params.event_value !== '1'
&& (params.event_source === '0' || params.event_source === '3')) {
throw 'Incorrect "event_value" parameter given: ' + params.event_value + '\nMust be 0 or 1.';
}
if ([0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity)) === -1) {
params.event_nseverity = '7';
}
if (params.event_value === '0') {
params.event_nseverity = '6';
}
priority = params['priority_' + severities[params.event_nseverity].name] || params.priority_default;
if (isNaN(priority) || priority < -2 || priority > 2) {
throw '"priority" should be -2..2';
}
if (params.event_source === '0' && isNaN(params.triggerid)) {
throw 'field "triggerid" is not a number';
}
if (isNaN(params.eventid)) {
throw 'field "eventid" is not a number';
}
if (typeof params.message !== 'string' || params.message.trim() === '') {
throw 'field "message" cannot be empty';
}
data = {
token: params.token,
user: params.user,
title: params.title,
message: params.message,
url: (params.event_source === '0')
? params.url + '/tr_events.php?triggerid=' + params.triggerid + '&eventid=' + params.eventid
: params.url,
url_title: params.url_title,
priority: priority
};
if (priority == 2) {
if (isNaN(params.retry) || params.retry < 30) {
throw 'field "retry" should be a number with value of at least 30 if "priority" is set to 2';
}
if (isNaN(params.expire) || params.expire > 10800) {
throw 'field "expire" should be a number with value of at most 10800 if "priority" is set to 2';
}
data.retry = params.retry;
data.expire = params.expire;
}
data = JSON.stringify(data);
Zabbix.log(4, '[ Pushover Webhook ] Sending request: ' + params.endpoint + '\n' + data);
request.addHeader('Content-Type: application/json');
response = request.post(params.endpoint, data);
Zabbix.log(4, '[ Pushover Webhook ] Received response with status code ' + request.getStatus() + '\n' + response);
if (response !== null) {
try {
response = JSON.parse(response);
}
catch (error) {
Zabbix.log(4, '[ Pushover Webhook ] Failed to parse response received from Pushover');
response = null;
}
}
if (request.getStatus() != 200 || response === null || typeof response !== 'object' || response.status !== 1) {
if (response !== null && typeof response === 'object' && typeof response.errors === 'object'
&& typeof response.errors[0] === 'string') {
throw response.errors[0];
}
else {
throw 'Unknown error. Check debug log for more information.';
}
}
return 'OK';
}
catch (error) {
Zabbix.log(4, '[ Pushover Webhook ] Pushover notification failed: ' + error);
throw 'Pushover notification failed: ' + error;
}
description: |
Please refer to setup guide here: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/pushover
Set token parameter with to your Pushover application key.
When assigning Pushover media to the Zabbix user - add user key into send to field.
message_templates:
- event_source: TRIGGERS
operation_mode: PROBLEM
subject: 'Problem: {EVENT.NAME}'
message: |
Problem started at {EVENT.TIME} on {EVENT.DATE}
Problem name: {EVENT.NAME}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Operational data: {EVENT.OPDATA}
Original problem ID: {EVENT.ID}
{TRIGGER.URL}
- event_source: TRIGGERS
operation_mode: RECOVERY
subject: 'Resolved in {EVENT.DURATION}: {EVENT.NAME}'
message: |
Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
Problem name: {EVENT.NAME}
Problem duration: {EVENT.DURATION}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Original problem ID: {EVENT.ID}
{TRIGGER.URL}
- event_source: TRIGGERS
operation_mode: UPDATE
subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
message: |
{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
{EVENT.UPDATE.MESSAGE}
Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
- event_source: DISCOVERY
operation_mode: PROBLEM
subject: 'Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
message: |
Discovery rule: {DISCOVERY.RULE.NAME}
Device IP: {DISCOVERY.DEVICE.IPADDRESS}
Device DNS: {DISCOVERY.DEVICE.DNS}
Device status: {DISCOVERY.DEVICE.STATUS}
Device uptime: {DISCOVERY.DEVICE.UPTIME}
Device service name: {DISCOVERY.SERVICE.NAME}
Device service port: {DISCOVERY.SERVICE.PORT}
Device service status: {DISCOVERY.SERVICE.STATUS}
Device service uptime: {DISCOVERY.SERVICE.UPTIME}
- event_source: AUTOREGISTRATION
operation_mode: PROBLEM
subject: 'Autoregistration: {HOST.HOST}'
message: |
Host name: {HOST.HOST}
Host IP: {HOST.IP}
Agent port: {HOST.PORT}
```
#### 导出格式
导出为YAML格式:
```yaml
zabbix_export:
version: '6.0'
date: '2021-08-31T13:34:17Z'
media_types:
- name: Pushover
type: WEBHOOK
parameters:
- name: endpoint
value: 'https://api.pushover.net/1/messages.json'
- name: eventid
value: '{EVENT.ID}'
- name: event_nseverity
value: '{EVENT.NSEVERITY}'
- name: event_source
value: '{EVENT.SOURCE}'
- name: event_value
value: '{EVENT.VALUE}'
- name: expire
value: '1200'
- name: message
value: '{ALERT.MESSAGE}'
- name: priority_average
value: '0'
- name: priority_default
value: '0'
- name: priority_disaster
value: '0'
- name: priority_high
value: '0'
- name: priority_information
value: '0'
- name: priority_not_classified
value: '0'
- name: priority_warning
value: '0'
- name: retry
value: '60'
- name: title
value: '{ALERT.SUBJECT}'
- name: token
value: '<PUSHOVER TOKEN HERE>'
- name: triggerid
value: '{TRIGGER.ID}'
- name: url
value: '{$ZABBIX.URL}'
- name: url_title
value: Zabbix
- name: user
value: '{ALERT.SENDTO}'
max_sessions: '0'
script: |
try {
var params = JSON.parse(value),
request = new HttpRequest(),
data,
response,
severities = [
{name: 'not_classified', color: '#97AAB3'},
{name: 'information', color: '#7499FF'},
{name: 'warning', color: '#FFC859'},
{name: 'average', color: '#FFA059'},
{name: 'high', color: '#E97659'},
{name: 'disaster', color: '#E45959'},
{name: 'resolved', color: '#009900'},
{name: 'default', color: '#000000'}
],
priority;
if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
request.setProxy(params.HTTPProxy);
}
if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) {
throw 'Incorrect "event_source" parameter given: "' + params.event_source + '".\nMust be 0-3.';
}
if (params.event_value !== '0' && params.event_value !== '1'
&& (params.event_source === '0' || params.event_source === '3')) {
throw 'Incorrect "event_value" parameter given: ' + params.event_value + '\nMust be 0 or 1.';
}
if ([0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity)) === -1) {
params.event_nseverity = '7';
}
if (params.event_value === '0') {
params.event_nseverity = '6';
}
priority = params['priority_' + severities[params.event_nseverity].name] || params.priority_default;
if (isNaN(priority) || priority < -2 || priority > 2) {
throw '"priority" should be -2..2';
}
if (params.event_source === '0' && isNaN(params.triggerid)) {
throw 'field "triggerid" is not a number';
}
if (isNaN(params.eventid)) {
throw 'field "eventid" is not a number';
}
if (typeof params.message !== 'string' || params.message.trim() === '') {
throw 'field "message" cannot be empty';
}
data = {
token: params.token,
user: params.user,
title: params.title,
message: params.message,
url: (params.event_source === '0')
? params.url + '/tr_events.php?triggerid=' + params.triggerid + '&eventid=' + params.eventid
: params.url,
url_title: params.url_title,
priority: priority
};
if (priority == 2) {
if (isNaN(params.retry) || params.retry < 30) {
throw 'field "retry" should be a number with value of at least 30 if "priority" is set to 2';
}
if (isNaN(params.expire) || params.expire > 10800) {
throw 'field "expire" should be a number with value of at most 10800 if "priority" is set to 2';
}
data.retry = params.retry;
data.expire = params.expire;
}
data = JSON.stringify(data);
Zabbix.log(4, '[ Pushover Webhook ] Sending request: ' + params.endpoint + '\n' + data);
request.addHeader('Content-Type: application/json');
response = request.post(params.endpoint, data);
Zabbix.log(4, '[ Pushover Webhook ] Received response with status code ' + request.getStatus() + '\n' + response);
if (response !== null) {
try {
response = JSON.parse(response);
}
catch (error) {
Zabbix.log(4, '[ Pushover Webhook ] Failed to parse response received from Pushover');
response = null;
}
}
if (request.getStatus() != 200 || response === null || typeof response !== 'object' || response.status !== 1) {
if (response !== null && typeof response === 'object' && typeof response.errors === 'object'
&& typeof response.errors[0] === 'string') {
throw response.errors[0];
}
else {
throw 'Unknown error. Check debug log for more information.';
}
}
return 'OK';
}
catch (error) {
Zabbix.log(4, '[ Pushover Webhook ] Pushover notification failed: ' + error);
throw 'Pushover notification failed: ' + error;
}
description: |
Please refer to setup guide here: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/pushover
Set token parameter with to your Pushover application key.
When assigning Pushover media to the Zabbix user - add user key into send to field.
message_templates:
- event_source: TRIGGERS
operation_mode: PROBLEM
subject: 'Problem: {EVENT.NAME}'
message: |
Problem started at {EVENT.TIME} on {EVENT.DATE}
Problem name: {EVENT.NAME}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Operational data: {EVENT.OPDATA}
Original problem ID: {EVENT.ID}
{TRIGGER.URL}
- event_source: TRIGGERS
operation_mode: RECOVERY
subject: 'Resolved in {EVENT.DURATION}: {EVENT.NAME}'
message: |
Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
Problem name: {EVENT.NAME}
Problem duration: {EVENT.DURATION}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Original problem ID: {EVENT.ID}
{TRIGGER.URL}
- event_source: TRIGGERS
operation_mode: UPDATE
subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
message: |
{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
{EVENT.UPDATE.MESSAGE}
Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
- event_source: DISCOVERY
operation_mode: PROBLEM
subject: 'Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
message: |
Discovery rule: {DISCOVERY.RULE.NAME}
Device IP: {DISCOVERY.DEVICE.IPADDRESS}
Device DNS: {DISCOVERY.DEVICE.DNS}
Device status: {DISCOVERY.DEVICE.STATUS}
Device uptime: {DISCOVERY.DEVICE.UPTIME}
Device service name: {DISCOVERY.SERVICE.NAME}
Device service port: {DISCOVERY.SERVICE.PORT}
Device service status: {DISCOVERY.SERVICE.STATUS}
Device service uptime: {DISCOVERY.SERVICE.UPTIME}
- event_source: AUTOREGISTRATION
operation_mode: PROBLEM
subject: 'Autoregistration: {HOST.HOST}'
message: |
Host name: {HOST.HOST}
Host IP: {HOST.IP}
Agent port: {HOST.PORT}
```
##### Export format
``` {.yaml}
groups:
- name: 'Zabbix servers'
```
##### 导出格式
```{.yaml}
groups:
- name: 'Zabbix servers'
```
#### Exporting a template
Export the configuration of template "10571" as an XML string.
Request:
```json
{
"jsonrpc": "2.0",
"method": "configuration.export",
"params": {
"options": {
"templates": [
"10571"
]
},
"format": "xml"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:00:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter><dt>Server uptime: (.*)</dt></parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>6805d4c39a624a8bab2cc8ab63df1ab3</uuid><name>CPU load</name><key>system.cpu.load</key><value_type>FLOAT</value_type><triggers><trigger><uuid>ab4c2526c2bc42e48a633082255ebcb3</uuid><expression>avg(/New template/system.cpu.load,3m)>2</expression><name>CPU load too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n",
"id": 1
}
```
#### 导出模板
将模板"10571"的配置导出为XML string.
请求:
```json
{
"jsonrpc": "2.0",
"method": "configuration.export",
"params": {
"options": {
"templates": [
"10571"
]
},
"format": "xml"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:00:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter><dt>Server uptime: (.*)</dt></parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>6805d4c39a624a8bab2cc8ab63df1ab3</uuid><name>CPU load</name><key>system.cpu.load</key><value_type>FLOAT</value_type><triggers><trigger><uuid>ab4c2526c2bc42e48a633082255ebcb3</uuid><expression>avg(/New template/system.cpu.load,3m)>2</expression><name>CPU load too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n",
"id": 1
}
```
#### Exporting
To export hosts, do the following:
- Go to: *Configuration* → *Hosts*
- Mark the checkboxes of the hosts to export
- Click on *Export* below the list
Depending on the selected format, hosts are exported to a local file
with a default name:
- *zabbix\_export\_hosts.yaml* - in YAML export (default option for
export)
- *zabbix\_export\_hosts.xml* - in XML export
- *zabbix\_export\_hosts.json* - in JSON export
#### 导出
要export 主机，请执行以下操作：
- 前往：*配置* → *主机*
- 勾选 主机 的复选框以 export
- 在列表下方点击*Export*
根据所选格式，主机会被导出到本地file
使用默认名称:
- *zabbix_export_hosts.yaml* - YAML格式的export（默认选项用于
export
- *zabbix\_export\_hosts.xml* - XML格式 export
- *zabbix\_export\_hosts.json* - JSON格式 export
#### Exporting
To export media types, do the following:
- Go to: *Administration* → *Media types*
- Mark the checkboxes of the media types to export
- Click on *Export* below the list
Depending on the selected format, media types are exported to a local
file with a default name:
- *zabbix\_export\_mediatypes.yaml* - in YAML export (default option
for export)
- *zabbix\_export\_mediatypes.xml* - in XML export
- *zabbix\_export\_mediatypes.json* - in JSON export
#### 导出
要export媒介类型，请执行以下操作：
- 前往：*管理* → *媒介类型*
- 勾选要export的媒介类型复选框
- 点击列表下方的*导出*
根据所选格式，媒体类型将被导出到本地
file 使用默认名称:
- *zabbix\_export\_mediatypes.yaml* - YAML格式的export（默认选项）
对于export
- *zabbix\_export\_mediatypes.xml* - XML格式 export
- *zabbix\_export\_mediatypes.json* - JSON格式 export
#### Exporting
To export network maps, do the following:
- Go to: *Monitoring* → *Maps*
- Mark the checkboxes of the network maps to export
- Click on *Export* below the list
Depending on the selected format, maps are exported to a local file with
a default name:
- *zabbix\_export\_maps.yaml* - in YAML export (default option for
export)
- *zabbix\_export\_maps.xml* - in XML export
- *zabbix\_export\_maps.json* - in JSON export
#### 导出
要export网络地图，请执行以下操作：
- 前往：*Monitoring* → *Maps*
- 勾选要export的网络地图复选框
- 点击列表下方的*Export*
根据所选格式，地图将被导出到本地file，并使用默认名称：
- *zabbix\_export\_maps.yaml* - YAML格式export（默认export选项）
- *zabbix\_export\_maps.xml* - XML格式export
- *zabbix\_export\_maps.json* - JSON格式export
#### Exporting
To export templates, do the following:
- Go to: *Configuration* → *Templates*
- Mark the checkboxes of the templates to export
- Click on *Export* below the list
Depending on the selected format, templates are exported to a local file
with a default name:
- *zabbix\_export\_templates.yaml* - in YAML export (default option
for export)
- *zabbix\_export\_templates.xml* - in XML export
- *zabbix\_export\_templates.json* - in JSON export
#### 导出
要export模板，请执行以下操作：
- 前往：*Configuration* → *模板*
- 勾选需要export的模板复选框
- 点击列表下方的*Export*
根据所选格式，模板将被导出到本地file，默认文件名如下：
- *zabbix\_export\_templates.yaml* - YAML格式export（export的默认选项）
- *zabbix\_export\_templates.xml* - XML格式export
- *zabbix\_export\_templates.json* - JSON格式export
###### Export request
A request to execute the Export function of the Exporter interface.
| | |
|---|---|
|direction|agent → plugin|
|response|no|
Parameters specific to export requests:
|Name|Type|Comments|
|---------|--------|----------|
|key|string|The plugin key.|
|parameters|array of strings (optional)|The parameters for Export function.|
*Example:*
{"id":4,"type":6,"key":"test.key","parameters":["foo","bar"]}
###### 导出请求
一个请求execute导出器接口的导出功能.
| | |
|---|---|
| direction | agent → plugin |
| response | no |
export请求的特定参数:
| Name | Type | Comments |
|---------|--------|----------|
| key | string | 插件键值. |
| parameters | array of strings (optional) | 导出功能的参数. |
*示例:*
{"id":4,"type":6,"key":"test.key","parameters":["foo","bar"]}
###### Export response
Response from the Export function of the Exporter interface.
| | |
|---|---|
|direction|plugin → agent|
|response|n/a|
Parameters specific to export responses:
|Name|Type|Comments|
|---------|--------|----------|
|value|string (optional) |Response value from the Export function. Absent, if error is returned.|
|error|string (optional) |Error message if the Export function has not been executed successfully. Absent, if value is returned.|
*Examples:*
{"id":5,"type":7,"value":"response"}
or
{"id":5,"type":7,"error":"error message"}
###### 导出响应
导出器接口Export函数的响应结果。
| | |
|---|---|
| direction | plugin → agent |
| response | n/a |
export响应特有的参数：
| Name | Type | Comments |
|---------|--------|----------|
| value | string (optional) | Export函数的返回值。若返回错误则此字段不存在。 |
| error | string (optional) | Export函数执行失败时的错误信息。若返回值存在则此字段不存在。 |
*示例：*
{"id":5,"type":7,"value":"response"}
或
{"id":5,"type":7,"error":"error message"}
#### Exposed metrics
The stats items gather the statistics in bulk and return a JSON, which
is the basis for dependent items to get their data from. The following
[internal metrics](/manual/config/items/itemtypes/internal) are returned
by either of the two items:
- `zabbix[boottime]`
- `zabbix[hosts]`
- `zabbix[items]`
- `zabbix[items_unsupported]`
- `zabbix[preprocessing_queue]` (server only)
- `zabbix[process,<type>,<mode>,<state>]` (only process type based
statistics)
- `zabbix[rcache,<cache>,<mode>]`
- `zabbix[requiredperformance]`
- `zabbix[triggers]` (server only)
- `zabbix[uptime]`
- `zabbix[vcache,buffer,<mode>]` (server only)
- `zabbix[vcache,cache,<parameter>]`
- `zabbix[version]`
- `zabbix[vmware,buffer,<mode>]`
- `zabbix[wcache,<cache>,<mode>]` ('trends' cache type server only)
#### 暴露的指标
统计监控项批量收集统计数据并返回JSON格式结果，这是依赖监控项从中get数据的基础。以下[internal metrics](/manual/config/items/itemtypes/internal)由两种监控项中的任意一种返回：
- `zabbix[boottime]`
- `zabbix[hosts]`
- `zabbix[items]`
- `zabbix[items_unsupported]`
- `zabbix[preprocessing_queue]` (仅服务器端)
- `zabbix[process,<type>,<mode>,<state>]` (仅基于进程类型的统计)
- `zabbix[rcache,<cache>,<mode>]`
- `zabbix[requiredperformance]`
- `zabbix[triggers]` (仅服务器端)
- `zabbix[uptime]`
- `zabbix[vcache,buffer,<mode>]` (仅服务器端)
- `zabbix[vcache,cache,<parameter>]`
- `zabbix[version]`
- `zabbix[vmware,buffer,<mode>]`
- `zabbix[wcache,<cache>,<mode>]` (仅'trends'缓存类型的服务器)
### Expression macros
{ITEM.KEY<1-9>} macros are now supported inside [expression macros](/manual/config/macros/expression_macros).
### 表达式宏
现在[expression macros](/manual/config/macros/expression_macros)内部支持使用{监控项.KEY<1-9>}宏。
### Expressions
The expressions object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**expression**<br>(required)|string|Regular expression.|
|**expression\_type**<br>(required)|integer|Type of Regular expression.<br><br>Possible values:<br>0 - Character string included;<br>1 - Any character string included;<br>2 - Character string not included;<br>3 - Result is TRUE;<br>4 - Result is FALSE.|
|exp\_delimiter|string|Expression delimiter. Only when `expression_type` *Any character string included*.<br><br>Default value `,`.<br><br>Possible values: `,`, `.`, `/`.|
|case\_sensitive|integer|Case sensitivity.<br><br>Default value `0`.<br><br>Possible values:<br>0 - Case insensitive;<br>1 - Case sensitive.|
### 表达式
表达式 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **expression**<br>(required) | string | 正则表达式。 |
| **expression\_type**<br>(required) | integer | 正则表达式类型。<br><br>可能的值：<br>0 - 包含字符 string;<br>1 - 包含任意字符 string;<br>2 - 不包含字符 string;<br>3 - 结果为 TRUE;<br>4 - 结果为 FALSE。 |
| exp\_delimiter | string | 表达式分隔符。仅当 `expression_type` *包含任意字符 string* 时使用。<br><br>默认值 `,`。<br><br>可能的值：`,`, `.`, `/`。 |
| case\_sensitive | integer | 大小写敏感。<br><br>默认值 `0`。<br><br>可能的值：<br>0 - 不区分大小写;<br>1 - 区分大小写。 |
### ExpressMS messenger webhook API changed
API version changed to v4 in ExpressMS messenger webhook.
### ExpressMS 即时通讯 webhook API 已变更
API version 在ExpressMS messenger webhook中更改为v4版本。
#### Extended logging
The data gathered by VMware collector can be logged for detailed
debugging using debug level 5. This level can be set in
[server](/manual/appendix/config/zabbix_server) and
[proxy](/manual/appendix/config/zabbix_proxy) configuration files or
using a runtime control option
(`-R log_level_increase="vmware collector,N"`, where N is a process
number). The following examples demonstrate how extended logging can be
started provided debug level 4 is already set:
# Increase log level of all vmware collectors:
zabbix_server -R log_level_increase="vmware collector"
# Increase log level of second vmware collector:
zabbix_server -R log_level_increase="vmware collector,2"
If extended logging of VMware collector data is not required it can be
stopped using the `-R log_level_decrease` option.
#### 扩展日志记录
通过设置调试级别5可以记录VMware采集器收集的数据以进行详细调试。该级别可在
[server](/manual/appendix/config/zabbix_server)和
[proxy](/manual/appendix/config/zabbix_proxy)配置文件中设置，
或使用运行时控制选项
(`-R log_level_increase="vmware collector,N"`，其中N为进程号)。
以下示例展示了在已设置调试级别4的情况下如何启动扩展日志记录：
# Increase log level of all vmware collectors:
zabbix_server -R log_level_increase="vmware collector"
# 提升第二个vmware采集器的日志级别：
zabbix_server -R log_level_increase="vmware collector,2"
若不需要VMware采集器数据的扩展日志记录，可使用`-R log_level_decrease`选项停止该功能。
#### Extended monitoring
Sometimes it is necessary to log received HTML page content. This is
especially useful if some web scenario step fails. Debug level 5 (trace)
serves that purpose. This level can be set in
[server](/manual/appendix/config/zabbix_server) and
[proxy](/manual/appendix/config/zabbix_proxy) configuration files or
using a runtime control option (`-R log_level_increase="http poller,N"`,
where N is the process number). The following examples demonstrate how
extended monitoring can be started provided debug level 4 is already
set:
# Increase log level of all http pollers:
zabbix_server -R log_level_increase="http poller"
# Increase log level of second http poller:
zabbix_server -R log_level_increase="http poller,2"
If extended web monitoring is not required it can be stopped using the
`-R log_level_decrease` option.
#### 扩展监控
有时需要记录接收到的HTML页面内容。这在某些Web场景步骤失败时特别有用。调试级别5（跟踪）正是为此目的而设。该级别可在
[server](/manual/appendix/config/zabbix_server)和
[proxy](/manual/appendix/config/zabbix_proxy)配置文件中设置，
或使用运行时控制选项（`-R log_level_increase="http poller,N"`，
其中N为进程号）。以下示例展示了在调试级别4已设置的情况下如何启动扩展监控：
# Increase log level of all http pollers:
zabbix_server -R log_level_increase="http poller"
# 提升第二个http poller的日志级别：
zabbix_server -R log_level_increase="http poller,2"
若不需要扩展Web监控，可使用
`-R log_level_decrease`选项停止该功能。
#### Extended SNMP gateway functionality
SNMP gateway can now provide information about triggers in a problem state and reveal host information in trigger
details.
Additionally, it is now possible to limit the rate of SNMP traps sent by SNMP gateway.
The list of supported OIDs has been extended with a new OID **.10** for a comma-delimited list of trigger hostnames.
New parameters have been added to the SNMP gateway configuration file:
- *ProblemBaseOID* - OID of the problem trigger table;
- *ProblemMinSeverity* - minimum severity, triggers having lower severity will not be included;
- *ProblemHideAck* - if specified, only triggers with unacknowledged problems will be included;
- *ProblemTagFilter* - if specified, only triggers with the specified tag name will be included;
- *TrapTimer* - if set, Zabbix will send no more than one trap of the highest severity in the given time frame.
For details, see [Zabbix SNMP Gateway](https://git.zabbix.com/projects/ZT/repos/snmp-gateway/browse/README.md).
#### 扩展 SNMP 网关功能
SNMP网关现在可以提供处于问题状态的触发器信息，并在触发器详情中显示主机信息。
此外，现在可以限制SNMP网关发送SNMP陷阱的速率。
支持的OID列表已扩展，新增了用于逗号分隔触发器主机名列表的OID **.10**。
SNMP网关配置file中新增了以下参数：
- *ProblemBaseOID* - 问题触发器表的OID；
- *ProblemMinSeverity* - 最低严重性，低于此严重性的触发器将不被包含；
- *ProblemHideAck* - 若指定，则仅包含未确认问题的触发器；
- *ProblemTagFilter* - 若指定，则仅包含具有指定标签名称的触发器；
- *TrapTimer* - 若设置，Zabbix将在给定时间范围内发送不超过一个最高严重性的陷阱。
详情请参阅[Zabbix SNMP Gateway](https://git.zabbix.com/projects/ZT/repos/snmp-gateway/browse/README.md)。
#### External check result
The return value of an external check is a standard output together with a standard error produced by the check.
::: noteimportant
An item that returns text (character, log, or text type of information) will not become unsupported in case of a standard error output.
:::
The return value is limited to 16MB (including trailing whitespace that is truncated); [database limits](/manual/config/items/item#text_data_limits) also apply.
If the requested script is not found or Zabbix server/proxy has no permissions to execute it, the item will become unsupported and a corresponding error message will be displayed.
In case of a timeout, the item will become unsupported, a corresponding error message will be displayed, and the process forked for the script will be terminated.
#### 外部检查结果
外部检查的返回值由检查产生的标准输出和标准错误组成。
::: noteimportant
返回文本（字符、日志或文本类型信息）的监控项不会因标准错误输出而变为不受支持状态。
:::
返回值限制为16MB（包括被截断的尾部空白字符）；[文本数据限制](/manual/config/items/item#文本数据限制)同样适用。
如果请求的脚本未找到，或Zabbix server/proxy没有execute权限，该监控项将变为不受支持状态并显示相应错误信息。
若发生超时，监控项将变为不受支持状态，显示相应错误信息，且为脚本派生的进程将被终止。
**External plugin loader**
Previously, plugins could only be compiled into Zabbix agent 2, which required recompiling the agent every time you need
to change the set of available plugins. Now, with the addition of the external plugin loader, plugins don't have to be
integrated into the agent 2 directly and can be added as separate external add-ons (loadable plugins), thus making the
creation process of additional plugins for gathering new monitoring metrics easier.
**外部插件加载器**
以往插件只能编译到Zabbix agent 2中，每次需要更改可用插件集时都必须重新编译agent。现在通过添加外部插件加载器，插件无需直接集成到agent 2中，可以作为独立的外部附加组件（可加载插件）添加，从而简化了为收集新监控指标创建额外插件的过程。
#### Extracting matching part of regular expression
Sometimes we may want to extract only the interesting value from a
target file instead of returning the whole line when a regular
expression match is found.
Since Zabbix 2.2.0, log items have the ability to extract desired values
from matched lines. This is accomplished by the additional **output**
parameter in `log` and `logrt` items.
Using the 'output' parameter allows to indicate the "capturing group" of
the match that we may be interested in.
So, for example
log[/path/to/the/file,"large result buffer allocation.*Entries: ([0-9]+)",,,,\1]
should allow returning the entry count as found in the content of:
Fr Feb 07 2014 11:07:36.6690 */ Thread Id 1400 (GLEWF) large result
buffer allocation - /Length: 437136/Entries: 5948/Client Ver: >=10/RPC
ID: 41726453/User: AUser/Form: CFG:ServiceLevelAgreement
Only the number will be returned because **\\1** refers to the first and
only capturing group: **(\[0-9\]+)**.
And, with the ability to extract and return a number, the value can be
used to define triggers.
#### 提取正则表达式的匹配部分
有时我们可能希望仅从目标file中提取感兴趣的值
而不是在正则表达式匹配时返回整行内容
自Zabbix 2.2.0起，日志监控项具备从匹配行中提取所需值的能力
这是通过在`log`和`logrt` 监控项中
添加**output**参数实现的
使用'output'参数可以指定我们感兴趣的匹配"捕获组"
例如
log[/path/to/the/file,"large result buffer allocation.*Entries: ([0-9]+)",,,,\1]
将允许返回在以下内容中找到的条目计数：
Fr Feb 07 2014 11:07:36.6690 */ Thread Id 1400 (GLEWF) large result
buffer allocation - /Length: 437136/Entries: 5948/Client Ver: >=10/RPC
ID: 41726453/User: AUser/Form: CFG:ServiceLevelAgreement
由于**\\1**引用第一个且唯一的捕获组：**(\[0-9\]+)**
所以仅返回数字
通过提取并返回数字的能力
该值可用于定义触发器
### Failover to standby node
Zabbix will fail over to another node automatically if the active node stops. There
must be at least one node in standby status for the failover to happen.
How fast will the failover be? All nodes update their last access time (and status, if
it is changed) every 5 seconds. So:
- If the active node shuts down and manages to report its status
as "stopped", another node will take over within **5 seconds**.
- If the active node shuts down/becomes unavailable without being able to update
its status, standby nodes will wait for the **failover delay** + 5 seconds to take over
The failover delay is configurable, with the supported range between 10 seconds and 15
minutes (one minute by default). To change the failover delay, you may run:
```
zabbix_server -R ha_set_failover_delay=5m
```
### 故障转移至备用节点
当主节点停止时，Zabbix将自动故障转移到另一个节点。必须至少有一个节点处于备用状态才能触发故障转移。
故障转移速度有多快？所有节点每5秒update其最后访问时间（若状态变更则包括状态）。因此：
- 如果主节点正常关闭并成功将其状态报告为"stopped"，另一个节点将在**5秒内**接管。
- 如果主节点关闭/不可用且无法update其状态，备用节点将等待**故障转移延迟** + 5秒后接管
故障转移延迟可配置，支持范围在10秒到15分钟之间（默认1分钟）。要修改故障转移延迟，可以run：
```
zabbix_server -R ha_set_failover_delay=5m
```
##### Favorite custom graphs no longer supported
It is no longer possible to add custom graphs to favorites in
*Monitoring* -> *Hosts* -> *Graphs*. After the upgrade any existing custom
graphs will be removed from favorites.
##### 不再支持收藏的自定义图表
在*监控* -> *主机* -> *图表*中不再支持将自定义图表添加至收藏夹。升级后，所有现有的自定义图表将从收藏夹中移除。
##### Field size limit
Maximum field size has been increased for the following fields:
- [Item preprocessing](/manual/config/items/preprocessing#configuration) parameters
- [Media type](/manual/config/notifications/media#common-parameters) message
##### 字段大小限制
以下字段的最大字段大小已增加：
- [Item preprocessing（监控项值预处理）](/manual/config/items/preprocessing#configuration) 参数
- [Media type（媒体消息类型）](/manual/config/notifications/media#common-parameters)
## FILES
*/usr/local/etc/zabbix\_agent2.conf*
Default location of Zabbix agent 2 configuration file (if not modified
during compile time).
[ ]{#lbAH}
## 文件
*/usr/local/etc/zabbix\_agent2.conf*
Zabbix agent 2 配置文件 file 的默认位置（若编译时未修改）。
[ ]{#lbAH}
## FILES
*/usr/local/etc/zabbix\_agentd.conf*
Default location of Zabbix agent configuration file (if not modified
during compile time).
[ ]{#lbAI}
## 文件
*/usr/local/etc/zabbix_agentd.conf*
Zabbix agent配置file的默认位置（如未修改
在编译期间).
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_proxy.conf*
Default location of Zabbix proxy configuration file (if not modified
during compile time).
[ ]{#lbAI}
## 文件
*/usr/local/etc/zabbix_proxy.conf*
Zabbix proxy配置文件file的默认位置（若编译时未修改）。
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_server.conf*
Default location of Zabbix server configuration file (if not modified
during compile time).
[ ]{#lbAI}
## 文件
*/usr/local/etc/zabbix_server.conf*
默认的Zabbix server配置文件file位置（如未修改
在编译期间).
[ ]{#lbAI}
## FILES
*/usr/local/etc/zabbix\_web\_service.conf*
Default location of Zabbix web service configuration file (if not
modified during compile time).
[ ]{#lbAG}
## 文件
*/usr/local/etc/zabbix\_web\_service.conf*
Zabbix web服务配置文件的默认位置file（如果在编译时未修改）。
[ ]{#lbAG}
##### File system
Because of the trap file implementation, Zabbix needs the file system to
support inodes to differentiate files (the information is acquired by a
stat() call).
##### 文件系统
由于陷阱file的实现方式，Zabbix需要file系统支持inode来区分文件（该信息通过stat()调用获取）。
#### Filter
A filter can be used to generate real items, triggers, and graphs only
for entities that match the criteria. The **Filters** tab contains
discovery rule filter definitions allowing to filter discovery values:
{width="600"}
|Parameter|Description|
|--|--------|
|*Type of calculation*|The following options for calculating filters are available:<br>**And** - all filters must be passed;<br>**Or** - enough if one filter is passed;<br>**And/Or** - uses *And* with different macro names and *Or* with the same macro name;<br>**Custom expression** - offers the possibility to define a custom calculation of filters. The formula must include all filters in the list. Limited to 255 symbols.|
|*Filters*|The following filter condition operators are available: *matches*, *does not match*, *exists*, *does not exist*.<br>*Matches* and *does not match* operators expect a [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE). For instance, if you are only interested in C:, D:, and E: file systems, you could put {\#FSNAME} into "Macro" and "\^C\|\^D\|\^E" regular expression into "Regular expression" text fields. Filtering is also possible by file system types using {\#FSTYPE} macro (e.g. "\^ext\|\^reiserfs") and by drive types (supported only by Windows agent) using {\#FSDRIVETYPE} macro (e.g., "fixed").<br>You can enter a regular expression or reference a global [regular expression](/manual/regular_expressions) in "Regular expression" field.<br>In order to test a regular expression you can use "grep -E", for example: ````for f in ext2 nfs reiserfs smbfs; do echo $f | grep -E '^ext|^reiserfs' || echo "SKIP: $f"; done```` <br><br> {\#FSDRIVETYPE} macro on Windows is supported since Zabbix **3.0.0**.<br><br>*Exists* and *does not exist* operators allow to filter entities based on the presence or absence of the specified LLD macro in the response (supported since version 5.4.0).<br>Defining several filters is supported since Zabbix **2.4.0**.<br>Note that if a macro from the filter is missing in the response, the found entity will be ignored, unless a "does not exist" condition is specified for this macro.<br><br>A warning will be displayed, if the absence of a macro affects the expression result. For example, if {#B} is missing in:<br>{#A} matches 1 and {#B} matches 2 - will give a warning<br>{#A} matches 1 or {#B} matches 2 - no warning.<br>This flexible warning logic is supported since Zabbix 6.0.11.|
::: notewarning
A mistake or a typo in the regular expression used
in the LLD rule (for example, an incorrect "File systems for discovery"
regular expression) may cause deletion of thousands of configuration
elements, historical values, and events for many hosts.
:::
::: noteimportant
Zabbix database in MySQL must be created as
case-sensitive if file system names that differ only by case are to be
discovered correctly.
:::
#### 过滤器
过滤器可用于仅generate真实的监控项、触发器及图表
对于符合标准的实体。**Filters** 选项卡包含
发现规则过滤器定义，用于筛选发现值：
{width="600"}
| 参数 | 描述 |
|--|--------|
| *Type of calculation* | 计算过滤器时可用的选项如下:<br>**And** - 必须通过所有过滤器;<br>**Or** - 只需通过一个过滤器即可;<br>**And/Or** - 对不同宏名称使用*And*，对相同宏名称使用*Or*;<br>**Custom expression** - 提供自定义过滤器计算方式。公式必须包含列表中的所有过滤器。限制为255个字符。 |
| *Filters* | 可用的筛选条件运算符包括：*匹配*、*不匹配*、*存在*、*不存在*。<br>*匹配*和*不匹配*运算符需要输入[Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions)（PCRE）。例如，若仅需监控C:、D:和E:的file系统，可在"宏"字段填入{\#FSNAME}，并在"正则表达式"文本框中输入"\^C\ | \^D\ | \^E"。也可通过file系统类型使用{\#FSTYPE}宏（如"\^ext\ | \^reiserfs"）或驱动器类型（仅Windows agent支持）使用{\#FSDRIVETYPE}宏（如"fixed"）进行筛选。<br>在"正则表达式"字段可输入正则表达式或引用全局[regular expression](/manual/regular_expressions)。<br>测试正则表达式可使用"grep -E"命令，例如：````for f in ext2 nfs reiserfs smbfs; do echo $f | grep -E '^ext|^reiserfs' || echo "SKIP: $f"; done````<br><br>Windows平台的{\#FSDRIVETYPE}宏自Zabbix **3.0.0**起支持。<br><br>*存在*和*不存在*运算符可根据响应中是否包含指定LLD宏进行实体筛选（自version 5.4.0起支持）。<br>多重筛选功能自Zabbix **2.4.0**起支持。<br>注意：若响应中缺少筛选器指定的宏，除非该宏设置了"不存在"条件，否则发现的实体将被忽略。<br><br>当宏缺失影响表达式结果时将显示警告。例如，若{#B}缺失时：<br>{#A}匹配1且{#B}匹配2——会触发警告<br>{#A}匹配1或{#B}匹配2——不触发警告<br>此灵活警告逻辑自Zabbix 6.0.11起支持。
::: notewarning
正则表达式中存在错误或拼写错误
在LLD规则中（例如，错误的"用于发现的文件系统"）
正则表达式)可能导致数千条配置被删除
多个主机的元素、历史值和事件。
:::
::: noteimportant
Zabbix在MySQL中的数据库必须创建为
区分大小写 如果file系统名称仅大小写不同则需
正确发现。
:::
##### Filter buttons
| | |
|---|---|
||Apply specified filtering criteria (without saving).|
||Reset current filter and return to saved parameters of the current tab. On the Home tab, this will clear the filter.|
||Save current filter parameters in a new tab. Only available on the *Home* tab.|
||Replace tab parameters with currently specified parameters. Not available on the *Home* tab.|
##### Filter buttons
| | |
|---|---|
||Apply specified filtering criteria (without saving).|
||Reset current filter and return to saved parameters of the current tab. On the Home tab, this will clear the filter.|
||Save current filter parameters in a new tab. Only available on the *Home* tab.|
||Replace tab parameters with currently specified parameters. Not available on the *Home* tab.|
##### Filter buttons
| | |
|--|--------|
||Apply specified filtering criteria (without saving).|
||Reset current filter and return to saved parameters of the current tab. On the main tab, this will clear the filter.|
||Save current filter parameters in a new tab. Only available on the main tab.|
||Replace tab parameters with currently specified parameters. Not available on the main tab.|
##### 过滤按钮
| | |
|--|--------|
|  | 应用指定的筛选条件（不保存）。 |
|  | 重置当前筛选器并返回当前标签页的已保存参数。在主标签页上，这将clear筛选器。 |
|  | 在新标签页中保存当前筛选参数。仅在主标签页可用。 |
|  | 用当前指定的参数替换标签页参数。不在主标签页上可用。 |
#### Filter expression
The filter expression is an arithmetical expression in infix notation.
Supported operands:
|Operand|Description|Example|
|--|------|------|
|`"<text>"`<br>`'<text>'`|Text constant.|'value: \\'1\\''<br>"value: '1'"|
|`<number>`|Numeric constant supporting scientific notation.|123|
|`<jsonpath starting with $>`|Value referred to by the JSONPath from the input document root node; only definite paths are supported.|$.object.name|
|`<jsonpath starting with @>`|Value referred to by the JSONPath from the current object/element; only definite paths are supported.|@.name|
Supported operators:
|Operator|Type|Description|Result|
|--|--------|----|----|
|`-`|binary|Subtraction.|Number.|
|`+`|binary|Addition.|Number.|
|`/`|binary|Division.|Number.|
|`*`|binary|Multiplication.|Number.|
|`==`|binary|Is equal to.|Boolean (1 or 0).|
|`!=`|binary|Is not equal to.|Boolean (1 or 0).|
|`<`|binary|Is less than.|Boolean (1 or 0).|
|`<=`|binary|Is less than or equal to.|Boolean (1 or 0).|
|`>`|binary|Is greater than.|Boolean (1 or 0).|
|`>=`|binary|Is greater than or equal to.|Boolean (1 or 0).|
|`=~`|binary|Matches regular expression.|Boolean (1 or 0).|
|`!`|unary|Boolean not.|Boolean (1 or 0).|
|`||`|binary|Boolean or.|Boolean (1 or 0).|
|`&&`|binary|Boolean and.|Boolean (1 or 0).|
#### 过滤表达式
过滤表达式是一个中缀表示法的算术表达式。
支持的运算数：
| 运算数 | 描述 | 示例 |
|--|------|------|
| `"<text>"`<br>`'<text>'` | 文本常量。 | 'value: \\'1\\''<br>"value: '1'" |
| `<number>` | 支持科学计数法的数字常量。 | 123 |
| `<jsonpath starting with $>` | 从输入文档根节点引用的JSONPath值；仅支持确定路径。 | $.object.name |
| `<jsonpath starting with @>` | 从当前object/元素引用的JSONPath值；仅支持确定路径。 | @.name |
支持的运算符：
| 运算符 | 类型 | 描述 | 结果 |
|--|--------|----|----|
| `-` | binary | 减法。 | 数字。 |
| `+` | binary | 加法。 | 数字。 |
| `/` | binary | 除法。 | 数字。 |
| `*` | binary | 乘法。 | 数字。 |
| `==` | binary | 等于。 | boolean (1或0)。 |
| `!=` | binary | 不等于。 | boolean (1或0)。 |
| `<` | binary | 小于。 | boolean (1或0)。 |
| `<=` | binary | 小于或等于。 | boolean (1或0)。 |
| `>` | binary | 大于。 | boolean (1或0)。 |
| `>=` | binary | 大于或等于。 | boolean (1或0)。 |
| `=~` | binary | 匹配正则表达式。 | boolean (1或0)。 |
| `!` | unary | boolean 非。 | boolean (1或0)。 |
| `||` | binary | boolean 或。 | boolean (1或0)。 |
| `&&` | binary | boolean 与。 | boolean (1或0)。 |
##### Filtering by host
In the *by host* mode results can be filtered by a host or by the host
group. Specifying a parent host group implicitly selects all nested host
groups.
##### 按主机过滤
在*按主机*模式下，结果可通过一个主机或主机组进行筛选。指定父级主机组将隐式选择所有嵌套的主机组。
##### Filtering by trigger template
In the *by trigger template* mode results can be filtered by one or
several parameters listed below.
|Parameter|Description|
|--|--------|
|*Template group*|Select all hosts with triggers from templates belonging to that group. Any host group that includes at least one template can be selected.|
|*Template*|Select hosts with triggers from the chosen template and all nested templates. Only triggers inherited from the selected template will be displayed. If a nested template has additional own triggers, those triggers will not be displayed.|
|*Template trigger*|Select hosts with chosen trigger. Other triggers of the selected hosts will not be displayed.|
|*Host group*|Select hosts belonging to the group.|
##### 按触发器模板过滤
在*按触发器模板*模式下，可以通过以下一个或多个参数筛选结果。
| 参数 | 描述 |
|--|--------|
| *Template group* | 选择所有包含来自该组模板触发器的主机。任何包含至少一个模板的主机组均可被选择。 |
| *Template* | 选择包含来自所选模板及所有嵌套模板触发器的主机。仅显示从所选模板继承的触发器。如果嵌套模板有额外的自有触发器，则不会显示这些触发器。 |
| *Template trigger* | 选择包含所选触发器的主机。所选主机的其他触发器将不会显示。 |
| *Host group* | 选择属于该组的主机。 |
#### Filtering VMware event log records
This example uses the [Matches regular expression](/manual/config/items/preprocessing#configuration) preprocessing step to filter unnecessary events from the VMware event log.
1\. On a working VMware Hypervisor host, check that the event log item [vmware.eventlog](/manual/config/items/itemtypes/simple_checks/vmware_keys) is present and working properly.
Note that the event log item could already be present on the hypervisor if a [VMware](/manual/vm_monitoring#ready-to-use-templates) template has been linked during the host creation.
2\. On the VMware Hypervisor host, create a [dependent item](/manual/config/items/itemtypes/dependent_items) of "Log" type and set the event log item as its master.
3\. In the *Preprocessing* tab of the dependent item, select the "Matches regular expression" preprocessing step and specify, for example, one of the following parameters:
```bash
# Filters all log events:
pattern: .* logged in .*
# Filters lines containing usernames after "User":
pattern: \bUser\s+\K\S+
```
::: noteimportant
If the regular expression is not matched, then the dependent item becomes unsupported with a corresponding error message.
To avoid this, mark the "Custom on fail" checkbox and select an option such as discarding the value or setting a custom one.
Please note that [discarded](/manual/config/items/preprocessing#configuration) values are not stored in the database; as a result, triggers are not evaluated and trend data is not generated.
:::
Alternatively, you may use the [Regular expression](/manual/config/items/preprocessing#configuration) preprocessing step to extract matching groups and control output. For example:
```bash
# Extracts and outputs the entire log event containing "logged in":
pattern: .*logged in.*
output: \0
# Extracts and outputs usernames following "User":
pattern: User (.*?)(?=\ )
output: \1
```
#### 过滤VMware事件日志记录
本示例使用[配置](/manual/config/items/preprocessing#配置)预处理步骤从VMware事件日志中过滤不必要的事件。
1\. 在运行的VMware Hypervisor 主机上，检查事件日志监控项[vmware.eventlog](/manual/config/items/itemtypes/simple_checks/vmware_keys)是否存在且正常工作。
注意如果在主机创建期间关联了[开箱即用模板](/manual/vm_monitoring#开箱即用模板)模板，则事件日志监控项可能已存在于hypervisor上。
2\. 在VMware Hypervisor 主机上，create一个"Log"类型的[dependent item](/manual/config/items/itemtypes/dependent_items)，并将事件日志监控项设为其主项。
3\. 在依赖项监控项的*预处理*标签页中，选择"匹配正则表达式"预处理步骤并指定以下示例参数之一：
```bash
# Filters all log events:
pattern: .* logged in .*
# Filters lines containing usernames after "User":
pattern: \bUser\s+\K\S+
```
::: noteimportant
如果正则表达式不匹配，则依赖项监控项将变为不受支持状态并显示相应错误消息。
为避免这种情况，请勾选"自定义失败处理"复选框并选择丢弃该值或设置自定义值等选项。
请注意[配置](/manual/config/items/preprocessing#配置)值不会存入数据库，因此不会评估触发器也不会生成趋势数据。
:::
或者，您可以使用[Regular expression](/manual/config/items/preprocessing#configuration)预处理步骤来提取匹配组并控制输出。例如：
```bash
# Extracts and outputs the entire log event containing "logged in":
pattern: .*logged in.*
output: \0
# Extracts and outputs usernames following "User":
pattern: User (.*?)(?=\ )
output: \1
```
#### Filter settings remembered
In several Monitoring pages (*Problems*, *Hosts*, *Latest data*) the current filter settings are
now remembered in the user profile. When the user opens the page again, the filter settings
will have stayed the same.
Additionally, the marking of a changed (but not saved) favorite filter is now a green dot next
to the filter name, instead of the filter name in italics.
#### 过滤设置已保存
在多个监控页面（*问题*、*主机*、*最新数据*）中，当前筛选器设置现在会被保存在用户配置文件中。当用户再次打开该页面时，筛选器设置将保持不变。
此外，已修改（但未保存）的收藏筛选器现在会在筛选器名称旁边显示一个绿点作为标记，而不再使用斜体显示的筛选器名称。
#### Find HTTP agent item
Find HTTP agent item with post body type XML for specific host ID.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 3,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28252",
"type": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "template item",
"key_": "ti",
"delay": "30s",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "localhost",
"query_fields": [
{
"mode": "xml"
}
],
"posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
"status_codes": "200",
"follow_redirects": "0",
"post_type": "3",
"http_proxy": "",
"headers": [],
"retrieve_mode": "1",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "",
"prevvalue": ""
}
],
"id": 3
}
```
#### 查找 HTTP agent 监控项
查找具有XML post body类型的HTTP agent 监控项，针对特定主机 ID.
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 3,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28252",
"type": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "template item",
"key_": "ti",
"delay": "30s",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "localhost",
"query_fields": [
{
"mode": "xml"
}
],
"posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
"status_codes": "200",
"follow_redirects": "0",
"post_type": "3",
"http_proxy": "",
"headers": [],
"retrieve_mode": "1",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "",
"prevvalue": ""
}
],
"id": 3
}
```
#### Find HTTP agent item prototype
Find HTTP agent item prototype with request method HEAD for specific host ID.
Request:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": "19",
"request_method": "3"
}
},
"id": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28257",
"type": "19",
"snmp_oid": "",
"hostid": "10254",
"name": "discovered",
"key_": "item[{#INAME}]",
"delay": "{#IUPDATE}",
"history": "90d",
"trends": "30d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "28255",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "2",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "{#IURL}",
"query_fields": [],
"posts": "",
"status_codes": "",
"follow_redirects": "0",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 17
}
```
#### 查找 HTTP agent 监控项 原型
查找针对特定主机 ID使用HEAD请求方法的HTTP agent 监控项原型.
请求:
```json
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": "19",
"request_method": "3"
}
},
"id": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28257",
"type": "19",
"snmp_oid": "",
"hostid": "10254",
"name": "discovered",
"key_": "item[{#INAME}]",
"delay": "{#IUPDATE}",
"history": "90d",
"trends": "30d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "28255",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "2",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "{#IURL}",
"query_fields": [],
"posts": "",
"status_codes": "",
"follow_redirects": "0",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 17
}
```
#### Finding dependent item
Find one Dependent item for item with ID "25545".
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": "18",
"master_itemid": "25545"
},
"limit": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25547",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Seconds",
"key_": "apache.status.uptime.seconds",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 1
}
```
#### 查找依赖的 监控项
为ID为"25545"的监控项查找一个依赖监控项.
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": "18",
"master_itemid": "25545"
},
"limit": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25547",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Seconds",
"key_": "apache.status.uptime.seconds",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 1
}
```
#### Finding dependent items by key
Retrieve all dependent items from host with ID "10116" that have the word "apache" in the key.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25550",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Days",
"key_": "apache.status.uptime.days",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "25555",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Hours",
"key_": "apache.status.uptime.hours",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}
```
#### 通过键值查找依赖的 监控项
从ID为"10116"的主机中检索所有键值包含"apache"的依赖监控项
请求:
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25550",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Days",
"key_": "apache.status.uptime.days",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "25555",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Hours",
"key_": "apache.status.uptime.hours",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}
```
#### Finding items by key
Retrieve all items used in triggers specific host ID that have word "system.cpu" in the item key and sort results by name.
Request:
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "42269",
"type": "18",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU utilization",
"key_": "system.cpu.util",
"delay": "0",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"logtimefmt": "",
"templateid": "42267",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "CPU utilization in %.",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "42264",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42259",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (15m avg)",
"key_": "system.cpu.load[all,avg15]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42219",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42249",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (1m avg)",
"key_": "system.cpu.load[all,avg1]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42209",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42257",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (5m avg)",
"key_": "system.cpu.load[all,avg5]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42217",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42260",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Number of CPUs",
"key_": "system.cpu.num",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42220",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}
```
#### 通过键值查找 监控项
检索所有在触发器中使用且特定于主机 ID的监控项，这些触发器在监控项键中包含"system.cpu"字样，并按名称对结果进行排序。
请求
```json
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应
```json
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "42269",
"type": "18",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU utilization",
"key_": "system.cpu.util",
"delay": "0",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"logtimefmt": "",
"templateid": "42267",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "CPU utilization in %.",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "42264",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42259",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (15m avg)",
"key_": "system.cpu.load[all,avg15]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42219",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42249",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (1m avg)",
"key_": "system.cpu.load[all,avg1]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42209",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42257",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (5m avg)",
"key_": "system.cpu.load[all,avg5]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42217",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42260",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Number of CPUs",
"key_": "system.cpu.num",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "42220",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}
```
##### Fit functions
Default `fit` is the *linear* function. But if your monitored system is
more complicated you have more options to choose from.
|`fit`|x = f(t)|
|-----|--------|
|*linear*|x = a + b\*t|
|*polynomialN*^[2](#footnotes)^|x = a~0~ + a~1~\*t + a~2~\*t^2^ + ... + a~n~\*t^n^|
|*exponential*|x = a\*exp(b\*t)|
|*logarithmic*|x = a + b\*log(t)|
|*power*|x = a\*t^b^|
##### 拟合函数
默认的`fit`是*线性*函数。但如果您的监控系统更为复杂，您还有更多选项可供选择。
| `fit` | x = f(t) |
|-----|--------|
| *线性* | x = a + b\*t |
| *多项式N*^[2](#footnotes)^ | x = a~0~ + a~1~\*t + a~2~\*t^2^ + ... + a~n~\*t^n^ |
| *指数* | x = a\*exp(b\*t) |
| *对数* | x = a + b\*log(t) |
| *幂* | x = a\*t^b^ |
#### Flexible intervals
Flexible intervals allow to redefine the default update interval for
specific time periods. A flexible interval is defined with *Interval*
and *Period* where:
- *Interval* – the update interval for the specified time period
- *Period* – the time period when the flexible interval is active (see
the [time periods](/manual/appendix/time_period) for detailed
description of the *Period* format)
If multiple flexible intervals overlap, the smallest *Interval* value is used for the overlapping period.
Note that if the smallest value of overlapping flexible intervals is '0', no polling will take place.
Outside the flexible intervals the default update interval is used.
Note that if the flexible interval equals the length of the period, the
item will be checked exactly once. If the flexible interval is greater
than the period, the item might be checked once or it might not be
checked at all (thus such configuration is not advisable). If the
flexible interval is less than the period, the item will be checked at
least once.
If the flexible interval is set to '0', the item is not polled during
the flexible interval period and resumes polling according to the
default *Update interval* once the period is over. Examples:
|Interval|Period|Description|
|--|--|------|
|10|1-5,09:00-18:00|Item will be checked every 10 seconds during working hours.|
|0|1-7,00:00-7:00|Item will not be checked during the night.|
|0|7-7,00:00-24:00|Item will not be checked on Sundays.|
|60|1-7,12:00-12:01|Item will be checked at 12:00 every day. Note that this was used as a workaround for scheduled checks and starting with Zabbix 3.0 it is recommended to use scheduling intervals for such checks.|
#### 弹性间隔
灵活间隔允许为特定时间段重新定义默认的update间隔。灵活间隔通过*间隔*和*周期*定义，其中：
- *间隔* - 指定时间段内的update间隔
- *周期* - 灵活间隔生效的时间段（参见
the [time periods](/manual/appendix/time_period) for detailed
description of the *Period* format)
如果多个灵活间隔重叠，则重叠期间使用最小的*间隔*值。
请注意，如果重叠灵活间隔的最小值为'0'，则不会进行轮询。
在灵活间隔之外的时间段，将使用默认的update间隔。
请注意，如果灵活间隔等于周期长度，则监控项将恰好检查一次。如果灵活间隔大于周期，则监控项可能检查一次或根本不检查（因此不建议使用此类配置）。如果灵活间隔小于周期，则监控项将至少检查一次。
如果灵活间隔设置为'0'，则在灵活间隔周期内不会轮询监控项，并在周期结束后根据默认的*更新间隔*恢复轮询。示例：
| 间隔 | 周期 | 描述 |
|--|--|------|
| 10 | 1-5,09:00-18:00 | 监控项将在工作时间内每10秒检查一次。 |
| 0 | 1-7,00:00-7:00 | 监控项在夜间不会检查。 |
| 0 | 7-7,00:00-24:00 | 监控项在周日不会检查。 |
| 60 | 1-7,12:00-12:01 | 监控项将在每天12:00检查。请注意，这曾用作计划检查的变通方法，从Zabbix 3.0开始，建议对此类检查使用调度间隔。 |
#### Flexible user parameters
Flexible user parameters accept parameters with the key. This way a
flexible user parameter can be the basis for creating several items.
Flexible user parameters have the following syntax:
UserParameter=key[*],command
|Parameter|Description|
|--|--------|
|**Key**|Unique item key. The \[\*\] defines that this key accepts parameters within the brackets.<br>Parameters are given when configuring the item.|
|**Command**|Command to be executed to evaluate value of the key.<br>*For flexible user parameters only*:<br>You may use positional references $1…$9 in the command to refer to the respective parameter in the item key.<br>Zabbix parses the parameters enclosed in \[ \] of the item key and substitutes $1,...,$9 in the command accordingly.<br>$0 will be substituted by the original command (prior to expansion of $0,...,$9) to be run.<br>Positional references are interpreted regardless of whether they are enclosed between double (") or single (') quotes.<br>To use positional references unaltered, specify a double dollar sign - for example, awk '{print $$2}'. In this case `$$2` will actually turn into `$2` when executing the command.|
::: noteimportant
Positional references with the $ sign are searched
for and replaced by Zabbix agent only for flexible user parameters. For
simple user parameters, such reference processing is skipped and,
therefore, any $ sign quoting is not necessary.
:::
::: noteimportant
Certain symbols are not allowed in user parameters
by default. See
[UnsafeUserParameters](/manual/appendix/config/zabbix_agentd)
documentation for a full list.
:::
#### 灵活的监控项参数
灵活的用户参数支持带参数的键值。这种方式使得灵活用户参数可以作为创建多个监控项的基础。
灵活用户参数的语法如下：
UserParameter=key[*],command
| 参数 | 描述 |
|--|--------|
| **Key** | 唯一的监控项键值。\[\*\]表示该键值接受方括号内的参数<br>参数在配置监控项时指定。 |
| **Command** | 用于评估键值的执行命令<br>*仅限灵活用户参数*：<br>可在命令中使用位置引用$1...$9来对应监控项键值中的参数<br>Zabbix会解析监控项键值中[]包含的参数，并相应替换命令中的$1,...,$9<br>$0将被替换为原始命令（在展开$0,...,$9之前）以便run<br>无论位置引用是否包含在双引号(")或单引号(')中都会被解析<br>如需原样使用位置引用，需指定双美元符号 - 例如awk '{print $$2}'。此时`$$2`在执行命令时会实际转换为`$2` |
::: noteimportant
带$符号的位置引用仅在灵活用户参数中会被Zabbix agent查找和替换。
对于简单用户参数，此类引用处理会被跳过，因此不需要对$符号进行转义。
:::
::: noteimportant
默认情况下用户参数中不允许使用某些特殊符号。
完整列表请参阅
[UnsafeUserParameters](/manual/appendix/config/zabbix_agentd)
文档。
:::
#### Flipping frontend locales
It has been observed that frontend locales may flip without apparent
logic, i. e. some pages (or parts of pages) are displayed in one
language while other pages (or parts of pages) in a different language.
Typically the problem may appear when there are several users, some of
whom use one locale, while others use another.
A known workaround to this is to disable multithreading in PHP and
Apache.
The problem is related to how setting the locale works [in
PHP](https://www.php.net/manual/en/function.setlocale): locale
information is maintained per process, not per thread. So in a
multi-thread environment, when there are several projects run by same
Apache process, it is possible that the locale gets changed in another
thread and that changes how data can be processed in the Zabbix thread.
For more information, please see related problem reports:
- [ZBX-10911](https://support.zabbix.com/browse/ZBX-10911) (Problem
with flipping frontend locales)
- [ZBX-16297](https://support.zabbix.com/browse/ZBX-16297) (Problem
with number processing in graphs using the `bcdiv` function of BC
Math functions)
#### 前端语言切换
已观察到前端区域设置可能在没有明显逻辑的情况下切换，即某些页面（或部分页面）显示为一种语言，而其他页面（或部分页面）显示为另一种语言。当存在多个用户且部分用户使用一种区域设置，而其他用户使用另一种区域设置时，通常会出现此问题。
已知的解决方法是禁用PHP和Apache中的多线程功能。
该问题与区域设置的工作机制[in
PHP](https://www.php.net/manual/en/function.setlocale)有关：区域信息是按进程而非线程维护的。因此在多线程环境中，当同一Apache进程run处理多个项目时，区域设置可能在另一个线程中被更改，从而影响Zabbix线程中数据的处理方式。
更多信息请参阅相关问题报告：
- [ZBX-10911](https://support.zabbix.com/browse/ZBX-10911)（前端区域设置切换问题）
- [ZBX-16297](https://support.zabbix.com/browse/ZBX-16297)（使用BC Math函数`bcdiv`处理图形数据时出现的数值处理问题）
### Float history
The float history object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|clock|timestamp|Time when that value was received.|
|itemid|string|ID of the related item.|
|ns|integer|Nanoseconds when the value was received.|
|value|float|Received value.|
### float 历史记录
float历史记录object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| clock | timestamp | 接收该值的时间。 |
| itemid | string | 相关监控项的ID。 |
| ns | integer | 接收该值的纳秒时间。 |
| value | float | 接收到的值。 |
### Float trend
The float trend object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|clock|timestamp|Timestamp of an hour for which the value was calculated. E. g. timestamp of 04:00:00 means values calculated for period 04:00:00-04:59:59.|
|itemid|integer|ID of the related item.|
|num|integer|Number of values that were available for the hour.|
|value\_min|float|Hourly minimum value.|
|value\_avg|float|Hourly average value.|
|value\_max|float|Hourly maximum value.|
### 浮点型趋势
float趋势object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| clock | timestamp | 计算值对应的小时时间戳。例如04:00:00的时间戳表示计算04:00:00-04:59:59期间的值。 |
| itemid | integer | 相关监控项的ID。 |
| num | integer | 该小时内可用的值的数量。 |
| value\_min | float | 每小时的最小值。 |
| value\_avg | float | 每小时的平均值。 |
| value\_max | float | 每小时的最大值。 |
##### Footnotes
^**1**^A Linux-specific note. Zabbix agent must have read-only access to
filesystem */proc*. Kernel patches from www.grsecurity.org limit access
rights of non-privileged users.
^**2**^ `vfs.dev.read[]`, `vfs.dev.write[]`: Zabbix agent will terminate
"stale" device connections if the item values are not accessed for more
than 3 hours. This may happen if a system has devices with dynamically
changing paths or if a device gets manually removed. Note also that
these items, if using an update interval of 3 hours or more, will always
return '0'.
^**3**^ `vfs.dev.read[]`, `vfs.dev.write[]`: If default *all* is used
for the first parameter then the key will return summary statistics,
including all block devices like sda, sdb and their partitions (sda1,
sda2, sdb3...) and multiple devices (MD raid) based on those block
devices/partitions and logical volumes (LVM) based on those block
devices/partitions. In such cases returned values should be considered
only as relative value (dynamic in time) but not as absolute values.
^**4**^ SSL (HTTPS) is supported only if agent is compiled with cURL
support. Otherwise the item will turn unsupported.
##### 脚注
^**1**^ Linux系统特定说明。Zabbix agent必须对*/proc*文件系统具有只读访问权限。来自www.grsecurity.org的内核补丁会限制非特权用户的访问权限。
^**2**^ `vfs.dev.read[]`、`vfs.dev.write[]`：如果监控项值超过3小时未被访问，Zabbix agent将终止"陈旧"的设备连接。这种情况可能发生在系统具有动态变化路径的设备，或设备被手动移除时。还需注意，如果这些监控项使用update间隔为3小时或更长，将始终返回'0'。
^**3**^ `vfs.dev.read[]`、`vfs.dev.write[]`：如果第一个参数使用默认值*all*，则该键将返回汇总统计信息，包括所有块设备如sda、sdb及其分区(sda1、sda2、sdb3...)以及基于这些块设备/分区的多设备(MD raid)和逻辑卷(LVM)。在这种情况下，返回值应仅被视为相对值(随时间动态变化)而非绝对值。
^**4**^ 仅当agent编译时支持cURL时，才支持SSL(HTTPS)。否则监控项将变为不支持状态。
##### Footnotes
^**1**^ Default value.
##### 脚注
^**1**^ 默认值。
##### Footnotes
^**1**^ For string values, only the string will be exported (e.g.
"EMAIL") without the numbering used in this table. The numbers for range
values (corresponding to the API values) in this table is used for
ordering only.
##### 脚注
^**1**^ 对于string值，仅会导出string（例如"EMAIL"），不包含本表中使用的编号。本表中范围值（对应API值）的编号仅用于排序目的。
##### Footnotes
^**1**^ For string values, only the string will be exported (e.g.
"ZABBIX\_ACTIVE") without the numbering used in this table. The numbers
for range values (corresponding to the API values) in this table is used
for ordering only.
##### 脚注
^**1**^ 对于string值，仅会导出string本身（例如"ZABBIX\_ACTIVE"），而不包含本表中使用的编号。本表中范围值（对应API值）的编号仅用于排序目的。
##### Footnotes
^**1**^ For string values, only the string will be exported (e.g.
"ZABBIX\_ACTIVE") without the numbering used in this table. The numbers
for range values (corresponding to the API values) in this table is used
for ordering only.
##### 脚注
^**1**^ 对于string值，仅会导出string本身（例如
"ZABBIX\_ACTIVE"），不包含本表中使用的编号。本表中范围值
（对应API值）的编号仅用于排序目的。
##### Footnotes
^**1**^ If multiple macros in a field or macros mixed with text are not
supported for the location, a single macro has to fill the whole field.
^**2**^ Macros used in tag names and values are resolved only during event generation process.
^**3**^ URLs that contain a [secret
macro](/manual/config/macros/user_macros#configuration) will not work,
as the macro in them will be resolved as "\*\*\*\*\*\*".
##### 脚注
^**1**^ 如果某字段位置不支持多个宏或宏与文本混合使用，则必须由单个宏填充整个字段。
^**2**^ 标签名称和值中使用的宏仅在事件生成过程中解析。
^**3**^ 包含[配置](/manual/config/macros/user_macros#配置)的URL将无法正常工作，因为其中的宏会被解析为"\*\*\*\*\*\*"。
##### Footnotes
^**1**^ In the fields marked with ^[1](lld_macros#footnotes)^ a single
macro has to fill the whole field. Multiple macros in a field or macros
mixed with text are not supported.
##### 脚注
^**1**^ 在标记为^[1](lld_macros#脚注)^的字段中
单个宏必须填满整个字段。不支持在一个字段中使用多个宏或将宏与文本混合使用。
##### Footnotes
^**1**^ net.if.in, net.if.out and net.if.total items do not provide
statistics of loopback interfaces (e.g. lo0).
^**2**^ These values for these items are not supported for loopback
interfaces on Solaris systems up to and including Solaris 10 6/06 as
byte, error and utilization statistics are not stored and/or reported by
the kernel. However, if you're monitoring a Solaris system via net-snmp,
values may be returned as net-snmp carries legacy code from the cmu-snmp
dated as old as 1997 that, upon failing to read byte values from the
interface statistics returns the packet counter (which does exist on
loopback interfaces) multiplied by an arbitrary value of 308. This makes
the assumption that the average length of a packet is 308 octets, which
is a very rough estimation as the MTU limit on Solaris systems for
loopback interfaces is 8892 bytes.
These values should not be assumed to be correct or even closely
accurate. They are guesstimates. The Zabbix agent does not do any guess
work, but net-snmp will return a value for these fields.
^**3**^ The command line on Solaris, obtained from /proc/pid/psinfo, is
limited to 80 bytes and contains the command line as it was when the
process was started.
^**4**^ Not supported on Windows Event Log.
^**5**^ On Windows XP vfs.file.time\[file,[change]{.underline}\] may be
equal to vfs.file.time\[file,[access]{.underline}\].
^**6**^ Supported only by Zabbix agent 2; not supported by Zabbix agent.
^**7**^ Supported only by Zabbix agent 2 on 64-bit Windows; not
supported by Zabbix agent.
##### 脚注
^**1**^ net.if.in、net.if.out 和 net.if.total 监控项 不提供
环回接口（如 lo0）的统计信息。
^**2**^ 这些 监控项 的数值在 Solaris 10 6/06 及更早版本的 Solaris 系统上
不支持环回接口，因为内核不存储和/或报告字节、错误和利用率统计信息。
然而，如果通过 net-snmp 监控 Solaris 系统，可能会返回数值，因为 net-snmp
继承了 1997 年的 cmu-snmp 遗留代码，当无法从接口统计信息中读取字节值时，
会返回数据包计数器（环回接口上确实存在）乘以一个任意值 308。这是基于
假设数据包的平均长度为 308 个八位字节，这是一个非常粗略的估计，因为
Solaris 系统上环回接口的 MTU 限制为 8892 字节。
这些数值不应被视为正确或接近准确。它们是猜测值。Zabbix agent 不会进行
任何猜测工作，但 net-snmp 会为这些字段返回一个值。
^**3**^ Solaris 上的命令行（从 /proc/pid/psinfo 获取）限制为 80 字节，
并且包含进程启动时的命令行。
^**4**^ Windows 事件日志不支持。
^**5**^ 在 Windows XP 上，vfs.file.time\[file,[change]{.underline}\] 可能
等于 vfs.file.time\[file,[access]{.underline}\]。
^**6**^ 仅 Zabbix agent 2 支持；Zabbix agent 不支持。
^**7**^ 仅在 64 位 Windows 上由 Zabbix agent 2 支持；
Zabbix agent 不支持。
##### Footnotes
^**1**^ Note that too many data gathering processes (pollers,
unreachable pollers, ODBC pollers, HTTP pollers, Java pollers, pingers, trappers,
proxypollers) together with IPMI manager, SNMP trapper and preprocessing
workers can **exhaust** the per-process file descriptor limit for the
preprocessing manager.
::: notewarning
This will cause Zabbix server to stop (usually
shortly after the start, but sometimes it can take more time). The
configuration file should be revised or the limit should be raised to
avoid this situation.
:::
^**2**^ When a lot of items are deleted it increases the load to the
database, because the housekeeper will need to remove all the history
data that these items had. For example, if we only have to remove 1 item
prototype from the template, but this template is linked to 50 hosts and for every host
the prototype is expanded to 100 real items, 5000 items in total have to
be removed (1\*50\*100). If 500 is set for MaxHousekeeperDelete
(MaxHousekeeperDelete=500), the housekeeper process will have to remove
up to 2500000 values (5000\*500) for the deleted items from history and
trends tables in one cycle.
##### 脚注
^**1**^ 注意过多的数据采集进程（轮询器，
不可达轮询器, ODBC轮询器, HTTP轮询器, Java轮询器, ping轮询器, trapper轮询器
代理轮询器(proxypollers)与IPMI管理器、SNMP捕捉器和预处理程序一起
workers可能会**耗尽**每个进程file的文件描述符限制
预处理管理器
::: notewarning
这将导致Zabbix server停止（通常
启动后不久（但有时可能需要更长时间）。
配置 file 应进行修订或将限制提高到
避免这种情况。
:::
^**2**^ 当大量监控项被删除时，会增加系统负载
数据库, 因为管家进程需要删除所有历史数据
这些监控项所拥有的数据。例如，如果我们只需要移除1个监控项
从模板继承原型，但该模板已链接到50个主机，且每个主机
原型被扩展到100个真实的监控项，总共需要5000个监控项
将被移除 (1*50*100). 如果MaxHousekeeperDelete设置为500
(MaxHousekeeperDelete=500), 管家进程将不得不删除
最多2500000个值（5000*500）用于从历史记录中删除的监控项
一个周期内的趋势表
##### Footnotes
^**1**^ See [Creating custom performance counter names for VMware](/manual/appendix/items/perf_counters).
^**2**^ The value of these items is obtained from VMware performance
counters and the VMwarePerfFrequency
[parameter](/manual/appendix/config/zabbix_server) is used to refresh
their data in Zabbix VMware cache:
- vmware.hv.datastore.read
- vmware.hv.datastore.write
- vmware.hv.network.in
- vmware.hv.network.out
- vmware.hv.perfcounter
- vmware.vm.cpu.ready
- vmware.vm.net.if.in
- vmware.vm.net.if.out
- vmware.vm.perfcounter
- vmware.vm.vfs.dev.read
- vmware.vm.vfs.dev.write
##### 脚注
^**1**^ 参见[Creating custom performance counter names for VMware](/manual/appendix/items/perf_counters).
^**2**^ 这些监控项的值从VMware性能计数器获取，并使用VMwarePerfFrequency
[parameter](/manual/appendix/config/zabbix_server)来刷新
它们在Zabbix vmware cache中的数据:
- vmware.hv.datastore.read
- vmware.hv.datastore.write
- vmware.hv.network.in
- vmware.hv.network.out
- vmware.hv.perfcounter
- vmware.vm.cpu.ready
- vmware.vm.net.if.in
- vmware.vm.net.if.out
- vmware.vm.perfcounter
- vmware.vm.vfs.dev.read
- vmware.vm.vfs.dev.write
### Footnotes
^**1**^ - Since Zabbix 6.0.13, loadable plugins started using the same versioning system as Zabbix itself.
As a result, MongoDB plugin version has changed from 1.2.0 to 6.0.13.
### 脚注
^**1**^ - 自Zabbix 6.0.13起，可加载插件开始采用与Zabbix自身相同的版本控制系统。
因此，MongoDB插件version的版本号已从1.2.0变更为6.0.13。
##### Footnotes
^**1**^ - Since Zabbix 6.0.13, loadable plugins started using the same versioning system as Zabbix itself.
As a result, MongoDB plugin version has changed from 1.2.0 to 6.0.13 and PostgreSQL plugin version
has changed from 1.2.1 to 6.0.13.
##### 脚注
^**1**^ - 自Zabbix 6.0.13起，可加载插件开始采用与Zabbix自身相同的版本控制系统。
因此，MongoDB插件version的版本号从1.2.0变更为6.0.13，PostgreSQL插件version
的版本号从1.2.1变更为6.0.13。
##### Footnotes
^**1**^ The `{HOST.*}` macros supported in item key parameters will
resolve to the interface that is selected for the item. When used in
items without interfaces they will resolve to either the Zabbix agent,
SNMP, JMX or IPMI interface of the host in this order of priority or to
'UNKNOWN' if the host does not have any interface.
^**2**^ In global scripts, interface IP/DNS fields and web scenarios the
macro will resolve to the main agent interface. If an agent interface is not
defined, the main SNMP interface will be used. If an SNMP interface is also not
defined, the main JMX interface will be used. If a JMX interface is not defined
either, the main IPMI interface will be used. If the host does not have
any interface, the macro resolves to 'UNKNOWN'.
^**3**^ Only the **avg**, **last**, **max** and **min** functions, with
seconds as parameter are supported in this macro in map labels.
^**4**^ `{HOST.*}` macros are supported in web scenario *Variables*,
*Headers*, *SSL certificate file* and *SSL key file* fields and in
scenario step *URL*, *Post*, *Headers* and *Required string* fields.
Since Zabbix 5.2.2, `{HOST.*}` macros are no longer supported in web
scenario *Name* and web scenario step *Name* fields.
^**5**^ Only the **avg**, **last**, **max** and **min** functions, with
seconds as parameter are supported within this macro in graph names. The
{HOST.HOST<1-9>} macro can be used as host within the macro. For
example:
last(/Cisco switch/ifAlias[{#SNMPINDEX}])
last(/{HOST.HOST}/ifAlias[{#SNMPINDEX}])
^**6**^ Supported since 5.2.5.
##### 脚注
^**1**^ 在监控项键参数中支持的`{HOST.*}`宏将解析为为监控项选择的接口。当在监控项中使用且没有接口时，它们将按此优先级顺序解析为主机的Zabbix agent、SNMP、JMX或IPMI接口，如果主机没有任何接口，则解析为'未知'。
^**2**^ 在全局脚本、接口IP/DNS字段和Web场景中，宏将解析为主agent接口。如果未定义agent接口，则将使用主SNMP接口。如果也未定义SNMP接口，则将使用主JMX接口。如果JMX接口也未定义，则将使用主IPMI接口。如果主机没有任何接口，宏将解析为'未知'。
^**3**^ 在地图标签中，此宏仅支持以秒为参数的**avg**、**last**、**max**和**min**函数。
^**4**^ `{HOST.*}`宏支持在Web场景的*Variables*、*Headers*、*SSL证书file*和*SSL密钥file*字段以及场景步骤的*URL*、*Post*、*Headers*和*Required string*字段中使用。自Zabbix 5.2.2起，`{HOST.*}`宏不再支持在Web场景*Name*和Web场景步骤*Name*字段中使用。
^**5**^ 在图表名称中，此宏仅支持以秒为参数的**avg**、**last**、**max**和**min**函数。{主机.主机<1-9>}宏可用作宏内的主机。例如：
last(/Cisco switch/ifAlias[{#SNMPINDEX}])
last(/{HOST.HOST}/ifAlias[{#SNMPINDEX}])
^**6**^ 自5.2.5版本起支持。
##### Footnotes
^**1**^ The VMware performance counter path has the
`group/counter[rollup]` format where:
- `group` - the performance counter group, for example *cpu*
- `counter` - the performance counter name, for example *usagemhz*
- `rollup` - the performance counter rollup type, for example
*average*
So the above example would give the following counter path:
`cpu/usagemhz[average]`
The performance counter group descriptions, counter names and rollup
types can be found in [VMware
documentation](https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.PerformanceManager.html).
^**2**^ The value of these items is obtained from VMware performance
counters and the VMwarePerfFrequency
[parameter](/manual/appendix/config/zabbix_server) is used to refresh
their data in Zabbix VMware cache:
- vmware.hv.datastore.read
- vmware.hv.datastore.write
- vmware.hv.network.in
- vmware.hv.network.out
- vmware.hv.perfcounter
- vmware.vm.cpu.ready
- vmware.vm.net.if.in
- vmware.vm.net.if.out
- vmware.vm.perfcounter
- vmware.vm.vfs.dev.read
- vmware.vm.vfs.dev.write
##### 脚注
^**1**^ VMware性能计数器路径具格式为 `group/counter[rollup]` ， 其中:
- `group` - 性能计数器组, 例如 *cpu*
- `counter` - 性能计数器名称, 例如 *usagemhz*
- `rollup` - 性能计数器汇总类型, 例如 *average*
所以上述示例会给出如下计数器路径： `cpu/usagemhz[average]`
性能计数器组描述、计数器名称和汇总类型可以在[VMware文档](https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.PerformanceManager.html)中找到
^**2**^ 这些项的值来自VMware性能计数器，VMwarePerfFrequency
[参数](/manual/appendix/config/zabbix_server) 用于刷新Zabbix
VMware缓存中的数据：
- vmware.hv.datastore.read
- vmware.hv.datastore.write
- vmware.hv.network.in
- vmware.hv.network.out
- vmware.hv.perfcounter
- vmware.vm.cpu.ready
- vmware.vm.net.if.in
- vmware.vm.net.if.out
- vmware.vm.perfcounter
- vmware.vm.vfs.dev.read
- vmware.vm.vfs.dev.write
#### Form buttons
Buttons at the bottom of the form allow to perform several operations.
| | |
|--|--------|
||Add a discovery rule. This button is only available for new discovery rules.|
||Update the properties of a discovery rule. This button is only available for existing discovery rules.|
||Create another discovery rule based on the properties of the current discovery rule.|
||Perform discovery based on the discovery rule immediately. The discovery rule must already exist. See [more details](/manual/config/items/check_now).<br>*Note* that when performing discovery immediately, configuration cache is not updated, thus the result will not reflect very recent changes to discovery rule configuration.|
||Test the discovery rule configuration. Use this button to verify the configuration settings (such as connectivity and parameter correctness) without permanently applying any changes.|
||Delete the discovery rule.|
||Cancel the editing of discovery rule properties.|
#### 表单按钮
表单底部的按钮允许执行多项操作。
| | |
|--|--------|
|  | 添加发现规则。该按钮仅适用于新建发现规则。 |
|  | 更新发现规则的属性。该按钮仅适用于现有发现规则。 |
|  | 基于当前发现规则的属性创建另一个发现规则。 |
|  | 立即基于发现规则执行发现。发现规则必须已存在。参见[more details](/manual/config/items/check_now)。<br>*注意*：立即执行发现时，configuration cache不会更新，因此结果不会反映最近对发现规则配置的更改。 |
|  | 测试发现规则配置。使用此按钮可验证配置设置（如连接性和参数正确性），而无需永久应用任何更改。 |
|  | 删除发现规则。 |
|  | 取消对发现规则属性的编辑。 |
#### Form buttons
Buttons at the bottom of the form allow to perform several operations.
| | |
|--|--------|
||Add an item. This button is only available for new items.|
||Update the properties of an item.|
||Create another item based on the properties of the current item.|
||Execute a check for a new item value immediately. Supported for **passive** checks only (see [more details](/manual/config/items/check_now)).<br>*Note* that when checking for a value immediately, configuration cache is not updated, thus the value will not reflect very recent changes to item configuration.|
||Test if item configuration is correct by getting a value.|
||Delete the item history and trends.|
||Delete the item.|
||Cancel the editing of item properties.|
#### 表单按钮
表单底部的按钮允许执行多种操作。
| | |
|--|--------|
|  | 添加一个监控项。此按钮仅对新监控项可用。 |
|  | 更新监控项的属性。 |
|  | 基于当前监控项的属性创建另一个监控项。 |
|  | 立即执行新监控项值的检查。仅支持**被动**检查（参见[more details](/manual/config/items/check_now)）。<br>*注意*：当立即检查值时，configuration cache不会更新，因此该值不会反映监控项配置的最新更改。 |
|  | 通过获取值来测试监控项配置是否正确。 |
|  | 删除监控项的历史数据和趋势数据。 |
|  | 删除监控项。 |
|  | 取消编辑监控项属性。 |
##### Form buttons
Buttons at the bottom of the form allow to perform several operations.
| | |
|--|--------|
||Add a report. This button is only available for new reports.|
||Update the properties of a report.|
||Create another report based on the properties of the current report.|
||Test if report configuration is correct by sending a report to the current user.|
||Delete the report.|
||Cancel the editing of report properties.|
##### 表单按钮
表单底部的按钮允许执行多种操作。
| | |
|--|--------|
|  | 添加报告。此按钮仅对新报告可用。 |
|  | 更新报告属性。 |
|  | 基于当前报告属性创建另一个报告。 |
|  | 通过向当前用户发送报告来测试报告配置是否正确。 |
|  | 删除报告。 |
|  | 取消报告属性编辑。 |
#### FreeBSD
See values supported for 'memtype' parameter on FreeBSD in the table.
|Supported value|Description|Source in kinfo\_proc structure|Tries to be compatible with|
|--|------|--|--|
|vsize|Virtual memory size|kp\_eproc.e\_vm.vm\_map.size or ki\_size|ps -o vsz|
|pmem|Percentage of real memory|calculated from rss|ps -o pmem|
|rss|Resident set size|kp\_eproc.e\_vm.vm\_rssize or ki\_rssize|ps -o rss|
|size ^[1](proc_mem_notes#footnotes)^|Size of process (code + data + stack)|tsize + dsize + ssize| |
|tsize|Text (code) size|kp\_eproc.e\_vm.vm\_tsize or ki\_tsize|ps -o tsiz|
|dsize|Data size|kp\_eproc.e\_vm.vm\_dsize or ki\_dsize|ps -o dsiz|
|ssize|Stack size|kp\_eproc.e\_vm.vm\_ssize or ki\_ssize|ps -o ssiz|
#### FreeBSD
查看FreeBSD上'memtype'参数支持的值，请参考下表。
| 支持的值 | 描述 | kinfo\_proc结构中的来源 | 尝试兼容的目标 |
|--|------|--|--|
| vsize | 虚拟memory大小 | kp\_eproc.e\_vm.vm\_map.size 或 ki\_size | ps -o vsz |
| pmem | 实际memory百分比 | 根据rss计算得出 | ps -o pmem |
| rss | 驻留集大小 | kp\_eproc.e\_vm.vm\_rssize 或 ki\_rssize | ps -o rss |
| size ^[1](proc_mem_notes#脚注)^ | 进程大小(代码 + 数据 + 栈) | tsize + dsize + ssize | |
| tsize | 文本(代码)大小 | kp\_eproc.e\_vm.vm\_tsize 或 ki\_tsize | ps -o tsiz |
| dsize | 数据大小 | kp\_eproc.e\_vm.vm\_dsize 或 ki\_dsize | ps -o dsiz |
| ssize | 栈大小 | kp\_eproc.e\_vm.vm\_ssize 或 ki\_ssize | ps -o ssiz |
## Frontend
## 前端
## Frontend
## 前端
## Frontend
## 前端
## Frontend
## 前端
## Frontend
## 前端
## Frontend
## 前端
##### Frontend configuration
A Zabbix proxy does not have a frontend; it communicates with Zabbix
server only.
##### 前端配置
Zabbix proxy没有前端界面，仅与Zabbix服务器通信。
##### Frontend configuration
A Zabbix proxy does not have a frontend; it communicates with Zabbix
server only.
##### 前端配置
Zabbix proxy没有前端界面，仅与Zabbix服务器进行通信。
##### Frontend configuration
A Zabbix proxy does not have a frontend; it communicates with Zabbix
server only.
##### 前端配置
Zabbix proxy 没有前端；它只与Zabbix server通信。
**Frontend configuration**
Create an action in the frontend, using some hard-to-guess secret code
to disallow unwanted hosts:
- Name: Autoregistration action Linux
- Conditions:
- Type of calculation: AND
- Condition (A): Host metadata contains //Linux//
- Condition (B): Host metadata contains //21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae//
- Operations:
- Send message to users: Admin via all media
- Add to host groups: Linux servers
- Link to templates: Linux
Please note that this method alone does not provide strong protection
because data is transmitted in plain text. Configuration cache reload is
required for changes to have an immediate effect.
**前端配置**
在前端创建一个动作，使用难以猜测的密钥代码来阻止非法的主机:
- 名称: Linux自动注册动作
- 条件:
- 计算类型: AND
- 条件(A): 主机元数据包含//Linux//
- 条件(B): 主机元数据包含//21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae//
- 操作:
- Send message to users: Admin via all media
- Add to host groups: Linux servers
- Link to templates: Linux
请注意，仅此方法无法提供强力保护，因为数据是以明文传输的。configuration cache需要重新加载才能使更改立即生效。
**Frontend configuration**
The first thing to do is to configure the frontend. Create 2 actions.
The first action:
- Name: Linux host autoregistration
- Conditions: Host metadata contains *Linux*
- Operations: Link to templates: Linux
::: noteclassic
You can skip an "Add host" operation in this case. Linking
to a template requires adding a host first so the server will do that
automatically.
:::
The second action:
- Name: Windows host autoregistration
- Conditions: Host metadata contains *Windows*
- Operations: Link to templates: Windows
**前端配置**
首先需要配置前端。创建2个动作。
第一个动作：
- 名称：Linux 主机 自动注册
- 条件：主机 元数据包含 *Linux*
- 操作：链接到模板：Linux
::: noteclassic
在这种情况下可以跳过"添加 主机"操作。链接到模板需要先添加 一个主机，因此服务器会自动完成此操作。
:::
第二个动作：
- 名称：Windows 主机 自动注册
- 条件：主机 元数据包含 *Windows*
- 操作：链接到模板：Windows
**Frontend configuration**
Update the action in the frontend:
- Name: Autoregistration action Linux
- Conditions:
- Type of calculation: AND
- Condition (A): Host metadata contains Linux
- Condition (B): Host metadata contains 21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae
- Operations:
- Send message to users: Admin via all media
- Add to host groups: Linux servers
- Link to templates: Linux
- Link to templates: MySQL by Zabbix Agent
**前端配置**
在前端更新操作：
- 名称：Linux自动注册操作
- 条件：
- 计算类型：AND
- 条件(A)：主机元数据包含Linux
- 条件(B)：主机元数据包含21df83bf21bf0be663090bb8d4128558ab9b95fba66a6dbf834f8b91ae5e08ae
- 操作：
- 向用户发送消息：通过所有媒介通知Admin
- 添加到主机组：Linux服务器
- 链接到模板：Linux
- 链接到模板：由Zabbix Agent提供的MySQL
##### Frontend configuration with Kerberos/ADFS
The Zabbix frontend configuration file (*zabbix.conf.php*) can be used to configure SSO with Kerberos authentication and ADFS:
```php
$SSO['SETTINGS'] = [
'security' => [
'requestedAuthnContext' => [
'urn:oasis:names:tc:SAML:2.0:ac:classes:Kerberos',
],
'requestedAuthnContextComparison' => 'exact'
]
];
```
In this case, in the SAML configuration *SP name ID* field set:
urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
##### 使用Kerberos/ADFS的前端配置
Zabbix前端配置文件file (*zabbix.conf.php*)可用于配置基于Kerberos认证和ADFS的SSO:
```php
$SSO['SETTINGS'] = [
'security' => [
'requestedAuthnContext' => [
'urn:oasis:names:tc:SAML:2.0:ac:classes:Kerberos',
],
'requestedAuthnContextComparison' => 'exact'
]
];
```
在此情况下，SAML配置中的*SP name ID*字段应设置为:
urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
### Frontend languages
Catalan and Romanian languages are now enabled in the frontend.
### 前端语言
前端现已支持加泰罗尼亚语和罗马尼亚语。
#### Frontend languages
Dutch, Georgian, and Spanish languages are now enabled in the frontend.
#### 前端语言
前端界面现已支持荷兰语、格鲁吉亚语和西班牙语。
### Frontend languages
German and Vietnamese languages are now enabled in the frontend.
### 前端语言
前端界面现已支持德语和越南语。
### Frontend
##### Miscellaneous
- Warnings about incorrect housekeeping configuration for TimescaleDB are now displayed
if history or trend tables contain compressed chunks,
but *Override item history period* or *Override item trend period* options are disabled.
For more information, see [TimescaleDB setup](/manual/appendix/install/timescaledb#configuration).
### 前端
##### 杂项
- 当历史数据表或趋势数据表包含压缩块时，若*覆盖监控项历史数据周期*或*覆盖监控项趋势数据周期*选项被禁用，
系统现在会显示关于TimescaleDB配置不正确的告警。
更多信息请参阅[配置](/manual/appendix/install/timescaledb#配置)。
#### Frontend
To enable encryption with certificate and database host identity
verification for connections between Zabbix frontend and the database:
- Check *Database TLS encryption* and *Verify database certificate*
- Specify path to *Database TLS key file*
- Specify path to *Database TLS CA file*
- Specify path to *Database TLS certificate file*
- Check *Database host verification*
{width="600"}
Alternatively, this can be set in */etc/zabbix/web/zabbix.conf.php:*
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '';
$DB['CERT_FILE'] = '';
$DB['CA_FILE'] = '/etc/ssl/pgsql/root.crt';
$DB['VERIFY_HOST'] = true;
$DB['CIPHER_LIST'] = '';
...
#### 前端
要为Zabbix前端与数据库之间的连接启用证书加密和数据库主机身份验证:
- 勾选*数据库TLS加密*和*验证数据库证书*
- 指定*数据库TLS密钥文件*的路径
- 指定*数据库TLS CA文件*的路径
- 指定*数据库TLS证书文件*的路径
- 勾选*数据库主机验证*
{width="600"}
或者，可以在*/etc/zabbix/web/zabbix.conf.php*中进行如下设置:
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '';
$DB['CERT_FILE'] = '';
$DB['CA_FILE'] = '/etc/ssl/pgsql/root.crt';
$DB['VERIFY_HOST'] = true;
$DB['CIPHER_LIST'] = '';
...
#### Frontend
To enable encryption with certificate authority verification for
connections between Zabbix frontend and the database:
- Check *Database TLS encryption* and *Verify database certificate*
- Specify path to *Database TLS CA file*
{width="600"}
Alternatively, this can be set in */etc/zabbix/web/zabbix.conf.php:*
...
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '';
$DB['CERT_FILE'] = '';
$DB['CA_FILE'] = '/etc/ssl/pgsql/root.crt';
$DB['VERIFY_HOST'] = false;
$DB['CIPHER_LIST'] = '';
...
#### 前端
要为Zabbix前端与数据库之间的连接启用带证书权威验证的加密:
- 勾选*数据库TLS加密*和*验证数据库证书*
- 指定*数据库TLS CA file*的路径
{width="600"}
或者，可以在*/etc/zabbix/web/zabbix.conf.php*中设置:
...
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '';
$DB['CERT_FILE'] = '';
$DB['CA_FILE'] = '/etc/ssl/pgsql/root.crt';
$DB['VERIFY_HOST'] = false;
$DB['CIPHER_LIST'] = '';
...
#### Frontend
To enable encryption with certificate verification for connections
between Zabbix frontend and the database:
- Check *Database TLS encryption* and *Verify database certificate*
- Specify path to Database TLS CA file
{width="600"}
Alternatively, this can be set in */etc/zabbix/web/zabbix.conf.php*:
...
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '';
$DB['CERT_FILE'] = '';
$DB['CA_FILE'] = '/etc/ssl/mysql/ca.pem';
$DB['VERIFY_HOST'] = false;
$DB['CIPHER_LIST'] = '';
...
Troubleshoot user using command-line tool to check if connection is
possible for required user:
mysql -u zbx_web -p -h 10.211.55.9 --ssl-mode=REQUIRED --ssl-ca=/var/lib/mysql/ca.pem
#### 前端
要为Zabbix前端与数据库之间的连接启用证书验证加密:
- 勾选*数据库TLS加密*和*验证数据库证书*
- 指定数据库TLS CA证书路径file
{width="600"}
或者，可以在*/etc/zabbix/web/zabbix.conf.php*文件中设置:
...
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '';
$DB['CERT_FILE'] = '';
$DB['CA_FILE'] = '/etc/ssl/mysql/ca.pem';
$DB['VERIFY_HOST'] = false;
$DB['CIPHER_LIST'] = '';
...
使用命令行工具排查用户连接问题，检查指定用户是否能建立连接:
mysql -u zbx_web -p -h 10.211.55.9 --ssl-mode=REQUIRED --ssl-ca=/var/lib/mysql/ca.pem
#### Frontend
To enable encryption with full verification for connections between
Zabbix frontend and the database:
- Check *Database TLS encryption* and *Verify database certificate*
- Specify path to *Database TLS key file*
- Specify path to *Database TLS CA file*
- Specify path to *Database TLS certificate file*
Note that *Database host verification* is checked and grayed out - this
step cannot be skipped for MySQL.
::: notewarning
If *Database TLS cipher list* field is left empty, the common ciphers permitted by both frontend (client) and server will be enabled.
Alternatively, the ciphers can be set explicitly, in conformance with the
[cipher configuration requirements](https://dev.mysql.com/doc/refman/8.0/en/encrypted-connection-protocols-ciphers.html#encrypted-connection-cipher-configuration).
:::
{width="600"}
Alternatively, this can be set in */etc/zabbix/web/zabbix.conf.php*:
...
// Used for TLS connection with strictly defined Cipher list.
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '/etc/ssl/mysql/client-key.pem';
$DB['CERT_FILE'] = '/etc/ssl/mysql/client-cert.pem';
$DB['CA_FILE'] = '/etc/ssl/mysql/ca.pem';
$DB['VERIFY_HOST'] = true;
$DB['CIPHER_LIST'] = 'TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:TLS_AES_128_CCM_SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-GC';
...
// or
...
// Used for TLS connection without Cipher list defined - selected by MySQL server
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '/etc/ssl/mysql/client-key.pem';
$DB['CERT_FILE'] = '/etc/ssl/mysql/client-cert.pem';
$DB['CA_FILE'] = '/etc/ssl/mysql/ca.pem';
$DB['VERIFY_HOST'] = true;
$DB['CIPHER_LIST'] = '';
...
#### 前端
要为Zabbix前端与数据库之间的连接启用完全验证加密:
- 勾选*数据库TLS加密*和*验证数据库证书*
- 指定*数据库TLS密钥file*的路径
- 指定*数据库TLS CAfile*的路径
- 指定*数据库TLS证书file*的路径
注意*数据库主机验证*选项被勾选且显示为灰色 - 对于MySQL此步骤不可跳过.
::: notewarning
如果*数据库TLS加密套件列表*字段留空，将启用前端(客户端)和服务器共同允许的通用加密套件.
或者，可以根据[cipher configuration requirements](https://dev.mysql.com/doc/refman/8.0/en/encrypted-connection-protocols-ciphers.html#encrypted-connection-cipher-configuration)明确设置加密套件.
:::
{width="600"}
或者，可以在*/etc/zabbix/web/zabbix.conf.php*中设置:
...
// 用于TLS连接并严格定义加密套件列表.
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '/etc/ssl/mysql/client-key.pem';
$DB['CERT_FILE'] = '/etc/ssl/mysql/client-cert.pem';
$DB['CA_FILE'] = '/etc/ssl/mysql/ca.pem';
$DB['VERIFY_HOST'] = true;
$DB['CIPHER_LIST'] = 'TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:TLS_AES_128_CCM_SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-GC';
...
// 或
...
// 用于TLS连接且不定义加密套件列表 - 由MySQL服务器选择
$DB['ENCRYPTION'] = true;
$DB['KEY_FILE'] = '/etc/ssl/mysql/client-key.pem';
$DB['CERT_FILE'] = '/etc/ssl/mysql/client-cert.pem';
$DB['CA_FILE'] = '/etc/ssl/mysql/ca.pem';
$DB['VERIFY_HOST'] = true;
$DB['CIPHER_LIST'] = '';
...
#### Frontend
To enable transport-only encryption for connections between Zabbix
frontend and the database:
- Check *Database TLS encryption*
- Leave *Verify database certificate* unchecked
{width="600"}
#### 前端
要为Zabbix前端与数据库之间的连接启用仅传输加密：
- 勾选*数据库TLS加密*
- 保持*验证数据库证书*未勾选状态
{width="600"}
#### Frontend
To enable transport-only encryption for connections between Zabbix
frontend and the database:
- Check *Database TLS encryption*
- Leave *Verify database certificate* unchecked
{width="600"}
#### 前端
要为Zabbix前端与数据库之间的连接启用仅传输加密：
- 勾选*数据库TLS加密*
- 保持*验证数据库证书*未勾选状态
{width="600"}
#### Function parameters
Function parameters allow to specify:
- host and item key (functions referencing the host item history only)
- function-specific parameters
- other expressions (not available for functions referencing the host
item history, see [other expressions](#other_expressions) for
examples)
The host and item key can be specified as `/host/key`. The referenced
item must be in a supported state (except for **nodata()** function,
which is calculated for unsupported items as well).
While other trigger expressions as function parameters are limited to
non-history functions in triggers, this limitation does not apply in
[calculated items](/manual/config/items/itemtypes/calculated).
#### 函数参数
函数参数允许指定：
- 主机和监控项键（仅引用主机监控项历史的函数）
- 函数特定参数
- 其他表达式（不适用于引用主机的函数）
item history, see [other expressions](#other_expressions) for
examples)
主机和监控项键可指定为`/host/key`。被引用的
监控项必须处于支持状态（**nodata()**函数除外，
该函数对不受支持的监控项也会进行计算）。
虽然作为函数参数的其他触发器表达式在触发器中仅限于
非历史函数，但此限制不适用于
[calculated items](/manual/config/items/itemtypes/calculated)。
## Functions
## 函数
#### Functions
Before setting a trigger, it is necessary to define what a problem state is and how
much time is needed to take action. Then there are two ways to set up a
trigger signaling about a potential unwanted situation. First: the
trigger must fire when the system is expected to be
in a problem state after the "time to act". Second: the trigger must fire when the system is
going to reach the problem state in less than "time to act".
Corresponding trigger functions to use are **forecast** and
**timeleft**. Note that underlying statistical analysis is basically
identical for both functions. You may set up a trigger whichever way you
prefer with similar results.
#### 函数
在设置触发器之前，需要先定义问题状态是什么以及需要多少时间来采取行动。然后有两种方式来设置触发器以发出潜在不良情况的信号。第一种：当系统预计在"行动时间"后处于问题状态时，触发器必须触发。第二种：当系统将在少于"行动时间"内达到问题状态时，触发器必须触发。对应的触发器函数是**forecast**和**timeleft**。请注意，这两个函数的基础统计分析基本上是相同的。您可以根据个人偏好以类似的结果设置任一种触发器。
#### Functions for Prometheus histograms
It has been possible to collect [Prometheus metrics](/manual/config/items/itemtypes/prometheus) in Zabbix for a
while now, but some of the metrics are difficult to work with. Specifically, the metrics of histogram type can be
presented in Zabbix as multiple items with the same key names, but different parameters. However, even though such items
are logically related and represent the same data, it has been difficult to analyze the collected data without
specialized functions. To cover this functionality gap in the new version, **rate()** and **histogram\_quantile()**
functions, producing the same result as their PromQL counterparts, have been added.
Other new additions to complement this functionality are the
**bucket\_rate\_foreach()** and the **bucket\_percentile()** functions.
For more information see:
- [History functions](/manual/appendix/functions/history#history-functions-1) (see **rate()**)
- [Aggregate functions](/manual/appendix/functions/aggregate#aggregate-functions-1)
(see **histogram\_quantile()**, **bucket\_percentile()**)
- [Foreach functions](/manual/appendix/functions/aggregate/foreach) (see **bucket\_rate\_foreach()**)
#### Prometheus 直方图函数
Zabbix 已支持采集[Prometheus metrics](/manual/config/items/itemtypes/prometheus)有一段时间了，但部分指标难以直接使用。特别是直方图类型的指标在Zabbix中会呈现为多个具有相同键名但参数不同的监控项。尽管这些监控项在逻辑上相关联并代表同一组数据，但缺乏专用函数时分析采集数据一直较为困难。为填补这一功能空白，新版本version中新增了**rate()**和**histogram\_quantile()**函数，其计算结果与PromQL对应函数完全一致。
为完善此功能还新增了：
**bucket\_rate\_foreach()**和**bucket\_percentile()**函数
更多信息请参阅：
- [4-历史数据函数](/manual/appendix/functions/history#4-历史数据函数) (参见**rate()**)
- [聚合函数](/manual/appendix/functions/aggregate#聚合函数)
(参见**histogram\_quantile()**, **bucket\_percentile()**)
- [Foreach functions](/manual/appendix/functions/aggregate/foreach) (参见**bucket\_rate\_foreach()**)
#### Functions
Functions allow to calculate the collected values (average, minimum,
maximum, sum), find strings, reference current time and other factors.
A complete list of [supported functions](/manual/appendix/functions) is
available.
Typically functions return numeric values for comparison. When returning
strings, comparison is possible with the **=** and **<>**
operators (see [example](#example_14)).
#### 函数
函数可用于计算采集值(平均值、最小值、最大值、总和)、查找字符串、引用当前时间及其他因素。
完整[supported functions](/manual/appendix/functions)列表可供查阅。
通常函数会返回用于比较的数值。当返回字符串时，可使用**=**和**<>**运算符进行比较(参见[示例](#example_14))。
#### Functions
Functions can be used at the end of JSONPath. Multiple functions can be
chained if the preceding function returns value that is accepted by the
following function.
Supported functions:
|Function|Description|Input|Output|
|--|--------|----|----|
|`avg`|Average value of numbers in input array.|Array of numbers.|Number.|
|`min`|Minimum value of numbers in input array.|Array of numbers.|Number.|
|`max`|Maximum value of numbers in input array.|Array of numbers.|Number.|
|`sum`|Sum of numbers in input array.|Array of numbers.|Number.|
|`length`|Number of elements in input array.|Array.|Number.|
|`first`|The first array element.|Array.|A JSON construct (object, array, value) depending on input array contents.|
Quoted numeric values are accepted by the JSONPath aggregate functions.
It means that the values are converted from string type to numeric if
aggregation is required.
Incompatible input will cause the function to generate error.
#### 函数
函数可以用于JSONPath的末尾。如果前一个函数返回的值能被后续函数接受，
则可以链式调用多个函数。
支持的函数：
| 函数 | 描述 | 输入 | 输出 |
|--|--------|----|----|
| `avg` | 输入array中数字的平均值。 | 数字的array。 | 数字。 |
| `min` | 输入array中数字的最小值。 | 数字的array。 | 数字。 |
| `max` | 输入array中数字的最大值。 | 数字的array。 | 数字。 |
| `sum` | 输入array中数字的总和。 | 数字的array。 | 数字。 |
| `length` | 输入array中的元素数量。 | array。 | 数字。 |
| `first` | 第一个array元素。 | array。 | 根据输入array内容返回JSON结构（object、array或值）。 |
JSONPath聚合函数接受带引号的数值。
这意味着如果需要聚合，值会从string类型转换为数字类型。
不兼容的输入将导致函数返回generate错误。
##### Function-specific parameters
Function-specific parameters are placed after the item key and are
separated from the item key by a comma. See the [supported
functions](/manual/appendix/functions) for a complete list of these
parameters.
Most of numeric functions accept time as a parameter. You may use
seconds or [time suffixes](/manual/appendix/suffixes) to indicate time.
Preceded by a hash mark, the parameter has a different meaning:
|Expression|Description|
|----------|-----------|
|**sum**(/host/key,**10m)**|Sum of values in the last 10 minutes.|
|**sum**(/host/key,**\#10)**|Sum of the last ten values.|
Parameters with a hash mark have a different meaning with the function
**last** - they denote the Nth previous value, so given the values 30, 70,
20, 60, 50 (from the most recent to the least recent):
- `last(/host/key,#2)` would return '70'
- `last(/host/key,#5)` would return '50'
##### 函数特定参数
函数特定参数位于监控项键之后
并通过逗号与监控项键分隔。完整参数列表请参阅[supported
functions](/manual/appendix/functions)
大多数数值函数接受时间参数。可使用
秒数或[time suffixes](/manual/appendix/suffixes)表示时间。
以井号开头的参数具有不同含义：
| 表达式 | 描述 |
|----------|-----------|
| **sum**(/主机/key,**10m)** | 最近10分钟内的数值总和 |
| **sum**(/主机/key,**\#10)** | 最近十个数值的总和 |
带井号的参数在**last**函数中
具有不同含义 - 表示第N个前值，例如给定数值序列30, 70,
20, 60, 50（从最新到最旧）：
- `last(/host/key,#2)` 将返回'70'
- `last(/host/key,#5)` 将返回'50'
##### Function-specific parameters
Function-specific parameters are placed after the item key and are
separated from the item key by a comma. See the [supported
functions](/manual/appendix/functions) for a complete list of these
parameters.
Most of numeric functions accept time as a parameter. You may use
seconds or [time suffixes](/manual/appendix/suffixes) to indicate time.
Preceded by a hashtag, the parameter has a different meaning:
|Expression|Description|
|----------|-----------|
|**sum**(/host/key,**10m)**|Sum of values in the last 10 minutes.|
|**sum**(/host/key,**\#10)**|Sum of the last ten values.|
Parameters with a hashtag have a different meaning with the function
**last** - they denote the Nth previous value, so given the values 3, 7,
2, 6, 5 (from most recent to least recent):
- `last(/host/key,#2)` would return '7'
- `last(/host/key,#5)` would return '5'
##### 特定函数参数
特定函数的参数放置在监控项键之后，并且是 用逗号与监控项键隔开。请参阅 [supported functions支持函数](/manual/appendix/functions) 获取这些的完整列表 参数。
大多数数值函数都接受时间作为参数。您可以使用 seconds 或 [time suffixes（时间戳后缀）](/manual/appendix/suffixes) 来表示时间。 前面有标签，参数有不同的含义：
|表达式|描述|
|----------|-----------|
|**sum**(/host/key,**10m)**|过去 10 分钟的数值总和。|
|**sum**(/host/key,**\#10)**|最后十个值的总和。|
带有标签的参数与函数具有不同的含义 **last** - 它们表示第 N 个先前的值，因此给定值 3、7、 2、6、5（从最近到至少最近）：
- `last(/host/key,#2)` 将返回 '7'
- `last(/host/key,#5)` 将返回 '5'
#### Function syntax
Foreach functions support two common parameters: `item filter` (see details below) and `time period`:
foreach_function(item filter,time period)
For example:
`avg_foreach(/*/mysql.qps?[group="MySQL Servers"],5m)`
will return the five-minute average of each 'mysql.qps' item in the MySQL server group.
Note that some functions support additional [parameters](#additional_parameters).
#### 函数语法
foreach函数支持两个通用参数：`item filter`（详见下文）和`time period`：
foreach_function(item filter,time period)
例如：
`avg_foreach(/*/mysql.qps?[group="MySQL Servers"],5m)`
将返回MySQL服务器组中每个'mysql.qps'监控项的5分钟平均值。
注意某些函数支持额外的[参数](#additional_parameters)。
### Further reading
You now know enough to start working with the Zabbix API, but don't stop
here. For further reading we suggest you have a look at the [list of
available APIs](/manual/api/reference).
### 延伸阅读
您现在已掌握足够知识开始使用Zabbix API，但请不要止步于此。建议您进一步阅读[list of
available APIs](/manual/api/reference)以深入学习。
#### General
#### 常规
#### General advice
- monitor required parameters only
- tune 'Update interval' for all items. Keeping a small update
interval may be good for nice graphs, however, this may overload
Zabbix
- tune parameters for default templates
- tune housekeeping parameters
- do not monitor parameters which return the same information.
- avoid the use of triggers with long period given as function
argument. For example, max(/host/key,1h) will be calculated
significantly slower than max(/host/key,1m).
#### 一般建议
- 仅监控所需参数
- 调整所有监控项的“更新间隔”。保持较小的更新间隔可能获得更好的图表展示，但是，这可能会使 Zabbix 过载
- 调整默认模板的参数
- 调整管家参数
- 不要监控返回相同信息的参数
- 避免使用作为函数参数给出的长周期触发器。例如， max(/host/key,1h) 的计算速度将明显慢于max(/host/key,1m)。
#### General attributes
The *User* tab contains general user attributes:
All mandatory input fields are marked with a red asterisk.
|Parameter|Description|
|--|--------|
|*Username*|Unique username, used as the login name.|
|*Name*|User first name (optional).<br>If not empty, visible in acknowledgment information and notification recipient information.|
|*Last name*|User last name (optional).<br>If not empty, visible in acknowledgment information and notification recipient information.|
|*Groups*|Select [user groups](usergroup) the user belongs to. Starting with Zabbix 3.4.3 this field is auto-complete so starting to type the name of a user group will offer a dropdown of matching groups. Scroll down to select. Alternatively, click on *Select* to add groups. Click on 'x' to remove the selected.<br>Adherence to user groups determines what host groups and hosts the user will have [access to](permissions).|
|*Password*|Two fields for entering the user password.<br>With an existing password, contains a *Password* button, clicking on which opens the password fields.<br>Note that passwords longer than 72 characters will be truncated.|
|*Language*|Language of the Zabbix frontend.<br>The php gettext extension is required for the translations to work.|
|*Time zone*|Select the time zone to override global [time zone](/manual/web_interface/time_zone#overview) on user level or select **System default** to use global time zone settings.|
|*Theme*|Defines how the frontend looks like:<br>**System default** - use default system settings<br>**Blue** - standard blue theme<br>**Dark** - alternative dark theme<br>**High-contrast light** - light theme with high contrast<br>**High-contrast dark** - dark theme with high contrast|
|*Auto-login*|Mark this checkbox to make Zabbix remember the user and log the user in automatically for 30 days. Browser cookies are used for this.|
|*Auto-logout*|With this checkbox marked the user will be logged out automatically, after the set amount of seconds (minimum 90 seconds, maximum 1 day).<br>[Time suffixes](/manual/appendix/suffixes) are supported, e.g. 90s, 5m, 2h, 1d.<br>Note that this option will not work:<br>\* If the "Show warning if Zabbix server is down" global configuration option is enabled and Zabbix frontend is kept open;<br>\* When Monitoring menu pages perform background information refreshes;<br>\* If logging in with the *Remember me for 30 days* option checked.|
|*Refresh*|Set the refresh rate used for graphs, plain text data, etc. Can be set to 0 to disable.|
|*Rows per page*|You can determine how many rows per page will be displayed in lists.|
|*URL (after login)*|You can make Zabbix transfer the user to a specific URL after successful login, for example, to Problems page.|
#### 通用属性
*用户*标签页包含常规用户属性：
所有必填字段均以红色星号标记。
| 参数 | 描述 |
|--|--------|
| *Username* | 唯一用户名，用作login名称。 |
| *Name* | 用户名字（可选）。<br>若非空，将在确认信息和通知接收方信息中显示。 |
| *Last name* | 用户姓氏（可选）。<br>若非空，将在确认信息和通知接收方信息中显示。 |
| *Groups* | 选择用户所属的[user groups](usergroup)。从Zabbix 3.4.3开始此字段支持自动补全，输入用户组名称时会显示匹配组的下拉列表。可滚动选择或点击*选择*添加组。点击'x'移除已选项。<br>用户组归属决定了用户将拥有哪些主机组和主机的[access to](permissions)权限。 |
| *Password* | 两个密码输入字段。<br>若存在密码，会显示*密码*按钮，点击后可展开密码字段。<br>注意超过72个字符的密码将被截断。 |
| *Language* | Zabbix前端界面语言。<br>需要php gettext扩展支持翻译功能。 |
| *Time zone* | 选择时区以覆盖用户级别的全局[概述](/manual/web_interface/time_zone#概述)设置，或选择**系统默认**使用全局时区配置。 |
| *Theme* | 定义前端主题样式：<br>**系统默认** - 使用默认系统主题<br>**蓝色** - 标准蓝色主题<br>**暗色** - 替代暗色主题<br>**高对比度亮色** - 高对比度亮色主题<br>**高对比度暗色** - 高对比度暗色主题 |
| *Auto-login* | 勾选此选项可使Zabbix记住用户并在30天内自动登录。此功能使用浏览器cookie实现。 |
| *Auto-logout* | 勾选后用户将在设定秒数后自动登出（最短90秒，最长1天）。<br>支持[Time suffixes](/manual/appendix/suffixes)时间单位，如90s、5m、2h、1d。<br>注意以下情况此功能无效：<br>\* 当"显示Zabbix server宕机警告"全局配置启用且Zabbix前端保持打开状态时；<br>\* 监控菜单页面执行后台信息刷新时；<br>\* 使用*30天内记住我*选项登录时。 |
| *Refresh* | 设置图表、纯文本数据等的刷新频率。设为0可禁用刷新。 |
| *Rows per page* | 可定义列表中每页显示的行数。 |
| *URL (after login)* | 可设置用户login成功后跳转至特定URL，例如跳转到问题页面。 |
#### General
Change certain global configuration options.
[Autoregistration API](/manual/api/reference/autoregistration) | [Icon
map API](/manual/api/reference/iconmap) | [Image
API](/manual/api/reference/image) | [User macro
API](/manual/api/reference/usermacro) | [Settings
API](/manual/api/reference/settings) | [Housekeeping
API](/manual/api/reference/housekeeping)
#### 常规
修改特定全局配置选项.
[Autoregistration API](/manual/api/reference/autoregistration) | [Icon
map API](/manual/api/reference/iconmap) | [Image
API](/manual/api/reference/image) | [User macro
API](/manual/api/reference/usermacro) | [Settings
API](/manual/api/reference/settings) | [Housekeeping
API](/manual/api/reference/housekeeping)
#### Generate multiple tokens
Generate two tokens.
Request:
```json
{
"jsonrpc": "2.0",
"method": "token.generate",
"params": [
"1",
"2"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"tokenid": "1",
"token": "bbcfce79a2d95037502f7e9a534906d3466c9a1484beb6ea0f4e7be28e8b8ce2"
},
{
"tokenid": "2",
"token": "fa1258a83d518eabd87698a96bd7f07e5a6ae8aeb8463cae33d50b91dd21bd6d"
}
],
"id": 0
}
```
#### 生成多个令牌
生成两个令牌。
请求:
```json
{
"jsonrpc": "2.0",
"method": "token.generate",
"params": [
"1",
"2"
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"tokenid": "1",
"token": "bbcfce79a2d95037502f7e9a534906d3466c9a1484beb6ea0f4e7be28e8b8ce2"
},
{
"tokenid": "2",
"token": "fa1258a83d518eabd87698a96bd7f07e5a6ae8aeb8463cae33d50b91dd21bd6d"
}
],
"id": 0
}
```
##### Generating from history/trends
Graphs can be drawn based on either item [history or
trends](/manual/config/items/history_and_trends).
For the users who have frontend [debug
mode](/manual/web_interface/debug_mode) activated, a gray, vertical
caption is displayed at the bottom right of a graph indicating where the
data come from.
Several factors influence whether history of trends is used:
- longevity of item history. For example, item history can be kept for
14 days. In that case, any data older than the fourteen days will be
coming from trends.
```{=html}
<!-- -->
```
- data congestion in the graph. If the amount of seconds to display in
a horizontal graph pixel exceeds 3600/16, trend data are displayed
(even if item history is still available for the same period).
```{=html}
<!-- -->
```
- if trends are disabled, item history is used for graph building - if
available for that period. This is supported starting with Zabbix
2.2.1 (before, disabled trends would mean an empty graph for the
period even if item history was available).
##### 基于历史数据/趋势数据生成
图表可以基于监控项 [history or
trends](/manual/config/items/history_and_trends)绘制.
对于已激活前端[debug
mode](/manual/web_interface/debug_mode)的用户，图表右下角会显示一个灰色的垂直标注，指示数据来源.
以下因素会影响是否使用趋势历史数据:
- 监控项历史数据的保留时长. 例如，监控项历史数据可以保留
14 days. In that case, any data older than the fourteen days will be
coming from trends.
```{=html}
<!-- -->
```
- 图表中的数据密度. 如果图表中需要显示的秒数
a horizontal graph pixel exceeds 3600/16, trend data are displayed
(even if item history is still available for the same period).
```{=html}
<!-- -->
```
- 如果趋势功能被禁用，将使用监控项历史数据来构建图表 - 前提是该时间段的历史数据可用. 此功能从Zabbix 2.2.1开始支持(在此之前，禁用趋势功能意味着即使监控项历史数据可用，该时间段也会显示空白图表).
#### Generating PSK
For example, a 256-bit (32 bytes) PSK can be generated using the
following commands:
- with *OpenSSL*:
```{=html}
<!-- -->
```
$ openssl rand -hex 32
af8ced32dfe8714e548694e2d29e1a14ba6fa13f216cb35c19d0feb1084b0429
- with *GnuTLS*:
```{=html}
<!-- -->
```
$ psktool -u psk_identity -p database.psk -s 32
Generating a random key for user 'psk_identity'
Key stored to database.psk
$ cat database.psk
psk_identity:9b8eafedfaae00cece62e85d5f4792c7d9c9bcc851b23216a1d300311cc4f7cb
Note that "psktool" above generates a database file with a PSK identity
and its associated PSK. Zabbix expects just a PSK in the PSK file, so
the identity string and colon (':') should be removed from the file.
#### 生成 PSK
例如，可以使用256位（32字节）PSK生成
以下命令：
- 使用*OpenSSL*:
```{=html}
<!-- -->
```
$ openssl rand -hex 32
af8ced32dfe8714e548694e2d29e1a14ba6fa13f216cb35c19d0feb1084b0429
- 使用*GnuTLS*:
```{=html}
<!-- -->
```
$ psktool -u psk_identity -p database.psk -s 32
为用户'psk_identity'生成随机密钥
密钥已存储至数据库.psk
$ cat database.psk
psk_identity:9b8eafedfaae00cece62e85d5f4792c7d9c9bcc851b23216a1d300311cc4f7cb
请注意，上述"psktool"会生成一个包含PSK身份标识的数据库file
及其关联的PSK。Zabbix在PSK file中仅期望一个PSK，因此
标识string和冒号(':')应从file中移除。
#### Geomap
A new geomap widget for the dashboards has been introduced providing a way to display hosts on geographical maps. For
more information see the *Geomap*
[dashboard widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap) and
[geographical maps](/manual/web_interface/frontend_sections/administration/general#geographical_maps).
#### 地理地图
仪表板新增了一个地理地图部件，提供了在地理地图上显示主机的功能。更多信息请参阅*地理地图*
[dashboard widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)和
[地理地图](/manual/web_interface/frontend_sections/administration/general#地理地图)。
##### Geomap widget
A new geomap widget for the dashboards has been introduced providing a
way to display hosts on geographical maps. For more information see
the *Geomap* [dashboard
widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)
and [geographical
maps](/manual/web_interface/frontend_sections/administration/general#geographical_maps).
#### Host editing as popup
The form for host creation and editing is now opened in a modal (popup)
window, in *Configuration* → *Hosts*, *Monitoring* → *Hosts* and in any
page, where there is a host menu or other direct link to the host
configuration.
Direct links to the host edit page still work and are opening the host
edit page in full page.
#### Geomap widget error
The maps in the Geomap widget may not load correctly, if you have upgraded from an older Zabbix version with NGINX and didn't switch to the new NGINX configuration file during the upgrade.
To fix the issue, you can discard the old configuration file, use the configuration file from 6.0 package and reconfigure it as described in the [download instructions](https://www.zabbix.com/download?zabbix=6.0&os_distribution=red_hat_enterprise_linux&os_version=8&db=mysql&ws=nginx) in section *e. Configure PHP for Zabbix frontend*.
Alternatively, you can manually edit an existing NGINX configuration file (typically, */etc/zabbix/nginx.conf*). To do so, open the file and locate the following block:
location ~ /(api\/|conf[^\.]|include|locale|vendor) {
deny all;
return 404;
}
Then, replace this block with:
location ~ /(api\/|conf[^\.]|include|locale) {
deny all;
return 404;
}
location /vendor {
deny all;
return 404;
}
#### Geomap widget error
如果您从旧版Zabbix version升级而来且仍在使用nginx，且在升级过程中未切换到新的nginx配置file，Geomap小部件中的地图可能无法正确加载。
要修复问题，您可以丢弃旧配置file，使用6.0软件包中的配置file，并按照[download instructions](https://www.zabbix.com/download?zabbix=6.0&os_distribution=red_hat_enterprise_linux&os_version=8&db=mysql&ws=nginx)中*e. 为Zabbix前端配置PHP*章节所述重新配置。
或者，您可以手动编辑现有的nginx配置file（通常为*/etc/zabbix/nginx.conf*）。为此，请打开file并找到以下代码块：
location ~ /(api\/|conf[^\.]|include|locale|vendor) {
deny all;
return 404;
}
然后，将此代码块替换为：
location ~ /(api\/|conf[^\.]|include|locale) {
deny all;
return 404;
}
location /vendor {
deny all;
return 404;
}
#### Get a count of standby nodes
Request:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"countOutput": true,
"filter": {
"status": 0
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": "3",
"id": 1
}
```
#### 获取备用节点数量
请求:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"countOutput": true,
"filter": {
"status": 0
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": "3",
"id": 1
}
```
#### Get a list of nodes ordered by status
Request:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"preservekeys": true,
"sortfield": "status",
"sortorder": "DESC"
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"ckuo7i1nw000h0sajj3l3hh8u": {
"ha_nodeid": "ckuo7i1nw000h0sajj3l3hh8u",
"name": "node-active",
"address": "192.168.1.13",
"port": "10051",
"lastaccess": "1635335704",
"status": "3"
},
"ckuo7i1nw000e0sajwfttc1mp": {
"ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
"name": "node6",
"address": "192.168.1.10",
"port": "10053",
"lastaccess": "1635332902",
"status": "2"
},
"ckuo7i1nv000c0sajz85xcrtt": {
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"name": "node4",
"address": "192.168.1.8",
"port": "10052",
"lastaccess": "1635334214",
"status": "1"
},
"ckuo7i1nv000a0saj1fcdkeu4": {
"ha_nodeid": "ckuo7i1nv000a0saj1fcdkeu4",
"name": "node2",
"address": "192.168.1.6",
"port": "10051",
"lastaccess": "1635335705",
"status": "0"
}
},
"id": 1
}
```
#### 获取按状态排序的节点列表
请求:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"preservekeys": true,
"sortfield": "status",
"sortorder": "DESC"
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"ckuo7i1nw000h0sajj3l3hh8u": {
"ha_nodeid": "ckuo7i1nw000h0sajj3l3hh8u",
"name": "node-active",
"address": "192.168.1.13",
"port": "10051",
"lastaccess": "1635335704",
"status": "3"
},
"ckuo7i1nw000e0sajwfttc1mp": {
"ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
"name": "node6",
"address": "192.168.1.10",
"port": "10053",
"lastaccess": "1635332902",
"status": "2"
},
"ckuo7i1nv000c0sajz85xcrtt": {
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"name": "node4",
"address": "192.168.1.8",
"port": "10052",
"lastaccess": "1635334214",
"status": "1"
},
"ckuo7i1nv000a0saj1fcdkeu4": {
"ha_nodeid": "ckuo7i1nv000a0saj1fcdkeu4",
"name": "node2",
"address": "192.168.1.6",
"port": "10051",
"lastaccess": "1635335705",
"status": "0"
}
},
"id": 1
}
```
#### Get a list of specific nodes by their IDs
Request:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"]
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"name": "node4",
"address": "192.168.1.8",
"port": "10052",
"lastaccess": "1635334214",
"status": "1"
},
{
"ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
"name": "node6",
"address": "192.168.1.10",
"port": "10053",
"lastaccess": "1635332902",
"status": "2"
}
],
"id": 1
}
```
#### 按节点ID获取特定节点列表
请求:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"]
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"name": "node4",
"address": "192.168.1.8",
"port": "10052",
"lastaccess": "1635334214",
"status": "1"
},
{
"ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
"name": "node6",
"address": "192.168.1.10",
"port": "10053",
"lastaccess": "1635332902",
"status": "2"
}
],
"id": 1
}
```
#### Get a list of stopped nodes
Request:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["ha_nodeid", "address", "port"],
"filter": {
"status": 1
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"ha_nodeid": "ckuo7i1nw000g0sajjsjre7e3",
"address": "192.168.1.12",
"port": "10051"
},
{
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"address": "192.168.1.8",
"port": "10052"
},
{
"ha_nodeid": "ckuo7i1nv000d0sajd95y1b6x",
"address": "192.168.1.9",
"port": "10053"
}
],
"id": 1
}
```
#### 获取已停止节点列表
请求:
```json
{
"jsonrpc": "2.0",
"method": "hanode.get",
"params": {
"output": ["ha_nodeid", "address", "port"],
"filter": {
"status": 1
}
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": [
{
"ha_nodeid": "ckuo7i1nw000g0sajjsjre7e3",
"address": "192.168.1.12",
"port": "10051"
},
{
"ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
"address": "192.168.1.8",
"port": "10052"
},
{
"ha_nodeid": "ckuo7i1nv000d0sajd95y1b6x",
"address": "192.168.1.9",
"port": "10053"
}
],
"id": 1
}
```
#### Getting Java gateway
You can install Java gateway either from the sources or packages
downloaded from [Zabbix website](http://www.zabbix.com/download.php).
Using the links below you can access information how to get and run
Zabbix Java gateway, how to configure Zabbix server (or Zabbix proxy) to
use Zabbix Java gateway for JMX monitoring, and how to configure Zabbix
items in Zabbix frontend that correspond to particular JMX counters.
|Installation from|Instructions|Instructions|
|-----------------|------------|------------|
|*Sources*|[Installation](/manual/installation/install#installing_java_gateway)|[Setup](/manual/concepts/java/from_sources)|
|*RHEL packages*|[Installation](/manual/installation/install_from_packages/rhel#java_gateway_installation)|[Setup](/manual/concepts/java/from_rhel)|
|*Debian/Ubuntu packages*|[Installation](/manual/installation/install_from_packages/debian_ubuntu#java_gateway_installation)|[Setup](/manual/concepts/java/from_debian_ubuntu)|
#### 获取 Java 网关
您可以从源代码或从[Zabbix website](http://www.zabbix.com/download.php)下载的软件包安装Java网关。
通过以下链接，您可以获取有关如何get和run
Zabbix Java网关的信息，如何配置Zabbix server（或Zabbix proxy）以
使用Zabbix Java网关进行JMX监控，以及如何在Zabbix前端配置与特定JMX计数器对应的Zabbix
监控项。
| 安装来源 | 安装说明 | 配置说明 |
|-----------------|------------|------------|
| *源代码* | [安装java网关](/manual/installation/install#安装java网关) | [Setup](/manual/concepts/java/from_sources) |
| *RHEL软件包* | [java网关安装](/manual/installation/install_from_packages/rhel#java网关安装) | [Setup](/manual/concepts/java/from_rhel) |
| *Debian/Ubuntu软件包* | [java网关安装](/manual/installation/install_from_packages/debian_ubuntu#java网关安装) | [Setup](/manual/concepts/java/from_debian_ubuntu) |
##### Getting the list of items
**Agent request**
The active checks request is used to obtain the active checks to be processed by agent. This request is sent by the agent upon start and then with _RefreshActiveChecks_ intervals.
```json
{
"request": "active checks",
"host": "Zabbix server",
"host_metadata": "mysql,nginx",
"interface": "zabbix.server.lan",
"ip": "159.168.1.1",
"port": 12050
}
```
| Field | Type | Mandatory | Value |
|-|-|-|--------|
| request | _string_ | yes | `active checks` |
| host | _string_ | yes | Host name. |
| host_metadata | _string_ | no | The configuration parameter HostMetadata or HostMetadataItem metric value. |
| interface | _string_ | no | The configuration parameter HostInterface or HostInterfaceItem metric value. |
| ip | _string_ | no | The configuration parameter ListenIP first IP if set. |
| port | _number_ | no | The configuration parameter ListenPort value if set and not default agent listening port. |
**Server response**
The active checks response is sent by the server back to agent after processing the active checks request.
```json
{
"response": "success",
"data": [
{
"key": "log[/home/zabbix/logs/zabbix_agentd.log]",
"key_orig": "log[/home/zabbix/logs/zabbix_agentd.log]",
"itemid": 1234,
"delay": 30,
"lastlogsize": 0,
"mtime": 0
},
{
"key": "agent.version",
"key_orig": "agent.version",
"itemid": 5678,
"delay": 10,
"lastlogsize": 0,
"mtime": 0
}
]
}
```
| Field |<| Type | Mandatory | Value |
|-|------|--|-|-----------------------|
| response |<| _string_ | yes | `success` \| `failed` |
| info |<| _string_ | no | Error information in the case of failure. |
| data |<| _array of objects_ | no | Active check items. |
| | key | _string_ | no | Item key with expanded macros. |
|^| key_orig | _string_ | no | Item key without expanded macros. |
|^| itemid | _number_ | no | Item identifier. |
|^| delay | _integer_ | no | Item update interval. |
|^| lastlogsize | _number_ | no | Item lastlogsize. |
|^| mtime | _number_ | no | Item mtime. |
| refresh_unsupported |<| _number_ | no | Unsupported item refresh interval. |
| regexp |<| _array of objects_ | no | Global regular expressions. |
| | name | _string_ | no | Global regular expression name. |
|^| expression | _string_ | no | Global regular expression. |
|^| expression_type | _number_ | no | Global regular expression type. |
|^| exp_delimiter | _string_ | no | Global regular expression delimiter. |
|^| case_sensitive | _number_ | no | Global regular expression case sensitivity setting. |
The server must respond with success.
For example:
1. Agent opens a TCP connection
2. Agent asks for the list of checks
3. Server responds with a list of items (item key, delay)
4. Agent parses the response
5. TCP connection is closed
6. Agent starts periodical collection of data
::: noteimportant
Note that (sensitive) configuration data may
become available to parties having access to the Zabbix server trapper
port when using an active check. This is possible because anyone may
pretend to be an active agent and request item configuration data;
authentication does not take place unless you use
[encryption](/manual/encryption) options.
:::
##### 获取监控项列表
**Agent请求**
主动检查请求用于获取需要由agent处理的主动检查项。该请求由agent在启动时发送，之后按照_RefreshActiveChecks_间隔定期发送。
```json
{
"request": "active checks",
"host": "Zabbix server",
"host_metadata": "mysql,nginx",
"interface": "zabbix.server.lan",
"ip": "159.168.1.1",
"port": 12050
}
```
| 字段 | 类型 | 必填 | 值 |
|-|-|-|--------|
| request | _string_ | yes | `active checks` |
| host | _string_ | yes | 主机名. |
| host_metadata | _string_ | no | 配置参数HostMetadata或HostMetadataItem的指标值。 |
| interface | _string_ | no | 配置参数HostInterface或HostInterfaceItem的指标值。 |
| ip | _string_ | no | 配置参数ListenIP的首个IP（如设置）。 |
| port | _number_ | no | 配置参数ListenPort的值（如设置且非默认agent监听端口）。 |
**服务器响应**
服务器在处理完主动检查请求后，会向agent返回主动检查响应。
```json
{
"response": "success",
"data": [
{
"key": "log[/home/zabbix/logs/zabbix_agentd.log]",
"key_orig": "log[/home/zabbix/logs/zabbix_agentd.log]",
"itemid": 1234,
"delay": 30,
"lastlogsize": 0,
"mtime": 0
},
{
"key": "agent.version",
"key_orig": "agent.version",
"itemid": 5678,
"delay": 10,
"lastlogsize": 0,
"mtime": 0
}
]
}
```
| 字段 | < | 类型 | 必填 | 值 |
|-|------|--|-|-----------------------|
| response | < | _string_ | yes | `success` \ | `failed` |
| info | < | _string_ | no | 失败时的错误信息。 |
| data | < | _array of objects_ | no | 主动检查监控项。 |
| | key | _string_ | no | 展开宏后的监控项键值。 |
| ^ | key_orig | _string_ | no | 未展开宏的监控项键值。 |
| ^ | itemid | _number_ | no | 监控项标识符。 |
| ^ | delay | _integer_ | no | 监控项update间隔。 |
| ^ | lastlogsize | _number_ | no | 监控项lastlogsize值。 |
| ^ | mtime | _number_ | no | 监控项mtime值。 |
| refresh_unsupported | < | _number_ | no | 不支持的监控项刷新间隔。 |
| regexp | < | _array of objects_ | no | 全局正则表达式。 |
| | name | _string_ | no | 全局正则表达式名称。 |
| ^ | expression | _string_ | no | 全局正则表达式。 |
| ^ | expression_type | _number_ | no | 全局正则表达式类型。 |
| ^ | exp_delimiter | _string_ | no | 全局正则表达式分隔符。 |
| ^ | case_sensitive | _number_ | no | 全局正则表达式大小写敏感设置。 |
服务器必须返回成功响应。
例如：
1. Agent建立TCP连接
2. Agent请求检查项列表
3. 服务器返回监控项列表（监控项键值、间隔时间）
4. Agent解析响应
5. 关闭TCP连接
6. Agent开始周期性数据采集
::: noteimportant
注意：当使用主动检查时，（敏感）配置数据可能
被能够访问Zabbix server trapper端口的第三方获取。
这是因为任何人都可以伪装成主动agent并请求监控项配置数据；
除非使用[encryption](/manual/encryption)选项，否则不会进行身份验证。
:::
#### Global event correlation
Events may not get correlated correctly if the time interval between the
first and second event is very small, i.e. half a second and less.
#### 全局事件关联
如果第一个事件和第二个事件之间的时间间隔非常小（即半秒或更短），事件可能无法get正确关联。
### Global macro
The global macro object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|globalmacroid|string|*(readonly)* ID of the global macro.|
|**macro**<br>(required)|string|Macro string.|
|**value**<br>(required)|string|Value of the macro.|
|type|integer|Type of macro.<br><br>Possible values:<br>0 - *(default)* Text macro;<br>1 - Secret macro;<br>2 - Vault secret.|
|description|string|Description of the macro.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 全局宏
全局宏object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| globalmacroid | string | *(只读)* 全局宏的ID. |
| **macro**<br>(required) | string | 宏string. |
| **value**<br>(required) | string | 宏的值. |
| type | integer | 宏类型.<br><br>可能的值:<br>0 - *(默认)* 文本宏;<br>1 - 加密宏;<br>2 - 保险库加密. |
| description | string | 宏的描述. |
注意对于某些方法(update, delete)，必需/可选参数的组合会有所不同.
##### Global messages displayed
As the messages arrive, they are displayed in a floating section on the
right hand side. This section can be repositioned freely by dragging the
section header.
For this section, several controls are available:
- 
**Snooze** button silences the currently active alarm sound;
- 
**Mute/Unmute** button switches between playing and not playing the
alarm sounds at all.
##### 全局显示消息
当消息到达时，它们会显示在右侧的浮动区域中。该区域可以通过拖动区域标题自由重新定位。
对于此区域，提供了多个控制选项：
- 
**暂停**按钮可静音当前活动的警报声；
- 
**静音/取消静音**按钮可在完全播放和不播放警报声之间切换。
### Go library for Windows updated
Go library used by Zabbix agent 2 in conjunction with MongoDB or PostgreSQL plugins to monitor Windows
now is `github.com/Microsoft/go-winio`, version 0.6.0 (previously `github.com/natefinch/npipe`).
See also [Agent 2 requirements](/manual/installation/requirements#agent-2).
### Windows 版 Go 库已更新
由Zabbix agent 2与MongoDB或PostgreSQL插件配合使用的Go库，用于监控Windows系统
现已更新为`github.com/Microsoft/go-winio`，version 0.6.0版本（之前为`github.com/natefinch/npipe`）。
另请参阅[agent-2](/manual/installation/requirements#agent-2)。
### Google Cloud Platform Monitoring
A new [template](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/gcp) *Google Cloud Platform by HTTP (GCP by HTTP)* is available.
See setup instructions for [HTTP templates](/manual/config/templates_out_of_the_box/http).
You can get this template:
- In *Configuration → Templates* in new installations.
- When upgrading from previous versions, the latest templates can be
downloaded from the [Zabbix Git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates?at=refs%2Fheads%2Frelease%2F6.0)
and manually imported into Zabbix in the *Configuration* →
*Templates* section. If a template with the same name already
exists, check the *Delete missing* option before importing to
achieve a clean import. This way the items that have been excluded
from the updated template will be removed (note that history of the
deleted items will be lost).
### Google Cloud Platform 监控
新增[template](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/gcp)*Google Cloud Platform by HTTP (GCP by HTTP)*模板可用。
查看[HTTP templates](/manual/config/templates_out_of_the_box/http)的设置说明。
您可以通过以下方式get此模板：
- 在新安装的Zabbix中，通过*配置 → 模板*菜单
- 从旧版本升级时，可从[Zabbix Git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates?at=refs%2Fheads%2Frelease%2F6.0)下载最新模板，
并通过*配置*→*模板*部分手动导入至Zabbix。若已存在同名模板，
导入前请勾选*删除缺失项*选项以实现import的清理。
此操作将移除更新模板中已排除的监控项（注意：被删除监控项的历史数据将丢失）。
# graph.create
# graph.create
# graph.delete
# graph.delete
# graph.get
# graph.get
# graphitem.get
# graphitem.get
### Graph item
::: noteclassic
Graph items can only be modified via the `graph`
API.
:::
The graph item object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|gitemid|string|*(readonly)* ID of the graph item.|
|**color**<br>(required)|string|Graph item's draw color as a hexadecimal color code.|
|**itemid**<br>(required)|string|ID of the item.|
|calc\_fnc|integer|Value of the item that will be displayed.<br><br>Possible values:<br>1 - minimum value;<br>2 - *(default)* average value;<br>4 - maximum value;<br>7 - all values;<br>9 - last value, used only by pie and exploded graphs.|
|drawtype|integer|Draw style of the graph item.<br><br>Possible values:<br>0 - *(default)* line;<br>1 - filled region;<br>2 - bold line;<br>3 - dot;<br>4 - dashed line;<br>5 - gradient line.|
|graphid|string|ID of the graph that the graph item belongs to.|
|sortorder|integer|Position of the item in the graph.<br><br>Default: starts with 0 and increases by one with each entry.|
|type|integer|Type of graph item.<br><br>Possible values:<br>0 - *(default)* simple;<br>2 - graph sum, used only by pie and exploded graphs.|
|yaxisside|integer|Side of the graph where the graph item's Y scale will be drawn.<br><br>Possible values:<br>0 - *(default)* left side;<br>1 - right side.|
### 图表 监控项
::: noteclassic
图表监控项只能通过`graph`
API进行修改.
:::
图表监控项object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| gitemid | string | *(只读)* 图表监控项的ID. |
| **color**<br>(required) | string | 图表监控项的绘制颜色(十六进制颜色代码). |
| **itemid**<br>(required) | string | 监控项的ID. |
| calc\_fnc | integer | 图表监控项显示的值.<br><br>可选值:<br>1 - 最小值;<br>2 - *(默认)* 平均值;<br>4 - 最大值;<br>7 - 所有值;<br>9 - 最后值(仅用于饼图和爆炸图). |
| drawtype | integer | 图表监控项的绘制样式.<br><br>可选值:<br>0 - *(默认)* 线形;<br>1 - 填充区域;<br>2 - 粗线;<br>3 - 点状;<br>4 - 虚线;<br>5 - 渐变线. |
| graphid | string | 图表监控项所属图表的ID. |
| sortorder | integer | 监控项在图表中的位置.<br><br>默认: 从0开始,每个条目递增1. |
| type | integer | 图表监控项的类型.<br><br>可选值:<br>0 - *(默认)* 简单类型;<br>2 - 图表总和(仅用于饼图和爆炸图). |
| yaxisside | integer | 图表监控项Y轴显示的侧边.<br><br>可选值:<br>0 - *(默认)* 左侧;<br>1 - 右侧. |
# graphprototype.create
# graphprototype.create
# graphprototype.delete
# graphprototype.delete
# graphprototype.get
# graphprototype.get
#### Graph prototypes
The following screenshot illustrates how we can use these macros in
graph prototypes:
{width="600"}
{width="600"}
A summary of our discovery rule:
{width="600"}
#### 图形原型
以下截图展示了如何在图形原型中使用这些宏:
{width="600"}
{width="600"}
我们的发现规则摘要:
{width="600"}
### Graph prototype
The graph prototype object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|graphid|string|*(readonly)* ID of the graph prototype.|
|**height**<br>(required)|integer|Height of the graph prototype in pixels.|
|**name**<br>(required)|string|Name of the graph prototype.|
|**width**<br>(required)|integer|Width of the graph prototype in pixels.|
|graphtype|integer|Graph prototypes's layout type.<br><br>Possible values:<br>0 - *(default)* normal;<br>1 - stacked;<br>2 - pie;<br>3 - exploded.|
|percent\_left|float|Left percentile.<br><br>Default: 0.|
|percent\_right|float|Right percentile.<br><br>Default: 0.|
|show\_3d|integer|Whether to show discovered pie and exploded graphs in 3D.<br><br>Possible values:<br>0 - *(default)* show in 2D;<br>1 - show in 3D.|
|show\_legend|integer|Whether to show the legend on the discovered graph.<br><br>Possible values:<br>0 - hide;<br>1 - *(default)* show.|
|show\_work\_period|integer|Whether to show the working time on the discovered graph.<br><br>Possible values:<br>0 - hide;<br>1 - *(default)* show.|
|templateid|string|*(readonly)* ID of the parent template graph prototype.|
|yaxismax|float|The fixed maximum value for the Y axis.|
|yaxismin|float|The fixed minimum value for the Y axis.|
|ymax\_itemid|string|ID of the item that is used as the maximum value for the Y axis.<br><br>Starting with Zabbix 6.0.7, if user have no access to specified item, the graph is rendered like ymax\_type would be set to '0' (calculated).|
|ymax\_type|integer|Maximum value calculation method for the Y axis.<br><br>Possible values:<br>0 - *(default)* calculated;<br>1 - fixed;<br>2 - item.|
|ymin\_itemid|string|ID of the item that is used as the minimum value for the Y axis.<br><br>Starting with Zabbix 6.0.7, if user have no access to specified item, the graph is rendered like ymin\_type would be set to '0' (calculated).|
|ymin\_type|integer|Minimum value calculation method for the Y axis.<br><br>Possible values:<br>0 - *(default)* calculated;<br>1 - fixed;<br>2 - item.|
|discover|integer|Graph prototype discovery status.<br><br>Possible values:<br>0 - *(default)* new graphs will be discovered;<br>1 - new graphs will not be discovered and existing graphs will be marked as lost.|
|uuid|string|Universal unique identifier, used for linking imported graph prototypes to already existing ones. Used only for graph prototypes on templates. Auto-generated, if not given.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 图形原型
图形原型object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| graphid | string | *(只读)* 图形原型的ID。 |
| **height**<br>(required) | integer | 图形原型的高度（像素）。 |
| **name**<br>(required) | string | 图形原型的名称。 |
| **width**<br>(required) | integer | 图形原型的宽度（像素）。 |
| graphtype | integer | 图形原型的布局类型。<br><br>可能值：<br>0 - *(默认)* 普通；<br>1 - 堆叠；<br>2 - 饼图；<br>3 - 爆炸图。 |
| percent\_left | float | 左侧百分比。<br><br>默认：0。 |
| percent\_right | float | 右侧百分比。<br><br>默认：0。 |
| show\_3d | integer | 是否以3D形式显示发现的饼图和爆炸图。<br><br>可能值：<br>0 - *(默认)* 以2D显示；<br>1 - 以3D显示。 |
| show\_legend | integer | 是否在发现的图形上显示图例。<br><br>可能值：<br>0 - 隐藏；<br>1 - *(默认)* 显示。 |
| show\_work\_period | integer | 是否在发现的图形上显示工作时间。<br><br>可能值：<br>0 - 隐藏；<br>1 - *(默认)* 显示。 |
| templateid | string | *(只读)* 父模板图形原型的ID。 |
| yaxismax | float | Y轴的固定最大值。 |
| yaxismin | float | Y轴的固定最小值。 |
| ymax\_itemid | string | 用作Y轴最大值的监控项的ID。<br><br>从Zabbix 6.0.7开始，如果用户无权访问指定的监控项，图形将按照ymax\_type设置为'0'（计算值）的方式渲染。 |
| ymax\_type | integer | Y轴最大值的计算方法。<br><br>可能值：<br>0 - *(默认)* 计算；<br>1 - 固定；<br>2 - 监控项。 |
| ymin\_itemid | string | 用作Y轴最小值的监控项的ID。<br><br>从Zabbix 6.0.7开始，如果用户无权访问指定的监控项，图形将按照ymin\_type设置为'0'（计算值）的方式渲染。 |
| ymin\_type | integer | Y轴最小值的计算方法。<br><br>可能值：<br>0 - *(默认)* 计算；<br>1 - 固定；<br>2 - 监控项。 |
| discover | integer | 图形原型的发现状态。<br><br>可能值：<br>0 - *(默认)* 将发现新图形；<br>1 - 不会发现新图形且现有图形将被标记为丢失。 |
| uuid | string | 通用唯一标识符，用于将导入的图形原型链接到已存在的图形原型。仅用于模板上的图形原型。如果未提供，则自动生成。 |
请注意，某些方法（update、delete）所需的/可选参数组合是不同的。
# graphprototype.update
# graphprototype.update
#### Graphs
##### Daylight Saving Time
Changes to Daylight Saving Time (DST) result in irregularities when
displaying X axis labels (date duplication, date missing, etc.).
##### Sum aggregation
When using [sum aggregation](/manual/config/visualization/graphs/aggregate#configuration)
in a graph for period that is less than one hour, graphs display
incorrect (multiplied) values when data come from trends.
##### Text overlapping
For some frontend languages (e.g., Japanese), local fonts can cause text overlapping in graph legend.
To avoid this, use version 2.3.0 (or later) of PHP GD extension.
#### 图形
##### 夏令时
夏令时(DST)变更会导致X轴标签显示异常(日期重复、日期缺失等).
##### 求和聚合
当在不足一小时的图表周期中使用[配置](/manual/config/visualization/graphs/aggregate#配置)时，
若数据来自趋势数据，图表会显示错误(翻倍)的数值.
##### 文本重叠
某些前端语言(如日语)使用本地字体可能导致图例文本重叠.
为避免此问题，请使用PHP GD扩展的version 2.3.0(或更高版本).
#### Graphs
Edit graphs or separate graph items for better presentation of the
gathered data.
[Graph API](/manual/api/reference/graph) | [Graph item
API](/manual/api/reference/graphitem)
#### 图形
编辑图表或单独的图形监控项以更好地展示收集的数据。
[Graph API](/manual/api/reference/graph) | [Graph item
API](/manual/api/reference/graphitem)
##### Graphs
With the item working for a while, it might be time to see something
visual. [Simple graphs](/manual/config/visualization/graphs/simple) are
available for any monitored numeric item without any additional
configuration. These graphs are generated on runtime.
To view the graph, go to *Monitoring → Latest data* and click on the
'Graph' link next to the item.
{width="600"}
##### 图形
当监控项运行一段时间后，可能是时候查看一些可视化内容了。[Simple graphs](/manual/config/visualization/graphs/simple)可用于任何受监控的数值型监控项，无需额外配置。这些图表是在运行时生成的。
要查看图表，请转到*Monitoring → Latest data*，然后点击监控项旁边的'Graph'链接。
{width="600"}
### Graph
The graph object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|graphid|string|*(readonly)* ID of the graph.|
|**height**<br>(required)|integer|Height of the graph in pixels.|
|**name**<br>(required)|string|Name of the graph|
|**width**<br>(required)|integer|Width of the graph in pixels.|
|flags|integer|*(readonly)* Origin of the graph.<br><br>Possible values are:<br>0 - *(default)* a plain graph;<br>4 - a discovered graph.|
|graphtype|integer|Graph's layout type.<br><br>Possible values:<br>0 - *(default)* normal;<br>1 - stacked;<br>2 - pie;<br>3 - exploded.|
|percent\_left|float|Left percentile.<br><br>Default: 0.|
|percent\_right|float|Right percentile.<br><br>Default: 0.|
|show\_3d|integer|Whether to show pie and exploded graphs in 3D.<br><br>Possible values:<br>0 - *(default)* show in 2D;<br>1 - show in 3D.|
|show\_legend|integer|Whether to show the legend on the graph.<br><br>Possible values:<br>0 - hide;<br>1 - *(default)* show.|
|show\_work\_period|integer|Whether to show the working time on the graph.<br><br>Possible values:<br>0 - hide;<br>1 - *(default)* show.|
|show\_triggers|integer|Whether to show the trigger line on the graph.<br><br>Possible values:<br>0 - hide;<br>1 - *(default)* show.|
|templateid|string|*(readonly)* ID of the parent template graph.|
|yaxismax|float|The fixed maximum value for the Y axis.<br><br>Default: 100.|
|yaxismin|float|The fixed minimum value for the Y axis.<br><br>Default: 0.|
|ymax\_itemid|string|ID of the item that is used as the maximum value for the Y axis.<br><br>Starting with Zabbix 6.0.7, if user have no access to specified item, the graph is rendered like ymax\_type would be set to '0' (calculated).|
|ymax\_type|integer|Maximum value calculation method for the Y axis.<br><br>Possible values:<br>0 - *(default)* calculated;<br>1 - fixed;<br>2 - item.|
|ymin\_itemid|string|ID of the item that is used as the minimum value for the Y axis.<br><br>Starting with Zabbix 6.0.7, if user have no access to specified item, the graph is rendered like ymax\_type would be set to '0' (calculated).|
|ymin\_type|integer|Minimum value calculation method for the Y axis.<br><br>Possible values:<br>0 - *(default)* calculated;<br>1 - fixed;<br>2 - item.|
|uuid|string|Universal unique identifier, used for linking imported graphs to already existing ones. Used only for graphs on templates. Auto-generated, if not given.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 图表
该图表 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| graphid | string | *(只读)* 图表的ID。 |
| **height**<br>(required) | integer | 图表的高度（以像素为单位）。 |
| **name**<br>(required) | string | 图表的名称 |
| **width**<br>(required) | integer | 图表的宽度（以像素为单位）。 |
| flags | integer | *(只读)* 图表的来源。<br><br>可能的值有：<br>0 - *(默认)* 普通图表；<br>4 - 发现的图表。 |
| graphtype | integer | 图表的布局类型。<br><br>可能的值：<br>0 - *(默认)* 普通；<br>1 - 堆叠；<br>2 - 饼图；<br>3 - 爆炸图。 |
| percent\_left | float | 左侧百分位数。<br><br>默认值：0。 |
| percent\_right | float | 右侧百分位数。<br><br>默认值：0。 |
| show\_3d | integer | 是否以3D形式显示饼图和爆炸图。<br><br>可能的值：<br>0 - *(默认)* 以2D显示；<br>1 - 以3D显示。 |
| show\_legend | integer | 是否在图表上显示图例。<br><br>可能的值：<br>0 - 隐藏；<br>1 - *(默认)* 显示。 |
| show\_work\_period | integer | 是否在图表上显示工作时间。<br><br>可能的值：<br>0 - 隐藏；<br>1 - *(默认)* 显示。 |
| show\_triggers | integer | 是否在图表上显示触发器线。<br><br>可能的值：<br>0 - 隐藏；<br>1 - *(默认)* 显示。 |
| templateid | string | *(只读)* 父模板图表的ID。 |
| yaxismax | float | Y轴的固定最大值。<br><br>默认值：100。 |
| yaxismin | float | Y轴的固定最小值。<br><br>默认值：0。 |
| ymax\_itemid | string | 用作Y轴最大值的 监控项 的ID。<br><br>从Zabbix 6.0.7开始，如果用户无权访问指定的 监控项，图表将按照ymax\_type设置为'0'（计算值）的方式渲染。 |
| ymax\_type | integer | Y轴最大值的计算方法。<br><br>可能的值：<br>0 - *(默认)* 计算值；<br>1 - 固定值；<br>2 - 监控项。 |
| ymin\_itemid | string | 用作Y轴最小值的 监控项 的ID。<br><br>从Zabbix 6.0.7开始，如果用户无权访问指定的 监控项，图表将按照ymax\_type设置为'0'（计算值）的方式渲染。 |
| ymin\_type | integer | Y轴最小值的计算方法。<br><br>可能的值：<br>0 - *(默认)* 计算值；<br>1 - 固定值；<br>2 - 监控项。 |
| uuid | string | 通用唯一标识符，用于将导入的图表链接到已存在的图表。仅用于模板上的图表。如果未提供，则自动生成。 |
请注意，某些方法（update, delete）所需的/可选参数组合是不同的。
# graph.update
# graph.update
### Group link
The group link object links a host prototype with a host group and has
the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**groupid**<br>(required)|string|ID of the host group.|
### 组链接
组链接object将一个主机原型与一个主机组关联，并具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **groupid**<br>(required) | string | 主机组的ID。 |
### Group prototype
The group prototype object defines a group that will be created for a
discovered host and has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**group_prototypeid**|string|*(readonly)* ID of the group prototype.|
|**name**<br>(required)|string|Name of the group prototype.|
### 组原型
组原型object定义了将为发现的主机创建的组，并具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **group_prototypeid** | string | *(只读)* 组原型的ID。 |
| **name**<br>(required) | string | 组原型的名称。 |
#### groups/group
|Parameter|Type|Description|Details|
|---------|----|-----------|-------|
|name|*string*|Group name.| |
#### groups/group
| 参数 | 类型 | 描述 | 详情 |
|---------|----|-----------|-------|
| name | *string* | 组名称. | |
#### GSM modem validation for SMS media type
In SMS media type configuration, the GSM modem path is now validated to be a modem device or symlink to such.
#### SMS 媒体类型的 GSM 调制解调器验证
在SMS媒介类型配置中，GSM调制解调器路径现在会被验证是否为调制解调器设备或其符号链接。
#### Guest user authorization
Automatic login for the guest user has been removed. After this change, the guest user will need to log in like any other user. Previously, a guest could immediately get to almost any monitoring or reporting page without going through authorization.
#### 访客用户授权
访客用户的自动login功能已被移除。此变更后，访客用户需要像其他用户一样登录系统。此前，访客无需经过授权即可立即get访问几乎所有的监控或报表页面。
#### GUI debugging
Problems related to the frontend performance may be diagnosed using the
frontend [debug mode](/manual/web_interface/debug_mode).
#### 图形用户界面调试
与前端性能相关的问题可以使用前端[ [调试模式](/manual/web_interface/debug_mode)。
### Handling of NaN values in Prometheus preprocessing
There is a new behavior for handling (skipping) NaN values. So, if a dataset consists of
valid numeric values and NaNs, then NaN values are skipped and:
- 'avg', 'max', 'min', 'sum' return a result that is calculated from the valid values
- 'count' returns the number of valid values
If all values in a dataset are NaNs then 'avg', 'max', 'min', and 'sum' return a "no data
(at least one value is required)" error, while 'count' returns 0.
Previously, if NaN was the first value in a dataset then:
- 'avg', 'max', 'min', 'sum' returned a "Value "NAN" of type "string" is not suitable for \
value type "Numeric (float)"" error
- 'count' returned the number of values (including NaN values)
Also previously, if NaN was not the first value in a dataset then:
- 'avg', 'sum' returned a "Value "NAN" of type "string" is not suitable for \
value type "Numeric (float)"" error
- 'max' returned the maximum of values until the first NaN was encountered
- 'min' returned the minimum of values until the first NaN was encountered
- 'count' returned the number of values (including NaN values)
### Prometheus 预处理中的 NaN 值处理
针对NaN值的处理(跳过)有了新的行为逻辑。当数据集包含有效数值和NaN值时，NaN值将被跳过且:
- 'avg', 'max', 'min', 'sum' 将基于有效值返回计算结果
- 'count' 返回有效值的数量
若数据集中所有值均为NaN，则'avg', 'max', 'min', 'sum' 返回"无数据(至少需要一个有效值)"错误，而'count'返回0。
在之前的版本中，当NaN是数据集的首个值时:
- 'avg', 'max', 'min', 'sum' 会返回"类型为"string"的值"NAN"不适用于数值类型(float)"错误
- 'count' 返回值的总数(包含NaN值)
同样在之前版本中，当NaN不是数据集的首个值时:
- 'avg', 'sum' 会返回"类型为"string"的值"NAN"不适用于数值类型(float)"错误
- 'max' 返回遇到首个NaN前的最大值
- 'min' 返回遇到首个NaN前的最小值
- 'count' 返回值的总数(包含NaN值)
#### Handling of regular expression compilation and runtime errors
If a regular expression used in `log[]`, `logrt[]`, `log.count[]` or `logrt.count[]` item cannot be compiled by PCRE or PCRE2 library then the item goes into NOTSUPPORTED state with an error message. To continue monitoring the log item, the regular expression should be fixed.
If the regular expression compiles successfully, but fails at runtime (on some or on all log records), then the log item remains supported and monitoring continues. The runtime error is logged in the Zabbix agent log file (without the log file record).
Note that the logging of regular expression runtime errors is supported since Zabbix 6.0.21.
The logging rate is limited to one runtime error per check to allow Zabbix agent to monitor its own log file. For example, if 10 records are analyzed and 3 records fail with a regexp runtime error, one record is produced in the agent log.
Exception: if MaxLinesPerSecond=1 and update interval=1 (only 1 record is allowed to analyze per check) then regexp runtime errors are not logged.
zabbix_agentd logs the item key in case of a runtime error, zabbix_agent2 logs the item ID to help identify which log item has runtime errors. It is recommended to redesign the regular expression in case of runtime errors.
#### 正则表达式编译与运行时错误的处理
如果在`log[]`、`logrt[]`、`log.count[]`或`logrt.count[]`监控项中使用的正则表达式无法被PCRE或PCRE2库编译，则该监控项会进入NOTSUPPORTED状态并显示错误消息。要继续监控日志监控项，应修复正则表达式。
如果正则表达式编译成功，但在运行时失败（在某些或所有日志记录上），则日志监控项仍保持支持状态并继续监控。运行时错误会被记录在Zabbix agent日志file中（不包含日志file记录）。
请注意，正则表达式运行时错误的记录功能自Zabbix 6.0.21起支持。
记录速率限制为每次检查一个运行时错误，以便Zabbix agent可以监控其自身的日志file。例如，如果分析了10条记录，其中3条记录因正则表达式运行时错误而失败，则会在agent日志中生成一条记录。
例外情况：如果MaxLinesPerSecond=1且update间隔=1（每次检查仅允许分析1条记录），则不会记录正则表达式运行时错误。
zabbix_agentd会在运行时错误时记录监控项键，zabbix_agent2则会记录监控项 ID以帮助识别哪个日志监控项存在运行时错误。建议在出现运行时错误时重新设计正则表达式。
# hanode.get
# hanode.get
#### Hardware
#### 硬件
#### Hardware
General advice on hardware:
- Use fastest processor available
- SCSI or SAS is better than IDE (performance of IDE disks may be
significantly improved by using utility hdparm) and SATA
- 15K RPM is better than 10K RPM which is better than 7200 RPM
- Use fast RAID storage
- Use fast Ethernet adapter
- Having more memory is always better
#### 硬件
关于硬件的一些建议：
- 使用最快的处理器
- SCSI 或 SAS 优于 IDE（使用实用程序 hdparm 可以显着提高 IDE 磁盘的性能）和 SATA
- 15K RPM 优于 10K RPM，10K RPM优于 7200 RPM
- 使用快速 RAID 存储
- 使用快速以太网适配器
- 内存越多越好
**ha\_remove\_node**\[=*target*\]
Remove the high availability (HA) node specified by its name or ID.
Note that active/standby nodes cannot be removed.
**ha\_set\_failover\_delay**\[=*delay*\]
Set high availability (HA) failover delay.
Time suffixes are supported, e.g. 10s, 1m.
**secrets\_reload**
Reload secrets from Vault.
**service\_cache\_reload**
Reload the service manager cache.
**prof\_enable**\[=*target*\]
Enable profiling.
Affects all processes if target is not specified.
Enabled profiling provides details of all rwlocks/mutexes by function name.
Supported since Zabbix 6.0.13.
**prof\_disable**\[=*target*\]
Disable profiling.
Affects all processes if target is not specified.
Supported since Zabbix 6.0.13.
**log\_level\_increase**\[=*target*\]
Increase log level, affects all processes if target is not specified
**log\_level\_decrease**\[=*target*\]
Decrease log level, affects all processes if target is not specified
[ ]{#lbAG}
**ha\_remove\_node**\[=*target*\]
移除指定名称或ID的高可用性(HA)节点。
注意：活动/备用节点无法被移除。
**ha\_set\_failover\_delay**\[=*delay*\]
设置高可用性(HA)故障转移延迟。
支持时间后缀，例如10s、1m。
**secrets\_reload**
从Vault重新加载密钥。
**service\_cache\_reload**
重新加载服务管理器缓存。
**prof\_enable**\[=*target*\]
启用性能分析。
若未指定目标则影响所有进程。
启用后可通过函数名提供所有读写锁/互斥锁的详细信息。
自Zabbix 6.0.13起支持。
**prof\_disable**\[=*target*\]
禁用性能分析。
若未指定目标则影响所有进程。
自Zabbix 6.0.13起支持。
**log\_level\_increase**\[=*target*\]
提升日志级别，若未指定目标则影响所有进程
**log\_level\_decrease**\[=*target*\]
降低日志级别，若未指定目标则影响所有进程
[ ]{#lbAG}
#### Header processing
The CSV file header line can be processed in two different ways:
- If the *With header row* checkbox is marked - header line values are
interpreted as column names. In this case the column names must be
unique and the data row should not contain more columns than the
header row;
- If the *With header row* checkbox is not marked - the header line is
interpreted as data. Column names are generated automatically
(1,2,3,4...)
CSV file example:
Nr,Item name,Key,Qty
1,active agent item,agent.hostname,33
"2","passive agent item","agent.version","44"
3,"active,passive agent items",agent.ping,55
::: noteclassic
A quotation character within a quoted field in the input
must be escaped by preceding it with another quotation
character.
:::
**Processing header line**
JSON output when a header line is expected:
``` {.json}
[
{
"Nr":"1",
"Item name":"active agent item",
"Key":"agent.hostname",
"Qty":"33"
},
{
"Nr":"2",
"Item name":"passive agent item",
"Key":"agent.version",
"Qty":"44"
},
{
"Nr":"3",
"Item name":"active,passive agent items",
"Key":"agent.ping",
"Qty":"55"
}
]
```
**No header line processing**
JSON output when a header line is not expected:
``` {.json}
[
{
"1":"Nr",
"2":"Item name",
"3":"Key",
"4":"Qty"
},
{
"1":"1",
"2":"active agent item",
"3":"agent.hostname",
"4":"33"
},
{
"1":"2",
"2":"passive agent item",
"3":"agent.version",
"4":"44"
},
{
"1":"3",
"2":"active,passive agent items",
"3":"agent.ping",
"4":"55"
}
]
```
#### Header 处理
CSV file 标题行可通过两种不同方式处理：
- 若勾选 *With header row* 复选框 - 标题行值将被解析为列名。此时列名必须唯一且数据行不应包含比标题行更多的列；
- 若未勾选 *With header row* 复选框 - 标题行将
interpreted as data. Column names are generated automatically
(1,2,3,4...)
CSV file 示例：
Nr,Item name,Key,Qty
1,active agent item,agent.hostname,33
"2","passive agent item","agent.version","44"
3,"active,passive agent items",agent.ping,55
::: noteclassic
输入数据中被引号包裹的字段内若出现引号字符，
必须通过前置另一个引号字符进行转义。
:::
**标题行处理**
预期存在标题行时的JSON输出：
```{.json}
[
{
"Nr":"1",
"Item name":"active agent item",
"Key":"agent.hostname",
"Qty":"33"
},
{
"Nr":"2",
"Item name":"passive agent item",
"Key":"agent.version",
"Qty":"44"
},
{
"Nr":"3",
"Item name":"active,passive agent items",
"Key":"agent.ping",
"Qty":"55"
}
]
```
**无标题行处理**
不预期存在标题行时的JSON输出：
```{.json}
[
{
"1":"Nr",
"2":"Item name",
"3":"Key",
"4":"Qty"
},
{
"1":"1",
"2":"active agent item",
"3":"agent.hostname",
"4":"33"
},
{
"1":"2",
"2":"passive agent item",
"3":"agent.version",
"4":"44"
},
{
"1":"3",
"2":"active,passive agent items",
"3":"agent.ping",
"4":"55"
}
]
```
##### Hidden menu
Even when the menu is hidden completely, a full menu is just one mouse
click away, by clicking on the burger icon. Note that it reappears over
page content; to move page content to the right you have to unhide the
menu by clicking on the show sidebar button.
##### 隐藏菜单
即使菜单被完全隐藏，只需点击汉堡图标即可一键唤出完整菜单。请注意菜单会覆盖在页面内容上方显示；若要将页面内容向右移动，需通过点击显示侧边栏按钮来取消隐藏菜单。
#### Hiding the file with list of common passwords
To increase the complexity of password brute force attacks, it is
suggested to limit access to the file `ui/data/top_passwords.txt` by
modifying web server configuration. This file contains a list of the
most common and context-specific passwords, and is used to prevent users
from setting such passwords if *Avoid easy-to-guess passwords* parameter
is enabled in the [password
policy](/manual/web_interface/frontend_sections/administration/authentication#internal_authentication).
For example, on NGINX file access can be limited by using the `location`
directive:
```ini
location = /data/top_passwords.txt {
deny all;
return 404;
}
```
On Apache - by using `.htaccess` file:
```ini
<Files "top_passwords.txt">
Order Allow,Deny
Deny from all
</Files>
```
#### 隐藏常用密码列表文件
为提高密码暴力破解攻击的复杂度，建议通过修改Web服务器配置来限制对file `ui/data/top_passwords.txt`的访问。该file包含最常见和上下文相关的密码列表，当[内部认证](/manual/web_interface/frontend_sections/administration/authentication#内部认证)中的*避免使用易猜测密码*参数启用时，用于防止用户设置此类密码。
例如，在nginx上，可通过使用`location`指令限制file访问：
```ini
location = /data/top_passwords.txt {
deny all;
return 404;
}
```
在Apache上，可通过使用`.htaccess` file实现：
```ini
<Files "top_passwords.txt">
Order Allow,Deny
Deny from all
</Files>
```
#### Hiding the file with list of common passwords
To increase the complexity of password brute force attacks, it is
suggested to limit access to the file `ui/data/top_passwords.txt` by
modifying web server configuration. This file contains a list of the
most common and context-specific passwords, and is used to prevent users
from setting such passwords if *Avoid easy-to-guess passwords* parameter
is enabled in the [password
policy](/manual/web_interface/frontend_sections/administration/authentication#internal_authentication).
For example, on NGINX file access can be limited by using the `location`
directive:
location = /data/top_passwords.txt {
deny all;
return 404;
}
On Apache - by using `.htacess` file:
<Files "top_passwords.txt">
Order Allow,Deny
Deny from all
</Files>
#### 隐藏带有常用密码列表的文件
为了应对暴力攻击增加密码的复杂性，建议通过修改 web 服务器配置来限制对文件 `ui/data/top_passwords.txt` 的访问。 此文件包含最常见和特定上下文的密码列表，在 [password policy](/manual/web_interface/frontend_sections/administration/authentication#internal_authentication)。
例如，在 NGINX 文件访问可以通过使用 `location` 来限制
命令:
location = /data/top_passwords.txt {
deny all;
return 404;
}
在 Apache 上 - 通过使用 `.htacess` 文件：
<Files "top_passwords.txt">
Order Allow,Deny
Deny from all
</Files>
#### High availability cluster for Zabbix server
The new version comes with a native high availability solution for
Zabbix server.
The solution consists of multiple zabbix\_server instances or nodes,
where only one node can be active (working) at a time, while other nodes
are on standby, ready to take over in case the current node is stopped
or fails.
See also: [High availability cluster](/manual/concepts/server/ha).
#### Zabbix server 的高可用集群
新版version为Zabbix server提供了原生高可用性解决方案.
该解决方案由多个zabbix\_server实例或节点组成,
其中同一时间只能有一个节点处于活动(工作)状态,其他节点处于待命状态,
在当前节点停止或发生故障时随时准备接管.
另请参阅: [High availability cluster](/manual/concepts/server/ha).
#### High availability cluster
Retrieve a list of server nodes and their status.
[High availability cluster API](/manual/api/reference/hanode)
#### 高可用集群
获取服务器节点列表及其状态。
[High availability cluster API](/manual/api/reference/hanode)
### High availability node
::: noteclassic
Nodes are created by the Zabbix server and cannot be
modified via the API.
:::
The High availability node object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|ha\_nodeid|string|ID of the node.|
|name|string|Name assigned to the node, using the HANodeName configuration entry of zabbix\_server.conf. Empty for a server running in standalone mode.|
|address|string|IP or DNS name where the node connects from.|
|port|integer|Port on which the node is running.|
|lastaccess|integer|Heartbeat time, t.i. time of last update from the node. UTC timestamp.|
|status|integer|State of the node.<br><br>Possible values:<br>0 - standby;<br>1 - stopped manually;<br>2 - unavailable;<br>3 - active.|
### 高可用节点
::: noteclassic
节点由Zabbix server创建且无法通过API进行修改。
:::
高可用节点object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| ha\_nodeid | string | 节点ID。 |
| name | string | 通过zabbix_server.conf的HANodeName配置项分配给节点的名称。独立模式运行的服务器此项为空。 |
| address | string | 节点连接来源的IP或DNS名称。 |
| port | integer | 节点运行端口号。 |
| lastaccess | integer | 心跳时间，即节点最后一次update的时间。UTC时间戳。 |
| status | integer | 节点状态。<br><br>可能取值：<br>0 - 待机；<br>1 - 手动停止；<br>2 - 不可用；<br>3 - 活跃。 |
#### High availability nodes
If [high availability cluster](/manual/concepts/server/ha) is enabled, then another block of data is displayed with the status of each high availability node.
{width="600"}
Displayed data:
|Column|Description|
|--|--------|
|*Name*|Node name, as defined in server configuration.|
|*Address*|Node IP address and port.|
|*Last access*|Time of node last access.<br>Hovering over the cell shows the timestamp of last access in long format.|
|*Status*|Node status:<br>**Active** - node is up and working<br>**Unavailable** - node hasn't been seen for more than failover delay (you may want to find out why)<br>**Stopped** - node has been stopped or couldn't start (you may want to start it or delete it)<br>**Standby** - node is up and waiting|
#### 高可用性节点
如果启用了[high availability cluster](/manual/concepts/server/ha)，则会显示另一个数据块，其中包含每个高可用性节点的状态。
{width="600"}
显示的数据：
| 列 | 描述 |
|--|--------|
| *Name* | 节点名称，定义于服务器配置中。 |
| *Address* | 节点IP地址和端口。 |
| *Last access* | 节点最后访问时间。<br>悬停在单元格上会以长格式显示最后访问的时间戳。 |
| *Status* | 节点状态：<br>**Active** - 节点正常运行<br>**Unavailable** - 节点超过故障转移延迟未被检测到（可能需要查明原因）<br>**Stopped** - 节点已停止或无法启动（可能需要启动或delete它）<br>**Standby** - 节点已启动并处于等待状态 |
# history.clear
# history.clear
#### History functions
|FUNCTION|<|<|<|
|--------|-|-|-|
|<|**Description**|**Function-specific parameters**|**Comments**|
|**change** (/host/key)|<|<|<|
|<|The amount of difference between the previous and latest value.|<|Supported value types: float, int, str, text, log<br><br>For strings returns:<br>0 - values are equal<br>1 - values differ<br><br>Example:<br>=> **change**(/host/key)>10<br><br>Numeric difference will be calculated, as seen with these incoming example values ('previous' and 'latest' value = difference):<br>'1' and '5' = `+4`<br>'3' and '1' = `-2`<br>'0' and '-2.5' = `-2.5`<br><br>See also: [abs](/manual/appendix/functions/math) for comparison|
|**changecount** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|<|
|<|Number of changes between adjacent values within the defined evaluation period.|See [common parameters](#common-parameters).<br><br>**mode** (optional; must be double-quoted)<br><br>Supported `modes`:<br>*all* - count all changes (default)<br>*dec* - count decreases<br>*inc* - count increases|Supported value types: float, int, str, text, log<br><br>For non-numeric value types, *mode* parameter is ignored.<br><br>Examples:<br>=> **changecount**(/host/key, 1w) → number of value changes for the last week until [now](/manual/config/triggers#evaluation_period)<br>=> **changecount**(/host/key,\#10,"inc") → number of value increases (relative to the adjacent value) among the last 10 values<br>=> **changecount**(/host/key,24h,"dec") → number of value decreases (relative to the adjacent value) for the last 24 hours until [now](/manual/config/triggers#evaluation_period)|
|**count** (/host/key,(sec\|\#num)<:time shift>,<operator>,<pattern>)|<|<|<|
|<|Number of values within the defined evaluation period.|See [common parameters](#common-parameters).<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* - matches if contains pattern (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>**pattern** (optional) - required pattern (string arguments must be double-quoted)|Supported value types: float, integer, string, text, log<br><br>Float items match with the precision of 2.22e-16; if database is [not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values) the precision is 0.000001.<br><br>With *bitand* as the third parameter, the fourth `pattern` parameter can be specified as two numbers, separated by '/': **number\_to\_compare\_with/mask**. count() calculates "bitwise AND" from the value and the *mask* and compares the result to *number\_to\_compare\_with*. If the result of "bitwise AND" is equal to *number\_to\_compare\_with*, the value is counted.<br>If *number\_to\_compare\_with* and *mask* are equal, only the *mask* need be specified (without '/').<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings. For the purpose of regexp matching, float values will always be represented with 4 decimal digits after '.'. Also note that for large numbers difference in decimal (stored in database) and binary (used by Zabbix server) representation may affect the 4th decimal digit.<br><br>Examples:<br>=> **count**(/host/key,**10m**) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period)<br>=> **count**(/host/key,**10m**,"like","error") → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that contain 'error'<br>=> **count**(/host/key,**10m**,,12) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that equal '12'<br>=> **count**(/host/key,**10m**,"gt",12) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **count**(/host/key,**\#10**,"gt",12) → number of values within the last 10 values until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **count**(/host/key,**10m:now-1d**,"gt",12) → number of values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period) that were over '12'<br>=> **count**(/host/key,**10m**,"bitand","6/7") → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) having '110' (in binary) in the 3 least significant bits.<br>=> **count**(/host/key,**10m:now-1d**) → number of values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period)|
|**countunique** (/host/key,(sec\|\#num)<:time shift>,<operator>,<pattern>)|<|<|<|
|<|Number of unique values within the defined evaluation period.|See [common parameters](#common-parameters).<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* - matches if contains pattern (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>**pattern** (optional) - required pattern (string arguments must be double-quoted)|Supported value types: float, integer, string, text, log<br><br>Float items match with the precision of 2.22e-16; if database is [not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values) the precision is 0.000001.<br><br>With *bitand* as the third parameter, the fourth `pattern` parameter can be specified as two numbers, separated by '/': **number\_to\_compare\_with/mask**. count() calculates "bitwise AND" from the value and the *mask* and compares the result to *number\_to\_compare\_with*. If the result of "bitwise AND" is equal to *number\_to\_compare\_with*, the value is counted.<br>If *number\_to\_compare\_with* and *mask* are equal, only the *mask* need be specified (without '/').<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings. For the purpose of regexp matching, float values will always be represented with 4 decimal digits after '.'. Also note that for large numbers difference in decimal (stored in database) and binary (used by Zabbix server) representation may affect the 4th decimal digit.<br><br>Examples:<br>=> **countunique**(/host/key,**10m**) → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period)<br>=> **countunique**(/host/key,**10m**,"like","error") → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that contain 'error'<br>=> **countunique**(/host/key,**10m**,"gt",12) → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **countunique**(/host/key,**\#10**,"gt",12) → number of unique values within the last 10 values until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **countunique**(/host/key,**10m:now-1d**,"gt",12) → number of unique values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period) that were over '12'<br>=> **countunique**(/host/key,**10m**,"bitand","6/7") → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) having '110' (in binary) in the 3 least significant bits.<br>=> **countunique**(/host/key,**10m:now-1d**) → number of unique values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period)|
|**find** (/host/key,<(sec\|\#num)<:time shift>>,<operator>,<pattern>)|<|<|<|
|<|Find a value match.|See [common parameters](#common-parameters).<br><br>**sec** or **\#num** (optional) - defaults to the latest value if not specified<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* - value contains the string given in `pattern` (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>**pattern** - required pattern (string arguments must be double-quoted); [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) regular expression if `operator` is *regexp*, *iregexp*.|Supported value types: float, int, str, text, log<br><br>Returns:<br>1 - found<br>0 - otherwise<br><br>If more than one value is processed, '1' is returned if there is at least one matching value.<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings.<br><br>Example:<br>=> **find**(/host/key,**10m**,"like","error") → find a value that contains 'error' within the last 10 minutes until [now](/manual/config/triggers#evaluation_period)|
|**first** (/host/key,sec<:time shift>)|<|<|<|
|<|The first (the oldest) value within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int, str, text, log<br><br>Example:<br>=> **first**(/host/key,**1h**) → retrieve the oldest value within the last hour until [now](/manual/config/triggers#evaluation_period)<br><br>See also last().|
|**fuzzytime** (/host/key,sec)|<|<|<|
|<|Checking how much the passive agent time differs from the Zabbix server/proxy time.|See [common-parameters](#common parameters).|Supported value types: float, int<br><br>Returns:<br>1 - difference between the passive item value (as timestamp) and Zabbix server/proxy timestamp is less than or equal to T seconds<br>0 - otherwise<br><br>Usually used with the 'system.localtime' item to check that local time is in sync with the local time of Zabbix server. *Note* that 'system.localtime' must be configured as a [passive check](/manual/appendix/items/activepassive#passive_checks).<br>Can be used also with vfs.file.time\[/path/file,modify\] key to check that file didn't get updates for long time.<br><br>Example:<br>=> **fuzzytime**(/host/key,**60s**)=0 → detect a problem if the time difference is over 60 seconds<br><br>This function is not recommended for use in complex trigger expressions (with multiple items involved), because it may cause unexpected results (time difference will be measured with the most recent metric), e.g. in `fuzzytime(/Host/system.localtime,60s)=0 or last(/Host/trap)<>0`|
|**last** (/host/key,<\#num<:time shift>>)|<|<|<|
|<|The most recent value.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value|Supported value types: float, int, str, text, log<br><br>Take note that a hash-tagged time period (\#N) works differently here than with many other functions.<br>For example:<br>last() is always equal to last(\#1)<br>last(\#3) - third most recent value (*not* three latest values)<br><br>Zabbix does not guarantee the exact order of values if more than two values exist within one second in history.<br><br>Example:<br>=> **last**(/host/key) → retrieve the last value<br>=> **last**(/host/key,**\#2**) → retrieve the previous value<br>=> **last**(/host/key,**\#1**) <> **last**(/host/key,**\#2**) → the last and previous values differ<br><br>See also first().|
|**logeventid** (/host/key,<\#num<:time shift>>,<pattern>)|<|<|<|
|<|Checking if event ID of the last log entry matches a regular expression.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value<br><br>**pattern** (optional) - regular expression describing the required pattern, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) style (string arguments must be double-quoted).|Supported value types: log<br><br>Returns:<br>0 - does not match<br>1 - matches|
|**logseverity** (/host/key,<\#num<:time shift>>)|<|<|<|
|<|Log severity of the last log entry.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value|Supported value types: log<br><br>Returns:<br>0 - default severity<br>N - severity (integer, useful for Windows event logs: 1 - Information, 2 - Warning, 4 - Error, 7 - Failure Audit, 8 - Success Audit, 9 - Critical, 10 - Verbose).<br>Zabbix takes log severity from **Information** field of Windows event log.|
|**logsource** (/host/key,<\#num<:time shift>>,<pattern>)|<|<|<|
|<|Checking if log source of the last log entry matches a regular expression.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value<br><br>**pattern** (optional) - regular expression describing the required pattern, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) style (string arguments must be double-quoted).|Supported value types: log<br><br>Returns:<br>0 - does not match<br>1 - matches<br><br>Normally used for Windows event logs. For example, logsource("VMware Server").|
|**monodec** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|<|
|<|Check if there has been a monotonous decrease in values.|See [common parameters](#common-parameters).<br><br>**mode** (must be double-quoted) - *weak* (every value is smaller or the same as the previous one; default) or *strict* (every value has decreased)|Supported value types: int<br><br>Returns 1 if all elements in the time period continuously decrease, 0 otherwise.<br><br>Example:<br>=> **monodec**(/Host1/system.swap.size\[all,free\],**60s**) + **monodec**(/Host2/system.swap.size\[all,free\],**60s**) + **monodec**(/Host3/system.swap.size\[all,free\],**60s**) - calculate in how many hosts there has been a decrease in free swap size|
|**monoinc** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|<|
|<|Check if there has been a monotonous increase in values.|See [common parameters](#common-parameters).<br><br>**mode** (must be double-quoted) - *weak* (every value is bigger or the same as the previous one; default) or *strict* (every value has increased)|Supported value types: int<br><br>Returns 1 if all elements in the time period continuously increase, 0 otherwise.<br><br>Example:<br>=> **monoinc**(/Host1/system.localtime,**\#3**,"strict")=0 - check if system local time has been increasing consistently|
|**nodata** (/host/key,sec,<mode>)|<|<|<|
|<|Checking for no data received.|See [common parameters](#common-parameters).<br><br>**sec** period should not be less than 30 seconds because the history syncer process calculates this function only every 30 seconds.<br><br>nodata(/host/key,0) is disallowed.<br><br>**mode** - if set to *strict* (double-quoted), this function will be insensitive to proxy availability (see comments for details).|All value types are supported.<br><br>Returns:<br>1 - if no data received during the defined period of time<br>0 - otherwise<br><br>Since Zabbix 5.0, the 'nodata' triggers monitored by proxy are, by default, sensitive to proxy availability - if proxy becomes unavailable, the 'nodata' triggers will not fire immediately after a restored connection, but will skip the data for the delayed period. Note that for passive proxies suppression is activated if connection is restored more than 15 seconds and no less than 2 & ProxyUpdateFrequency seconds later. For active proxies suppression is activated if connection is restored more than 15 seconds later.<br><br>To turn off sensitiveness to proxy availability, use the third parameter, e.g.: **nodata**(/host/key,**5m**,**"strict"**); in this case the function will work the same as before 5.0.0 and fire as soon as the evaluation period (five minutes) without data has past.<br><br>Note that this function will display an error if, within the period of the 1st parameter:<br>- there's no data and Zabbix server was restarted<br>- there's no data and maintenance was completed<br>- there's no data and the item was added or re-enabled<br>Errors are displayed in the *Info* column in trigger [configuration](/manual/web_interface/frontend_sections/configuration/hosts/triggers).<br><br>This function may not work properly if there are time differences between Zabbix server, proxy and agent. See also: [Time synchronization requirement](/manual/installation/requirements#time_synchronization).|
|**percentile** (/host/key,(sec\|\#num)<:time shift>,percentage)|<|<|<|
|<|P-th percentile of a period, where P (percentage) is specified by the third parameter.|See [common parameters](#common-parameters).<br><br>**percentage** - a floating-point number between 0 and 100 (inclusive) with up to 4 digits after the decimal point|Supported value types: float, int|
|**rate** (/host/key,sec<:time shift>)|<|<|<|
|<|Per-second average rate of the increase in a monotonically increasing counter within the defined time period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Functionally corresponds to '[rate](https://prometheus.io/docs/prometheus/latest/querying/functions/#rate)' of PromQL.<br><br>Example:<br>=> **rate**(/host/key,**30s**) → If the monotonic increase over 30 seconds is 20, this function will return 0.67.|
|**trendavg** (/host/key,time period:time shift)|<|<|<|
|<|Average of trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendavg**(/host/key,**1h:now/h**) → average for the previous hour (e.g. 12:00-13:00)<br>=> **trendavg**(/host/key,**1h:now/h-1h**) → average for two hours ago (11:00-12:00)<br>=> **trendavg**(/host/key,**1h:now/h-2h**) → average for three hours ago (10:00-11:00)<br>=> **trendavg**(/host/key,**1M:now/M-1y**) → average for the previous month a year ago|
|**trendcount** (/host/key,time period:time shift)|<|<|<|
|<|Number of successfully retrieved trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendcount**(/host/key,**1h:now/h**) → count for the previous hour (e.g. 12:00-13:00)<br>=> **trendcount**(/host/key,**1h:now/h-1h**) → count for two hours ago (11:00-12:00)<br>=> **trendcount**(/host/key,**1h:now/h-2h**) → count for three hours ago (10:00-11:00)<br>=> **trendcount**(/host/key,**1M:now/M-1y**) → count for the previous month a year ago|
|**trendmax** (/host/key,time period:time shift)|<|<|<|
|<|The maximum in trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendmax**(/host/key,**1h:now/h**) → maximum for the previous hour (e.g. 12:00-13:00)<br>=> **trendmax**(/host/key,**1h:now/h**) - **trendmin**(/host/key,**1h:now/h**) → calculate the difference between the maximum and minimum values (trend delta) for the previous hour (12:00-13:00)<br>=> **trendmax**(/host/key,**1h:now/h-1h**) → maximum for two hours ago (11:00-12:00)<br>=> **trendmax**(/host/key,**1h:now/h-2h**) → maximum for three hours ago (10:00-11:00)<br>=> **trendmax**(/host/key,**1M:now/M-1y**) → maximum for the previous month a year ago|
|**trendmin** (/host/key,time period:time shift)|<|<|<|
|<|The minimum in trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendmin**(/host/key,**1h:now/h**) → minimum for the previous hour (e.g. 12:00-13:00)<br>=> **trendmin**(/host/key,**1h:now/h**) - **trendmin**(/host/key,**1h:now/h**) → calculate the difference between the maximum and minimum values (trend delta) for the previous hour (12:00-13:00)<br>=> **trendmin**(/host/key,**1h:now/h-1h**) → minimum for two hours ago (11:00-12:00)<br>=> **trendmin**(/host/key,**1h:now/h-2h**) → minimum for three hours ago (10:00-11:00)<br>=> **trendmin**(/host/key,**1M:now/M-1y**) → minimum for the previous month a year ago|
|**trendstl** (/host/key,eval period:time shift,detection period,season,<deviations>,<devalg>,<s_window>)|<|<|<|
|<|Returns an anomaly rate - a decimal value between 0 and 1 that is ((the number of anomaly values in detect period) / (total number of values in detect period).|**eval period** - the time period that must be decomposed (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)<br><br>**detection period** - the time period starting from the end of eval period for which anomalies are calculated (minimum '1h', cannot be longer than eval period), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week).<br><br>**season** - the shortest time period where seasonality (repeating patterns) is expected (minimum '2h', cannot be longer than eval period, number of entries in the eval period must be greater than the two times of the resulting frequency (season/h)), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week).<br><br>**deviations** - the number of deviations (calculated with devalg) to count as anomaly (can be decimal), (must be greater than or equal to 1, default is 3)<br><br>**devalg** - deviation algorithm, can be 'stddevpop', 'stddevsamp' or 'mad' (default)<br><br>**s_window** - the span (in lags) of the loess window for seasonal extraction (default is 10 * number of entries in eval period + 1)|Examples:<br>=> **trendstl**(/host/key,**100h:now/h**,10h,2h) → analysing the last 100 hours of trend data,<br>find the anomalies rate for the previous 10 hours of that period,<br>expecting the periodicity to be 2h,<br>the remainder series values of the evaluation period are considered anomalies if they reach the value of 3 deviations of the MAD of that remainder series<br>=> **trendstl**(/host/key,**100h:now/h-10h**,100h,2h,2.1,'mad') → analysing the period of previous 100 hours of trend data, starting counting 10 hours ago<br>find the anomalies rate for that entire period<br>expecting the periodicity to be 2h,<br>the remainder series values of the evaluation period are considered anomalies if they reach the value of 2,1 deviations of the MAD of that remainder series<br>=> **trendstl**(/host/key,**100d:now/d-1d**,10d,1d,4,,10) → analysing previous 100 days of trend data starting from a day ago,<br>find the anomalies rate for the period of last 10d of that period,<br>expecting the periodicity to be 1d,<br>the remainder series values of the evaluation period are considered anomalies if they reach the value of 4 deviations of the MAD of that remainder series,<br>overriding the default span of the loess window for seasonal extraction of "10 * number of entries in eval period + 1" with the span of 10 lags<br>=> **trendstl**(/host/key,**1M:now/M-1y**,1d,2h,,'stddevsamp') → minimum for the previous month a year ago<br>analysing previous month of trend data starting from a year ago,<br>find the anomalies rate of the last day of that period<br>expecting the periodicity to be 2h,<br>the remainder series values of the evaluation period are considered anomalies if they reach the value of 3 deviation of the sample standard deviation of that remainder series|
|**trendsum** (/host/key,time period:time shift)|<|<|<|
|<|Sum of trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendsum**(/host/key,**1h:now/h**) → sum for the previous hour (e.g. 12:00-13:00)<br>=> **trendsum**(/host/key,**1h:now/h-1h**) → sum for two hours ago (11:00-12:00)<br>=> **trendsum**(/host/key,**1h:now/h-2h**) → sum for three hours ago (10:00-11:00)<br>=> **trendsum**(/host/key,**1M:now/M-1y**) → sum for the previous month a year ago|
#### History functions
|FUNCTION|<|<|<|
|--------|-|-|-|
|<|**Description**|**Function-specific parameters**|**Comments**|
|**change** (/host/key)|<|<|<|
|<|The amount of difference between the previous and latest value.|<|Supported value types: float, int, str, text, log<br><br>For strings returns:<br>0 - values are equal<br>1 - values differ<br><br>Example:<br>=> **change**(/host/key)>10<br><br>Numeric difference will be calculated, as seen with these incoming example values ('previous' and 'latest' value = difference):<br>'1' and '5' = `+4`<br>'3' and '1' = `-2`<br>'0' and '-2.5' = `-2.5`<br><br>See also: [abs](/manual/appendix/functions/math) for comparison|
|**changecount** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|<|
|<|Number of changes between adjacent values within the defined evaluation period.|See [common parameters](#common parameters).<br><br>**mode** (optional; must be double-quoted)<br><br>Supported `modes`:<br>*all* - count all changes (default)<br>*dec* - count decreases<br>*inc* - count increases|Supported value types: float, int, str, text, log<br><br>For non-numeric value types, *mode* parameter is ignored.<br><br>Examples:<br>=> **changecount**(/host/key, 1w) → number of value changes for the last week until [now](/manual/config/triggers#evaluation_period)<br>=> **changecount**(/host/key,\#10,"inc") → number of value increases (relative to the adjacent value) among the last 10 values<br>=> **changecount**(/host/key,24h,"dec") → number of value decreases (relative to the adjacent value) for the last 24 hours until [now](/manual/config/triggers#evaluation_period)|
|**count** (/host/key,(sec\|\#num)<:time shift>,<operator>,<pattern>)|<|<|<|
|<|Number of values within the defined evaluation period.|See [common parameters](#common parameters).<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* - matches if contains pattern (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>**pattern** (optional) - required pattern (string arguments must be double-quoted)|Supported value types: float, integer, string, text, log<br><br>Float items match with the precision of 2.22e-16; if database is [not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values) the precision is 0.000001.<br><br>With *bitand* as the third parameter, the fourth `pattern` parameter can be specified as two numbers, separated by '/': **number\_to\_compare\_with/mask**. count() calculates "bitwise AND" from the value and the *mask* and compares the result to *number\_to\_compare\_with*. If the result of "bitwise AND" is equal to *number\_to\_compare\_with*, the value is counted.<br>If *number\_to\_compare\_with* and *mask* are equal, only the *mask* need be specified (without '/').<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings. For the purpose of regexp matching, float values will always be represented with 4 decimal digits after '.'. Also note that for large numbers difference in decimal (stored in database) and binary (used by Zabbix server) representation may affect the 4th decimal digit.<br><br>Examples:<br>=> **count**(/host/key,**10m**) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period)<br>=> **count**(/host/key,**10m**,"like","error") → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that contain 'error'<br>=> **count**(/host/key,**10m**,,12) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that equal '12'<br>=> **count**(/host/key,**10m**,"gt",12) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **count**(/host/key,**\#10**,"gt",12) → number of values within the last 10 values until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **count**(/host/key,**10m:now-1d**,"gt",12) → number of values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period) that were over '12'<br>=> **count**(/host/key,**10m**,"bitand","6/7") → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) having '110' (in binary) in the 3 least significant bits.<br>=> **count**(/host/key,**10m:now-1d**) → number of values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period)|
|**countunique** (/host/key,(sec\|\#num)<:time shift>,<operator>,<pattern>)|<|<|<|
|<|Number of unique values within the defined evaluation period.|See [common parameters](#common parameters).<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* - matches if contains pattern (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>**pattern** (optional) - required pattern (string arguments must be double-quoted)|Supported value types: float, integer, string, text, log<br><br>Float items match with the precision of 2.22e-16; if database is [not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values) the precision is 0.000001.<br><br>With *bitand* as the third parameter, the fourth `pattern` parameter can be specified as two numbers, separated by '/': **number\_to\_compare\_with/mask**. count() calculates "bitwise AND" from the value and the *mask* and compares the result to *number\_to\_compare\_with*. If the result of "bitwise AND" is equal to *number\_to\_compare\_with*, the value is counted.<br>If *number\_to\_compare\_with* and *mask* are equal, only the *mask* need be specified (without '/').<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings. For the purpose of regexp matching, float values will always be represented with 4 decimal digits after '.'. Also note that for large numbers difference in decimal (stored in database) and binary (used by Zabbix server) representation may affect the 4th decimal digit.<br><br>Examples:<br>=> **countunique**(/host/key,**10m**) → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period)<br>=> **countunique**(/host/key,**10m**,"like","error") → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that contain 'error'<br>=> **countunique**(/host/key,**10m**,"gt",12) → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **countunique**(/host/key,**\#10**,"gt",12) → number of unique values within the last 10 values until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **countunique**(/host/key,**10m:now-1d**,"gt",12) → number of unique values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period) that were over '12'<br>=> **countunique**(/host/key,**10m**,"bitand","6/7") → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) having '110' (in binary) in the 3 least significant bits.<br>=> **countunique**(/host/key,**10m:now-1d**) → number of unique values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period)|
|**find** (/host/key,<(sec\|\#num)<:time shift>>,<operator>,<pattern>)|<|<|<|
|<|Find a value match.|See [common parameters](#common parameters).<br><br>**sec** or **\#num** (optional) - defaults to the latest value if not specified<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* - value contains the string given in `pattern` (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>**pattern** - required pattern (string arguments must be double-quoted); [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) regular expression if `operator` is *regexp*, *iregexp*.|Supported value types: float, int, str, text, log<br><br>Returns:<br>1 - found<br>0 - otherwise<br><br>If more than one value is processed, '1' is returned if there is at least one matching value.<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings.<br><br>Example:<br>=> **find**(/host/key,**10m**,"like","error") → find a value that contains 'error' within the last 10 minutes until [now](/manual/config/triggers#evaluation_period)|
|**first** (/host/key,sec<:time shift>)|<|<|<|
|<|The first (the oldest) value within the defined evaluation period.|See [common parameters](#common parameters).|Supported value types: float, int, str, text, log<br><br>Example:<br>=> **first**(/host/key,**1h**) → retrieve the oldest value within the last hour until [now](/manual/config/triggers#evaluation_period)<br><br>See also last().|
|**fuzzytime** (/host/key,sec)|<|<|<|
|<|Checking how much the passive agent time differs from the Zabbix server/proxy time.|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Returns:<br>1 - difference between the passive item value (as timestamp) and Zabbix server/proxy timestamp is less than or equal to T seconds<br>0 - otherwise<br><br>Usually used with the 'system.localtime' item to check that local time is in sync with the local time of Zabbix server. *Note* that 'system.localtime' must be configured as a [passive check](/manual/appendix/items/activepassive#passive_checks).<br>Can be used also with vfs.file.time\[/path/file,modify\] key to check that file didn't get updates for long time.<br><br>Example:<br>=> **fuzzytime**(/host/key,**60s**)=0 → detect a problem if the time difference is over 60 seconds<br><br>This function is not recommended for use in complex trigger expressions (with multiple items involved), because it may cause unexpected results (time difference will be measured with the most recent metric), e.g. in `fuzzytime(/Host/system.localtime,60s)=0 or last(/Host/trap)<>0`|
|**last** (/host/key,<\#num<:time shift>>)|<|<|<|
|<|The most recent value.|See [common parameters](#common parameters).<br><br>**\#num** (optional) - the Nth most recent value|Supported value types: float, int, str, text, log<br><br>Take note that a hash-tagged time period (\#N) works differently here than with many other functions.<br>For example:<br>last() is always equal to last(\#1)<br>last(\#3) - third most recent value (*not* three latest values)<br><br>Zabbix does not guarantee the exact order of values if more than two values exist within one second in history.<br><br>Example:<br>=> **last**(/host/key) → retrieve the last value<br>=> **last**(/host/key,**\#2**) → retrieve the previous value<br>=> **last**(/host/key,**\#1**) <> **last**(/host/key,**\#2**) → the last and previous values differ<br><br>See also first().|
|**logeventid** (/host/key,<\#num<:time shift>>,<pattern>)|<|<|<|
|<|Checking if event ID of the last log entry matches a regular expression.|See [common parameters](#common parameters).<br><br>**\#num** (optional) - the Nth most recent value<br><br>**pattern** (optional) - regular expression describing the required pattern, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) style (string arguments must be double-quoted).|Supported value types: log<br><br>Returns:<br>0 - does not match<br>1 - matches|
|**logseverity** (/host/key,<\#num<:time shift>>)|<|<|<|
|<|Log severity of the last log entry.|See [common parameters](#common parameters).<br><br>**\#num** (optional) - the Nth most recent value|Supported value types: log<br><br>Returns:<br>0 - default severity<br>N - severity (integer, useful for Windows event logs: 1 - Information, 2 - Warning, 4 - Error, 7 - Failure Audit, 8 - Success Audit, 9 - Critical, 10 - Verbose).<br>Zabbix takes log severity from **Information** field of Windows event log.|
|**logsource** (/host/key,<\#num<:time shift>>,<pattern>)|<|<|<|
|<|Checking if log source of the last log entry matches a regular expression.|See [common parameters](#common parameters).<br><br>**\#num** (optional) - the Nth most recent value<br><br>**pattern** (optional) - regular expression describing the required pattern, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) style (string arguments must be double-quoted).|Supported value types: log<br><br>Returns:<br>0 - does not match<br>1 - matches<br><br>Normally used for Windows event logs. For example, logsource("VMware Server").|
|**monodec** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|<|
|<|Check if there has been a monotonous decrease in values.|See [common parameters](#common parameters).<br><br>**mode** (must be double-quoted) - *weak* (every value is smaller or the same as the previous one; default) or *strict* (every value has decreased)|Supported value types: int<br><br>Returns 1 if all elements in the time period continuously decrease, 0 otherwise.<br><br>Example:<br>=> **monodec**(/Host1/system.swap.size\[all,free\],**60s**) + **monodec**(/Host2/system.swap.size\[all,free\],**60s**) + **monodec**(/Host3/system.swap.size\[all,free\],**60s**) - calculate in how many hosts there has been a decrease in free swap size|
|**monoinc** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|<|
|<|Check if there has been a monotonous increase in values.|See [common parameters](#common parameters).<br><br>**mode** (must be double-quoted) - *weak* (every value is bigger or the same as the previous one; default) or *strict* (every value has increased)|Supported value types: int<br><br>Returns 1 if all elements in the time period continuously increase, 0 otherwise.<br><br>Example:<br>=> **monoinc**(/Host1/system.localtime,**\#3**,"strict")=0 - check if system local time has been increasing consistently|
|**nodata** (/host/key,sec,<mode>)|<|<|<|
|<|Checking for no data received.|See [common parameters](#common parameters).<br><br>**sec** period should not be less than 30 seconds because the history syncer process calculates this function only every 30 seconds.<br><br>nodata(/host/key,0) is disallowed.<br><br>**mode** - if set to *strict* (double-quoted), this function will be insensitive to proxy availability (see comments for details).|All value types are supported.<br><br>Returns:<br>1 - if no data received during the defined period of time<br>0 - otherwise<br><br>Since Zabbix 5.0, the 'nodata' triggers monitored by proxy are, by default, sensitive to proxy availability - if proxy becomes unavailable, the 'nodata' triggers will not fire immediately after a restored connection, but will skip the data for the delayed period. Note that for passive proxies suppression is activated if connection is restored more than 15 seconds and no less than 2 & ProxyUpdateFrequency seconds later. For active proxies suppression is activated if connection is restored more than 15 seconds later.<br><br>To turn off sensitiveness to proxy availability, use the third parameter, e.g.: **nodata**(/host/key,**5m**,**"strict"**); in this case the function will work the same as before 5.0.0 and fire as soon as the evaluation period (five minutes) without data has past.<br><br>Note that this function will display an error if, within the period of the 1st parameter:<br>- there's no data and Zabbix server was restarted<br>- there's no data and maintenance was completed<br>- there's no data and the item was added or re-enabled<br>Errors are displayed in the *Info* column in trigger [configuration](/manual/web_interface/frontend_sections/configuration/hosts/triggers).<br><br>This function may not work properly if there are time differences between Zabbix server, proxy and agent. See also: [Time synchronization requirement](/manual/installation/requirements#time_synchronization).|
|**percentile** (/host/key,(sec\|\#num)<:time shift>,percentage)|<|<|<|
|<|P-th percentile of a period, where P (percentage) is specified by the third parameter.|See [common parameters](#common parameters).<br><br>**percentage** - a floating-point number between 0 and 100 (inclusive) with up to 4 digits after the decimal point|Supported value types: float, int|
|**rate** (/host/key,sec<:time shift>)|<|<|<|
|<|Per-second average rate of the increase in a monotonically increasing counter within the defined time period.|See [common parameters](#common parameters).|Supported value types: float, int<br><br>Functionally corresponds to '[rate](https://prometheus.io/docs/prometheus/latest/querying/functions/#rate)' of PromQL.<br><br>Example:<br>=> **rate**(/host/key,**30s**) → If the monotonic increase over 30 seconds is 20, this function will return 0.67.|
|**trendavg** (/host/key,time period:time shift)|<|<|<|
|<|Average of trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendavg**(/host/key,**1h:now/h**) → average for the previous hour (e.g. 12:00-13:00)<br>=> **trendavg**(/host/key,**1h:now/h-1h**) → average for two hours ago (11:00-12:00)<br>=> **trendavg**(/host/key,**1h:now/h-2h**) → average for three hours ago (10:00-11:00)<br>=> **trendavg**(/host/key,**1M:now/M-1y**) → average for the previous month a year ago|
|**trendcount** (/host/key,time period:time shift)|<|<|<|
|<|Number of successfully retrieved trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendcount**(/host/key,**1h:now/h**) → count for the previous hour (e.g. 12:00-13:00)<br>=> **trendcount**(/host/key,**1h:now/h-1h**) → count for two hours ago (11:00-12:00)<br>=> **trendcount**(/host/key,**1h:now/h-2h**) → count for three hours ago (10:00-11:00)<br>=> **trendcount**(/host/key,**1M:now/M-1y**) → count for the previous month a year ago|
|**trendmax** (/host/key,time period:time shift)|<|<|<|
|<|The maximum in trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendmax**(/host/key,**1h:now/h**) → maximum for the previous hour (e.g. 12:00-13:00)<br>=> **trendmax**(/host/key,**1h:now/h**) - **trendmin**(/host/key,**1h:now/h**) → calculate the difference between the maximum and minimum values (trend delta) for the previous hour (12:00-13:00)<br>=> **trendmax**(/host/key,**1h:now/h-1h**) → maximum for two hours ago (11:00-12:00)<br>=> **trendmax**(/host/key,**1h:now/h-2h**) → maximum for three hours ago (10:00-11:00)<br>=> **trendmax**(/host/key,**1M:now/M-1y**) → maximum for the previous month a year ago|
|**trendmin** (/host/key,time period:time shift)|<|<|<|
|<|The minimum in trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendmin**(/host/key,**1h:now/h**) → minimum for the previous hour (e.g. 12:00-13:00)<br>=> **trendmax**(/host/key,**1h:now/h**) - **trendmin**(/host/key,**1h:now/h**) → calculate the difference between the maximum and minimum values (trend delta) for the previous hour (12:00-13:00)<br>=> **trendmin**(/host/key,**1h:now/h-1h**) → minimum for two hours ago (11:00-12:00)<br>=> **trendmin**(/host/key,**1h:now/h-2h**) → minimum for three hours ago (10:00-11:00)<br>=> **trendmin**(/host/key,**1M:now/M-1y**) → minimum for the previous month a year ago|
|**trendsum** (/host/key,time period:time shift)|<|<|<|
|<|Sum of trend values within the defined time period.|**time period** - the time period (minimum '1h'), defined as <N><time unit> where<br>`N` - number of time units<br>`time unit` - h (hour), d (day), w (week), M (month) or y (year).<br><br>[Time shift](/manual/config/triggers/expression#function-specific_parameters) - the time period offset (see examples)|Examples:<br>=> **trendsum**(/host/key,**1h:now/h**) → sum for the previous hour (e.g. 12:00-13:00)<br>=> **trendsum**(/host/key,**1h:now/h-1h**) → sum for two hours ago (11:00-12:00)<br>=> **trendsum**(/host/key,**1h:now/h-2h**) → sum for three hours ago (10:00-11:00)<br>=> **trendsum**(/host/key,**1M:now/M-1y**) → sum for the previous month a year ago|
#### History functions
|FUNCTION|<|<|
|--|--|--|
|**Description**|**Function-specific parameters**|**Comments**|
|**change** (/host/key)|<|<|
|The amount of difference between the previous and latest value.| |Supported value types: float, int, str, text, log<br><br>For strings returns:<br>0 - values are equal<br>1 - values differ<br><br>Example:<br>=> **change**(/host/key)>10<br><br>Numeric difference will be calculated, as seen with these incoming example values ('previous' and 'latest' value = difference):<br>'1' and '5' = `+4`<br>'3' and '1' = `-2`<br>'0' and '-2.5' = `-2.5`<br><br>See also: [abs](/manual/appendix/functions/math) for comparison|
|**changecount** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|
|Number of changes between adjacent values within the defined evaluation period.|See [common parameters](#common-parameters).<br><br>**mode** (optional; must be double-quoted)<br><br>Supported `modes`:<br>*all* - count all changes (default)<br>*dec* - count decreases<br>*inc* - count increases|Supported value types: float, int, str, text, log<br><br>For non-numeric value types, *mode* parameter is ignored.<br><br>Examples:<br>=> **changecount**(/host/key, 1w) → number of value changes for the last week until [now](/manual/config/triggers#evaluation_period)<br>=> **changecount**(/host/key,\#10,"inc") → number of value increases (relative to the adjacent value) among the last 10 values<br>=> **changecount**(/host/key,24h,"dec") → number of value decreases (relative to the adjacent value) for the last 24 hours until [now](/manual/config/triggers#evaluation_period)|
|**count** (/host/key,(sec\|\#num)<:time shift>,<operator>,<pattern>)|<|<|
|Number of values within the defined evaluation period.|See [common parameters](#common-parameters).<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default for integer, float)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* (default for string, text, log) - matches if contains pattern (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>Note that:<br>*eq* (default), *ne*, *gt*, *ge*, *lt*, *le*, *band*, *regexp*, *iregexp* are supported for integer items<br>*eq* (default), *ne*, *gt*, *ge*, *lt*, *le*, *regexp*, *iregexp* are supported for float items<br>*like* (default), *eq*, *ne*, *regexp*, *iregexp* are supported for string, text and log items<br><br>**pattern** (optional) - required pattern (string arguments must be double-quoted)|Supported value types: float, integer, string, text, log<br><br>Float items match with the precision of 2.22e-16; if database is [not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values) the precision is 0.000001.<br><br>With *bitand* as the third parameter, the fourth `pattern` parameter can be specified as two numbers, separated by '/': **number\_to\_compare\_with/mask**. count() calculates "bitwise AND" from the value and the *mask* and compares the result to *number\_to\_compare\_with*. If the result of "bitwise AND" is equal to *number\_to\_compare\_with*, the value is counted.<br>If *number\_to\_compare\_with* and *mask* are equal, only the *mask* need be specified (without '/').<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings. For the purpose of regexp matching, float values will always be represented with 4 decimal digits after '.'. Also note that for large numbers difference in decimal (stored in database) and binary (used by Zabbix server) representation may affect the 4th decimal digit.<br><br>Examples:<br>=> **count**(/host/key,**10m**) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period)<br>=> **count**(/host/key,**10m**,"like","error") → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that contain 'error'<br>=> **count**(/host/key,**10m**,,12) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that equal '12'<br>=> **count**(/host/key,**10m**,"gt",12) → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **count**(/host/key,**\#10**,"gt",12) → number of values within the last 10 values until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **count**(/host/key,**10m:now-1d**,"gt",12) → number of values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period) that were over '12'<br>=> **count**(/host/key,**10m**,"bitand","6/7") → number of values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) having '110' (in binary) in the 3 least significant bits.<br>=> **count**(/host/key,**10m:now-1d**) → number of values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period)|
|**countunique** (/host/key,(sec\|\#num)<:time shift>,<operator>,<pattern>)|<|<|
|Number of unique values within the defined evaluation period.|See [common parameters](#common-parameters).<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default for integer, float)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* (default for string, text, log) - matches if contains pattern (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>Note that:<br>*eq* (default), *ne*, *gt*, *ge*, *lt*, *le*, *band*, *regexp*, *iregexp* are supported for integer items<br>*eq* (default), *ne*, *gt*, *ge*, *lt*, *le*, *regexp*, *iregexp* are supported for float items<br>*like* (default), *eq*, *ne*, *regexp*, *iregexp* are supported for string, text and log items<br><br>**pattern** (optional) - required pattern (string arguments must be double-quoted)|Supported value types: float, integer, string, text, log<br><br>Float items match with the precision of 2.22e-16; if database is [not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values) the precision is 0.000001.<br><br>With *bitand* as the third parameter, the fourth `pattern` parameter can be specified as two numbers, separated by '/': **number\_to\_compare\_with/mask**. countunique() calculates "bitwise AND" from the value and the *mask* and compares the result to *number\_to\_compare\_with*. If the result of "bitwise AND" is equal to *number\_to\_compare\_with*, the value is counted.<br>If *number\_to\_compare\_with* and *mask* are equal, only the *mask* need be specified (without '/').<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings. For the purpose of regexp matching, float values will always be represented with 4 decimal digits after '.'. Also note that for large numbers difference in decimal (stored in database) and binary (used by Zabbix server) representation may affect the 4th decimal digit.<br><br>Examples:<br>=> **countunique**(/host/key,**10m**) → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period)<br>=> **countunique**(/host/key,**10m**,"like","error") → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that contain 'error'<br>=> **countunique**(/host/key,**10m**,"gt",12) → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **countunique**(/host/key,**\#10**,"gt",12) → number of unique values within the last 10 values until [now](/manual/config/triggers#evaluation_period) that are over '12'<br>=> **countunique**(/host/key,**10m:now-1d**,"gt",12) → number of unique values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period) that were over '12'<br>=> **countunique**(/host/key,**10m**,"bitand","6/7") → number of unique values for the last 10 minutes until [now](/manual/config/triggers#evaluation_period) having '110' (in binary) in the 3 least significant bits.<br>=> **countunique**(/host/key,**10m:now-1d**) → number of unique values between 24 hours and 10 minutes and 24 hours ago from [now](/manual/config/triggers#evaluation_period)|
|**find** (/host/key,<(sec\|\#num)<:time shift>>,<operator>,<pattern>)|<|<|
|Find a value match.|See [common parameters](#common-parameters).<br><br>**sec** or **\#num** (optional) - defaults to the latest value if not specified<br><br>**operator** (optional; must be double-quoted)<br><br>Supported `operators`:<br>*eq* - equal (default for integer, float)<br>*ne* - not equal<br>*gt* - greater<br>*ge* - greater or equal<br>*lt* - less<br>*le* - less or equal<br>*like* (default for string, text, log) - value contains the string given in `pattern` (case-sensitive)<br>*bitand* - bitwise AND<br>*regexp* - case-sensitive match of the regular expression given in `pattern`<br>*iregexp* - case-insensitive match of the regular expression given in `pattern`<br><br>Note that:<br>*eq* (default), *ne*, *gt*, *ge*, *lt*, *le*, *band*, *regexp*, *iregexp* are supported for integer items<br>*eq* (default), *ne*, *gt*, *ge*, *lt*, *le*, *regexp*, *iregexp* are supported for float items<br>*like* (default), *eq*, *ne*, *regexp*, *iregexp* are supported for string, text and log items<br><br>**pattern** - required pattern (string arguments must be double-quoted); [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) regular expression if `operator` is *regexp*, *iregexp*.|Supported value types: float, int, str, text, log<br><br>Returns:<br>1 - found<br>0 - otherwise<br><br>If more than one value is processed, '1' is returned if there is at least one matching value.<br><br>With *regexp* or *iregexp* as the third parameter, the fourth `pattern` parameter can be an ordinary or [global](/manual/regular_expressions#global_regular_expressions) (starting with '@') regular expression. In case of global regular expressions case sensitivity is inherited from global regular expression settings.<br><br>Example:<br>=> **find**(/host/key,**10m**,"like","error") → find a value that contains 'error' within the last 10 minutes until [now](/manual/config/triggers#evaluation_period)|
|**first** (/host/key,sec<:time shift>)|<|<|
|The first (the oldest) value within the defined evaluation period.|See [common parameters](#common-parameters).|Supported value types: float, int, str, text, log<br><br>Example:<br>=> **first**(/host/key,**1h**) → retrieve the oldest value within the last hour until [now](/manual/config/triggers#evaluation_period)<br><br>See also last().|
|**fuzzytime** (/host/key,sec)|<|<|
|Checking how much the passive agent time differs from the Zabbix server/proxy time.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Returns:<br>1 - difference between the passive item value (as timestamp) and Zabbix server/proxy timestamp (clock of value collection) is less than or equal to *sec* seconds<br>0 - otherwise<br><br>Usually used with the 'system.localtime' item to check that local time is in sync with the local time of Zabbix server. *Note* that 'system.localtime' must be configured as a [passive check](/manual/appendix/items/activepassive#passive_checks).<br>Can be used also with vfs.file.time\[/path/file,modify\] key to check that file didn't get updates for long time.<br><br>Example:<br>=> **fuzzytime**(/host/key,**60s**)=0 → detect a problem if the time difference is over 60 seconds<br><br>This function is not recommended for use in complex trigger expressions (with multiple items involved), because it may cause unexpected results (time difference will be measured with the most recent metric), e.g. in `fuzzytime(/Host/system.localtime,60s)=0 or last(/Host/trap)<>0`|
|**last** (/host/key,<\#num<:time shift>>)|<|<|
|The most recent value.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value|Supported value types: float, int, str, text, log<br><br>Take note that a hash-tagged time period (\#N) works differently here than with many other functions.<br>For example:<br>last(/host/key) is always equal to last(/host/key,\#1)<br>last(/host/key,\#3) - third most recent value (*not* three latest values)<br><br>Zabbix does not guarantee the exact order of values if more than two values exist within one second in history.<br><br>Example:<br>=> **last**(/host/key) → retrieve the last value<br>=> **last**(/host/key,**\#2**) → retrieve the previous value<br>=> **last**(/host/key,**\#1**) <> **last**(/host/key,**\#2**) → the last and previous values differ<br><br>See also first().|
|**logeventid** (/host/key,<\#num<:time shift>>,<pattern>)|<|<|
|Checking if event ID of the last log entry matches a regular expression.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value<br><br>**pattern** (optional) - regular expression describing the required pattern, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) style (string arguments must be double-quoted).|Supported value types: log<br><br>Returns:<br>0 - does not match<br>1 - matches|
|**logseverity** (/host/key,<\#num<:time shift>>)|<|<|
|Log severity of the last log entry.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value|Supported value types: log<br><br>Returns:<br>0 - default severity<br>N - severity (integer, useful for Windows event logs: 1 - Information, 2 - Warning, 4 - Error, 7 - Failure Audit, 8 - Success Audit, 9 - Critical, 10 - Verbose).<br>Zabbix takes log severity from **Information** field of Windows event log.|
|**logsource** (/host/key,<\#num<:time shift>>,<pattern>)|<|<|
|Checking if log source of the last log entry matches a regular expression.|See [common parameters](#common-parameters).<br><br>**\#num** (optional) - the Nth most recent value<br><br>**pattern** (optional) - regular expression describing the required pattern, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) style (string arguments must be double-quoted).|Supported value types: log<br><br>Returns:<br>0 - does not match<br>1 - matches<br><br>Normally used for Windows event logs. For example, logsource("VMware Server").|
|**monodec** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|
|Check if there has been a monotonous decrease in values.|See [common parameters](#common-parameters).<br><br>**mode** (must be double-quoted) - *weak* (every value is smaller or the same as the previous one; default) or *strict* (every value has decreased)|Supported value types: int<br><br>Returns 1 if all elements in the time period continuously decrease, 0 otherwise.<br><br>Example:<br>=> **monodec**(/Host1/system.swap.size\[all,free\],**60s**) + **monodec**(/Host2/system.swap.size\[all,free\],**60s**) + **monodec**(/Host3/system.swap.size\[all,free\],**60s**) - calculate in how many hosts there has been a decrease in free swap size|
|**monoinc** (/host/key,(sec\|\#num)<:time shift>,<mode>)|<|<|
|Check if there has been a monotonous increase in values.|See [common parameters](#common-parameters).<br><br>**mode** (must be double-quoted) - *weak* (every value is bigger or the same as the previous one; default) or *strict* (every value has increased)|Supported value types: int<br><br>Returns 1 if all elements in the time period continuously increase, 0 otherwise.<br><br>Example:<br>=> **monoinc**(/Host1/system.localtime,**\#3**,"strict")=0 - check if system local time has been increasing consistently|
|**nodata** (/host/key,sec,<mode>)|<|<|
|Checking for no data received.|See [common parameters](#common-parameters).<br><br>**sec** period should not be less than 30 seconds because the history syncer process calculates this function only every 30 seconds.<br><br>nodata(/host/key,0) is disallowed.<br><br>**mode** - if set to *strict* (double-quoted), this function will be insensitive to proxy availability (see comments for details).|All value types are supported.<br><br>Returns:<br>1 - if no data received during the defined period of time<br>0 - otherwise<br><br>Since Zabbix 5.0, the 'nodata' triggers monitored by proxy are, by default, sensitive to proxy availability - if proxy becomes unavailable, the 'nodata' triggers will not fire immediately after a restored connection, but will skip the data for the delayed period. Note that for passive proxies suppression is activated if connection is restored more than 15 seconds and no less than 2 seconds later. For active proxies suppression is activated if connection is restored more than 15 seconds later.<br><br>To turn off sensitiveness to proxy availability, use the third parameter, e.g.: **nodata**(/host/key,**5m**,**"strict"**); in this case the function will work the same as before 5.0.0 and fire as soon as the evaluation period (five minutes) without data has past.<br><br>Note that this function will display an error if, within the period of the 1st parameter:<br>- there's no data and Zabbix server was restarted<br>- there's no data and maintenance was completed<br>- there's no data and the item was added or re-enabled<br>Errors are displayed in the *Info* column in trigger [configuration](/manual/web_interface/frontend_sections/configuration/hosts/triggers).<br><br>This function may not work properly if there are time differences between Zabbix server, proxy and agent. See also: [Time synchronization requirement](/manual/installation/requirements#time_synchronization);<br><br>nodata() function cannot be used in the expression by itself; at least one function from [another group](/manual/appendix/functions), referencing the host item, must be included in the expression (except [date and time functions](/manual/appendix/functions/time)). For detailed information on how the nodata() function works within expressions, see [Calculation time](/manual/config/triggers#calculation-time).|
|**percentile** (/host/key,(sec\|\#num)<:time shift>,percentage)|<|<|
|P-th percentile of a period, where P (percentage) is specified by the third parameter.|See [common parameters](#common-parameters).<br><br>**percentage** - a floating-point number between 0 and 100 (inclusive) with up to 4 digits after the decimal point|Supported value types: float, int|
|**rate** (/host/key,sec<:time shift>)|<|<|
|Per-second average rate of the increase in a monotonically increasing counter within the defined time period.|See [common parameters](#common-parameters).|Supported value types: float, int<br><br>Functionally corresponds to '[rate](https://prometheus.io/docs/prometheus/latest/querying/functions/#rate)' of PromQL.<br><br>Example:<br>=> **rate**(/host/key,**30s**) → If the monotonic increase over 30 seconds is 20, this function will return 0.67.|
#### 历史函数
| 功能 | < | < |
|--|--|--|
| **Description** | **功能特定参数** | **注释** |
| **change** (/host/key) | < | < |
| The amount of difference between the previous and latest value. | | 支持的值类型: float, 整型, 字符串, 文本, 日志<br><br>对于字符串返回:<br>0 - 值相等<br>1 - 值不同<br><br>示例:<br>=> **change**(/主机/key)>10<br><br>数值差异将按如下方式计算，以下传入示例值 ('前一个' 与 '最新一个' 值 = 变化) 可见:<br>'1' 和 '5' = `+4`<br>'3' 和 '1' = `-2`<br>'0' 和 '-2.5' = `-2.5`<br><br>另请参阅: [abs](/manual/appendix/functions/math) 进行比较 |
| **changecount** (/host/key,(sec\ | \#num)<:时间偏移>,<模式>) | < | < |
| Number of changes between adjacent values within the defined evaluation period. | 参见[通用参数](#common-parameters)。<br><br>**mode**（可选；必须使用双引号）<br><br>支持的`modes`：<br>*all* - 统计所有变更（默认）<br>*dec* - 统计减少次数<br>*inc* - 统计增加次数 | 支持的值类型：float、整型、字符串、文本、日志<br><br>对于非数值类型，*mode*参数将被忽略。<br><br>示例：<br>=> **changecount**(/主机/key, 1w) → 最近一周内直到[评估周期](/manual/config/triggers#评估周期)的值变更次数<br>=> **changecount**(/主机/key,\#10,"inc") → 最近10个值中相对前值增加的次数（局部单调性检测：value[n] > value[n-1]）<br>=> **changecount**(/主机/key,24h,"dec") → 最近24小时内直到[评估周期](/manual/config/triggers#评估周期)的值减少次数（相对于相邻值） |
| **count** (/host/key,(sec\ | \#num)<:时间偏移>,<操作符>,<模式>) | < | < |
| Number of values within the defined evaluation period. | 参见[通用参数](#common-parameters).<br><br>**operator** (可选; 必须使用双引号)<br><br>支持的`operators`:<br>*eq* - 等于 (默认为integer, float)<br>*ne* - 不等于<br>*gt* - 大于<br>*ge* - 大于或等于<br>*lt* - 小于<br>*le* - 小于或等于<br>*like* (默认为string, 文本, 日志) - 如果包含模式则匹配(区分大小写)<br>*bitand* - 按位与<br>*regexp* - 对`pattern`中给定的正则表达式进行区分大小写的匹配<br>*iregexp* - 对`pattern`中给定的正则表达式进行不区分大小写的匹配<br><br>注意:<br>integer 监控项支持*eq*(默认), *ne*, *gt*, *ge*, *lt*, *le*, *band*, *regexp*, *iregexp*<br>浮点型监控项支持*eq*(默认), *ne*, *gt*, *ge*, *lt*, *le*, *regexp*, *iregexp*<br>string, 文本和日志监控项支持*like*(默认), *eq*, *ne*, *regexp*, *iregexp*<br><br>**pattern** (可选) - 所需模式(string参数必须使用双引号) | 支持的值类型: float, integer, string, 文本, 日志<br><br>浮点型监控项匹配精度为2.22e-16; 如果数据库是[not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values)则精度为0.000001.<br><br>当第三个参数为*bitand*时，第四个`pattern`参数可以指定为两个数字，用'/'分隔: **number\_to\_compare\_with/mask**. count()计算值与*mask*的"按位与"结果，并与*number\_to\_compare\_with*比较。如果"按位与"结果等于*number\_to\_compare\_with*，则计入该值。<br>如果*number\_to\_compare\_with*和*mask*相等，只需指定*mask*(不带'/').<br><br>当第三个参数为*regexp*或*iregexp*时，第四个`pattern`参数可以是普通或[全局正则表达式](/manual/regular_expressions#全局正则表达式)(以'@'开头)正则表达式。对于全局正则表达式，大小写敏感性继承自全局正则表达式设置。为了正则表达式匹配，float值将始终表示为小数点后4位。还需注意，对于大数，十进制(存储在数据库中)和二进制(由Zabbix server使用)表示的差异可能会影响第4位小数。<br><br>示例:<br>=> **count**(/主机/key,**10m**) → 最近10分钟直到[评估周期](/manual/config/triggers#评估周期)的值数量<br>=> **count**(/主机/key,**10m**,"like","error") → 最近10分钟直到[评估周期](/manual/config/triggers#评估周期)包含'错误'的值数量<br>=> **count**(/主机/key,**10m**,,12) → 最近10分钟直到[评估周期](/manual/config/triggers#评估周期)等于'12'的值数量<br>=> **count**(/主机/key,**10m**,"gt",12) → 最近10分钟直到[评估周期](/manual/config/triggers#评估周期)超过'12'的值数量<br>=> **count**(/主机/key,**\#10**,"gt",12) → 最近10个值直到[评估周期](/manual/config/triggers#评估周期)超过'12'的值数量<br>=> **count**(/主机/key,**10m:now-1d**,"gt",12) → 从[评估周期](/manual/config/triggers#评估周期)算起24小时前10分钟到24小时前超过'12'的值数量<br>=> **count**(/主机/key,**10m**,"bitand","6/7") → 最近10分钟直到[评估周期](/manual/config/triggers#评估周期)在最低3位有'110'(二进制)的值数量<br>=> **count**(/主机/key,**10m:now-1d**) → 从[评估周期](/manual/config/triggers#评估周期)算起24小时前10分钟到24小时前的值数量 |
| **countunique** (/host/key,(sec\ | \#num)<:时间偏移>,<操作符>,<模式>) | < | < |
| Number of unique values within the defined evaluation period. | 参见[通用参数](#common-parameters).<br><br>**operator** (可选; 必须使用双引号)<br><br>支持的`operators`:<br>*eq* - 等于 (默认为integer, float)<br>*ne* - 不等于<br>*gt* - 大于<br>*ge* - 大于或等于<br>*lt* - 小于<br>*le* - 小于或等于<br>*like* (默认为string, 文本, 日志) - 如果包含模式则匹配(区分大小写)<br>*bitand* - 按位与<br>*regexp* - 对`pattern`中给定的正则表达式进行区分大小写的匹配<br>*iregexp* - 对`pattern`中给定的正则表达式进行不区分大小写的匹配<br><br>注意:<br>*eq* (默认), *ne*, *gt*, *ge*, *lt*, *le*, *band*, *regexp*, *iregexp* 支持integer 监控项<br>*eq* (默认), *ne*, *gt*, *ge*, *lt*, *le*, *regexp*, *iregexp* 支持浮点型监控项<br>*like* (默认), *eq*, *ne*, *regexp*, *iregexp* 支持string, 文本和日志监控项<br><br>**pattern** (可选) - 必需的模式(string参数必须使用双引号) | 支持的值类型: float, integer, string, 文本, 日志<br><br>浮点型监控项匹配精度为2.22e-16; 如果数据库是[not upgraded](https://www.zabbix.com/documentation/5.0/manual/installation/upgrade_notes_500#enabling_extended_range_of_numeric_float_values)则精度为0.000001.<br><br>当第三个参数为*bitand*时，第四个`pattern`参数可以指定为两个数字，用'/'分隔: **number\_to\_compare\_with/mask**. countunique()计算值与*mask*的"按位与"结果，并与*number\_to\_compare\_with*比较。如果"按位与"结果等于*number\_to\_compare\_with*，则该值被计数。<br>如果*number\_to\_compare\_with*和*mask*相等，则只需指定*mask*(不带'/').<br><br>当第三个参数为*regexp*或*iregexp*时，第四个`pattern`参数可以是普通或[全局正则表达式](/manual/regular_expressions#全局正则表达式)(以'@'开头)的正则表达式。对于全局正则表达式，区分大小写继承自全局正则表达式设置。为了正则表达式匹配，float值将始终表示为小数点后4位。还需注意，对于大数，十进制(存储在数据库中)和二进制(由Zabbix server使用)表示的差异可能会影响第4位小数。<br><br>示例:<br>=> **countunique**(/主机/key,**10m**) → 最近10分钟到[评估周期](/manual/config/triggers#评估周期)的唯一值数量<br>=> **countunique**(/主机/key,**10m**,"like","error") → 最近10分钟到[评估周期](/manual/config/triggers#评估周期)包含'错误'的唯一值数量<br>=> **countunique**(/主机/key,**10m**,"gt",12) → 最近10分钟到[评估周期](/manual/config/triggers#评估周期)超过'12'的唯一值数量<br>=> **countunique**(/主机/key,**\#10**,"gt",12) → 最近10个值到[评估周期](/manual/config/triggers#评估周期)超过'12'的唯一值数量<br>=> **countunique**(/主机/key,**10m:now-1d**,"gt",12) → 从[评估周期](/manual/config/triggers#评估周期)算起24小时前10分钟到24小时前超过'12'的唯一值数量<br>=> **countunique**(/主机/key,**10m**,"bitand","6/7") → 最近10分钟到[评估周期](/manual/config/triggers#评估周期)在最低3位有'110'(二进制)的唯一值数量<br>=> **countunique**(/主机/key,**10m:now-1d**) → 从[评估周期](/manual/config/triggers#评估周期)算起24小时前10分钟到24小时前的唯一值数量 |
| **find** (/host/key,<(sec\ | \#num)<:时间偏移>>,<操作符>,<模式>) | < | < |
| Find a value match. | 参见[通用参数](#common-parameters).<br><br>**sec** 或 **\#num** (可选) - 未指定时默认取最新值<br><br>**operator** (可选; 必须使用双引号包裹)<br><br>支持的`operators`:<br>*eq* - 等于 (integer, float的默认值)<br>*ne* - 不等于<br>*gt* - 大于<br>*ge* - 大于等于<br>*lt* - 小于<br>*le* - 小于等于<br>*like* (string, 文本, 日志的默认值) - 值包含`pattern`中给定的string (区分大小写)<br>*bitand* - 按位与<br>*regexp* - 匹配`pattern`中给定的正则表达式 (区分大小写)<br>*iregexp* - 匹配`pattern`中给定的正则表达式 (不区分大小写)<br><br>注意事项:<br>integer 监控项支持: *eq* (默认), *ne*, *gt*, *ge*, *lt*, *le*, *band*, *regexp*, *iregexp*<br>浮点型监控项支持: *eq* (默认), *ne*, *gt*, *ge*, *lt*, *le*, *regexp*, *iregexp*<br>string, 文本和日志监控项支持: *like* (默认), *eq*, *ne*, *regexp*, *iregexp*<br><br>**pattern** - 必需的模式 (string参数必须使用双引号包裹); 当`operator`为*regexp*, *iregexp*时需提供[Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE)正则表达式 | 支持的值类型: float, int, str, text, log<br><br>返回值:<br>1 - 找到匹配项<br>0 - 其他情况<br><br>若处理多个值，当存在至少一个匹配值时返回'1'<br><br>当第三个参数为*regexp*或*iregexp*时，第四个`pattern`参数可以是普通或[全局正则表达式](/manual/regular_expressions#全局正则表达式) (以'@'开头)正则表达式。对于全局正则表达式，其大小写敏感特性继承自全局正则表达式设置。<br><br>示例:<br>=> **find**(/主机/key,**10m**,"like","error") → 在最近10分钟内查找包含[评估周期](/manual/config/triggers#评估周期)的'错误'值
| **first** (/host/key,sec<:time shift>) | < | < |
| The first (the oldest) value within the defined evaluation period. | 参见[通用参数](#common-parameters). | 支持的值类型: float, int, str, text, log<br><br>示例:<br>=> **first**(/主机/key,**1h**) → 获取最近一小时内的最旧值直到[评估周期](/manual/config/triggers#评估周期)<br><br>另见last(). |
| **fuzzytime** (/host/key,sec) | < | < |
| Checking how much the passive agent time differs from the Zabbix server/proxy time. | 参见[通用参数](#common-parameters) | 支持的值类型: float, int<br><br>返回值:<br>1 - 被动监控项值(作为时间戳)与Zabbix server/proxy时间戳(数值采集时钟)之间的差值小于等于*sec*秒<br>0 - 其他情况<br><br>通常与'system.localtime'监控项一起使用，用于检查本地时间是否与Zabbix server的本地时间同步。*注意*'system.localtime'必须配置为[被动检查](/manual/appendix/items/activepassive#被动检查)。<br>也可与vfs.file.time\[/path/file,modify\]键一起使用，检查file是否长时间未get更新。<br><br>示例:<br>=> **fuzzytime**(/主机/key,**60s**)=0 → 当时间差超过60秒时检测到问题<br><br>不建议在复杂触发器表达式中使用此函数(涉及多个监控项)，因为它可能导致意外结果(时间差将使用最新指标测量)，例如在`fuzzytime(/Host/system.localtime,60s)=0 or last(/Host/trap)<>0`中 |
| **last** (/host/key,<\#num<:time shift>>) | < | < |
| The most recent value. | 参见[通用参数](#common-parameters).<br><br>**\#num** (可选) - 第N个最近的值 | 支持的值类型: float, int, str, text, log<br><br>请注意带井号的时间段(\#N)在此处的运作方式与许多其他函数不同.<br>例如:<br>last(/主机/key) 始终等于 last(/主机/key,\#1)<br>last(/主机/key,\#3) - 第三个最近的值(*不是*三个最新值)<br><br>如果在历史记录中一秒内存在多个值，Zabbix不保证值的精确顺序.<br><br>示例:<br>=> **last**(/主机/key) → 获取最后一个值<br>=> **last**(/主机/key,**\#2**) → 获取前一个值<br>=> **last**(/主机/key,**\#1**) <> **last**(/主机/key,**\#2**) → 最后一个值和前一个值不同<br><br>另见first().
| **logeventid** (/host/key,<\#num<:time shift>>,<pattern>) | < | < |
| Checking if event ID of the last log entry matches a regular expression. | 参见[通用参数](#common-parameters).<br><br>**\#num** (可选) - 第N个最近的值<br><br>**pattern** (可选) - 描述所需模式的正则表达式, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) 风格 (string 参数必须使用双引号). | 支持的值类型: log<br><br>返回:<br>0 - 不匹配<br>1 - 匹配 |
| **logseverity** (/host/key,<\#num<:time shift>>) | < | < |
| Log severity of the last log entry. | 参见[通用参数](#common-parameters).<br><br>**\#num** (可选) - 第N个最新值 | 支持的值类型: log<br><br>返回值:<br>0 - 默认严重级别<br>N - 严重级别(integer, 适用于Windows事件日志: 1 - 信息, 2 - 警告, 4 - 错误, 7 - 失败审核, 8 - 成功审核, 9 - 严重, 10 - 详细).<br>Zabbix从Windows事件日志的**Information**字段获取日志严重级别. |
| **logsource** (/host/key,<\#num<:time shift>>,<pattern>) | < | < |
| Checking if log source of the last log entry matches a regular expression. | 参见[通用参数](#common-parameters).<br><br>**\#num** (可选) - 第N个最近的值<br><br>**pattern** (可选) - 描述所需模式的正则表达式, [Perl Compatible Regular Expression](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) (PCRE) 风格 (string 参数必须使用双引号). | 支持的值类型: log<br><br>返回:<br>0 - 不匹配<br>1 - 匹配<br><br>通常用于Windows事件日志. 例如, logsource("VMware Server"). |
| **monodec** (/host/key,(sec\ | \#num)<:time shift>,<mode>) | < | < |
| Check if there has been a monotonous decrease in values. | 参见[通用参数](#common-parameters).<br><br>**mode** (必须使用双引号) - *weak* (每个值小于或等于前一个值；默认) 或 *strict* (每个值均递减) | 支持值类型: int<br><br>如果时间段内所有元素持续递减则返回1，否则返回0.<br><br>示例:<br>=> **monodec**(/Host1/system.swap.size\[all,free\],**60s**) + **monodec**(/Host2/system.swap.size\[all,free\],**60s**) + **monodec**(/Host3/system.swap.size\[all,free\],**60s**) - 计算有多少个主机出现空闲交换空间减少的情况 |
| **monoinc** (/host/key,(sec\ | \#num)<:时间偏移>,<模式>) | < | < |
| Check if there has been a monotonous increase in values. | 参见[通用参数](#common-parameters)。<br><br>**mode** (必须使用双引号) - *weak* (每个值大于或等于前一个值；默认) 或 *strict* (每个值都严格递增) | 支持的值类型: int<br><br>如果时间段内所有元素持续递增则返回1，否则返回0。<br><br>示例:<br>=> **monoinc**(/Host1/system.localtime,**\#3**,"strict")=0 - 检查系统本地时间是否持续严格递增 |
| **nodata** (/host/key,sec,<mode>) | < | < |
| Checking for no data received. | 参见[通用参数](#common-parameters).<br><br>**sec** 周期不应小于30秒，因为历史同步器进程每30秒才计算一次此函数.<br><br>nodata(/主机/key,0) 是不允许的.<br><br>**mode** - 如果设置为*strict*(双引号包裹)，该函数将对proxy可用性不敏感(详见注释). | 支持所有值类型.<br><br>返回:<br>1 - 如果在定义的时间段内未收到数据<br>0 - 其他情况<br><br>从Zabbix 5.0开始，由proxy监控的'nodata'触发器默认对proxy可用性敏感 - 如果proxy变为不可用，'nodata'触发器不会在连接恢复后立即触发，而是会跳过延迟期间的数据。注意对于被动proxies，如果连接恢复时间超过15秒且不少于2秒，则会激活抑制。对于主动proxies，如果连接恢复时间超过15秒，则会激活抑制.<br><br>要关闭对proxy可用性的敏感性，请使用第三个参数，例如: **nodata**(/主机/key,**5m**,**"strict"**); 这种情况下该函数将像5.0.0之前版本一样工作，一旦超过评估周期(五分钟)没有数据就会立即触发.<br><br>注意如果在第一个参数周期内出现以下情况，该函数将显示错误:<br>- 没有数据且Zabbix server已重启<br>- 没有数据且维护已完成<br>- 没有数据且监控项已添加或重新启用<br>错误显示在触发器[configuration](/manual/web_interface/frontend_sections/configuration/hosts/triggers)的*Info*列中.<br><br>如果Zabbix server、proxy和agent之间存在时间差异，该函数可能无法正常工作。另请参阅: [时间同步](/manual/installation/requirements#时间同步);<br><br>nodata()函数不能单独在表达式中使用；表达式中必须包含至少一个来自[another group](/manual/appendix/functions)的函数，引用主机 监控项([date and time functions](/manual/appendix/functions/time)除外)。有关nodata()函数在表达式中如何工作的详细信息，请参阅[计算时间](/manual/config/triggers#计算时间). |
| **percentile** (/host/key,(sec\ | #num)<:时间偏移>,百分比) | < | < |
| P-th percentile of a period, where P (percentage) is specified by the third parameter. | 参见[通用参数](#common-parameters).<br><br>**percentage** - 介于0到100之间(含)的浮点数，小数点后最多4位 | 支持的值类型: float, int |
| **rate** (/host/key,sec<:time shift>) | < | < |
| Per-second average rate of the increase in a monotonically increasing counter within the defined time period. | 参见[通用参数](#common-parameters) | 支持的值类型: float, 整型<br><br>功能上对应PromQL的'[rate](https://prometheus.io/docs/prometheus/latest/querying/functions/#rate)'<br><br>示例:<br>=> **rate**(/主机/key,**30s**) → 若30秒内单调递增值为20，该函数将返回0.67 |
# history.get
# history.get
#### History
Retrieve historical values gathered by Zabbix monitoring processes for
presentation or further processing.
[History API](/manual/api/reference/history)
#### 历史数据
获取由Zabbix监控进程收集的历史数据
用于展示或进一步处理
[History API](/manual/api/reference/history)
### HMAC function for JavaScript
A new function has been added to the JavaScript engine allowing to return HMAC hash:
- `hmac('<hash type>',key,string)`
This is useful for cases when hash-based message authentication code (HMAC) is required for signing requests.
MD5 and SHA256 hash types are supported, e. g.:
- `hmac('md5',key,string)`
- `hmac('sha256',key,string)`
### JavaScript 的 HMAC 函数
JavaScript引擎新增了一个可返回HMAC哈希值的函数:
- `hmac('<hash type>',key,string)`
这在需要基于哈希的消息认证码(HMAC)来签署请求的场景中非常实用。
支持MD5和SHA256哈希类型，例如:
- `hmac('md5',key,string)`
- `hmac('sha256',key,string)`
#### Host access from several user groups
A user may belong to any number of user groups. These groups may have
different access permissions to hosts.
Therefore, it is important to know what hosts an unprivileged user will
be able to access as a result. For example, let us consider how access
to host **X** (in Hostgroup 1) will be affected in various situations
for a user who is in user groups A and B.
- If Group A has only *Read* access to Hostgroup 1, but Group B
*Read-write* access to Hostgroup 1, the user will get **Read-write**
access to 'X'.
::: noteimportant
“Read-write” permissions have precedence over
“Read” permissions starting with Zabbix 2.2.
:::
- In the same scenario as above, if 'X' is simultaneously also in
Hostgroup 2 that is **denied** to Group A or B, access to 'X' will
be **unavailable**, despite a *Read-write* access to Hostgroup 1.
- If Group A has no permissions defined and Group B has a *Read-write*
access to Hostgroup 1, the user will get **Read-write** access to
'X'.
- If Group A has *Deny* access to Hostgroup 1 and Group B has a
*Read-write* access to Hostgroup 1, the user will get access to 'X'
**denied**.
#### 来自多个用户组的主机访问
一个用户可以属于任意数量的用户组。这些组可能对主机拥有不同的访问权限。
因此，了解非特权用户最终能够访问哪些主机非常重要。例如，让我们考虑一个同时属于用户组A和B的用户，在不同情况下对主机组1中的主机 **X**的访问权限会如何变化。
- 如果组A对主机组1只有*读取*权限，而组B
*Read-write* access to Hostgroup 1, the user will get **Read-write**
access to 'X'.
::: noteimportant
从Zabbix 2.2开始，"读写"权限优先于"读取"权限。
:::
- 在上述相同场景中，如果'X'同时也在主机组2中，而组A或B被**拒绝**访问主机组2，那么即使对主机组1有*读写*权限，也无法访问'X'。
- 如果组A没有定义权限而组B对主机组1有*读写*权限，用户将get对'X'的**读写**访问权限。
- 如果组A对主机组1有*拒绝*权限而组B对主机组1有*读写*权限，用户将get对'X'的访问被**拒绝**。
##### Host configuration
A host must be configured to process IPMI checks. An IPMI interface must
be added, with the respective IP and port numbers, and IPMI
authentication parameters must be defined.
See the [configuration of hosts](/manual/config/hosts/host) for more
details.
##### 主机配置
一个主机 必须配置以处理IPMI检查。必须添加一个IPMI接口，包含相应的IP地址和端口号，并且必须定义IPMI认证参数。
有关更多详细信息，请参阅[configuration of hosts](/manual/config/hosts/host)。
#### Host configuration
To use VMware simple checks the host must have the following user macros
defined:
- **{$VMWARE.URL}** - VMware service (vCenter or ESX hypervisor) SDK
URL (<https://servername/sdk>)
- **{$VMWARE.USERNAME}** - VMware service user name
- **{$VMWARE.PASSWORD}** - VMware service {$VMWARE.USERNAME} user
password
#### Host 配置
要使用VMware简单检查主机必须定义以下用户宏:
- **{$VMWARE.URL}** - VMware服务(vCenter或ESX虚拟机管理程序)SDK URL (<https://servername/sdk>)
- **{$VMWARE.USERNAME}** - VMware服务用户名
- **{$VMWARE.PASSWORD}** - VMware服务{$VMWARE.USERNAME}用户密码
##### Host configuration
You can specify that an individual host should be monitored by a proxy
in the [host configuration](/manual/config/hosts/host) form, using the
*Monitored by proxy* field.
Host [mass update](/manual/config/hosts/hostupdate) is another way of
specifying that hosts should be monitored by a proxy.
##### 主机配置
您可以在[host configuration](/manual/config/hosts/host)表单中通过*由proxy监控*字段
指定单个主机应由proxy监控
主机 [mass update](/manual/config/hosts/hostupdate)是另一种
指定主机应由proxy监控的方式
# host.create
# host.create
##### Host creation
A host is added if the *Add host* operation is selected. A host is also
added, even if the *Add host* operation is missing, if you select
operations resulting in actions on a host. Such operations are:
- enable host
- disable host
- add host to a host group
- link template to a host
Created hosts are added to the *Discovered hosts* group (by default,
configurable in *Administration* → *General* →
*[Other](/manual/web_interface/frontend_sections/administration/general#other_parameters)*).
If you wish hosts to be added to another group, add a *Remove from host
groups* operation (specifying "Discovered hosts") and also add an *Add
to host groups* operation (specifying another host group), because a
host must belong to a host group.
The IP address of the discovered device is the criterion for finding a host in the system. If a host with that IP address and interface type already exists, that host will be the target for performing operations.
If the IP address of the discovered host is changed or the interface is deleted, a new host will be created upon the next discovery.
##### 主机创建
如果选择了*添加主机*操作，则会添加一个主机。即使缺少*添加主机*操作，如果选择对一个主机执行操作的命令，也会添加一个主机。这些操作包括：
- 启用主机
- 禁用主机
- 将主机添加到一个主机组
- 将模板链接到一个主机
创建的主机会被添加到*已发现的主机*组（默认情况下，可在*管理* → *常规* → *[其他参数](/manual/web_interface/frontend_sections/administration/general#其他参数)*中配置）。
如果希望将主机添加到其他组，请添加*从主机组中移除*操作（指定"已发现的主机"），并同时添加*添加到主机组*操作（指定另一个主机组），因为主机必须属于一个主机组。
发现设备的IP地址是在系统中查找一个主机的标准。如果具有该IP地址和接口类型的一个主机已存在，则该主机将成为执行操作的目标。
如果发现的主机的IP地址发生更改或接口被删除，则在下次发现时将创建一个新的主机。
# host.delete
# host.delete
#### Host editing as popup
The form for host creation and editing is now opened in a modal (popup)
window, in *Configuration* → *Hosts*, *Monitoring* → *Hosts* and in any
page, where there is a host menu or other direct link to the host
configuration.
Direct links to the host edit page still work and are opening the host
edit page in full page.
#### 主机编辑弹窗
主机创建和编辑表单现已在模态窗口(弹出窗口)中打开，包括*配置*→*主机*、*监控*→*主机*以及任何包含一个主机菜单或其他直接链接至主机配置的页面。
指向主机编辑页面的直接链接仍然有效，并会在完整页面中打开主机编辑界面。
# host.get
# host.get
##### Host graph tags
|Element|Element property|Required|Type|Range^**[1](#footnotes)**^|Description|
|--|--|-|--|----|--------|
|graphs| |\-| | |Root element for graphs.|
| |name|x|`string`| |Graph name.|
| |width|\-|`integer`|20-65535 (default: 900)|Graph width, in pixels. Used for preview and for pie/exploded graphs.|
| |height|\-|`integer`|20-65535 (default: 200)|Graph height, in pixels. Used for preview and for pie/exploded graphs.|
| |yaxismin|\-|`double`|Default: 0|Value of Y axis minimum.<br><br>Used if 'ymin\_type\_1' is FIXED.|
| |yaxismax|\-|`double`|Default: 0|Value of Y axis maximum.<br><br>Used if 'ymax\_type\_1' is FIXED.|
| |show\_work\_period|\-|`string`|0 - NO<br>1 - YES (default)|Highlight non-working hours.<br><br>Used by normal and stacked graphs.|
| |show\_triggers|\-|`string`|0 - NO<br>1 - YES (default)|Display simple trigger values as a line.<br><br>Used by normal and stacked graphs.|
| |type|\-|`string`|0 - NORMAL (default)<br>1 - STACKED<br>2 - PIE<br>3 - EXPLODED|Graph type.|
| |show\_legend|\-|`string`|0 - NO<br>1 - YES (default)|Display graph legend.|
| |show\_3d|\-|`string`|0 - NO (default)<br>1 - YES|Enable 3D style.<br><br>Used by pie and exploded pie graphs.|
| |percent\_left|\-|`double`|Default:0|Show the percentile line for left axis.<br><br>Used only for normal graphs.|
| |percent\_right|\-|`double`|Default:0|Show the percentile line for right axis.<br><br>Used only for normal graphs.|
| |ymin\_type\_1|\-|`string`|0 - CALCULATED (default)<br>1 - FIXED<br>2 - ITEM|Minimum value of Y axis.<br><br>Used by normal and stacked graphs.|
| |ymax\_type\_1|\-|`string`|0 - CALCULATED (default)<br>1 - FIXED<br>2 - ITEM|Maximum value of Y axis.<br><br>Used by normal and stacked graphs.|
|ymin\_item\_1| |\-| | |Individual item details.<br><br>Required if 'ymin\_type\_1' is ITEM.|
| |host|x|`string`| |Item host.|
| |key|x|`string`| |Item key.|
|ymax\_item\_1| |\-| | |Individual item details.<br><br>Required if 'ymax\_type\_1' is ITEM.|
| |host|x|`string`| |Item host.|
| |key|x|`string`| |Item key.|
|graph\_items| |x| | |Root element for graph items.|
| |sortorder|\-|`integer`| |Draw order. The smaller value is drawn first. Can be used to draw lines or regions behind (or in front of) another.|
| |drawtype|\-|`string`|0 - SINGLE\_LINE (default)<br>1 - FILLED\_REGION<br>2 - BOLD\_LINE<br>3 - DOTTED\_LINE<br>4 - DASHED\_LINE<br>5 - GRADIENT\_LINE|Draw style of the graph item.<br><br>Used only by normal graphs.|
| |color|\-|`string`| |Element color (6 symbols, hex).|
| |yaxisside|\-|`string`|0 - LEFT (default)<br>1 - RIGHT|Side of the graph where the graph item's Y scale will be drawn.<br><br>Used by normal and stacked graphs.|
| |calc\_fnc|\-|`string`|1 - MIN<br>2 - AVG (default)<br>4 - MAX<br>7 - ALL (minimum, average and maximum; used only by simple graphs)<br>9 - LAST (used only by pie and exploded pie graphs)|Data to draw if more than one value exists for an item.|
| |type|\-|`string`|0 - SIMPLE (default)<br>2 - GRAPH\_SUM (value of the item represents the whole pie; used only by pie and exploded pie graphs)|Graph item type.|
|item| |x| | |Individual item.|
| |host|x|`string`| |Item host.|
| |key|x|`string`| |Item key.|
##### 主机图形标签
| 元素 | 元素属性 | 必填 | 类型 | 范围^**[1](#footnotes)**^ | 描述 |
|--|--|-|--|----|--------|
| graphs | | \- | | | 图表根元素。 |
| | name | x | `string` | | 图表名称。 |
| | width | \- | `integer` | 20-65535 (default: 900) | 图表宽度，单位为像素。用于预览及饼图/爆炸图。 |
| | height | \- | `integer` | 20-65535 (default: 200) | 图表高度，单位为像素。用于预览及饼图/爆炸图。 |
| | yaxismin | \- | `double` | Default: 0 | Y轴最小值。<br><br>当'ymin\_type\_1'为FIXED时使用。 |
| | yaxismax | \- | `double` | Default: 0 | Y轴最大值。<br><br>当'ymax\_type\_1'为FIXED时使用。 |
| | show\_work\_period | \- | `string` | 0 - NO<br>1 - YES (default) | 高亮非工作时间。<br><br>用于普通图和堆叠图。 |
| | show\_triggers | \- | `string` | 0 - NO<br>1 - YES (default) | 将简单触发器值显示为线条。<br><br>用于普通图和堆叠图。 |
| | type | \- | `string` | 0 - NORMAL (default)<br>1 - STACKED<br>2 - PIE<br>3 - EXPLODED | 图表类型。 |
| | show\_legend | \- | `string` | 0 - NO<br>1 - YES (default) | 显示图例。 |
| | show\_3d | \- | `string` | 0 - NO (default)<br>1 - YES | 启用3D样式。<br><br>用于饼图和爆炸饼图。 |
| | percent\_left | \- | `double` | Default:0 | 显示左轴百分位线。<br><br>仅用于普通图。 |
| | percent\_right | \- | `double` | Default:0 | 显示右轴百分位线。<br><br>仅用于普通图。 |
| | ymin\_type\_1 | \- | `string` | 0 - CALCULATED (default)<br>1 - FIXED<br>2 - ITEM | Y轴最小值。<br><br>用于普通图和堆叠图。 |
| | ymax\_type\_1 | \- | `string` | 0 - CALCULATED (default)<br>1 - FIXED<br>2 - ITEM | Y轴最大值。<br><br>用于普通图和堆叠图。 |
| ymin\_item\_1 | | \- | | | 单个监控项详情。<br><br>当'ymin\_type\_1'为监控项时必填。 |
| | host | x | `string` | | 监控项 主机。 |
| | key | x | `string` | | 监控项键。 |
| ymax\_item\_1 | | \- | | | 单个监控项详情。<br><br>当'ymax\_type\_1'为监控项时必填。 |
| | host | x | `string` | | 监控项 主机。 |
| | key | x | `string` | | 监控项键。 |
| graph\_items | | x | | | 图表监控项根元素。 |
| | sortorder | \- | `integer` | | 绘制顺序。数值小的优先绘制。可用于将线条或区域绘制在另一元素后方(或前方)。 |
| | drawtype | \- | `string` | 0 - SINGLE\_LINE (default)<br>1 - FILLED\_REGION<br>2 - BOLD\_LINE<br>3 - DOTTED\_LINE<br>4 - DASHED\_LINE<br>5 - GRADIENT\_LINE | 图表监控项绘制样式。<br><br>仅用于普通图。 |
| | color | \- | `string` | | 元素颜色(6位十六进制)。 |
| | yaxisside | \- | `string` | 0 - LEFT (default)<br>1 - RIGHT | 图表监控项Y轴绘制位置。<br><br>用于普通图和堆叠图。 |
| | calc\_fnc | \- | `string` | 1 - MIN<br>2 - AVG (default)<br>4 - MAX<br>7 - ALL (minimum, average and maximum; used only by simple graphs)<br>9 - LAST (used only by pie and exploded pie graphs) | 当监控项存在多个值时绘制何种数据。 |
| | type | \- | `string` | 0 - SIMPLE (default)<br>2 - GRAPH\_SUM (value of the item represents the whole pie; used only by pie and exploded pie graphs) | 图表监控项类型。 |
| item | | x | | | 单个监控项。 |
| | host | x | `string` | | 监控项 主机。 |
| | key | x | `string` | | 监控项键。 |
# hostgroup.create
# hostgroup.create
# hostgroup.delete
# hostgroup.delete
# hostgroup.get
# hostgroup.get
# hostgroup.massadd
# hostgroup.massadd
# hostgroup.massremove
# hostgroup.massremove
# hostgroup.massupdate
# hostgroup.massupdate
### Host group
The host group object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|groupid|string|*(readonly)* ID of the host group.|
|**name**<br>(required)|string|Name of the host group.|
|flags|integer|*(readonly)* Origin of the host group.<br><br>Possible values:<br>0 - a plain host group;<br>4 - a discovered host group.|
|internal|integer|*(readonly)* Whether the group is used internally by the system. An internal group cannot be deleted.<br><br>Possible values:<br>0 - *(default)* not internal;<br>1 - internal.|
|uuid|string|Universal unique identifier, used for linking imported host groups to already existing ones. Auto-generated, if not given.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 主机组
主机 组 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| groupid | string | *(只读)* 主机 组的 ID。 |
| **name**<br>(required) | string | 主机 组的名称。 |
| flags | integer | *(只读)* 主机 组的来源。<br><br>可能的值：<br>0 - 普通 主机组;<br>4 - 发现的 主机组。 |
| internal | integer | *(只读)* 该组是否由系统内部使用。内部组无法删除。<br><br>可能的值：<br>0 - *(默认)* 非内部;<br>1 - 内部。 |
| uuid | string | 通用唯一标识符，用于将导入的 主机 组链接到已存在的组。如果未提供，则自动生成。 |
请注意，对于某些方法 (update, delete)，必需/可选参数的组合是不同的。
# hostgroup.update
# hostgroup.update
# hostinterface.create
# hostinterface.create
# hostinterface.delete
# hostinterface.delete
# hostinterface.get
# hostinterface.get
# hostinterface.massadd
# hostinterface.massadd
# hostinterface.massremove
# hostinterface.massremove
# hostinterface.replacehostinterfaces
# hostinterface.replacehostinterfaces
### Host interface
The host interface object has the following properties.
::: noteimportant
Note that both IP and DNS are required. If you do
not want to use DNS, set it to an empty string.
:::
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|available|integer|*(readonly)* Availability of host interface.<br><br>Possible values are:<br>0 - *(default)* unknown;<br>1 - available;<br>2 - unavailable.|
|details|object|Additional object for interface. **Required** if interface 'type' is SNMP.|
|disable\_until|timestamp|*(readonly)* The next polling time of an unavailable host interface.|
|**dns**<br>(required)|string|DNS name used by the interface.<br><br>Can be empty if the connection is made via IP.|
|error|string|*(readonly)* Error text if host interface is unavailable.|
|errors\_from|timestamp|*(readonly)* Time when host interface became unavailable.|
|**hostid**<br>(required)|string|ID of the host the interface belongs to.|
|interfaceid|string|*(readonly)* ID of the interface.|
|**ip**<br>(required)|string|IP address used by the interface.<br><br>Can be empty if the connection is made via DNS.|
|**main**<br>(required)|integer|Whether the interface is used as default on the host. Only one interface of some type can be set as default on a host.<br><br>Possible values are:<br>0 - not default;<br>1 - default.|
|**port**<br>(required)|string|Port number used by the interface. Can contain user macros.|
|**type**<br>(required)|integer|Interface type.<br><br>Possible values are:<br>1 - agent;<br>2 - SNMP;<br>3 - IPMI;<br>4 - JMX.<br>|
|**useip**<br>(required)|integer|Whether the connection should be made via IP.<br><br>Possible values are:<br>0 - connect using host DNS name;<br>1 - connect using host IP address for this host interface.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 主机接口
主机 接口 object 具有以下属性。
::: noteimportant
注意IP和DNS均为必填项。若您
不想使用DNS，请将其设为空 string。
:::
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| available | integer | *(只读)* 主机 接口的可用性。<br><br>可能值为:<br>0 - *(默认)* 未知;<br>1 - 可用;<br>2 - 不可用。 |
| details | object | 接口的附加 object。当接口 '类型' 为SNMP时**必填**。 |
| disable\_until | timestamp | *(只读)* 不可用 主机 接口的下次轮询时间。 |
| **dns**<br>(required) | string | 接口使用的DNS名称。<br><br>若通过IP连接可留空。 |
| error | string | *(只读)* 当 主机 接口不可用时的错误文本。 |
| errors\_from | timestamp | *(只读)* 主机 接口变为不可用的时间。 |
| **hostid**<br>(required) | string | 接口所属 主机 的ID。 |
| interfaceid | string | *(只读)* 接口的ID。 |
| **ip**<br>(required) | string | 接口使用的IP地址。<br><br>若通过DNS连接可留空。 |
| **main**<br>(required) | integer | 是否作为 主机 的默认接口。每种类型接口在 一个主机 上只能设置一个默认项。<br><br>可能值为:<br>0 - 非默认;<br>1 - 默认。 |
| **port**<br>(required) | string | 接口使用的端口号。可包含用户宏。 |
| **type**<br>(required) | integer | 接口类型。<br><br>可能值为:<br>1 - agent;<br>2 - SNMP;<br>3 - IPMI;<br>4 - JMX。<br> |
| **useip**<br>(required) | integer | 是否应通过IP建立连接。<br><br>可能值为:<br>0 - 使用 主机DNS名称 连接;<br>1 - 为此 主机 接口使用 主机IP地址 连接。 |
注意对于某些方法(update, delete)，必填/可选参数的组合会有所不同。
# hostinterface.update
# hostinterface.update
### Host inventory
The host inventory object has the following properties.
::: notetip
Each property has it's own unique ID number, which is
used to associate host inventory fields with items.
:::
|ID|Property|[Type](/manual/api/reference_commentary#data_types)|Description|Maximum length|
|-|--|-|-----|-----|
|4|alias|string|Alias.|128 characters|
|11|asset\_tag|string|Asset tag.|64 characters|
|28|chassis|string|Chassis.|64 characters|
|23|contact|string|Contact person.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|32|contract\_number|string|Contract number.|64 characters|
|47|date\_hw\_decomm|string|HW decommissioning date.|64 characters|
|46|date\_hw\_expiry|string|HW maintenance expiry date.|64 characters|
|45|date\_hw\_install|string|HW installation date.|64 characters|
|44|date\_hw\_purchase|string|HW purchase date.|64 characters|
|34|deployment\_status|string|Deployment status.|64 characters|
|14|hardware|string|Hardware.|255 characters|
|15|hardware\_full|string|Detailed hardware.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|39|host\_netmask|string|Host subnet mask.|39 characters|
|38|host\_networks|string|Host networks.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|40|host\_router|string|Host router.|39 characters|
|30|hw\_arch|string|HW architecture.|32 characters|
|33|installer\_name|string|Installer name.|64 characters|
|24|location|string|Location.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|25|location\_lat|string|Location latitude.|16 characters|
|26|location\_lon|string|Location longitude.|16 characters|
|12|macaddress\_a|string|MAC address A.|64 characters|
|13|macaddress\_b|string|MAC address B.|64 characters|
|29|model|string|Model.|64 characters|
|3|name|string|Name.|128 characters|
|27|notes|string|Notes.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|41|oob\_ip|string|OOB IP address.|39 characters|
|42|oob\_netmask|string|OOB host subnet mask.|39 characters|
|43|oob\_router|string|OOB router.|39 characters|
|5|os|string|OS name.|128 characters|
|6|os\_full|string|Detailed OS name.|255 characters|
|7|os\_short|string|Short OS name.|128 characters|
|61|poc\_1\_cell|string|Primary POC mobile number.|64 characters|
|58|poc\_1\_email|string|Primary email.|128 characters|
|57|poc\_1\_name|string|Primary POC name.|128 characters|
|63|poc\_1\_notes|string|Primary POC notes.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|59|poc\_1\_phone\_a|string|Primary POC phone A.|64 characters|
|60|poc\_1\_phone\_b|string|Primary POC phone B.|64 characters|
|62|poc\_1\_screen|string|Primary POC screen name.|64 characters|
|68|poc\_2\_cell|string|Secondary POC mobile number.|64 characters|
|65|poc\_2\_email|string|Secondary POC email.|128 characters|
|64|poc\_2\_name|string|Secondary POC name.|128 characters|
|70|poc\_2\_notes|string|Secondary POC notes.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|66|poc\_2\_phone\_a|string|Secondary POC phone A.|64 characters|
|67|poc\_2\_phone\_b|string|Secondary POC phone B.|64 characters|
|69|poc\_2\_screen|string|Secondary POC screen name.|64 characters|
|8|serialno\_a|string|Serial number A.|64 characters|
|9|serialno\_b|string|Serial number B.|64 characters|
|48|site\_address\_a|string|Site address A.|128 characters|
|49|site\_address\_b|string|Site address B.|128 characters|
|50|site\_address\_c|string|Site address C.|128 characters|
|51|site\_city|string|Site city.|128 characters|
|53|site\_country|string|Site country.|64 characters|
|56|site\_notes|string|Site notes.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|55|site\_rack|string|Site rack location.|128 characters|
|52|site\_state|string|Site state.|64 characters|
|54|site\_zip|string|Site ZIP/postal code.|64 characters|
|16|software|string|Software.|255 characters|
|18|software\_app\_a|string|Software application A.|64 characters|
|19|software\_app\_b|string|Software application B.|64 characters|
|20|software\_app\_c|string|Software application C.|64 characters|
|21|software\_app\_d|string|Software application D.|64 characters|
|22|software\_app\_e|string|Software application E.|64 characters|
|17|software\_full|string|Software details.|Depends on the database used:<br>- 65535 characters for SQL databases<br>- 2048 characters for Oracle databases|
|10|tag|string|Tag.|64 characters|
|1|type|string|Type.|64 characters|
|2|type\_full|string|Type details.|64 characters|
|35|url\_a|string|URL A.|255 characters|
|36|url\_b|string|URL B.|255 characters|
|37|url\_c|string|URL C.|255 characters|
|31|vendor|string|Vendor.|64 characters|
### 主机资产清单
主机 资产清单 object 具有以下属性.
::: notetip
每个属性都有其唯一的ID编号, 用于将 主机 资产清单字段与 监控项 关联.
:::
| ID | 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 | 最大长度 |
|-|--|-|-----|-----|
| 4 | alias | string | alias. | 128字符 |
| 11 | asset\_tag | string | 资产标签. | 64字符 |
| 28 | chassis | string | 机箱. | 64字符 |
| 23 | contact | string | 联系人. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 32 | contract\_number | string | 合同编号. | 64字符 |
| 47 | date\_hw\_decomm | string | 硬件退役日期. | 64字符 |
| 46 | date\_hw\_expiry | string | 硬件维护到期日. | 64字符 |
| 45 | date\_hw\_install | string | 硬件安装日期. | 64字符 |
| 44 | date\_hw\_purchase | string | 硬件购买日期. | 64字符 |
| 34 | deployment\_status | string | 部署状态. | 64字符 |
| 14 | hardware | string | 硬件. | 255字符 |
| 15 | hardware\_full | string | 详细硬件信息. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 39 | host\_netmask | string | 主机 子网掩码. | 39字符 |
| 38 | host\_networks | string | 主机 网络. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 40 | host\_router | string | 主机 路由器. | 39字符 |
| 30 | hw\_arch | string | 硬件架构. | 32字符 |
| 33 | installer\_name | string | 安装者名称. | 64字符 |
| 24 | location | string | 位置. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 25 | location\_lat | string | 位置纬度. | 16字符 |
| 26 | location\_lon | string | 位置经度. | 16字符 |
| 12 | macaddress\_a | string | MAC地址A. | 64字符 |
| 13 | macaddress\_b | string | MAC地址B. | 64字符 |
| 29 | model | string | 型号. | 64字符 |
| 3 | name | string | 名称. | 128字符 |
| 27 | notes | string | 备注. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 41 | oob\_ip | string | 带外IP地址. | 39字符 |
| 42 | oob\_netmask | string | 带外 主机 子网掩码. | 39字符 |
| 43 | oob\_router | string | 带外路由器. | 39字符 |
| 5 | os | string | 操作系统名称. | 128字符 |
| 6 | os\_full | string | 详细操作系统名称. | 255字符 |
| 7 | os\_short | string | 简短操作系统名称. | 128字符 |
| 61 | poc\_1\_cell | string | 主要联系人手机号. | 64字符 |
| 58 | poc\_1\_email | string | 主要邮箱. | 128字符 |
| 57 | poc\_1\_name | string | 主要联系人姓名. | 128字符 |
| 63 | poc\_1\_notes | string | 主要联系人备注. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 59 | poc\_1\_phone\_a | string | 主要联系人电话A. | 64字符 |
| 60 | poc\_1\_phone\_b | string | 主要联系人电话B. | 64字符 |
| 62 | poc\_1\_screen | string | 主要联系人屏幕名称. | 64字符 |
| 68 | poc\_2\_cell | string | 次要联系人手机号. | 64字符 |
| 65 | poc\_2\_email | string | 次要联系人邮箱. | 128字符 |
| 64 | poc\_2\_name | string | 次要联系人姓名. | 128字符 |
| 70 | poc\_2\_notes | string | 次要联系人备注. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 66 | poc\_2\_phone\_a | string | 次要联系人电话A. | 64字符 |
| 67 | poc\_2\_phone\_b | string | 次要联系人电话B. | 64字符 |
| 69 | poc\_2\_screen | string | 次要联系人屏幕名称. | 64字符 |
| 8 | serialno\_a | string | 序列号A. | 64字符 |
| 9 | serialno\_b | string | 序列号B. | 64字符 |
| 48 | site\_address\_a | string | 站点地址A. | 128字符 |
| 49 | site\_address\_b | string | 站点地址B. | 128字符 |
| 50 | site\_address\_c | string | 站点地址C. | 128字符 |
| 51 | site\_city | string | 站点城市. | 128字符 |
| 53 | site\_country | string | 站点国家. | 64字符 |
| 56 | site\_notes | string | 站点备注. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 55 | site\_rack | string | 站点机架位置. | 128字符 |
| 52 | site\_state | string | 站点州/省. | 64字符 |
| 54 | site\_zip | string | 站点邮编. | 64字符 |
| 16 | software | string | 软件. | 255字符 |
| 18 | software\_app\_a | string | 软件应用A. | 64字符 |
| 19 | software\_app\_b | string | 软件应用B. | 64字符 |
| 20 | software\_app\_c | string | 软件应用C. | 64字符 |
| 21 | software\_app\_d | string | 软件应用D. | 64字符 |
| 22 | software\_app\_e | string | 软件应用E. | 64字符 |
| 17 | software\_full | string | 软件详情. | 取决于使用的数据库:<br>- SQL数据库支持65535字符<br>- Oracle数据库支持2048字符 |
| 10 | tag | string | 标签. | 64字符 |
| 1 | type | string | 类型. | 64字符 |
| 2 | type\_full | string | 类型详情. | 64字符 |
| 35 | url\_a | string | URL A. | 255字符 |
| 36 | url\_b | string | URL B. | 255字符 |
| 37 | url\_c | string | URL C. | 255字符 |
| 31 | vendor | string | 供应商. | 64字符 |
##### Host item tags
|Element|Element property|Required|Type|Range^**[1](#footnotes)**^|Description|
|--|--|-|--|----|--------|
|items| |\-| | |Root element for items.|
| |name|x|`string`| |Item name.|
| |type|\-|`string`|0 - ZABBIX\_PASSIVE (default)<br>2 - TRAP<br>3 - SIMPLE<br>5 - INTERNAL<br>7 - ZABBIX\_ACTIVE<br>10 - EXTERNAL<br>11 - ODBC<br>12 - IPMI<br>13 - SSH<br>14 - TELNET<br>15 - CALCULATED<br>16 - JMX<br>17 - SNMP\_TRAP<br>18 - DEPENDENT<br>19 - HTTP\_AGENT<br>20 - SNMP\_AGENT<br>21 - ITEM\_TYPE\_SCRIPT|Item type.|
| |snmp\_oid|\-|`string`| |SNMP object ID.<br><br>Required by SNMP items.|
| |key|x|`string`| |Item key.|
| |delay|\-|`string`|Default: 1m|Update interval of the item.<br><br>Note that `delay` will be always '0' for trapper items.<br><br>Accepts seconds or a time unit with suffix (30s, 1m, 2h, 1d).<br>Optionally one or more [custom intervals](/manual/config/items/item/custom_intervals) can be specified either as flexible intervals or scheduling.<br>Multiple intervals are separated by a semicolon.<br>User macros may be used. A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.<br>Flexible intervals may be written as two macros separated by a forward slash (e.g. `{$FLEX_INTERVAL}/{$FLEX_PERIOD}`).|
| |history|\-|`string`|Default: 90d|Time period of how long the history data should be stored. A time period using the time suffix, a user macro or LLD macro.|
| |trends|\-|`string`|Default: 365d|Time period of how long the trends data should be stored. A time period using the time suffix, a user macro or LLD macro.|
| |status|\-|`string`|0 - ENABLED (default)<br>1 - DISABLED|Item status.|
| |value\_type|\-|`string`|0 - FLOAT<br>1 - CHAR<br>2 - LOG<br>3 - UNSIGNED (default)<br>4 - TEXT|Received value type.|
| |allowed\_hosts|\-|`string`| |List of IP addresses (comma delimited) of hosts allowed sending data for the item.<br><br>Used by trapper and HTTP agent items.|
| |units|\-|`string`| |Units of returned values (bps, B, etc).|
| |params|\-|`text`| |Additional parameters depending on the type of the item:<br>- executed script for Script, SSH and Telnet items;<br>- SQL query for database monitor items;<br>- formula for calculated items.|
| |ipmi\_sensor|\-|`string`| |IPMI sensor.<br><br>Used only by IPMI items.|
| |authtype|\-|`string`|Authentication type for SSH agent items:<br>0 - PASSWORD (default)<br>1 - PUBLIC\_KEY<br><br>Authentication type for HTTP agent items:<br>0 - NONE (default)<br>1 - BASIC<br>2 - NTLM|Authentication type.<br><br>Used only by SSH and HTTP agent items.|
| |username|\-|`string`| |Username for authentication.<br>Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items.<br><br>Required by SSH and Telnet items.<br>When used by JMX agent, password should also be specified together with the username or both properties should be left blank.|
| |password|\-|`string`| |Password for authentication.<br>Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items.<br><br>When used by JMX agent, username should also be specified together with the password or both properties should be left blank.|
| |publickey|\-|`string`| |Name of the public key file.<br><br>Required for SSH agent items.|
| |privatekey|\-|`string`| |Name of the private key file.<br><br>Required for SSH agent items.|
| |description|\-|`text`| |Item description.|
| |inventory\_link|\-|`string`|0 - NONE<br><br>Capitalized host inventory field name. For example:<br>4 - ALIAS<br>6 - OS\_FULL<br>14 - HARDWARE<br>etc.|Host inventory field that is populated by the item.<br><br>Refer to the [host inventory page](/manual/api/reference/host/object#host_inventory) for a list of supported host inventory fields and their IDs.|
| |logtimefmt|\-|`string`| |Format of the time in log entries.<br>Used only by log items.|
| |interface\_ref|\-|`string`|Format: `if<N>`|Reference to the host interface.|
| |jmx\_endpoint|\-|`string`| |JMX endpoint.<br><br>Used only by JMX agent items.|
| |url|\-|`string`| |URL string.<br><br>Required only for HTTP agent items.|
| |allow\_traps|\-|`string`|0 - NO (default)<br>1 - YES|Allow to populate value as in a trapper item.<br><br>Used only by HTTP agent items.|
| |follow\_redirects|\-|`string`|0 - NO<br>1 - YES (default)|Follow HTTP response redirects while polling data.<br><br>Used only by HTTP agent items.|
|headers| |\-| | |Root element for HTTP(S) request headers, where header name is used as key and header value as value.<br>Used only by HTTP agent items.|
| |name|x|`string`| |Header name.|
| |value|x|`string`| |Header value.|
| |http\_proxy|\-|`string`| |HTTP(S) proxy connection string.<br><br>Used only by HTTP agent items.|
| |output\_format|\-|`string`|0 - RAW (default)<br>1 - JSON|How to process response.<br><br>Used only by HTTP agent items.|
| |post\_type|\-|`string`|0 - RAW (default)<br>2 - JSON<br>3 - XML|Type of post data body.<br><br>Used only by HTTP agent items.|
| |posts|\-|`string`| |HTTP(S) request body data.<br><br>Used only by HTTP agent items.|
|query\_fields| |\-| | |Root element for query parameters.<br><br>Used only by HTTP agent items.|
| |name|x|`string`| |Parameter name.|
| |value|\-|`string`| |Parameter value.|
| |request\_method|\-|`string`|0 - GET (default)<br>1 - POST<br>2 - PUT<br>3 - HEAD|Request method.<br><br>Used only by HTTP agent items.|
| |retrieve\_mode|\-|`string`|0 - BODY (default)<br>1 - HEADERS<br>2 - BOTH|What part of response should be stored.<br><br>Used only by HTTP agent items.|
| |ssl\_cert\_file|\-|`string`| |Public SSL Key file path.<br><br>Used only by HTTP agent items.|
| |ssl\_key\_file|\-|`string`| |Private SSL Key file path.<br><br>Used only by HTTP agent items.|
| |ssl\_key\_password|\-|`string`| |Password for SSL Key file.<br><br>Used only by HTTP agent items.|
| |status\_codes|\-|`string`| |Ranges of required HTTP status codes separated by commas. Supports user macros.<br>Example: 200,200-{$M},{$M},200-400<br><br>Used only by HTTP agent items.|
| |timeout|\-|`string`| |Item data polling request timeout. Supports user macros.<br><br>Used by HTTP agent and Script items.|
| |verify\_host|\-|`string`|0 - NO (default)<br>1 - YES|Whether to validate that the host name for the connection matches the one in the host's certificate.<br><br>Used only by HTTP agent items.|
| |verify\_peer|\-|`string`|0 - NO (default)<br>1 - YES|Whether to validate that the host's certificate is authentic.<br><br>Used only by HTTP agent items.|
|parameters| |\-| | |Root element for user-defined parameters.<br><br>Used only by Script items.|
| |name|x|`string`| |Parameter name.<br><br>Used only by Script items.|
| |value|\-|`string`| |Parameter value.<br><br>Used only by Script items.|
|value map| |\-| | |Value map.|
| |name|x|`string`| |Name of the value map to use for the item.|
|preprocessing| |\-| | |Root element for item value preprocessing.|
|step| |\-| | |Individual item value preprocessing step.|
| |type|x|`string`|1 - MULTIPLIER<br>2 - RTRIM<br>3 - LTRIM<br>4 - TRIM<br>5 - REGEX<br>6 - BOOL\_TO\_DECIMAL<br>7 - OCTAL\_TO\_DECIMAL<br>8 - HEX\_TO\_DECIMAL<br>9 - SIMPLE\_CHANGE (calculated as (received value-previous value))<br>10 - CHANGE\_PER\_SECOND (calculated as (received value-previous value)/(time now-time of last check))<br>11 - XMLPATH<br>12 - JSONPATH<br>13 - IN\_RANGE<br>14 - MATCHES\_REGEX<br>15 - NOT\_MATCHES\_REGEX<br>16 - CHECK\_JSON\_ERROR<br>17 - CHECK\_XML\_ERROR<br>18 - CHECK\_REGEX\_ERROR<br>19 - DISCARD\_UNCHANGED<br>20 - DISCARD\_UNCHANGED\_HEARTBEAT<br>21 - JAVASCRIPT<br>22 - PROMETHEUS\_PATTERN<br>23 - PROMETHEUS\_TO\_JSON<br>24 - CSV\_TO\_JSON<br>25 - STR\_REPLACE<br>26 - CHECK\_NOT\_SUPPORTED<br>27 - XML\_TO\_JSON|Type of the item value preprocessing step.|
| |parameters|\-| | |Root element for parameters of the item value preprocessing step.|
| |parameter|x|`string`| |Individual parameter of the item value preprocessing step.|
| |error\_handler|\-|`string`|0 - ORIGINAL\_ERROR (default)<br>1 - DISCARD\_VALUE<br>2 - CUSTOM\_VALUE<br>3 - CUSTOM\_ERROR|Action type used in case of preprocessing step failure.|
| |error\_handler\_params|\-|`string`| |Error handler parameters used with 'error\_handler'.|
|master\_item| |\-| | |Individual item master item.<br><br>Required by dependent items.|
| |key|x|`string`| |Dependent item master item key value.<br><br>Recursion up to 3 dependent items and maximum count of dependent items equal to 29999 are allowed.|
|triggers| |\-| | |Root element for simple triggers.|
| |*For trigger element tag values, see host [trigger tags](/manual/xml_export_import/hosts#host_trigger_tags).*| | | | |
|tags| |\-| | |Root element for item tags.|
| |tag|x|`string`| |Tag name.|
| |value|\-|`string`| |Tag value.|
##### 主机 监控项标签
| 元素 | 元素属性 | 必需 | 类型 | 范围^**[1](#footnotes)**^ | 描述 |
|--|--|-|--|----|--------|
| items | | \- | | | 监控项的根元素。 |
| | name | x | `string` | | 监控项名称。 |
| | type | \- | `string` | 0 - ZABBIX\_PASSIVE (default)<br>2 - TRAP<br>3 - SIMPLE<br>5 - INTERNAL<br>7 - ZABBIX\_ACTIVE<br>10 - EXTERNAL<br>11 - ODBC<br>12 - IPMI<br>13 - SSH<br>14 - TELNET<br>15 - CALCULATED<br>16 - JMX<br>17 - SNMP\_TRAP<br>18 - DEPENDENT<br>19 - HTTP\_AGENT<br>20 - SNMP\_AGENT<br>21 - ITEM\_TYPE\_SCRIPT | 监控项类型。 |
| | snmp\_oid | \- | `string` | | SNMP object ID。<br><br>SNMP 监控项必需。 |
| | key | x | `string` | | 监控项键值。 |
| | delay | \- | `string` | Default: 1m | 监控项的更新间隔。<br><br>注意：对于trapper 监控项，`delay`将始终为'0'。<br><br>接受秒数或带后缀的时间单位（30s, 1m, 2h, 1d）。<br>可选地可以指定一个或多个[custom intervals](/manual/config/items/item/custom_intervals)作为灵活间隔或调度。<br>多个间隔用分号分隔。<br>可以使用用户宏。单个宏必须填满整个字段。不支持字段中的多个宏或宏与文本混合。<br>灵活间隔可以写成两个宏，用斜杠分隔（例如`{$FLEX_INTERVAL}/{$FLEX_PERIOD}`）。 |
| | history | \- | `string` | Default: 90d | 历史数据应存储的时间段。使用时间后缀、用户宏或LLD宏的时间段。 |
| | trends | \- | `string` | Default: 365d | 趋势数据应存储的时间段。使用时间后缀、用户宏或LLD宏的时间段。 |
| | status | \- | `string` | 0 - ENABLED (default)<br>1 - DISABLED | 监控项状态。 |
| | value\_type | \- | `string` | 0 - FLOAT<br>1 - CHAR<br>2 - LOG<br>3 - UNSIGNED (default)<br>4 - TEXT | 接收值类型。 |
| | allowed\_hosts | \- | `string` | | 允许为监控项发送数据的主机的IP地址列表（逗号分隔）。<br><br>用于trapper和HTTP agent 监控项。 |
| | units | \- | `string` | | 返回值的单位（bps, B等）。 |
| | params | \- | `text` | | 根据监控项类型的附加参数：<br>- 脚本、SSH和Telnet 监控项的执行脚本；<br>- 数据库监控监控项的SQL query；<br>- 计算监控项的公式。 |
| | ipmi\_sensor | \- | `string` | | IPMI传感器。<br><br>仅用于IPMI 监控项。 |
| | authtype | \- | `string` | Authentication type for SSH agent items:<br>0 - PASSWORD (default)<br>1 - PUBLIC\_KEY<br><br>Authentication type for HTTP agent items:<br>0 - NONE (default)<br>1 - BASIC<br>2 - NTLM | 认证类型。<br><br>仅用于SSH和HTTP agent 监控项。 |
| | username | \- | `string` | | 认证用户名。<br>用于简单检查、SSH、Telnet、数据库监控、JMX和HTTP agent 监控项。<br><br>SSH和Telnet 监控项必需。<br>当用于JMX agent时，密码也应与用户名一起指定，或者两个属性都应留空。 |
| | password | \- | `string` | | 认证密码。<br>用于简单检查、SSH、Telnet、数据库监控、JMX和HTTP agent 监控项。<br><br>当用于JMX agent时，用户名也应与密码一起指定，或者两个属性都应留空。 |
| | publickey | \- | `string` | | 公钥file的名称。<br><br>SSH agent 监控项必需。 |
| | privatekey | \- | `string` | | 私钥file的名称。<br><br>SSH agent 监控项必需。 |
| | description | \- | `text` | | 监控项描述。 |
| | inventory\_link | \- | `string` | 0 - NONE<br><br>Capitalized host inventory field name. For example:<br>4 - ALIAS<br>6 - OS\_FULL<br>14 - HARDWARE<br>etc. | 主机库存字段，由监控项填充。<br><br>参考[主机资产清单](/manual/api/reference/host/object#主机资产清单)获取支持的主机库存字段及其ID列表。 |
| | logtimefmt | \- | `string` | | 日志条目中的时间格式。<br>仅用于日志监控项。 |
| | interface\_ref | \- | `string` | Format: `if<N>` | 引用主机接口。 |
| | jmx\_endpoint | \- | `string` | | JMX端点。<br><br>仅用于JMX agent 监控项。 |
| | url | \- | `string` | | URL string。<br><br>仅HTTP agent 监控项必需。 |
| | allow\_traps | \- | `string` | 0 - NO (default)<br>1 - YES | 允许像trapper 监控项一样填充值。<br><br>仅用于HTTP agent 监控项。 |
| | follow\_redirects | \- | `string` | 0 - NO<br>1 - YES (default) | 在轮询数据时跟随HTTP响应重定向。<br><br>仅用于HTTP agent 监控项。 |
| headers | | \- | | | HTTP(S)请求头的根元素，其中头名称用作键，头值用作值。<br>仅用于HTTP agent 监控项。 |
| | name | x | `string` | | 头名称。 |
| | value | x | `string` | | 头值。 |
| | http\_proxy | \- | `string` | | HTTP(S) proxy连接string。<br><br>仅用于HTTP agent 监控项。 |
| | output\_format | \- | `string` | 0 - RAW (default)<br>1 - JSON | 如何处理响应。<br><br>仅用于HTTP agent 监控项。 |
| | post\_type | \- | `string` | 0 - RAW (default)<br>2 - JSON<br>3 - XML | 发布数据正文的类型。<br><br>仅用于HTTP agent 监控项。 |
| | posts | \- | `string` | | HTTP(S)请求正文数据。<br><br>仅用于HTTP agent 监控项。 |
| query\_fields | | \- | | | query参数的根元素。<br><br>仅用于HTTP agent 监控项。 |
| | name | x | `string` | | 参数名称。 |
| | value | \- | `string` | | 参数值。 |
| | request\_method | \- | `string` | 0 - GET (default)<br>1 - POST<br>2 - PUT<br>3 - HEAD | 请求方法。<br><br>仅用于HTTP agent 监控项。 |
| | retrieve\_mode | \- | `string` | 0 - BODY (default)<br>1 - HEADERS<br>2 - BOTH | 应存储响应的哪部分。<br><br>仅用于HTTP agent 监控项。 |
| | ssl\_cert\_file | \- | `string` | | 公共SSL密钥file路径。<br><br>仅用于HTTP agent 监控项。 |
| | ssl\_key\_file | \- | `string` | | 私有SSL密钥file路径。<br><br>仅用于HTTP agent 监控项。 |
| | ssl\_key\_password | \- | `string` | | SSL密钥file的密码。<br><br>仅用于HTTP agent 监控项。 |
| | status\_codes | \- | `string` | | 所需HTTP状态代码的范围，用逗号分隔。支持用户宏。<br>示例：200,200-{$M},{$M},200-400<br><br>仅用于HTTP agent 监控项。 |
| | timeout | \- | `string` | | 监控项数据轮询请求超时。支持用户宏。<br><br>用于HTTP agent和脚本监控项。 |
| | verify\_host | \- | `string` | 0 - NO (default)<br>1 - YES | 是否验证连接的主机名称与主机证书中的名称匹配。<br><br>仅用于HTTP agent 监控项。 |
| | verify\_peer | \- | `string` | 0 - NO (default)<br>1 - YES | 是否验证主机证书的真实性。<br><br>仅用于HTTP agent 监控项。 |
| parameters | | \- | | | 用户定义参数的根元素。<br><br>仅用于脚本监控项。 |
| | name | x | `string` | | 参数名称。<br><br>仅用于脚本监控项。 |
| | value | \- | `string` | | 参数值。<br><br>仅用于脚本监控项。 |
| value map | | \- | | | 值映射。 |
| | name | x | `string` | | 用于监控项的值映射名称。 |
| preprocessing | | \- | | | 监控项值预处理的根元素。 |
| step | | \- | | | 单个监控项值预处理步骤。 |
| | type | x | `string` | 1 - MULTIPLIER<br>2 - RTRIM<br>3 - LTRIM<br>4 - TRIM<br>5 - REGEX<br>6 - BOOL\_TO\_DECIMAL<br>7 - OCTAL\_TO\_DECIMAL<br>8 - HEX\_TO\_DECIMAL<br>9 - SIMPLE\_CHANGE (calculated as (received value-previous value))<br>10 - CHANGE\_PER\_SECOND (calculated as (received value-previous value)/(time now-time of last check))<br>11 - XMLPATH<br>12 - JSONPATH<br>13 - IN\_RANGE<br>14 - MATCHES\_REGEX<br>15 - NOT\_MATCHES\_REGEX<br>16 - CHECK\_JSON\_ERROR<br>17 - CHECK\_XML\_ERROR<br>18 - CHECK\_REGEX\_ERROR<br>19 - DISCARD\_UNCHANGED<br>20 - DISCARD\_UNCHANGED\_HEARTBEAT<br>21 - JAVASCRIPT<br>22 - PROMETHEUS\_PATTERN<br>23 - PROMETHEUS\_TO\_JSON<br>24 - CSV\_TO\_JSON<br>25 - STR\_REPLACE<br>26 - CHECK\_NOT\_SUPPORTED<br>27 - XML\_TO\_JSON | 监控项值预处理步骤的类型。 |
| | parameters | \- | | | 监控项值预处理步骤参数的根元素。 |
| | parameter | x | `string` | | 监控项值预处理步骤的单个参数。 |
| | error\_handler | \- | `string` | 0 - ORIGINAL\_ERROR (default)<br>1 - DISCARD\_VALUE<br>2 - CUSTOM\_VALUE<br>3 - CUSTOM\_ERROR | 预处理步骤失败时使用的操作类型。 |
| | error\_handler\_params | \- | `string` | | 与'error\_handler'一起使用的错误处理程序参数。 |
| master\_item | | \- | | | 单个监控项主监控项。<br><br>依赖监控项必需。 |
| | key | x | `string` | | 依赖监控项主监控项键值。<br><br>允许递归最多3个依赖监控项，最大依赖监控项数量为29999。 |
| triggers | | \- | | | 简单触发器的根元素。 |
| | *For trigger element tag values, see host [主机触发器标签](/manual/xml_export_import/hosts#主机触发器标签).* | | | | |
| tags | | \- | | | 监控项标签的根元素。 |
| | tag | x | `string` | | 标签名称。 |
| | value | \- | `string` | | 标签值。 |
##### Host low-level discovery rule tags
|Element|Element property|Required|Type|Range^**[1](#footnotes)**^|Description|
|--|--|-|--|----|--------|
|discovery\_rules| |\-| | |Root element for low-level discovery rules.|
| |*For most of the element tag values, see element tag values for a regular item. Only the tags that are specific to low-level discovery rules, are described below.*| | | | |
| |type|\-|`string`|0 - ZABBIX\_PASSIVE (default)<br>2 - TRAP<br>3 - SIMPLE<br>5 - INTERNAL<br>7 - ZABBIX\_ACTIVE<br>10 - EXTERNAL<br>11 - ODBC<br>12 - IPMI<br>13 - SSH<br>14 - TELNET<br>16 - JMX<br>18 - DEPENDENT<br>19 - HTTP\_AGENT<br>20 - SNMP\_AGENT|Item type.|
| |lifetime|\-|`string`|Default: 30d|Time period after which items that are no longer discovered will be deleted. Seconds, time unit with suffix or user macro.|
|filter| | | | |Individual filter.|
| |evaltype|\-|`string`|0 - AND\_OR (default)<br>1 - AND<br>2 - OR<br>3 - FORMULA|Logic to use for checking low-level discovery rule filter conditions.|
| |formula|\-|`string`| |Custom calculation formula for filter conditions.|
|conditions| |\-| | |Root element for filter conditions.|
| |macro|x|`string`| |Low-level discovery macro name.|
| |value|\-|`string`| |Filter value: regular expression or global regular expression.|
| |operator|\-|`string`|8 - MATCHES\_REGEX (default)<br>9 - NOT\_MATCHES\_REGEX|Condition operator.|
| |formulaid|x|`character`| |Arbitrary unique ID that is used to reference a condition from the custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|lld\_macro\_paths| |\-| | |Root element for LLD macro paths.|
| |lld\_macro|x|`string`| |Low-level discovery macro name.|
| |path|x|`string`| |Selector for value which will be assigned to the corresponding macro.|
|preprocessing| |\-| | |LLD rule value preprocessing.|
|step| |\-| | |Individual LLD rule value preprocessing step.|
| |*For most of the element tag values, see element tag values for a host item value preprocessing. Only the tags that are specific to low-level discovery value preprocessing, are described below.*| | | | |
| |type|x|`string`|5 - REGEX<br>11 - XMLPATH<br>12 - JSONPATH<br>15 - NOT\_MATCHES\_REGEX<br>16 - CHECK\_JSON\_ERROR<br>17 - CHECK\_XML\_ERROR<br>20 - DISCARD\_UNCHANGED\_HEARTBEAT<br>21 - JAVASCRIPT<br>23 - PROMETHEUS\_TO\_JSON<br>24 - CSV\_TO\_JSON<br>25 - STR\_REPLACE<br>27 - XML\_TO\_JSON|Type of the item value preprocessing step.|
|trigger\_prototypes| |\-| | |Root element for trigger prototypes.|
| |*For trigger prototype element tag values, see regular [host trigger](/manual/xml_export_import/hosts#host_trigger_tags) tags.*| | | | |
|graph\_prototypes| |\-| | |Root element for graph prototypes.|
| |*For graph prototype element tag values, see regular [host graph](/manual/xml_export_import/hosts#host_graph_tags) tags.*| | | | |
|host\_prototypes| |\-| | |Root element for host prototypes.|
| |*For host prototype element tag values, see regular [host](/manual/xml_export_import/hosts#host_tags) tags.*| | | | |
|item\_prototypes| |\-| | |Root element for item prototypes.|
| |*For item prototype element tag values, see regular [host item](/manual/xml_export_import/hosts#host_item_tags) tags.*| | | | |
|master\_item| |\-| | |Individual item prototype master item/item prototype data.|
| |key|x|`string`| |Dependent item prototype master item/item prototype key value.<br><br>Required for a dependent item.|
##### 主机低级别发现规则标签
| 元素 | 元素属性 | 必填 | 类型 | 范围^**[1](#footnotes)**^ | 描述 |
|--|--|-|--|----|--------|
| discovery\_rules | | \- | | | 低级发现规则的根元素。 |
| | *For most of the element tag values, see element tag values for a regular item. Only the tags that are specific to low-level discovery rules, are described below.* | | | | |
| | type | \- | `string` | 0 - ZABBIX\_PASSIVE (default)<br>2 - TRAP<br>3 - SIMPLE<br>5 - INTERNAL<br>7 - ZABBIX\_ACTIVE<br>10 - EXTERNAL<br>11 - ODBC<br>12 - IPMI<br>13 - SSH<br>14 - TELNET<br>16 - JMX<br>18 - DEPENDENT<br>19 - HTTP\_AGENT<br>20 - SNMP\_AGENT | 监控项 类型。 |
| | lifetime | \- | `string` | Default: 30d | 不再发现的 监控项 将被删除的时间周期。秒数、带后缀的时间单位或用户宏。 |
| filter | | | | | 单个过滤器。 |
| | evaltype | \- | `string` | 0 - AND\_OR (default)<br>1 - AND<br>2 - OR<br>3 - FORMULA | 用于检查低级发现规则过滤条件的逻辑。 |
| | formula | \- | `string` | | 过滤条件的自定义计算公式。 |
| conditions | | \- | | | 过滤条件的根元素。 |
| | macro | x | `string` | | 低级发现宏名称。 |
| | value | \- | `string` | | 过滤值：正则表达式或全局正则表达式。 |
| | operator | \- | `string` | 8 - MATCHES\_REGEX (default)<br>9 - NOT\_MATCHES\_REGEX | 条件运算符。 |
| | formulaid | x | `character` | | 用于从自定义表达式中引用条件的任意唯一ID。只能包含大写字母。修改过滤条件时必须由用户定义ID，但在后续请求时会重新生成。 |
| lld\_macro\_paths | | \- | | | LLD宏路径的根元素。 |
| | lld\_macro | x | `string` | | 低级发现宏名称。 |
| | path | x | `string` | | 选择器，用于分配给相应宏的值。 |
| preprocessing | | \- | | | LLD规则值预处理。 |
| step | | \- | | | 单个LLD规则值预处理步骤。 |
| | *For most of the element tag values, see element tag values for a host item value preprocessing. Only the tags that are specific to low-level discovery value preprocessing, are described below.* | | | | |
| | type | x | `string` | 5 - REGEX<br>11 - XMLPATH<br>12 - JSONPATH<br>15 - NOT\_MATCHES\_REGEX<br>16 - CHECK\_JSON\_ERROR<br>17 - CHECK\_XML\_ERROR<br>20 - DISCARD\_UNCHANGED\_HEARTBEAT<br>21 - JAVASCRIPT<br>23 - PROMETHEUS\_TO\_JSON<br>24 - CSV\_TO\_JSON<br>25 - STR\_REPLACE<br>27 - XML\_TO\_JSON | 监控项 值预处理步骤的类型。 |
| trigger\_prototypes | | \- | | | 触发器原型的根元素。 |
| | *For trigger prototype element tag values, see regular [主机触发器标签](/manual/xml_export_import/hosts#主机触发器标签) tags.* | | | | |
| graph\_prototypes | | \- | | | 图形原型的根元素。 |
| | *For graph prototype element tag values, see regular [主机图形标签](/manual/xml_export_import/hosts#主机图形标签) tags.* | | | | |
| host\_prototypes | | \- | | | 主机 原型的根元素。 |
| | *For host prototype element tag values, see regular [主机标签](/manual/xml_export_import/hosts#主机标签) tags.* | | | | |
| item\_prototypes | | \- | | | 监控项原型 的根元素。 |
| | *For item prototype element tag values, see regular [主机-监控项标签](/manual/xml_export_import/hosts#主机-监控项标签) tags.* | | | | |
| master\_item | | \- | | | 单个 监控项 原型主 监控项/监控项 原型数据。 |
| | key | x | `string` | | 依赖 监控项 原型主 监控项/监控项 原型键值。<br><br>依赖 监控项 的必填项。 |
### Host macro
The host macro object defines a macro available on a host, host
prototype or template. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|hostmacroid|string|*(readonly)* ID of the host macro.|
|**hostid**<br>(required)|string|ID of the host that the macro belongs to.|
|**macro**<br>(required)|string|Macro string.|
|**value**<br>(required)|string|Value of the macro.|
|type|integer|Type of macro.<br><br>Possible values:<br>0 - *(default)* Text macro;<br>1 - Secret macro;<br>2 - Vault secret.|
|description|string|Description of the macro.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 主机宏
主机宏object定义了在一个主机、主机原型或模板上可用的宏。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| hostmacroid | string | *(只读)* 主机宏的ID。 |
| **hostid**<br>(required) | string | 宏所属的主机的ID。 |
| **macro**<br>(required) | string | 宏string。 |
| **value**<br>(required) | string | 宏的值。 |
| type | integer | 宏的类型。<br><br>可能的值:<br>0 - *(默认)* 文本宏;<br>1 - 秘密宏;<br>2 - 保险库秘密。 |
| description | string | 宏的描述。 |
请注意，对于某些方法(update, delete)，必需/可选参数的组合是不同的。
Host markers displayed on the map have the color of the host's most
serious problem and green color if a host has no problems. Clicking on
a host marker allows viewing the host's visible name and the number of
unresolved problems grouped by severity. Clicking on the visible name
will open [host
menu](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu).
Hosts displayed on the map can be filtered by problem severity. Press on
the filter icon in the widget's upper right corner and mark the required
severities.
主机标记在地图上显示的颜色取决于主机的最严重问题级别，若一个主机没有问题则显示为绿色。点击一个主机标记可查看主机的可见名称及按严重程度分组的未解决问题数量。点击可见名称将打开[主机菜单](/manual/web_interface/frontend_sections/monitoring/dashboard#主机菜单)。
地图上显示的主机可按问题严重程度进行筛选。点击部件右上角的筛选图标并勾选所需严重级别。
# host.massadd
# host.massadd
# host.massremove
# host.massremove
# host.massupdate
# host.massupdate
#### Host menu
Clicking on a host in the *Problems* widget brings up the host menu. It
includes links to host inventory, latest data, problems, graphs,
dashboards, web scenarios and configuration. Note that host
configuration is available for Admin and Superadmin users only.
[Global
scripts](/manual/web_interface/frontend_sections/administration/scripts)
can also be run from the host menu. These scripts need to have their
scope defined as 'Manual host action' to be available in the host menu.
The host menu is accessible by clicking on a host in several other
frontend sections:
- Monitoring → [Problems](problems)
- Monitoring → [Problems](problems) → Event details
- Monitoring → [Hosts](hosts)
- Monitoring → Hosts → [Web
Monitoring](/manual/web_interface/frontend_sections/monitoring/hosts/web)
- Monitoring → [Latest data](latest_data)
- Monitoring → [Maps](maps)
- Reports → [Triggers top
100](/manual/web_interface/frontend_sections/reports/triggers_top)
#### 主机菜单
点击*问题*小部件中的一个主机会弹出主机菜单。该
菜单包含指向主机资产清单、最新数据、问题、图表、
仪表板、Web场景和配置的链接。请注意主机
配置仅对管理员和超级管理员用户可见。
[Global
scripts](/manual/web_interface/frontend_sections/administration/scripts)
也可以从主机菜单中run。这些脚本需要将其
作用域定义为'手动主机操作'才能在主机菜单中使用。
通过点击以下前端部分的一个主机均可访问主机菜单：
- 监控 → [Problems](problems)
- 监控 → [Problems](problems) → 事件详情
- 监控 → [Hosts](hosts)
- 监控 → 主机 → [Web
Monitoring](/manual/web_interface/frontend_sections/monitoring/hosts/web)
- 监控 → [Latest data](latest_data)
- 监控 → [Maps](maps)
- 报表 → [Triggers top
100](/manual/web_interface/frontend_sections/reports/triggers_top)
##### Hostname parameter
To perform [active
checks](/manual/appendix/items/activepassive#active_checks) on a host
Zabbix agent needs to have the hostname defined. Moreover, the hostname
value set on the agent side should exactly match the "[Host
name](/manual/config/hosts/host)" configured for the host in the
frontend.
The hostname value on the agent side can be defined by either the
**Hostname** or **HostnameItem** parameter in the agent [configuration
file](/manual/appendix/config/zabbix_agentd_win) - or the default values
are used if any of these parameters are not specified.
The default value for **HostnameItem** parameter is the value returned
by the "system.hostname" agent key and for Windows platform it returns
the NetBIOS host name.
The default value for **Hostname** is the value returned by the
**HostnameItem** parameter. So, in effect, if both these parameters are
unspecified the actual hostname will be the host NetBIOS name; Zabbix
agent will use NetBIOS host name to retrieve the list of active checks
from Zabbix server and send results to it.
The default value for **Hostname** is the value returned by the
**HostnameItem** parameter. So, in effect, if both these parameters are
unspecified the actual hostname will be the host NetBIOS name; Zabbix
agent will use NetBIOS host name to retrieve the list of active checks
from Zabbix server and send results to it.
The "system.hostname" key supports two optional parameters - *type* and
*transform*.
*Type* parameter determines the type of the name the item should return.
Supported values:
- *netbios* (default) - returns the NetBIOS host name which is limited
to 15 symbols and is in the UPPERCASE only;
- *host* - case-sensitive, returns the full, real Windows host name (without a domain);
- *shorthost* (supported since Zabbix 5.4.7) - returns part of the
hostname before the first dot. It will return a full string if the
name does not contain a dot.
*Transform* parameter is supported since Zabbix 5.4.7 and allows to
specify additional transformation rule for the hostname. Supported
values:
- *none* (default) - use the original letter case;
- *lower* - convert the text into lowercase.
So, to simplify the configuration of zabbix\_agentd.conf file and make
it unified, two different approaches could be used.
1. leave **Hostname** or **HostnameItem** parameters undefined and
Zabbix agent will use NetBIOS host name as the hostname;
2. leave **Hostname** parameter undefined and define **HostnameItem**
like this:\
**HostnameItem=system.hostname\[host\]** - for Zabbix agent to use
the full, real (case sensitive) Windows host name as the hostname\
**HostnameItem=system.hostname\[shorthost,lower\]** - for Zabbix
agent to use only part of the hostname before the first dot,
converted into lowercase.
Host name is also used as part of Windows service name which is used for
installing, starting, stopping and uninstalling the Windows service. For
example, if Zabbix agent configuration file specifies
`Hostname=Windows_db_server`, then the agent will be installed as a
Windows service "`Zabbix Agent [Windows_db_server]`". Therefore, to have
a different Windows service name for each Zabbix agent instance, each
instance must use a different host name.
#### agent配置
##### Host naming
When adding hosts, a host name is the result of reverse DNS lookup or IP
address if reverse lookup fails. Lookup is performed from the Zabbix
server or Zabbix proxy, depending on which is doing the discovery. If
lookup fails on the proxy, it is not retried on the server. If the host
with such a name already exists, the next host would get **\_2**
appended to the name, then **\_3** and so on.
It is also possible to override DNS/IP lookup and instead use an item
value for host name, for example:
- You may discover multiple servers with Zabbix agent running using a
Zabbix agent item for discovery and assign proper names to them
automatically, based on the string value returned by this item
- You may discover multiple SNMP network devices using an SNMP agent
item for discovery and assign proper names to them automatically,
based on the string value returned by this item
If the host name has been set using an item value, it is not updated
during the following discovery checks. If it is not possible to set host
name using an item value, default value (DNS name) is used.
If a host already exists with the discovered IP address, a new host is
not created. However, if the discovery action contains operations (link
template, add to host group, etc), they are performed on the existing
host.
##### 主机命名
添加主机时，一个主机名称是反向DNS查询的结果，若查询失败则使用IP地址。查询由Zabbix服务器或Zabbix proxy执行，具体取决于执行发现的组件。如果在proxy上查询失败，则不会在服务器上重试。若已存在同名主机，则下一个主机会在名称后get追加**\_2**，然后是**\_3**，依此类推。
也可覆盖DNS/IP查询，改用监控项值作为主机名，例如：
- 可通过Zabbix agent的监控项值发现多台运行Zabbix agent的服务器，并根据该监控项返回的string值自动分配正确名称
- 可通过SNMP agent发现多台SNMP网络设备
item for discovery and assign proper names to them automatically,
based on the string value returned by this item
若主机名称已通过监控项值设置，则在后续发现检查中不会更新。若无法通过监控项值设置主机名称，则使用默认值（DNS名称）。
若具有被发现IP地址的一个主机已存在，则不会创建新主机。但若发现操作包含关联模板、添加到主机组等操作，这些操作将在现有主机上执行。
# hostprototype.create
# hostprototype.create
# hostprototype.delete
# hostprototype.delete
# hostprototype.get
# hostprototype.get
#### Host prototypes
Host prototypes can be created with the low-level discovery rule. When virtual machines
are discovered, these prototypes are the basis for generating real hosts.
Prototypes, before becoming discovered, cannot have their own items and
triggers, other than those from the linked templates.
{width="600"}
In order for hosts created from a prototype to have unique host names,
the *Host name* field must contain at least one [low-level discovery
macro](/manual/config/macros/lld_macros).
Since Zabbix 5.2, discovered hosts may be configured with custom
interfaces or inherit the IP of a host the discovery rule belongs to
(default). To add one or more custom interface, switch the *Interface*
selector from *Inherit* to *Custom* mode, then press
 and select
the required interface type from the drop-down menu that appears. All
supported types of interfaces can be defined for a host prototype:
Zabbix agent, SNMP, JMX, IPMI. Interface fields support low-level
discovery macros and [user macros](/manual/config/macros/user_macros).
If several custom interfaces are specified - use the *Default* column to
specify the primary interface.
Notes:
- If *Custom* is selected, but no interfaces have been specified the
hosts will be created without interfaces.
- If *Inherit* is selected for a host prototype that belongs to a
template, discovered hosts will inherit the interface of a host to
which the template is linked to.
::: notewarning
A host will not be created, if the host interface
contains incorrect data
:::
LLD macros can also be used for the visible name, host group prototype
fields, tag values, or values of host prototype user macros.
Other options that can be specified for a host prototype are:
- Linkage to existing host groups
- Template linkage
- Encryption
If *Create enabled* is checked, the host will be added in an enabled
state. If unchecked, the host will be added, but in a disabled state.
If *Discover* is checked (default), the host will be created. If
unchecked, the host will not be created, unless this setting is
overridden in the [discovery
rule](/manual/discovery/low_level_discovery#override). This
functionality provides additional flexibility when creating discovery
rules.
Discovered hosts are prefixed with the name of the discovery rule that
created them, in the host list. Discovered hosts can be manually
deleted. Discovered hosts will also be automatically deleted, based on
the *Keep lost resources period (in days)* value of the discovery rule.
Most of the configuration options are read-only, except for
enabling/disabling the host and host inventory.
::: noteclassic
Zabbix does not support nested host prototypes, i.e. host prototypes are not supported on hosts that are discovered by low-level discovery rule.
:::
#### 主机原型
主机原型可以通过低级发现规则创建。当虚拟机被发现时，这些原型将成为生成实际主机的基础。
在未被发现之前，原型不能拥有自己的监控项和触发器（来自链接模板的除外）。
{width="600"}
为了使从原型创建的主机具有唯一的主机名称，*主机名*字段必须至少包含一个[low-level discovery
macro](/manual/config/macros/lld_macros)。
自Zabbix 5.2起，发现的主机可以配置自定义接口或继承发现规则所属一个主机的IP（默认）。要添加一个或多个自定义接口，需将*接口*选择器从*继承*切换到*自定义*模式，然后点击并从出现的下拉菜单中选择所需的接口类型。所有支持的接口类型都可以为一个主机原型定义：Zabbix agent、SNMP、JMX、IPMI。接口字段支持低级发现宏和[user macros](/manual/config/macros/user_macros)。
如果指定了多个自定义接口，请使用*默认*列指定主接口。
注意事项：
- 如果选择*自定义*但未指定任何接口，主机将在没有接口的情况下创建。
- 如果为属于
template, discovered hosts will inherit the interface of a host to
which the template is linked to.
的一个主机原型选择*继承*
::: notewarning
如果主机接口包含错误数据，一个主机将不会被创建
:::
LLD宏还可用于可见名称、主机组原型字段、标签值或主机原型用户宏的值。
可以为一个主机原型指定的其他选项包括：
- 链接到现有的主机组
- 模板链接
- 加密
如果勾选*创建启用*，主机将以启用状态添加。如果未勾选，主机将被添加但处于禁用状态。
如果勾选*发现*（默认），主机将被创建。如果未勾选，主机将不会被创建，除非在[覆盖](/manual/discovery/low_level_discovery#覆盖)中覆盖此设置。此功能为创建发现规则提供了额外的灵活性。
发现的主机在主机列表中会以创建它们的发现规则名称作为前缀。发现的主机可以手动删除。发现的主机也会根据发现规则的*保留丢失资源周期（天）*值自动删除。大多数配置选项是只读的，除了启用/禁用主机和主机资产清单。
::: noteclassic
Zabbix不支持嵌套的主机原型，即在通过低级发现规则发现的主机上不支持主机原型。
:::
### Host prototype tag
The host prototype tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**tag**<br>(required)|string|Host prototype tag name.|
|value|string|Host prototype tag value.|
### 主机原型标签
主机原型标签object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **tag**<br>(required) | string | 主机原型标签名称。 |
| value | string | 主机原型标签值。 |
### Host prototype
The host prototype object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|hostid|string|*(readonly)* ID of the host prototype.|
|**host**<br>(required)|string|Technical name of the host prototype.|
|name|string|Visible name of the host prototype.<br><br>Default: `host` property value.|
|status|integer|Status of the host prototype.<br><br>Possible values are:<br>0 - *(default)* monitored host;<br>1 - unmonitored host.|
|inventory\_mode|integer|Host inventory population mode.<br><br>Possible values are:<br>-1 - *(default)* disabled;<br>0 - manual;<br>1 - automatic.|
|templateid|string|*(readonly)* ID of the parent template host prototype.|
|discover|integer|Host prototype discovery status.<br><br>Possible values:<br>0 - *(default)* new hosts will be discovered;<br>1 - new hosts will not be discovered and existing hosts will be marked as lost.|
|custom\_interfaces|integer|Source of interfaces for hosts created by the host prototype.<br><br>Possible values:<br>0 - *(default)* inherit interfaces from parent host;<br>1 - use host prototypes custom interfaces.|
|uuid|string|Universal unique identifier, used for linking imported host prototypes to already existing ones. Used only for host prototypes on templates. Auto-generated, if not given.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 主机原型
主机原型object具有以下属性
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| hostid | string | *(只读)* 主机原型ID. |
| **host**<br>(required) | string | 主机原型的技术名称. |
| name | string | 主机原型的可见名称。<br><br>默认值：`host`属性值。 |
| status | integer | 主机原型状态.<br><br>可选值为:<br>0 - *(默认)* 受监控的主机;<br>1 - 未监控的主机. |
| inventory\_mode | integer | 主机 资产清单填充模式。<br><br>可选值为：<br>-1 - *(默认)* 禁用；<br>0 - 手动；<br>1 - 自动。 |
| templateid | string | *(只读)* 父模板主机原型的ID。 |
| discover | integer | 主机 原型发现状态。<br><br>可能取值：<br>0 - *(默认)* 新主机将被发现；<br>1 - 新主机将不被发现且现有主机将被标记为丢失。 |
| custom\_interfaces | integer | 由主机原型创建的主机接口来源.<br><br>可选值:<br>0 - *(默认)* 从父级主机继承接口;<br>1 - 使用主机原型自定义接口. |
| uuid | string | 通用唯一标识符，用于将导入的主机原型与已存在的原型进行关联。仅适用于模板上的主机原型。若未提供则自动生成。 |
请注意，某些方法（update、delete）所需/可选参数的组合有所不同。
# hostprototype.update
# hostprototype.update
##### Host removal
Hosts discovered by a network discovery rule are removed automatically
from *Monitoring* → *Discovery* if a discovered entity is not in the
rule's IP range any more. Hosts are removed immediately.
##### 主机移除
由网络发现规则发现的主机如果不再处于规则的IP范围内，则会自动从*监控* → *发现*中移除。主机会被立即删除。
#### Hosts and host groups
Manage host groups, hosts and everything related to them, including host
interfaces, host macros and maintenance periods.
[Host API](/manual/api/reference/host) | [Host group
API](/manual/api/reference/hostgroup) | [Host interface
API](/manual/api/reference/hostinterface) | [User macro
API](/manual/api/reference/usermacro) | [Value map
API](/manual/api/reference/valuemap) | [Maintenance
API](/manual/api/reference/maintenance)
#### 主机与主机组
管理主机组、主机及其相关配置，包括主机接口、主机宏和维护周期。
[Host API](/manual/api/reference/host) | [Host group
API](/manual/api/reference/hostgroup) | [Host interface
API](/manual/api/reference/hostinterface) | [User macro
API](/manual/api/reference/usermacro) | [Value map
API](/manual/api/reference/valuemap) | [Maintenance
API](/manual/api/reference/maintenance)
#### Hosts/host prototypes
In a [host](/manual/config/hosts/host) and [host
prototype](/manual/vm_monitoring#host_prototypes) configuration, user
macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|-|------------------------------|----------|
|Interface IP/DNS|<|DNS only|
|Interface port|<|no|
|*SNMP v1, v2*|<|<|
| |SNMP community|yes|
|*SNMP v3*|<|<|
| |Context name|yes|
|^|Security name|yes|
|^|Authentication passphrase|yes|
|^|Privacy passphrase|yes|
|*IPMI*|<|<|
| |Username|yes|
|^|Password|yes|
|*Tags*^[2](supported_by_location_user#footnotes)^|<|<|
| |Tag names|yes|
|^|Tag values|yes|
#### 主机/主机原型
在[host](/manual/config/hosts/host)和[主机原型](/manual/vm_monitoring#主机原型)配置中，
用户宏可用于以下字段：
| 位置 | < | 支持多宏/与文本混合^[1](supported_by_location_user#脚注)^ |
|-|------------------------------|----------|
| 接口IP/DNS | < | 仅DNS |
| 接口端口 | < | 否 |
| *SNMP v1, v2* | < | < |
| | SNMP团体名 | 是 |
| *SNMP v3* | < | < |
| | 上下文名称 | 是 |
| ^ | 安全名称 | 是 |
| ^ | 认证口令 | 是 |
| ^ | 加密口令 | 是 |
| *IPMI* | < | < |
| | 用户名 | 是 |
| ^ | 密码 | 是 |
| *标签*^[2](supported_by_location_user#脚注)^ | < | < |
| | 标签名称 | 是 |
| ^ | 标签值 | 是 |
#### Hosts/host prototypes
In a [host](/manual/config/hosts/host) and [host
prototype](/manual/vm_monitoring#host_prototypes) configuration, user
macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|--------|-|------------------------------------------------------------------------|
|Interface IP/DNS|<|DNS only|
|Interface port|<|no|
|*SNMP v1, v2*|<|<|
|<|SNMP community|yes|
|*SNMP v3*|<|<|
|<|Context name|yes|
|^|Security name|yes|
|^|Authentication passphrase|yes|
|^|Privacy passphrase|yes|
|*IPMI*|<|<|
|<|Username|yes|
|^|Password|yes|
|//Tags //|<|<|
|<|Tag names|yes|
|^|Tag values|yes|
#### Overview
[用户自定义](/manual/config/macros/user_macros)宏可以用于以下场景:
[User-definable](/manual/config/macros/user_macros) macros are supported
in the following locations:
- 设备
- 接口 IP/DNS
- 接口 port
- Hosts
- Interface IP/DNS
- Interface port
```{=html}
<!-- -->
```
- 被动 proxy
- 接口 port
```{=html}
<!-- -->
```
- Items 和 item 原型
- 名称
- Key 参数
- 更新间隔
- 用户自定义间隔
- 历史数据存储周期
- 趋势数据存储周期
- SNMPv3 context 名称
- SNMPv3 security 名称
- SNMPv3 auth 密码
- SNMPv3 priv 密码
- SNMPv1/v2 团体串
- SNMP OID
- SNMP port
- SSH 用户名
- SSH 公钥
- SSH 私钥
- SSH 密码
- SSH 脚本
- Telnet 用户名
- Telnet 密码
- Telnet 脚本
- Calculated item
[公式](/manual/config/items/itemtypes/calculated#configurable_fields)
- Trapper item "Allowed hosts" 字段
- 数据库监控附加字段
- JMX item endpoint 字段
- 从Zabbix 4.0开始支持以下字段:
- item 值预处理步骤
- HTTP agent URL 字段
- HTTP agent HTTP query fields 字段
- HTTP agent request body 字段
- HTTP agent required status codes 字段
- HTTP agent headers field key 和 value
- HTTP agent HTTP 认证用户名字段
- HTTP agent HTTP 认证密码字段
- HTTP agent HTTP proxy 字段
- HTTP agent SSL certificate 文件字段
- HTTP agent SSL key 文件字段
- HTTP agent SSL key 密码字段
- HTTP agent HTTP 超时字段
- HTTP agent HTTP 允许设备字段
- Items and item prototypes
- Name
- Key parameters
- Update interval
- Custom intervals
- History storage period
- Trend storage period
- SNMPv3 context name
- SNMPv3 security name
- SNMPv3 auth pass
- SNMPv3 priv pass
- SNMPv1/v2 community
- SNMP OID
- SNMP port
- SSH username
- SSH public key
- SSH private key
- SSH password
- SSH script
- Telnet username
- Telnet password
- Telnet script
- Calculated item
[formula](/manual/config/items/itemtypes/calculated#configurable_fields)
- Trapper item "Allowed hosts" field
- Database monitoring additional parameters
- JMX item endpoint field
- since Zabbix 4.0 also in:
- item value preprocessing steps
- HTTP agent URL field
- HTTP agent HTTP query fields field
- HTTP agent request body field
- HTTP agent required status codes field
- HTTP agent headers field key and value
- HTTP agent HTTP authentication username field
- HTTP agent HTTP authentication password field
- HTTP agent HTTP proxy field
- HTTP agent SSL certificate file field
- HTTP agent SSL key file field
- HTTP agent SSL key password field
- HTTP agent HTTP timeout field
- HTTP agent HTTP allowed hosts field
```{=html}
<!-- -->
```
- 发现
```{=html}
<!-- -->
```
* 更新间隔
* SNMPv3 context 字段
* SNMPv3 security 字段
* SNMPv3 auth 密码
* SNMPv3 priv 密码
* SNMPv1/v2 团体串
* SNMP OID
* Discovery
* Update interval
* SNMPv3 context name
* SNMPv3 security name
* SNMPv3 auth pass
* SNMPv3 priv pass
* SNMPv1/v2 community
* SNMP OID
- Low-level 发现规则
- 名称
- Key 参数
- 更新间隔
- 用户自定义间隔
- SNMPv3 context 名称
- SNMPv3 security 名称
- SNMPv3 auth 密码
- SNMPv3 priv 密码
- SNMPv1/v2 团体串
- SNMP OID
- SNMP port
- SSH 用户名
- SSH 公钥
- SSH 私钥
- SSH 密码
- SSH 脚本
- Telnet 用户名
- Telnet 密码
- Telnet 脚本
- Trapper item 允许设备字段
- 数据库监控附加字段
- JMX item endpoint 字段
- 保持资源丢失时间
- 过滤正则表达式
- 从Zabbix 4.0开始支持以下字段:
- HTTP agent URL 字段
- HTTP agent HTTP query fields 字段
- HTTP agent request body 字段
- HTTP agent required status codes 字段
- HTTP agent headers field key 和 value
- HTTP agent HTTP 认证用户名字段
- HTTP agent HTTP 认证密码字段
- HTTP agent HTTP 超时字段
- Low-level discovery rule
- Name
- Key parameters
- Update interval
- Custom intervals
- SNMPv3 context name
- SNMPv3 security name
- SNMPv3 auth pass
- SNMPv3 priv pass
- SNMPv1/v2 community
- SNMP OID
- SNMP port
- SSH username
- SSH public key
- SSH private key
- SSH password
- SSH script
- Telnet username
- Telnet password
- Telnet script
- Trapper item "Allowed hosts" field
- Database monitoring additional parameters
- JMX item endpoint field
- Keep lost resources period
- Filter regular expressions
- since Zabbix 4.0 also in:
- HTTP agent URL field
- HTTP agent HTTP query fields field
- HTTP agent request body field
- HTTP agent required status codes field
- HTTP agent headers field key and value
- HTTP agent HTTP authentication username field
- HTTP agent HTTP authentication password field
- HTTP agent HTTP timeout field
```{=html}
<!-- -->
```
- Web scenario
```{=html}
<!-- -->
```
* 名称
* 更新间隔
* Agent
* HTTP proxy
* Variables
* Headers
* Step name
* Step URL
* Step post variables
* Step headers
* Step timeout
* Required string
* 必须的状态
* 认证 (用户名和密码)
* SSL certificate 文件
* SSL key 文件
* SSL key 密码
* Web scenario
* Name
* Update interval
* Agent
* HTTP proxy
* Variables
* Headers
* Step name
* Step URL
* Step post variables
* Step headers
* Step timeout
* Required string
* Required status codes
* Authentication (user and password)
* SSL certificate file
* SSL key file
* SSL key password
* Triggers
* 名称
* 表达式 (仅在常量和函数参数中)
* 描述信息
* URLs
- Triggers
```{=html}
<!-- -->
```
* Name
* Expression (only in constants and function parameters)
* Description
* URLs
* 基于Trigger通知
* 基于Trigger内部通知
* 问题更新通知
* Trigger-based notifications
* Trigger-based internal notifications
* Problem update notifications
* 事件tags
* Tag 名称
* Tag 值
* Tag 匹配
* Event tags
* Tag name
* Tag value
* Tag for matching
- 动作操作
```{=html}
<!-- -->
```
* 默认步骤持续时间
* 步骤持续时间
* Action operations
* Default operation step duration
* Step duration
* 动作条件
* 时间周期条件
* Action conditions
* Time period condition
- 全局脚本 (包括确认文本)
- Global scripts (including confirmation text)
```{=html}
<!-- -->
```
- dynamic URL screen 元素的URL字段。
- URL field of dynamic URL screen element
```{=html}
<!-- -->
```
- 管理 → 用户 → 媒介: 'When active' 字段。
- 管理 → 一般 → 工作时间: 'Working time' 字段。
- Administration → Users → Media: 'When active' field
- Administration → General → Working time: 'Working time' field
需要Zabbix所支持宏的完整列表, 请参考
[支持宏列表](/manual/appendix/macros/supported_by_location)。 For a
complete list of all macros supported Zabbix, see [macros supported by
location](/manual/appendix/macros/supported_by_location).
##### Host tags
|Element|Element property|Required|Type|Range^**[1](#footnotes)**^|Description|
|--|--|-|--|----|--------|
|groups| |x| | |Root element for host groups.|
| |name|x|`string`| |Host group name.|
|hosts| |\-| | |Root element for hosts.|
| |host|x|`string`| |Unique host name.|
| |name|\-|`string`| |Visible host name.|
| |description|\-|`text`| |Host description.|
| |status|\-|`string`|0 - ENABLED (default)<br>1 - DISABLED|Host status.|
| |ipmi\_authtype|\-|`string`|-1 - DEFAULT (default)<br>0 - NONE<br>1 - MD2<br>2 - MD5<br>4 - STRAIGHT<br>5 - OEM<br>6 - RMCP\_PLUS|IPMI session authentication type.|
| |ipmi\_privilege|\-|`string`|1 - CALLBACK<br>2 - USER (default)<br>3 - OPERATOR<br>4 - ADMIN<br>5 - OEM|IPMI session privilege level.|
| |ipmi\_username|\-|`string`| |Username for IPMI checks.|
| |ipmi\_password|\-|`string`| |Password for IPMI checks.|
|proxy| |\-| | |Proxy.|
| |name|x|`string`| |Name of the proxy (if any) that monitors the host.|
|templates| |\-| | |Root element for linked templates.|
| |name|x|`string`| |Template name.|
|interfaces| |\-| | |Root element for host interfaces.|
| |default|\-|`string`|0 - NO<br>1 - YES (default)|Whether this is the primary host interface.<br>There can be only one primary interface of one type on a host.|
| |type|\-|`string`|1 - ZABBIX (default)<br>2 - SNMP<br>3 - IPMI<br>4 - JMX|Interface type.|
| |useip|\-|`string`|0 - NO<br>1 - YES (default)|Whether to use IP as the interface for connecting to the host (if not, DNS will be used).|
| |ip|\-|`string`| |IP address, can be either IPv4 or IPv6.<br><br>Required if the connection is made via IP.|
| |dns|\-|`string`| |DNS name.<br><br>Required if the connection is made via DNS.|
| |port|\-|`string`| |Port number. Supports user macros.|
| |interface\_ref|x|`string`|Format: `if<N>`|Interface reference name to be used in items.|
|details| |\-| | |Root element for interface details.|
| |version|\-|`string`|1 - SNMPV1<br>2 - SNMP\_V2C (default)<br>3 - SNMP\_V3|Use this SNMP version.|
| |community|\-|`string`| |SNMP community.<br><br>Required by SNMPv1 and SNMPv2 items.|
| |contextname|\-|`string`| |SNMPv3 context name.<br><br>Used only by SNMPv3 items.|
| |securityname|\-|`string`| |SNMPv3 security name.<br><br>Used only by SNMPv3 items.|
| |securitylevel|\-|`string`|0 - NOAUTHNOPRIV (default)<br>1 - AUTHNOPRIV<br>2 - AUTHPRIV|SNMPv3 security level.<br><br>Used only by SNMPv3 items.|
| |authprotocol|\-|`string`|0 - MD5 (default)<br>1 - SHA1<br>2 - SHA224<br>3 - SHA256<br>4 - SHA384<br>5 - SHA512|SNMPv3 authentication protocol.<br><br>Used only by SNMPv3 items.|
| |authpassphrase|\-|`string`| |SNMPv3 authentication passphrase.<br><br>Used only by SNMPv3 items.|
| |privprotocol|\-|`string`|0 - DES (default)<br>1 - AES128<br>2 - AES192<br>3 - AES256<br>4 - AES192C<br>5 - AES256C|SNMPv3 privacy protocol.<br><br>Used only by SNMPv3 items.|
| |privpassphrase|\-|`string`| |SNMPv3 privacy passphrase.<br><br>Used only by SNMPv3 items.|
| |bulk|\-|`string`|0 - NO<br>1 - YES (default)|Use bulk requests for SNMP.|
|items| |\-| | |Root element for items.|
| |*For item element tag values, see host [item](/manual/xml_export_import/hosts#host_item_tags) tags.*| | | | |
|tags| |\-| | |Root element for host tags.|
| |tag|x|`string`| |Tag name.|
| |value|\-|`string`| |Tag value.|
|macros| |\-| | |Root element for macros.|
| |macro|x| | |User macro name.|
| |type|\-|`string`|0 - TEXT (default)<br>1 - SECRET\_TEXT<br>2 - VAULT|Type of the macro.|
| |value|\-|`string`| |User macro value.|
| |description|\-|`string`| |User macro description.|
|inventory| |\-| | |Root element for host inventory.|
| |<inventory\_property>|\-| | |Individual inventory property.<br><br>All available inventory properties are listed under the respective tags, e.g. <type>, <name>, <os> (see example above).|
|inventory\_mode| |\-|`string`|-1 - DISABLED<br>0 - MANUAL (default)<br>1 - AUTOMATIC|Inventory mode.|
|valuemaps| |\-| | |Root element for host value maps.|
| |name|x|`string`| |Value map name.|
| |mapping|\-| | |Root element for mappings.|
| |value|x|`string`| |Value of a mapping.|
| |newvalue|x|`string`| |New value of a mapping.|
##### 主机标签
| 元素 | 元素属性 | 必填 | 类型 | 范围^**[1](#footnotes)**^ | 描述 |
|--|--|-|--|----|--------|
| groups | | x | | | 主机组的根元素。 |
| | name | x | `string` | | 主机组名称。 |
| hosts | | \- | | | 主机的根元素。 |
| | host | x | `string` | | 唯一主机名。 |
| | name | \- | `string` | | 可见主机名。 |
| | description | \- | `text` | | 主机描述。 |
| | status | \- | `string` | 0 - ENABLED (default)<br>1 - DISABLED | 主机状态。 |
| | ipmi\_authtype | \- | `string` | -1 - DEFAULT (default)<br>0 - NONE<br>1 - MD2<br>2 - MD5<br>4 - STRAIGHT<br>5 - OEM<br>6 - RMCP\_PLUS | IPMI会话认证类型。 |
| | ipmi\_privilege | \- | `string` | 1 - CALLBACK<br>2 - USER (default)<br>3 - OPERATOR<br>4 - ADMIN<br>5 - OEM | IPMI会话权限级别。 |
| | ipmi\_username | \- | `string` | | IPMI检查的用户名。 |
| | ipmi\_password | \- | `string` | | IPMI检查的密码。 |
| proxy | | \- | | | Proxy。 |
| | name | x | `string` | | 监控主机的proxy名称（如有）。 |
| templates | | \- | | | 关联模板的根元素。 |
| | name | x | `string` | | 模板名称。 |
| interfaces | | \- | | | 主机接口的根元素。 |
| | default | \- | `string` | 0 - NO<br>1 - YES (default) | 是否为主主机接口。<br>一个一个主机上每种类型只能有一个主接口。 |
| | type | \- | `string` | 1 - ZABBIX (default)<br>2 - SNMP<br>3 - IPMI<br>4 - JMX | 接口类型。 |
| | useip | \- | `string` | 0 - NO<br>1 - YES (default) | 是否使用IP连接主机（否则使用DNS）。 |
| | ip | \- | `string` | | IP地址，可以是IPv4或IPv6。<br><br>通过IP连接时必填。 |
| | dns | \- | `string` | | DNS名称。<br><br>通过DNS连接时必填。 |
| | port | \- | `string` | | 端口号。支持用户宏。 |
| | interface\_ref | x | `string` | Format: `if<N>` | 接口引用名称，用于监控项。 |
| details | | \- | | | 接口详情的根元素。 |
| | version | \- | `string` | 1 - SNMPV1<br>2 - SNMP\_V2C (default)<br>3 - SNMP\_V3 | 使用此SNMPversion。 |
| | community | \- | `string` | | SNMP团体名。<br><br>SNMPv1和SNMPv2监控项必填。 |
| | contextname | \- | `string` | | SNMPv3上下文名称。<br><br>仅用于SNMPv3监控项。 |
| | securityname | \- | `string` | | SNMPv3安全名称。<br><br>仅用于SNMPv3监控项。 |
| | securitylevel | \- | `string` | 0 - NOAUTHNOPRIV (default)<br>1 - AUTHNOPRIV<br>2 - AUTHPRIV | SNMPv3安全级别。<br><br>仅用于SNMPv3监控项。 |
| | authprotocol | \- | `string` | 0 - MD5 (default)<br>1 - SHA1<br>2 - SHA224<br>3 - SHA256<br>4 - SHA384<br>5 - SHA512 | SNMPv3认证协议。<br><br>仅用于SNMPv3监控项。 |
| | authpassphrase | \- | `string` | | SNMPv3认证密码。<br><br>仅用于SNMPv3监控项。 |
| | privprotocol | \- | `string` | 0 - DES (default)<br>1 - AES128<br>2 - AES192<br>3 - AES256<br>4 - AES192C<br>5 - AES256C | SNMPv3隐私协议。<br><br>仅用于SNMPv3监控项。 |
| | privpassphrase | \- | `string` | | SNMPv3隐私密码。<br><br>仅用于SNMPv3监控项。 |
| | bulk | \- | `string` | 0 - NO<br>1 - YES (default) | 对SNMP使用批量请求。 |
| items | | \- | | | 监控项的根元素。 |
| | *For item element tag values, see host [主机-监控项标签](/manual/xml_export_import/hosts#主机-监控项标签) tags.* | | | | |
| tags | | \- | | | 主机标签的根元素。 |
| | tag | x | `string` | | 标签名称。 |
| | value | \- | `string` | | 标签值。 |
| macros | | \- | | | 宏的根元素。 |
| | macro | x | | | 用户宏名称。 |
| | type | \- | `string` | 0 - TEXT (default)<br>1 - SECRET\_TEXT<br>2 - VAULT | 宏的类型。 |
| | value | \- | `string` | | 用户宏值。 |
| | description | \- | `string` | | 用户宏描述。 |
| inventory | | \- | | | 主机资产清单的根元素。 |
| | <inventory\_property> | \- | | | 单个资产清单属性。<br><br>所有可用资产清单属性列在相应标签下，例如<type>、<name>、<os>（见上例）。 |
| inventory\_mode | | \- | `string` | -1 - DISABLED<br>0 - MANUAL (default)<br>1 - AUTOMATIC | 资产清单模式。 |
| valuemaps | | \- | | | 主机值映射的根元素。 |
| | name | x | `string` | | 值映射名称。 |
| | mapping | \- | | | 映射的根元素。 |
| | value | x | `string` | | 映射的值。 |
| | newvalue | x | `string` | | 映射的新值。 |
### Host tag
The host tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**tag**<br>(required)|string|Host tag name.|
|value|string|Host tag value.|
### 主机标签
主机 标签 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **tag**<br>(required) | string | 主机 标签名称。 |
| value | string | 主机 标签值。 |
### Host
The host object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|hostid|string|*(readonly)* ID of the host.|
|**host**<br>(required)|string|Technical name of the host.|
|description|text|Description of the host.|
|flags|integer|*(readonly)* Origin of the host.<br><br>Possible values:<br>0 - a plain host;<br>4 - a discovered host.|
|inventory\_mode|integer|Host inventory population mode.<br><br>Possible values are:<br>-1 - *(default)* disabled;<br>0 - manual;<br>1 - automatic.|
|ipmi\_authtype|integer|IPMI authentication algorithm.<br><br>Possible values are:<br>-1 - *(default)* default;<br>0 - none;<br>1 - MD2;<br>2 - MD5<br>4 - straight;<br>5 - OEM;<br>6 - RMCP+.|
|ipmi\_password|string|IPMI password.|
|ipmi\_privilege|integer|IPMI privilege level.<br><br>Possible values are:<br>1 - callback;<br>2 - *(default)* user;<br>3 - operator;<br>4 - admin;<br>5 - OEM.|
|ipmi\_username|string|IPMI username.|
|maintenance\_from|timestamp|*(readonly)* Starting time of the effective maintenance.|
|maintenance\_status|integer|*(readonly)* Effective maintenance status.<br><br>Possible values are:<br>0 - *(default)* no maintenance;<br>1 - maintenance in effect.|
|maintenance\_type|integer|*(readonly)* Effective maintenance type.<br><br>Possible values are:<br>0 - *(default)* maintenance with data collection;<br>1 - maintenance without data collection.|
|maintenanceid|string|*(readonly)* ID of the maintenance that is currently in effect on the host.|
|name|string|Visible name of the host.<br><br>Default: `host` property value.|
|proxy\_hostid|string|ID of the proxy that is used to monitor the host.|
|status|integer|Status and function of the host.<br><br>Possible values are:<br>0 - *(default)* monitored host;<br>1 - unmonitored host.|
|tls\_connect|integer|Connections to host.<br><br>Possible values are:<br>1 - *(default)* No encryption;<br>2 - PSK;<br>4 - certificate.|
|tls\_accept|integer|Connections from host.<br><br>Possible bitmap values are:<br>1 - *(default)* No encryption;<br>2 - PSK;<br>4 - certificate.<br><br>This is a bitmask field; any sum of possible bitmap values is acceptable (for example, 6 for PSK and certificate).|
|tls\_issuer|string|Certificate issuer.|
|tls\_subject|string|Certificate subject.|
|tls\_psk\_identity|string|*(write-only)* PSK identity; must be paired with only one PSK (across [autoregistration](/manual/api/reference/autoregistration/object), [hosts](/manual/api/reference/host/object), and [proxies](/manual/api/reference/proxy/object)). Required if either `tls_connect` or `tls_accept` has PSK enabled.<br>Do not include sensitive information in the PSK identity, as it is sent unencrypted over the network to inform the receiver which PSK to use.|
|tls\_psk|string|*(write-only)* Pre-shared key (PSK); must be at least 32 hex digits. Required if either `tls_connect` or `tls_accept` has PSK enabled.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 主机
主机 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| hostid | string | *(只读)* 主机的ID。 |
| **host**<br>(required) | string | 主机的技术名称。 |
| description | text | 主机的描述。 |
| flags | integer | *(只读)* 主机的来源。<br><br>可能的值:<br>0 - 普通主机;<br>4 - 发现的主机。 |
| inventory\_mode | integer | 主机资产清单填充模式。<br><br>可能的值有:<br>-1 - *(默认)* 禁用;<br>0 - 手动;<br>1 - 自动。 |
| ipmi\_authtype | integer | IPMI认证算法。<br><br>可能的值有:<br>-1 - *(默认)* 默认;<br>0 - 无;<br>1 - MD2;<br>2 - MD5<br>4 - 直接;<br>5 - OEM;<br>6 - RMCP+。 |
| ipmi\_password | string | IPMI密码。 |
| ipmi\_privilege | integer | IPMI权限级别。<br><br>可能的值有:<br>1 - 回调;<br>2 - *(默认)* 用户;<br>3 - 操作员;<br>4 - 管理员;<br>5 - OEM。 |
| ipmi\_username | string | IPMI用户名。 |
| maintenance\_from | timestamp | *(只读)* 有效维护的开始时间。 |
| maintenance\_status | integer | *(只读)* 有效维护状态。<br><br>可能的值有:<br>0 - *(默认)* 无维护;<br>1 - 维护中。 |
| maintenance\_type | integer | *(只读)* 有效维护类型。<br><br>可能的值有:<br>0 - *(默认)* 带数据收集的维护;<br>1 - 不带数据收集的维护。 |
| maintenanceid | string | *(只读)* 当前在主机上生效的维护ID。 |
| name | string | 主机的可见名称。<br><br>默认值: `host` 属性值。 |
| proxy\_hostid | string | 用于监控主机的proxy的ID。 |
| status | integer | 主机的状态和功能。<br><br>可能的值有:<br>0 - *(默认)* 受监控的主机;<br>1 - 未监控的主机。 |
| tls\_connect | integer | 连接到主机的方式。<br><br>可能的值有:<br>1 - *(默认)* 无加密;<br>2 - PSK;<br>4 - 证书。 |
| tls\_accept | integer | 来自主机的连接。<br><br>可能的位图值有:<br>1 - *(默认)* 无加密;<br>2 - PSK;<br>4 - 证书。<br><br>这是一个位掩码字段; 任何可能的位图值的和都是可接受的(例如，6表示PSK和证书)。 |
| tls\_issuer | string | 证书颁发者。 |
| tls\_subject | string | 证书主题。 |
| tls\_psk\_identity | string | *(只写)* PSK标识; 必须仅与一个PSK配对(跨[autoregistration](/manual/api/reference/autoregistration/object), [hosts](/manual/api/reference/host/object), 和[proxies](/manual/api/reference/proxy/object))。如果`tls_connect`或`tls_accept`启用了PSK，则为必需。<br>不要在PSK标识中包含敏感信息，因为它会以明文形式通过网络发送，告知接收方使用哪个PSK。 |
| tls\_psk | string | *(只写)* 预共享密钥(PSK); 必须至少为32位十六进制数字。如果`tls_connect`或`tls_accept`启用了PSK，则为必需。 |
请注意，对于某些方法(update, delete)，必需/可选参数的组合是不同的。
##### Host trigger tags
|Element|Element property|Required|Type|Range^**[1](#footnotes)**^|Description|
|--|--|-|--|----|--------|
|triggers| |\-| | |Root element for triggers.|
| |expression|x|`string`| |Trigger expression.|
| |recovery\_mode|\-|`string`|0 - EXPRESSION (default)<br>1 - RECOVERY\_EXPRESSION<br>2 - NONE|Basis for generating OK events.|
| |recovery\_expression|\-|`string`| |Trigger recovery expression.|
| |correlation\_mode|\-|`string`|0 - DISABLED (default)<br>1 - TAG\_VALUE|Correlation mode (no event correlation or event correlation by tag).|
| |correlation\_tag|\-|`string`| |The tag name to be used for event correlation.|
| |name|x|`string`| |Trigger name.|
| |event_name|\-|`string`| |Event name.|
| |opdata|\-|`string`| |Operational data.|
| |url|\-|`string`| |URL associated with the trigger.|
| |status|\-|`string`|0 - ENABLED (default)<br>1 - DISABLED|Trigger status.|
| |priority|\-|`string`|0 - NOT\_CLASSIFIED (default)<br>1 - INFO<br>2 - WARNING<br>3 - AVERAGE<br>4 - HIGH<br>5 - DISASTER|Trigger severity.|
| |description|\-|`text`| |Trigger description.|
| |type|\-|`string`|0 - SINGLE (default)<br>1 - MULTIPLE|Event generation type (single problem event or multiple problem events).|
| |manual\_close|\-|`string`|0 - NO (default)<br>1 - YES|Manual closing of problem events.|
|dependencies| |\-| | |Root element for dependencies.|
| |name|x|`string`| |Dependency trigger name.|
| |expression|x|`string`| |Dependency trigger expression.|
| |recovery\_expression|\-|`string`| |Dependency trigger recovery expression.|
|tags| |\-| | |Root element for event tags.|
| |tag|x|`string`| |Tag name.|
| |value|\-|`string`| |Tag value.|
##### 主机触发器标签
| 元素 | 元素属性 | 必填 | 类型 | 范围^**[1](#footnotes)**^ | 描述 |
|--|--|-|--|----|--------|
| triggers | | \- | | | 触发器根元素。 |
| | expression | x | `string` | | 触发器表达式。 |
| | recovery\_mode | \- | `string` | 0 - EXPRESSION (default)<br>1 - RECOVERY\_EXPRESSION<br>2 - NONE | 生成OK事件的基础。 |
| | recovery\_expression | \- | `string` | | 触发器恢复表达式。 |
| | correlation\_mode | \- | `string` | 0 - DISABLED (default)<br>1 - TAG\_VALUE | 关联模式（无事件关联或通过标签进行事件关联）。 |
| | correlation\_tag | \- | `string` | | 用于事件关联的标签名称。 |
| | name | x | `string` | | 触发器名称。 |
| | event_name | \- | `string` | | 事件名称。 |
| | opdata | \- | `string` | | 操作数据。 |
| | url | \- | `string` | | 与触发器关联的URL。 |
| | status | \- | `string` | 0 - ENABLED (default)<br>1 - DISABLED | 触发器状态。 |
| | priority | \- | `string` | 0 - NOT\_CLASSIFIED (default)<br>1 - INFO<br>2 - WARNING<br>3 - AVERAGE<br>4 - HIGH<br>5 - DISASTER | 触发器严重性。 |
| | description | \- | `text` | | 触发器描述。 |
| | type | \- | `string` | 0 - SINGLE (default)<br>1 - MULTIPLE | 事件生成类型（单个问题事件或多个问题事件）。 |
| | manual\_close | \- | `string` | 0 - NO (default)<br>1 - YES | 手动关闭问题事件。 |
| dependencies | | \- | | | 依赖项根元素。 |
| | name | x | `string` | | 依赖触发器名称。 |
| | expression | x | `string` | | 依赖触发器表达式。 |
| | recovery\_expression | \- | `string` | | 依赖触发器恢复表达式。 |
| tags | | \- | | | 事件标签根元素。 |
| | tag | x | `string` | | 标签名称。 |
| | value | \- | `string` | | 标签值。 |
# host.update
# host.update
##### Host web scenario tags
|Element|Element property|Required|Type|Range^**[1](#footnotes)**^|Description|
|--|--|-|--|----|--------|
|httptests| |\-| | |Root element for web scenarios.|
| |name|x|`string`| |Web scenario name.|
| |delay|\-|`string`|Default: 1m|Frequency of executing the web scenario. Seconds, time unit with suffix or user macro.|
| |attempts|\-|`integer`|1-10 (default: 1)|The number of attempts for executing web scenario steps.|
| |agent|\-|`string`|Default: Zabbix|Client agent. Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.|
| |http\_proxy|\-|`string`| |Specify an HTTP proxy to use, using the format: `http://[username[:password]@]proxy.example.com[:port]`|
|variables| |\-| | |Root element for scenario-level variables (macros) that may be used in scenario steps.|
| |name|x|`text`| |Variable name.|
| |value|x|`text`| |Variable value.|
|headers| |\-| | |Root element for HTTP headers that will be sent when performing a request. Headers should be listed using the same syntax as they would appear in the HTTP protocol.|
| |name|x|`text`| |Header name.|
| |value|x|`text`| |Header value.|
| |status|\-|`string`|0 - ENABLED (default)<br>1 - DISABLED|Web scenario status.|
| |authentication|\-|`string`|0 - NONE (default)<br>1 - BASIC<br>2 - NTLM|Authentication method.|
| |http\_user|\-|`string`| |User name used for basic, HTTP or NTLM authentication.|
| |http\_password|\-|`string`| |Password used for basic, HTTP or NTLM authentication.|
| |verify\_peer|\-|`string`|0 - NO (default)<br>1 - YES|Whether to validate that the host's certificate is authentic.|
| |verify\_host|\-|`string`|0 - NO (default)<br>1 - YES|Whether to validate that the host name for the connection matches the one in the host's certificate.|
| |ssl\_cert\_file|\-|`string`| |Name of the SSL certificate file used for client authentication (must be in PEM format).|
| |ssl\_key\_file|\-|`string`| |Name of the SSL private key file used for client authentication (must be in PEM format).|
| |ssl\_key\_password|\-|`string`| |SSL private key file password.|
|steps| |x| | |Root element for web scenario steps.|
| |name|x|`string`| |Web scenario step name.|
| |url|x|`string`| |URL for monitoring.|
|query\_fields| |\-| | |Root element for query fields - an array of HTTP fields that will be added to the URL when performing a request.|
| |name|x|`string`| |Query field name.|
| |value|\-|`string`| |Query field value.|
|posts| |\-| | |HTTP POST variables as a string (raw post data) or as an array of HTTP fields (form field data).|
| |name|x|`string`| |Post field name.|
| |value|x|`string`| |Post field value.|
|variables| |\-| | |Root element of step-level variables (macros) that should be applied after this step.<br><br>If the variable value has a 'regex:' prefix, then its value is extracted from the data returned by this step according to the regular expression pattern following the 'regex:' prefix|
| |name|x|`string`| |Variable name.|
| |value|x|`string`| |Variable value.|
|headers| |\-| | |Root element for HTTP headers that will be sent when performing a request. Headers should be listed using the same syntax as they would appear in the HTTP protocol.|
| |name|x|`string`| |Header name.|
| |value|x|`string`| |Header value.|
| |follow\_redirects|\-|`string`|0 - NO<br>1 - YES (default)|Follow HTTP redirects.|
| |retrieve\_mode|\-|`string`|0 - BODY (default)<br>1 - HEADERS<br>2 - BOTH|HTTP response retrieve mode.|
| |timeout|\-|`string`|Default: 15s|Timeout of step execution. Seconds, time unit with suffix or user macro.|
| |required|\-|`string`| |Text that must be present in the response. Ignored if empty.|
| |status\_codes|\-|`string`| |A comma delimited list of accepted HTTP status codes. Ignored if empty. For example: 200-201,210-299|
|tags| |\-| | |Root element for web scenario tags.|
| |tag|x|`string`| |Tag name.|
| |value|\-|`string`| |Tag value.|
##### 主机 Web 场景标签
| 元素 | 元素属性 | 必填 | 类型 | 范围^**[1](#footnotes)**^ | 描述 |
|--|--|-|--|----|--------|
| httptests | | \- | | | 网络场景的根元素。 |
| | name | x | `string` | | 网络场景名称. |
| | delay | \- | `string` | Default: 1m | 执行Web场景的频率. 支持秒数/带后缀的时间单位/用户宏. |
| | attempts | \- | `integer` | 1-10 (default: 1) | 执行Web场景步骤的尝试次数。 |
| | agent | \- | `string` | Default: Zabbix | 客户端 agent. Zabbix将模拟所选浏览器。当网站针对不同浏览器返回不同内容时，此功能非常有用。 |
| | http\_proxy | \- | `string` | | 指定要使用的HTTP proxy，格式为：`http://[username[:password]@]proxy.example.com[:port]` |
| variables | | \- | | | 用于场景步骤中可能使用的场景级变量（宏）的根元素。 |
| | name | x | `text` | | 变量名称. |
| | value | x | `text` | | 变量值. |
| headers | | \- | | | 执行请求时将发送的HTTP头部信息的根元素。头部应按照HTTP协议中出现的相同语法列出。 |
| | name | x | `text` | | 表头名称. |
| | value | x | `text` | | 表头值. |
| | status | \- | `string` | 0 - ENABLED (default)<br>1 - DISABLED | Web场景状态. |
| | authentication | \- | `string` | 0 - NONE (default)<br>1 - BASIC<br>2 - NTLM | 认证方法 |
| | http\_user | \- | `string` | | 用于基本认证、HTTP或NTLM认证的用户名。 |
| | http\_password | \- | `string` | | 用于基本认证、HTTP认证或NTLM认证的密码。 |
| | verify\_peer | \- | `string` | 0 - NO (default)<br>1 - YES | 是否验证主机证书的真实性。 |
| | verify\_host | \- | `string` | 0 - NO (default)<br>1 - YES | 是否验证连接中主机名称与主机证书中的名称匹配. |
| | ssl\_cert\_file | \- | `string` | | 用于客户端认证的SSL证书file名称（必须为PEM格式）。 |
| | ssl\_key\_file | \- | `string` | | 用于客户端认证的SSL私钥file名称（必须为PEM格式）。 |
| | ssl\_key\_password | \- | `string` | | SSL私钥 file 密码. |
| steps | | x | | | Web场景步骤的根元素。 |
| | name | x | `string` | | Web场景步骤名称. |
| | url | x | `string` | | 监控URL. |
| query\_fields | | \- | | | query字段的根元素 - 一个HTTP字段的array，在执行请求时将被添加到URL中。 |
| | name | x | `string` | | query 字段名称. |
| | value | \- | `string` | | query 字段值. |
| posts | | \- | | | 以string（原始POST数据）或HTTP字段array（表单字段数据）形式传递的HTTP POST变量。 |
| | name | x | `string` | | 表单字段名称. |
| | value | x | `string` | | 发布字段值. |
| variables | | \- | | | 应在此步骤后应用的步骤级变量（宏）的根元素。<br><br>如果变量值带有'regex:'前缀，则根据'regex:'前缀后的正则表达式模式，从该步骤返回的数据中提取其值 |
| | name | x | `string` | | 变量名称. |
| | value | x | `string` | | 变量值. |
| headers | | \- | | | 执行请求时将发送的HTTP头部信息的根元素。头部信息应使用与HTTP协议中相同的语法列出。 |
| | name | x | `string` | | 表头名称. |
| | value | x | `string` | | 表头值. |
| | follow\_redirects | \- | `string` | 0 - NO<br>1 - YES (default) | 跟随HTTP重定向。 |
| | retrieve\_mode | \- | `string` | 0 - BODY (default)<br>1 - HEADERS<br>2 - BOTH | HTTP响应检索模式. |
| | timeout | \- | `string` | Default: 15s | 步骤执行超时时间。单位为秒，可带后缀的时间单位或用户宏。 |
| | required | \- | `string` | | 响应中必须包含的文本。如果为空则忽略。 |
| | status\_codes | \- | `string` | | 以逗号分隔的HTTP状态码允许列表. 若为空则忽略. 例如: 200-201,210-299 |
| tags | | \- | | | Web场景标签的根元素。 |
| | tag | x | `string` | | 标签名称. |
| | value | \- | `string` | | 标签值. |
#### - Housekeeper
The housekeeper is a periodical process, executed by Zabbix server. The
process removes outdated information and information deleted by user.
In this section housekeeping tasks can be enabled or disabled on a
per-task basis separately for: events and alerts/IT services/user
sessions/history/trends. Audit housekeeping settings are available in a
separate [menu
section](/manual/web_interface/frontend_sections/administration/general#audit_log).
If housekeeping is enabled, it is possible to set for how many days data
records will be kept before being removed by the housekeeper.
Deleting an item/trigger will also delete problems generated by that
item/trigger.
Also, an event will only be deleted by the housekeeper if it is not
associated with a problem in any way. This means that if an event is
either a problem or recovery event, it will not be deleted until the
related problem record is removed. The housekeeper will delete problems
first and events after, to avoid potential problems with stale events or
problem records.
For history and trends an additional option is available: *Override item
history period* and *Override item trend period*. This option allows to
globally set for how many days item history/trends will be kept (1 hour
to 25 years; or "0"), in this case overriding the values set for
individual items in *History storage period/Trend storage period* fields
in [item configuration](/manual/config/items/item). Note, that the
storage period will not be overridden for items that have configuration
option *Do not keep history* and/or *Do not keep trends* enabled.
It is possible to override the history/trend storage period even if
internal housekeeping is disabled. Thus, when using an external
housekeeper, the history storage period could be set using the history
*Data storage period* field.
::: noteimportant
If using TimescaleDB, in order to take full
advantage of TimescaleDB automatic partitioning of history and trends
tables, *Override item history period* and *Override item trend period*
options must be enabled as well as *Enable internal housekeeping* option
for history and trends. Otherwise, the data kept in these tables will
still be stored in partitions, however, the housekeeper will be cleaning
the history and trends by deleting individual records rather than by
dropping outdated partitions. When dropping of outdated partitions is
enabled, Zabbix server and frontend will no longer keep track of deleted
items and history for deleted items will be cleared when an outdated
partition is deleted.
:::
[Time suffixes](/manual/appendix/suffixes) are supported in the period
fields, e.g. 1d (one day), 1w (one week). The minimum is 1 day (1 hour
for history), the maximum - 25 years.
*Reset defaults* button allows to revert any changes made.
##### -图片
图像部分显示Zabbix中可用的所有图像。 图像存储在数据库中。
{width="600"}
*类型* 下拉菜单允许您在图标和背景图像之间切换：
- 标用于显示[网络图](/manual/config/visualization/maps/map) 元素
- 背景用作网络图的背景图像
**添加图像**
您可以通过点击右上角*创建图标*或者*创建背景*按钮添加自己的图像。
图像属性：
|参数 描|n|
|--------------|-|
|*名称* 图|的唯一名称。|
|*上传* 从|地系统中选择要上传到Zabbix的文件（PNG，JPEG）。|
::: noteclassic
上传文件的最大大小受ZBX\_MAX\_IMAGE\_SIZE值的限制，为1024x1024字节或1
MB。\
\
如果图像大小接近1
MB，“max\_allowed\_packet”的MySQL配置参数的默认值为1MB，则图像的上传可能会失败。在这种情况下，增加
[max\_allowed\_packet](http://dev.mysql.com/doc/refman/5.5/en/server-system-variables.html#sysvar_max_allowed_packet)
参数。
:::
# housekeeping.get
# housekeeping.get
### Housekeeping
The settings object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|hk\_events\_mode|integer|Enable internal housekeeping for events and alerts.<br><br>Possible values:<br>0 - Disable;<br>1 - *(default)* Enable.|
|hk\_events\_trigger|string|Trigger data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 365d.|
|hk\_events\_service|string|Service data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 1d.|
|hk\_events\_internal|string|Internal data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 1d.|
|hk\_events\_discovery|string|Network discovery data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 1d.|
|hk\_events\_autoreg|string|Autoregistration data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 1d.|
|hk\_services\_mode|integer|Enable internal housekeeping for services.<br><br>Possible values:<br>0 - Disable;<br>1 - *(default)* Enable.|
|hk\_services|string|Services data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 365d.|
|hk\_audit\_mode|integer|Enable internal housekeeping for audit.<br><br>Possible values:<br>0 - Disable;<br>1 - *(default)* Enable.|
|hk\_audit|string|Audit data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 365d.|
|hk\_sessions\_mode|integer|Enable internal housekeeping for sessions.<br><br>Possible values:<br>0 - Disable;<br>1 - *(default)* Enable.|
|hk\_sessions|string|Sessions data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 365d.|
|hk\_history\_mode|integer|Enable internal housekeeping for history.<br><br>Possible values:<br>0 - Disable;<br>1 - *(default)* Enable.|
|hk\_history\_global|integer|Override item history period.<br><br>Possible values:<br>0 - Do not override;<br>1 - *(default)* Override.|
|hk\_history|string|History data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 90d.|
|hk\_trends\_mode|integer|Enable internal housekeeping for trends.<br><br>Possible values:<br>0 - Disable;<br>1 - *(default)* Enable.|
|hk\_trends\_global|integer|Override item trend period.<br><br>Possible values:<br>0 - Do not override;<br>1 - *(default)* Override.|
|hk\_trends|string|Trends data storage period. Accepts seconds and time unit with suffix.<br><br>Default: 365d.|
|db\_extension|string|*(readonly)* Configuration flag DB extension. If this flag is set to "timescaledb" then the server changes its behavior for housekeeping and item deletion.|
|compression\_status|integer|Enable TimescaleDB compression for history and trends.<br><br>Possible values:<br>0 - *(default)* Off;<br>1 - On.|
|compress\_older|string|Compress history and trends records older than specified period. Accepts seconds and time unit with suffix.<br><br>Default: 7d.|
|compression\_availability|integer|*(readonly)* Compression availability.<br><br>Possible values:<br>0 - Unavailable;<br>1 - Available.|
### 数据清理
设置 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| hk\_events\_mode | integer | 启用事件和告警的内部维护。<br><br>可选值:<br>0 - 禁用;<br>1 - *(默认)* 启用。 |
| hk\_events\_trigger | string | 触发器数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 365d。 |
| hk\_events\_service | string | 服务数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 1d。 |
| hk\_events\_internal | string | 内部数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 1d。 |
| hk\_events\_discovery | string | 网络发现数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 1d。 |
| hk\_events\_autoreg | string | 自动注册数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 1d。 |
| hk\_services\_mode | integer | 启用服务的内部维护。<br><br>可选值:<br>0 - 禁用;<br>1 - *(默认)* 启用。 |
| hk\_services | string | 服务数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 365d。 |
| hk\_audit\_mode | integer | 启用审计的内部维护。<br><br>可选值:<br>0 - 禁用;<br>1 - *(默认)* 启用。 |
| hk\_audit | string | 审计数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 365d。 |
| hk\_sessions\_mode | integer | 启用会话的内部维护。<br><br>可选值:<br>0 - 禁用;<br>1 - *(默认)* 启用。 |
| hk\_sessions | string | 会话数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 365d。 |
| hk\_history\_mode | integer | 启用历史的内部维护。<br><br>可选值:<br>0 - 禁用;<br>1 - *(默认)* 启用。 |
| hk\_history\_global | integer | 覆盖 监控项 历史周期。<br><br>可选值:<br>0 - 不覆盖;<br>1 - *(默认)* 覆盖。 |
| hk\_history | string | 历史数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 90d。 |
| hk\_trends\_mode | integer | 启用趋势的内部维护。<br><br>可选值:<br>0 - 禁用;<br>1 - *(默认)* 启用。 |
| hk\_trends\_global | integer | 覆盖 监控项 趋势周期。<br><br>可选值:<br>0 - 不覆盖;<br>1 - *(默认)* 覆盖。 |
| hk\_trends | string | 趋势数据存储周期。接受带后缀的秒数和时间单位。<br><br>默认: 365d。 |
| db\_extension | string | *(只读)* 配置 flag 数据库扩展。如果此 flag 设置为 "timescaledb"，则服务器会更改其维护和 监控项 删除的行为。 |
| compression\_status | integer | 为历史和趋势启用TimescaleDB压缩。<br><br>可选值:<br>0 - *(默认)* 关闭;<br>1 - 开启。 |
| compress\_older | string | 压缩早于指定周期的历史和趋势记录。接受带后缀的秒数和时间单位。<br><br>默认: 7d。 |
| compression\_availability | integer | *(只读)* 压缩可用性。<br><br>可选值:<br>0 - 不可用;<br>1 - 可用。 |
# housekeeping.update
# housekeeping.update
#### How it works
In log monitoring you may encounter lines similar to these:
Line1: Application 1 stopped
Line2: Application 2 stopped
Line3: Application 1 was restarted
Line4: Application 2 was restarted
The idea of event correlation is to be able to match the problem event
from Line1 to the resolution from Line3 and the problem event from Line2
to the resolution from Line4, and close these problems one by one:
Line1: Application 1 stopped
Line3: Application 1 was restarted #problem from Line 1 closed
Line2: Application 2 stopped
Line4: Application 2 was restarted #problem from Line 2 closed
To do this you need to tag these related events as, for example,
"Application 1" and "Application 2". That can be done by applying a
regular expression to the log line to extract the tag value. Then, when
events are created, they are tagged "Application 1" and "Application 2"
respectively and problem can be matched to the resolution.
#### 工作原理
在日志监控中，您可能会遇到类似以下内容的日志行：
Line1: Application 1 stopped
Line2: Application 2 stopped
Line3: Application 1 was restarted
Line4: Application 2 was restarted
事件关联的理念在于能够将Line1的问题事件
与Line3的解决措施相匹配，以及将Line2的问题事件
与Line4的解决措施相匹配，并逐个关闭这些问题：
Line1: Application 1 stopped
Line3: Application 1 was restarted #problem from Line 1 closed
Line2: 应用程序2已停止
Line4: Application 2 was restarted #problem from Line 2 closed
为此，您需要将这些相关事件标记为例如
"Application 1"和"Application 2"。这可以通过对
日志行应用正则表达式来提取标记值实现。然后，当
事件被创建时，它们将分别被标记为"Application 1"和"Application 2"，
从而可以将问题与解决措施相匹配。
#### HP OpenView
Zabbix can be configured to send messages to OpenView server. The
following steps must be performed:
#### 惠普 OpenView
Zabbix 可以配置向 OpenView 服务器发送消息。必须执行以下步骤：
### HTML support in Geomap attribution dropped
The attribution text for the [Geomap dashboard widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)
can now only contain plain text; HTML support has been dropped. If this field already contains HTML, it will be rendered
as plain text after the upgrade.
In [Geographical maps](/manual/web_interface/frontend_sections/administration/general#geographical-maps) settings
in the Administration → General section, the field *Attribution* is now only visible when *Tile provider* is set to *Other*.
### Geomap 属性中的 HTML 支持已弃用
[Geomap dashboard widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)的归属文本
现在仅支持纯文本格式，已取消对HTML的支持。若该字段已包含HTML内容，升级后将作为纯文本呈现。
在[地理地图](/manual/web_interface/frontend_sections/administration/general#地理地图)设置中
（位于管理→常规部分），*归属*字段现在仅当*瓦片提供商*设置为*其他*时才会显示。
### HTML support in Geomap attribution dropped
The attribution text for the [Geomap dashboard widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)
can now only contain plain text; HTML support has been dropped.
In [Geographical maps](/manual/web_interface/frontend_sections/administration/general#geographical-maps) settings
in the Administration → General section, the field *Attribution* is now only visible when *Tile provider* is set to *Other*.
### Geomap 属性中的 HTML 支持已弃用
[Geomap dashboard widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/geomap)的归属文本
现在仅支持纯文本格式，已取消对HTML的支持。
在[地理地图](/manual/web_interface/frontend_sections/administration/general#地理地图)设置中
（位于管理→常规部分），*归属*字段现在仅当*瓦片提供商*设置为*其他*时才会显示。
### HTTP authentication
HTTP or web server-based authentication (for example: Basic
Authentication, NTLM/Kerberos) can be used to check user names and
passwords. Note that a user must exist in Zabbix as well, however its
Zabbix password will not be used.
::: noteimportant
Be careful! Make sure that web server
authentication is configured and works properly before switching it
on.
:::
{width="600"}
Configuration parameters:
|Parameter|Description|
|--|--------|
|*Enable HTTP authentication*|Mark the checkbox to enable HTTP authentication. Hovering the mouse over  will bring up a hint box warning that in the case of web server authentication, all users (even with [frontend access](/manual/config/users_and_usergroups/usergroup#configuration) set to LDAP/Internal) will be authenticated by the web server, not by Zabbix.|
|*Default login form*|Specify whether to direct non-authenticated users to:<br>**Zabbix login form** - standard Zabbix login page.<br>**HTTP login form** - HTTP login page.<br>It is recommended to enable web-server based authentication for the `index_http.php` page only. If *Default login form* is set to 'HTTP login page' the user will be logged in automatically if web server authentication module will set valid user login in the `$_SERVER` variable.<br>Supported `$_SERVER` keys are `PHP_AUTH_USER`, `REMOTE_USER`, `AUTH_USER`.|
|*Remove domain name*|A comma-delimited list of domain names that should be removed from the username.<br>E.g. `comp,any` - if username is 'Admin\@any', 'comp\\Admin', user will be logged in as 'Admin'; if username is 'notacompany\\Admin', login will be denied.|
|*Case sensitive login*|Unmark the checkbox to disable case-sensitive login for usernames (enabled by default).<br>Disabling case-sensitive login allows, for example, to log in as "admin" even if the Zabbix user is "Admin" or "ADMIN".<br>Please note that if case-sensitive login is disabled and there are multiple Zabbix users with similar usernames (e.g., Admin and admin), the login for those users will always be denied with the following error message: "Authentication failed: supplied credentials are not unique."|
::: notetip
For internal users who are unable to log in using HTTP
credentials (with HTTP login form set as default) leading to the 401
error, you may want to add a `ErrorDocument 401 /index.php?form=default`
line to basic authentication directives, which will redirect to the
regular Zabbix login form.
:::
### HTTP 认证
基于HTTP或Web服务器的认证（例如：Basic）
身份验证（NTLM/Kerberos）可用于检查用户名和
密码。请注意，用户也必须存在于Zabbix中，然而其
Zabbix密码将不会被使用。
::: noteimportant
注意！确保Web服务器
在切换之前，认证已配置并正常工作
开启。
:::
{width="600"}
配置参数:
| 参数 | 描述 |
|--|--------|
| *Enable HTTP authentication* | 勾选此复选框以启用HTTP认证。将鼠标悬停在上会显示提示框，警告在启用Web服务器认证的情况下，所有用户（即使[配置](/manual/config/users_and_usergroups/usergroup#配置)设置为LDAP/内部）都将由Web服务器而非Zabbix进行认证。 |
| *Default login form* | 指定是否将未认证用户重定向至:<br>**Zabbix login 表单** - 标准Zabbix login页面.<br>**HTTP login 表单** - HTTP login页面.<br>建议仅对`index_http.php`页面启用基于Web服务器的认证. 若*默认login表单*设置为'HTTP login页面'，当Web服务器认证模块在`$_SERVER`变量中设置了有效的用户login时，用户将自动登录.<br>支持的`$_SERVER`键值为`PHP_AUTH_USER`, `REMOTE_USER`, `AUTH_USER`. |
| *Remove domain name* | 应从用户名中移除的域名列表（以逗号分隔）。<br>例如 `comp,any` - 若用户名为'Admin\@any'或'comp\\Admin'，用户将以'管理员'身份登录；若用户名为'notacompany\\Admin'，则login将被拒绝。 |
| *Case sensitive login* | 取消勾选该复选框以禁用用户名的大小写敏感login（默认启用）。<br>禁用大小写敏感login后，例如即使用户名为"Admin"或"ADMIN"，仍可以"admin"身份登录。<br>请注意，如果禁用大小写敏感login且存在多个相似用户名（如Admin和admin），这些用户的login将始终被拒绝并显示错误信息："认证失败：提供的凭据不唯一。" |
::: notetip
对于无法使用HTTP登录的内部用户
凭据（默认设置为HTTP login表单）导致401
错误，您可能需要添加一个`ErrorDocument 401 /index.php?form=default`
行到基本认证指令，这将重定向到
常规Zabbix login表单。
:::
### HTTP field
The HTTP field object defines a name and value that is used to specify
variable, HTTP header, POST form field data of query field data. It has
the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**name**<br>(required)|string|Name of header / variable / POST or GET field.|
|**value**<br>(required)|string|Value of header / variable / POST or GET field.|
### HTTP 字段
HTTP字段object用于定义名称和值，用于指定变量、HTTP头部、POST表单字段数据或query字段数据。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **name**<br>(required) | string | 头部/变量/POST或GET字段的名称。 |
| **value**<br>(required) | string | 头部/变量/POST或GET字段的值。 |
#### HttpRequest
::: noteimportant
"HttpRequest" is a new name for this object since Zabbix 5.4.
Previously it was called "CurlHttpRequest".
Method names have also been changed in Zabbix 5.4.
The old object/method names are now deprecated and their support will be discontinued after Zabbix 6.0.
:::
This object encapsulates cURL handle allowing to make simple HTTP requests.
Errors are thrown as exceptions.
::: noteimportant
The initialization of multiple `HttpRequest` objects is limited to 10 per script execution.
:::
|Method|Description|
|--|--------|
|`addHeader(value)`|Adds HTTP header field. This field is used for all following requests until cleared with the `clearHeader()` method.<br>The total length of header fields that can be added to a single `HttpRequest` object is limited to 128 Kbytes (special characters and header names included).|
|`clearHeader()`|Clears HTTP header. If no header fields are set, `HttpRequest` will set Content-Type to application/json if the data being posted is JSON-formatted; text/plain otherwise.|
|`connect(url)`|Sends HTTP CONNECT request to the URL and returns the response.|
|`customRequest(method, url, data)`|Allows to specify any HTTP method in the first parameter. Sends the method request to the URL with optional *data* payload and returns the response.|
|`delete(url, data)`|Sends HTTP DELETE request to the URL with optional *data* payload and returns the response.|
|`getHeaders(<asArray>)`|Returns the object of received HTTP header fields.<br>The `asArray` parameter may be set to "true" (e.g. `getHeaders(true)`), "false" or be undefined. If set to "true" the received HTTP header field values will be returned as arrays; this should be used to retrieve the field values of multiple same-name headers.<br>If not set or set to "false", the received HTTP header field values will be returned as strings.|
|`get(url, data)`|Sends HTTP GET request to the URL with optional *data* payload and returns the response.|
|`head(url)`|Sends HTTP HEAD request to the URL and returns the response.|
|`options(url)`|Sends HTTP OPTIONS request to the URL and returns the response.|
|`patch(url, data)`|Sends HTTP PATCH request to the URL with optional *data* payload and returns the response.|
|`put(url, data)`|Sends HTTP PUT request to the URL with optional *data* payload and returns the response.|
|`post(url, data)`|Sends HTTP POST request to the URL with optional *data* payload and returns the response.|
|`getStatus()`|Returns the status code of the last HTTP request.|
|`setProxy(proxy)`|Sets HTTP proxy to "proxy" value. If this parameter is empty then no proxy is used.|
|`setHttpAuth(bitmask, username, password)`|Sets enabled HTTP authentication methods (HTTPAUTH\_BASIC, HTTPAUTH\_DIGEST, HTTPAUTH\_NEGOTIATE, HTTPAUTH\_NTLM, HTTPAUTH\_NONE) in the 'bitmask' parameter.<br>The HTTPAUTH\_NONE flag allows to disable HTTP authentication.<br>Examples:<br>``request.setHttpAuth(HTTPAUTH_NTLM | HTTPAUTH_BASIC, username, password)`<br>`request.setHttpAuth(HTTPAUTH_NONE)``|
|`trace(url, data)`|Sends HTTP TRACE request to the URL with optional *data* payload and returns the response.|
Example:
```javascript
try {
Zabbix.log(4, 'jira webhook script value='+value);
var result = {
'tags': {
'endpoint': 'jira'
}
},
params = JSON.parse(value),
req = new HttpRequest(),
fields = {},
resp;
req.addHeader('Content-Type: application/json');
req.addHeader('Authorization: Basic '+params.authentication);
fields.summary = params.summary;
fields.description = params.description;
fields.project = {"key": params.project_key};
fields.issuetype = {"id": params.issue_id};
resp = req.post('https://jira.example.com/rest/api/2/issue/',
JSON.stringify({"fields": fields})
);
if (req.getStatus() != 201) {
throw 'Response code: '+req.getStatus();
}
resp = JSON.parse(resp);
result.tags.issue_id = resp.id;
result.tags.issue_key = resp.key;
} catch (error) {
Zabbix.log(4, 'jira issue creation failed json : '+JSON.stringify({"fields": fields}));
Zabbix.log(4, 'jira issue creation failed : '+error);
result = {};
}
return JSON.stringify(result);
```
#### HttpRequest
::: noteimportant
"HttpRequest"是自Zabbix 5.4起对该object的新命名。
先前它被称为"CurlHttpRequest"。
方法名称在Zabbix 5.4中也已变更。
旧的object/方法名称现已弃用，其支持将在Zabbix 6.0之后停止。
:::
该object封装了cURL句柄，允许发起简单的HTTP请求。
错误将以异常形式抛出。
::: noteimportant
每个脚本执行过程中`HttpRequest` objects的初始化数量限制为10个。
:::
| 方法 | 描述 |
|--|--------|
| `addHeader(value)` | 添加HTTP头字段。该字段将用于所有后续请求，直到通过`clearHeader()`方法清除。<br>单个`HttpRequest` object可添加的HTTP头字段总长度限制为128KB（含特殊字符和头字段名称）。 |
| `clearHeader()` | 清除HTTP头。若未设置任何头字段，当POST数据为JSON格式时`HttpRequest`将自动设置Content-Type为application/json；否则设为text/plain。 |
| `connect(url)` | 向URL发送HTTP CONNECT请求并返回响应。 |
| `customRequest(method, url, data)` | 允许在第一个参数中指定任意HTTP方法。向URL发送带可选*data*负载的方法请求并返回响应。 |
| `delete(url, data)` | 向URL发送带可选*data*负载的HTTP DELETE请求并返回响应。 |
| `getHeaders(<asArray>)` | 返回接收到的HTTP头字段object。<br>`asArray`参数可设为"true"（如`getHeaders(true)`）、"false"或未定义。若设为"true"，接收的HTTP头字段值将以数组形式返回；这适用于获取同名多头的字段值。<br>若未设置或设为"false"，接收的HTTP头字段值将以字符串形式返回。 |
| `get(url, data)` | 向URL发送带可选*data*负载的HTTP GET请求并返回响应。 |
| `head(url)` | 向URL发送HTTP HEAD请求并返回响应。 |
| `options(url)` | 向URL发送HTTP OPTIONS请求并返回响应。 |
| `patch(url, data)` | 向URL发送带可选*data*负载的HTTP PATCH请求并返回响应。 |
| `put(url, data)` | 向URL发送带可选*data*负载的HTTP PUT请求并返回响应。 |
| `post(url, data)` | 向URL发送带可选*data*负载的HTTP POST请求并返回响应。 |
| `getStatus()` | 返回最后一次HTTP请求的状态码。 |
| `setProxy(proxy)` | 将HTTP proxy设为"proxy"值。若该参数为空则不使用proxy。 |
| `setHttpAuth(bitmask, username, password)` | 在'bitmask'参数中设置启用的HTTP认证方法（HTTPAUTH\_BASIC、HTTPAUTH\_DIGEST、HTTPAUTH\_NEGOTIATE、HTTPAUTH\_NTLM、HTTPAUTH\_NONE）。<br>HTTPAUTH\_NONE flag可用于禁用HTTP认证。<br>示例：<br>``request.setHttpAuth(HTTPAUTH_NTLM | HTTPAUTH_BASIC, username, password)`<br>`request.setHttpAuth(HTTPAUTH_NONE)`` |
| `trace(url, data)` | 向URL发送带可选*data*负载的HTTP TRACE请求并返回响应。 |
示例：
```javascript
try {
Zabbix.log(4, 'jira webhook script value='+value);
var result = {
'tags': {
'endpoint': 'jira'
}
},
params = JSON.parse(value),
req = new HttpRequest(),
fields = {},
resp;
req.addHeader('Content-Type: application/json');
req.addHeader('Authorization: Basic '+params.authentication);
fields.summary = params.summary;
fields.description = params.description;
fields.project = {"key": params.project_key};
fields.issuetype = {"id": params.issue_id};
resp = req.post('https://jira.example.com/rest/api/2/issue/',
JSON.stringify({"fields": fields})
);
if (req.getStatus() != 201) {
throw 'Response code: '+req.getStatus();
}
resp = JSON.parse(resp);
result.tags.issue_id = resp.id;
result.tags.issue_key = resp.key;
} catch (error) {
Zabbix.log(4, 'jira issue creation failed json : '+JSON.stringify({"fields": fields}));
Zabbix.log(4, 'jira issue creation failed : '+error);
result = {};
}
return JSON.stringify(result);
```
#### HTTPS checks
Web scenarios and HTTP agent items using the https protocol, Zabbix
agent checks `net.tcp.service[https...]` and
`net.tcp.service.perf[https...]` may fail if the target server is
configured to disallow TLS v1.0 protocol or below. Please see
[ZBX-9879](https://support.zabbix.com/browse/ZBX-9879) for more
information and available workarounds.
#### HTTPS 检查
使用 https 协议的 Web 场景和 HTTP agent 监控项，如果目标服务器将 TLS v1.0 或更低版本协议配置为 disallow，Zabbix agent 监控项 net.tcp.service[https...] 和 net.tcp.service.perf[https...] 会失败。请参阅 [ZBX-9879](https://support.zabbix.com/browse/ZBX-9879) 了解更多信息和解决方案。
# HTTP template operation
Steps to ensure correct operation of templates that collect metrics with
[HTTP agent](/manual/config/items/itemtypes/http):
1\. Create a host in Zabbix and specify an IP address or DNS name of the
monitoring target as the main interface. This is needed for the
{HOST.CONN} macro to resolve properly in the template items.\
2. [Link](/manual/config/templates/linking#linking_a_template) the
template to the host created in step 1 (if the template is not available
in your Zabbix installation, you may need to import the template's .xml
file first - see [Templates
out-of-the-box](/manual/config/templates_out_of_the_box) section for
instructions).\
3. Adjust the values of mandatory macros as needed.\
4. Configure the instance being monitored to allow sharing data with
Zabbix - see instructions in the *Additional steps/comments* column.
::: notetip
This page contains only a minimum set of macros and
setup steps that are required for proper template operation. A detailed
description of a template, including the full list of macros, items and
triggers, is available in the template's Readme.md file (accessible by
clicking on a template name).
:::
|Template|Mandatory macros|Additional steps/comments|
|--------|----------------|-------------------------|
|[Apache by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/apache_http)|**{$APACHE.STATUS.HOST}** - the hostname or IP address of Apache status page (default: 127.0.0.1).<br>**{$APACHE.STATUS.PATH}** - the URL path (default: server-status?auto).<br>**{$APACHE.STATUS.PORT}** - the port of Apache status page (default: 80).<br>**{$APACHE.STATUS.SCHEME}** - the request scheme. Supported: http (default), https.|Apache module mod\_status should be set (see Apache [documentation](https://httpd.apache.org/docs/current/mod/mod_status.html) for details).<br>To check availability, run:<br>`httpd -M 2>/dev/null \| grep status_module`<br><br>Apache configuration example:<br>`<Location "/server-status">`<br>`SetHandler server-status`<br>`Require host example.com`<br>`</Location>`|
|[Asterisk by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/tel/asterisk_http)|**{$AMI.PORT}** - AMI port number for checking service availability (default: 8088).<br>**{$AMI.SECRET}** - the Asterisk Manager secret (default: zabbix).<br>**{$AMI.URL}** - the Asterisk Manager API URL in the format<br>`<scheme>://<host>:<port>/<prefix>/rawman`<br>(default: http://asterisk:8088/asterisk/rawman).<br>**{$AMI.USERNAME}** - the Asterisk Manager name.|1\. Enable the [mini-HTTP Server](https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server).<br><br>2. Add the option `webenabled=yes` to the general section of *manager.conf* file.<br><br>3. Create *Asterisk Manager* user in the Asterisk instance.|
|[ClickHouse by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/clickhouse_http/README.md)|**{$CLICKHOUSE.PORT}** - the port of ClickHouse HTTP endpoint (default: 8123).<br>**{$CLICKHOUSE.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$CLICKHOUSE.USER}**, **{$CLICKHOUSE.PASSWORD}** - ClickHouse login credentials (default username: zabbix, password: zabbix\_pass).<br>If you don't need authentication, remove headers from HTTP agent type items.|Create a ClickHouse user with a 'web' profile and permission to view databases (see ClickHouse [documentation](https://clickhouse.tech/docs/en/operations/settings/settings-users/) for details).<br><br>See template's *Readme.md* file for a ready-to-use zabbix.xml file configuration.|
|[Cloudflare by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/cloudflare_http/README.md)|**{$CLOUDFLARE.API.TOKEN}** - Cloudflare API token value (default: \`<change>\`).<br>**{$CLOUDFLARE.ZONE\_ID}** - Cloudflare Site Zone ID (default: \`<change>\`).|Cloudflare API Tokens are available in the Cloudflare account under *My Profile→ API Tokens*.<br>Zone ID is available in the Cloudflare account under *Account Home → Site*.|
|[DELL PowerEdge R720 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r720_http/README.md),<br>[DELL PowerEdge R740 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r740_http/README.md),<br>[DELL PowerEdge R820 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r820_http/README.md),<br>[DELL PowerEdge R840 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r840_http/README.md)|**{$API.URL}** - Dell iDRAC Redfish API URL in the format `<scheme>://<host>:<port>` (default: <Put your URL here>)<br>**{$API.USER}**, **{$API.PASSWORD}** - Dell iDRAC login credentials (default: not set).|In the Dell iDRAC interface of your server:<br>1. Enable Redfish API .<br>2. Create a user for monitoring with read-only permissions.|
|[Elasticsearch Cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/elasticsearch_http/README.md)|**{$ELASTICSEARCH.PORT}** - the port of the Elasticsearch host (default: 9200).<br>**{$ELASTICSEARCH.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$ELASTICSEARCH.USERNAME}**, **{$ELASTICSEARCH.PASSWORD}** - login credentials, required only if used for Elasticsearch authentication.|<|
|[Etcd by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/etcd_http/README.md)|**{$ETCD.PORT}**- the port used by Etcd API endpoint (default: 2379).<br>**{$ETCD.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$ETCD.USER}**, **{$ETCD.PASSWORD}** - login credentials, required only if used for Etcd authentication.|Metrics are collected from /metrics endpoint; to specify the endpoint's location use `--listen-metrics-urls` flag (see Etcd [documentation](https://github.com/etcd-io/website/blob/master/content/docs/v3.4.0/op-guide/configuration.md#--listen-metrics-urls) for details).<br><br>To verify, whether Etcd is configured to allow metric collection, run:<br>`curl -L http://localhost:2379/metrics`<br><br>To check, if Etcd is accessible from Zabbix proxy or Zabbix server run:<br>`curl -L http:%%//<etcd_node_adress>:2379/metrics%%`<br><br>The template should be added to each node with Etcd.|
|[GitLab by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/gitlab_http)|**{$GITLAB.PORT}** - the port of GitLab web endpoint (default: 80)<br>**{$GITLAB.URL}** - GitLab instance URL (default: localhost)|This template works with self-hosted GitLab instances; metrics are collected from the `/metrics` endpoint.<br><br>To access the metrics, the client IP address must be explicitly allowed (see [GitLab documentation](https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html) for details).<br><br>Note, that certain metrics may not be available for a particular GitLab instance version and configuration.|
|[Hadoop by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/hadoop_http/README.md)|**{$HADOOP.NAMENODE.HOST}** - the Hadoop NameNode host IP address or FQDN (default: NameNode).<br>**{$HADOOP.NAMENODE.PORT}** - the Hadoop NameNode web-UI port (default: 9870).<br>**{$HADOOP.RESOURCEMANAGER.HOST}** - the Hadoop ResourceManager host IP address or FQDN (default: ResourceManager).<br>**{$HADOOP.RESOURCEMANAGER.PORT}** - the Hadoop ResourceManager web-UI port (default: 8088).|Metrics are collected by polling the Hadoop API remotely using an HTTP agent and JSONPath preprocessing. Zabbix server (or proxy) executes direct requests to ResourceManager, NodeManagers, NameNode, DataNodes APIs.|
|[HAProxy by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/haproxy_http/README.md)|**{$HAPROXY.STATS.PATH}** - the path of HAProxy Stats page (default: stats).<br>**{$HAPROXY.STATS.PORT}** - the port of the HAProxy Stats host or container (default: 8404).<br>**{$HAPROXY.STATS.SCHEME}** - the request scheme. Supported: http (default), https.|HAProxy Stats page should be set up (see HAProxy [blog post](https://www.haproxy.com/blog/exploring-the-haproxy-stats-page/) for details or template's Readme.md for configuration example).|
|[HashiCorp Vault by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vault_http/README.md)|**{$VAULT.API.PORT}** - the port on which the Vault listens for API requests (default: 8200).<br>**{$VAULT.API.SCHEME}** - the API request scheme. Supported: http (default), https.<br>**{$VAULT.HOST}** - Vault host name (default: <PUT YOUR VAULT HOST>).<br>**{$VAULT.TOKEN}** - Vault authorization token (default: <PUT YOUR AUTH TOKEN>).|1\. Configure the Vault API (see [official documentation](https://www.vaultproject.io/docs/configuration) for details).<br>2. Create a Vault service token, then copy and paste it into {$VAULT.TOKEN} macro value in Zabbix.|
|[Hikvision camera by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cctv/hikvision/README.md)|**{$HIKVISION\_ISAPI\_PORT}** - ISAPI port on a device (default: 80).<br>**{$USER}**, **{$PASSWORD}** - camera login credentials (default username: admin, password: 1234).|<|
|[InfluxDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/influxdb_http/README.md)|**{$INFLUXDB.API.TOKEN}** - InfluxDB API authorization token (default: \`\`).<br>**{$INFLUXDB.URL}** - InfluxDB instance URL in the format `<scheme>://<host>:<port>` (default: http://localhost:8086).|This template collects internal service metrics from the InfluxDB /metrics endpoint of self-hosted InfluxDB instances.<br><br>See InfluxDB [documentation](https://docs.influxdata.com/influxdb/v2.0/security/tokens/) for details.|
|[Jenkins by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/jenkins/README.md)|**{$JENKINS.API.KEY}** - API key to access Metrics Servlet; required for common metrics (default: \`\`).<br>**{$JENKINS.API.TOKEN}** - API token for HTTP BASIC authentication; required for monitoring computers and builds (default: \`\`).<br>**{$JENKINS.URL}** - Jenkins URL in the format `<scheme>://<host>:<port>`; required for monitoring computers and builds (default: \`\`).<br>**{$JENKINS.USER}** - username for HTTP BASIC authentication; required for monitoring computers and builds (default: zabbix).|Metrics are collected by requests to Metrics API.<br><br>For common metrics: install and configure Metrics plugin parameters according to the [official documentation](https://plugins.jenkins.io/metrics/). Issue an API key for access to the Metrics Servlet, then use it as {$JENKINS.API.KEY} macro value.<br><br>For monitoring computers and builds: create an API token for the Jenkins user that will be used for monitoring, then use it as {$JENKINS.API.TOKEN} macro value. See Jenkins [documentation](https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/) for details.|
|[Microsoft SharePoint by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md)|**{$SHAREPOINT.URL}** - portal page URL, for example *http://sharepoint.companyname.local/* (default: \`\`).<br>**{$SHAREPOINT.ROOT}** - a root directory; only the specified directory and all its subfolders will be monitored (default: /Shared Documents)<br>**{$SHAREPOINT.USER}**, **{$SHAREPOINT.PASSWORD}** - SharePoint login credentials (default: not set).|The template contains additional macros, which can be used to filter out certain dictionaries and types during LLD process (see template's [Readme.md](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md) for the description of available filter macros).|
|[NetApp AFF A700 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/netapp_aff_a700_http/README.md)|**{$URL}** - AFF700 cluster URL address (default: ' ' )<br>**{$USERNAME}**, **{PASSWORD}** - AFF700 login credentials (default: not set).|Create a host for AFF A700 with cluster management IP as the Zabbix agent interface.|
|[NGINX by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nginx_http/README.md)|**{$NGINX.STUB\_STATUS.HOST}** - the hostname or IP address of NGINX stub\_status host or container (default: localhost).<br>**{$NGINX.STUB\_STATUS.PATH}** - the path of NGINX stub\_status page (default: basic\_status).<br>**{$NGINX.STUB\_STATUS.PORT}** - the port of NGINX stub\_status host or container (default: 80).<br>**{$NGINX.STUB\_STATUS.SCHEME}** - the request scheme. Supported: http (default), https.|`'ngx_http_stub_status_module` should be set up (see NGINX [documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html) for details or template's Readme.md for configuration example).<br>To check availability, run:<br>`nginx -V 2>&1 \| grep -o with-http_stub_status_module`|
|[NGINX Plus by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nginx_plus_http/README.md)|**{$NGINX.API.ENDPOINT}** - NGINX Plus API URL in the format `<scheme>://<host>:<port>/<location>/` (default: ' ').|1\. Enable NGINX Plus API (see NGINX [documentation](https://www.nginx.com/products/nginx/live-activity-monitoring/) for details).<br>2. Set the macro {$NGINX.API.ENDPOINT}<br>3. If required, use other template macros to filter out discovery operations and discover only required zones and upstreams.|
|[PHP-FPM by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/php-fpm_agent/README.md)|**{$PHP\_FPM.HOST}** - a hostname or an IP of PHP-FPM status host or container (default: localhost).<br>**{$PHP\_FPM.PING.PAGE}** - PHP-FPM ping page path (default:ping).<br>**{$PHP\_FPM.PORT}** - the port of PHP-FPM status host or container (default: 80).<br>**{$PHP\_FPM.PROCESS\_NAME}** - PHP-FPM process name (default: php-fpm).<br>**{$PHP\_FPM.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$PHP\_FPM.STATUS.PAGE}** - PHP-FPM status page path (default:`status`).|1\. Open the php-fpm configuration file and enable the status page:<br>`pm.status_path = /status`<br>`ping.path = /ping`<br><br>2. Validate the syntax: `$ php-fpm7 -t`<br><br>3. Reload the php-fpm service.<br><br>4. In the Nginx Server Block (virtual host) configuration file, add (see template's *Readme.md* for an expanded example with comments):<br>`location ~ ^/(status\|ping)$ {`<br>`access_log off;`<br>`fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;`<br>`fastcgi_index index.php;`<br>`include fastcgi_params;`<br>`fastcgi_pass 127.0.0.1:9000;`<br>`}`<br><br>5. Check the syntax: `$ nginx -t`<br><br>6. Reload Nginx<br><br>7. Verify: `curl -L 127.0.0.1/status`|
|[RabbitMQ cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/rabbitmq_http/README.md)|**{$RABBITMQ.API.CLUSTER\_HOST}** - the hostname or IP address of RabbitMQ cluster API endpoint (default: 127.0.0.1).<br>**{$RABBITMQ.API.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$RABBITMQ.API.USER}**, **{$RABBITMQ.API.PASSWORD}** - RabbitMQ login credentials (default username: zbx\_monitor, password: zabbix).|Enable RabbitMQ management plugin (see [RabbitMQ documentation](https://www.rabbitmq.com/management.html)).<br><br>To create a RabbitMQ user with necessary permissions for monitoring, run:<br>'' rabbitmqctl add\_user zbx\_monitor <PASSWORD> ''<br>`rabbitmqctl set_permissions -p / zbx_monitor %% "" "" ".*"%%`<br>`rabbitmqctl set_user_tags zbx_monitor monitoring`<br><br>If the cluster consists of several nodes, it is recommended to assign the cluster template to a separate balancing host. In case of a single-node installation, the cluster template can be assigned to the host with a node template.|
|[TiDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_tidb_http/README.md)|**{$TIDB.PORT}** - The port of TiDB server metrics web endpoint (default: 10080)<br>**{$TIDB.URL}** - TiDB server URL (default: localhost).|This template works with TiDB server of PingCAP TiDB cluster.<br>Internal service metrics are collected from TiDB /metrics endpoint and TiDB monitoring API.|
|[TiDB PD by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_pd_http/README.md)|**{$TIDB.PORT}** - The port of TiDB server metrics web endpoint (default: 2379)<br>**{$TIDB.URL}** - TiDB server URL (default: localhost).|This template works with PD server of PingCAP TiDB cluster.<br>Internal service metrics are collected from PD /metrics endpoint and TiDB monitoring API.|
|[TiDB TiKV by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_tikv_http/README.md)|**{$TIDB.PORT}** - The port of TiDB server metrics web endpoint (default: 20180)<br>**{$TIDB.URL}** - TiDB server URL (default: localhost).|This template works with TiKV server of PingCAP TiDB cluster.<br>Internal service metrics are collected from TiKV /metrics endpoint.|
|[Travis CI by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/travis_http/README.md)|**{$TRAVIS.API.TOKEN}** - Travis API Token (default: not set)<br>**{$TRAVIS.API.URL}** - Travis API URL (default: api.travis-ci.com).|Travis API authentication token can be found in the *User → Settings → API authentication* section.<br>{$TRAVIS.API.URL} format for a private project is *api.travis-ci.com*.<br>{$TRAVIS.API.URL} format for an enterprise project is *api.example.com* (replace example.com with the domain Travis CI is running on).|
|[VMWare SD-WAN VeloCloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/velocloud_http/README.md)|**{$VELOCLOUD.TOKEN}** - VMware SD-WAN Orchestrator API Token (default: \`\`).<br>**{$VELOCLOUD.URL}** - VMware SD-WAN Orchestrator URL, for example, *velocloud.net* (default: \`\`).|API token should be created in the VMware SD-WAN Orchestrator (see [VMware documentation](https://docs.vmware.com/en/VMware-SD-WAN/4.0/vmware-sd-wan-operator-guide/GUID-C150D536-A75F-47C1-8AFF-17C417F40C1D.html) for details).|
|[ZooKeeper by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zookeeper_http/README.md)|**{$ZOOKEEPER.COMMAND\_URL}** - admin.commandURL; the URL for listing and issuing commands relative to the root URL (default: commands).<br>**{ZOOKEEPER.PORT}** - admin.serverPort; the port the embedded Jetty server listens on (default: 8080).<br>**{$ZOOKEEPER.SCHEME}** - the request scheme. Supported: http (default), https.|Metrics are collected from each ZooKeeper node by requests to AdminServer (enabled by default). See [ZooKeeper documentation](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_adminserver_config) to enable or configure AdminServer.|
# HTTP template operation
Steps to ensure correct operation of templates that collect metrics with
[HTTP agent](/manual/config/items/itemtypes/http):
1\. Create a host in Zabbix and specify an IP address or DNS name of the
monitoring target as the main interface. This is needed for the
{HOST.CONN} macro to resolve properly in the template items.\
2. [Link](/manual/config/templates/linking#linking_a_template) the
template to the host created in step 1 (if the template is not available
in your Zabbix installation, you may need to import the template's .xml
file first - see [Templates
out-of-the-box](/manual/config/templates_out_of_the_box) section for
instructions).\
3. Adjust the values of mandatory macros as needed.\
4. Configure the instance being monitored to allow sharing data with
Zabbix - see instructions in the *Additional steps/comments* column.
::: notetip
This page contains only a minimum set of macros and
setup steps that are required for proper template operation. A detailed
description of a template, including the full list of macros, items and
triggers, is available in the template's Readme.md file (accessible by
clicking on a template name).
:::
|Template|Mandatory macros|Additional steps/comments|
|--------|----------------|-------------------------|
|[Apache by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/apache_http)|**{$APACHE.STATUS.HOST}** - the hostname or IP address of Apache status page (default: 127.0.0.1).<br>**{$APACHE.STATUS.PATH}** - the URL path (default: server-status?auto).<br>**{$APACHE.STATUS.PORT}** - the port of Apache status page (default: 80).<br>**{$APACHE.STATUS.SCHEME}** - the request scheme. Supported: http (default), https.|Apache module mod\_status should be set (see Apache [documentation](https://httpd.apache.org/docs/current/mod/mod_status.html) for details).<br>To check availability, run:<br>`httpd -M 2>/dev/null \| grep status_module`<br><br>Apache configuration example:<br>`<Location "/server-status">`<br>`SetHandler server-status`<br>`Require host example.com`<br>`</Location>`|
|[Asterisk by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/tel/asterisk_http)|**{$AMI.PORT}** - AMI port number for checking service availability (default: 8088).<br>**{$AMI.SECRET}** - the Asterisk Manager secret (default: zabbix).<br>**{$AMI.URL}** - the Asterisk Manager API URL in the format<br>`<scheme>://<host>:<port>/<prefix>/rawman`<br>(default: http://asterisk:8088/asterisk/rawman).<br>**{$AMI.USERNAME}** - the Asterisk Manager name.|1\. Enable the [mini-HTTP Server](https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server).<br><br>2. Add the option `webenabled=yes` to the general section of *manager.conf* file.<br><br>3. Create *Asterisk Manager* user in the Asterisk instance.|
|[ClickHouse by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/clickhouse_http/README.md)|**{$CLICKHOUSE.PORT}** - the port of ClickHouse HTTP endpoint (default: 8123).<br>**{$CLICKHOUSE.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$CLICKHOUSE.USER}**, **{$CLICKHOUSE.PASSWORD}** - ClickHouse login credentials (default username: zabbix, password: zabbix\_pass).<br>If you don't need authentication, remove headers from HTTP agent type items.|Create a ClickHouse user with a 'web' profile and permission to view databases (see ClickHouse [documentation](https://clickhouse.tech/docs/en/operations/settings/settings-users/) for details).<br><br>See template's *Readme.md* file for a ready-to-use zabbix.xml file configuration.|
|[Cloudflare by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/cloudflare_http/README.md)|**{$CLOUDFLARE.API.TOKEN}** - Cloudflare API token value (default: \`<change>\`).<br>**{$CLOUDFLARE.ZONE\_ID}** - Cloudflare Site Zone ID (default: \`<change>\`).|Cloudflare API Tokens are available in the Cloudflare account under *My Profile→ API Tokens*.<br>Zone ID is available in the Cloudflare account under *Account Home → Site*.|
|[DELL PowerEdge R720 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r720_http/README.md),<br>[DELL PowerEdge R740 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r740_http/README.md),<br>[DELL PowerEdge R820 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r820_http/README.md),<br>[DELL PowerEdge R840 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r840_http/README.md)|**{$API.URL}** - Dell iDRAC Redfish API URL in the format `<scheme>://<host>:<port>` (default: <Put your URL here>)<br>**{$API.USER}**, **{$API.PASSWORD}** - Dell iDRAC login credentials (default: not set).|In the Dell iDRAC interface of your server:<br>1. Enable Redfish API .<br>2. Create a user for monitoring with read-only permissions.|
|[Elasticsearch Cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/elasticsearch_http/README.md)|**{$ELASTICSEARCH.PORT}** - the port of the Elasticsearch host (default: 9200).<br>**{$ELASTICSEARCH.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$ELASTICSEARCH.USERNAME}**, **{$ELASTICSEARCH.PASSWORD}** - login credentials, required only if used for Elasticsearch authentication.|<|
|[Etcd by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/etcd_http/README.md)|**{$ETCD.PORT}**- the port used by Etcd API endpoint (default: 2379).<br>**{$ETCD.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$ETCD.USER}**, **{$ETCD.PASSWORD}** - login credentials, required only if used for Etcd authentication.|Metrics are collected from /metrics endpoint; to specify the endpoint's location use `--listen-metrics-urls` flag (see Etcd [documentation](https://github.com/etcd-io/website/blob/master/content/docs/v3.4.0/op-guide/configuration.md#--listen-metrics-urls) for details).<br><br>To verify, whether Etcd is configured to allow metric collection, run:<br>`curl -L http://localhost:2379/metrics`<br><br>To check, if Etcd is accessible from Zabbix proxy or Zabbix server run:<br>`curl -L http:%%//<etcd_node_adress>:2379/metrics%%`<br><br>The template should be added to each node with Etcd.|
|[GitLab by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/gitlab_http)|**{$GITLAB.PORT}** - the port of GitLab web endpoint (default: 80)<br>**{$GITLAB.URL}** - GitLab instance URL (default: localhost)|This template works with self-hosted GitLab instances; metrics are collected from the `/metrics` endpoint.<br><br>To access the metrics, the client IP address must be explicitly allowed (see [GitLab documentation](https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html) for details).<br><br>Note, that certain metrics may not be available for a particular GitLab instance version and configuration.|
|[Hadoop by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/hadoop_http/README.md)|**{$HADOOP.NAMENODE.HOST}** - the Hadoop NameNode host IP address or FQDN (default: NameNode).<br>**{$HADOOP.NAMENODE.PORT}** - the Hadoop NameNode web-UI port (default: 9870).<br>**{$HADOOP.RESOURCEMANAGER.HOST}** - the Hadoop ResourceManager host IP address or FQDN (default: ResourceManager).<br>**{$HADOOP.RESOURCEMANAGER.PORT}** - the Hadoop ResourceManager web-UI port (default: 8088).|Metrics are collected by polling the Hadoop API remotely using an HTTP agent and JSONPath preprocessing. Zabbix server (or proxy) executes direct requests to ResourceManager, NodeManagers, NameNode, DataNodes APIs.|
|[HAProxy by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/haproxy_http/README.md)|**{$HAPROXY.STATS.PATH}** - the path of HAProxy Stats page (default: stats).<br>**{$HAPROXY.STATS.PORT}** - the port of the HAProxy Stats host or container (default: 8404).<br>**{$HAPROXY.STATS.SCHEME}** - the request scheme. Supported: http (default), https.|HAProxy Stats page should be set up (see HAProxy [blog post](https://www.haproxy.com/blog/exploring-the-haproxy-stats-page/) for details or template's Readme.md for configuration example).|
|[HashiCorp Vault by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vault_http/README.md)|**{$VAULT.API.PORT}** - the port on which the Vault listens for API requests (default: 8200).<br>**{$VAULT.API.SCHEME}** - the API request scheme. Supported: http (default), https.<br>**{$VAULT.HOST}** - Vault host name (default: <PUT YOUR VAULT HOST>).<br>**{$VAULT.TOKEN}** - Vault authorization token (default: <PUT YOUR AUTH TOKEN>).|1\. Configure the Vault API (see [official documentation](https://www.vaultproject.io/docs/configuration) for details).<br>2. Create a Vault service token, then copy and paste it into {$VAULT.TOKEN} macro value in Zabbix.|
|[Hikvision camera by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cctv/hikvision/README.md)|**{$HIKVISION\_ISAPI\_PORT}** - ISAPI port on a device (default: 80).<br>**{$USER}**, **{$PASSWORD}** - camera login credentials (default username: admin, password: 1234).|<|
|[InfluxDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/influxdb_http/README.md)|**{$INFLUXDB.API.TOKEN}** - InfluxDB API authorization token (default: \`\`).<br>**{$INFLUXDB.URL}** - InfluxDB instance URL in the format `<scheme>://<host>:<port>` (default: http://localhost:8086).|This template collects internal service metrics from the InfluxDB /metrics endpoint of self-hosted InfluxDB instances.<br><br>See InfluxDB [documentation](https://docs.influxdata.com/influxdb/v2.0/security/tokens/) for details.|
|[Jenkins by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/jenkins/README.md)|**{$JENKINS.API.KEY}** - API key to access Metrics Servlet; required for common metrics (default: \`\`).<br>**{$JENKINS.API.TOKEN}** - API token for HTTP BASIC authentication; required for monitoring computers and builds (default: \`\`).<br>**{$JENKINS.URL}** - Jenkins URL in the format `<scheme>://<host>:<port>`; required for monitoring computers and builds (default: \`\`).<br>**{$JENKINS.USER}** - username for HTTP BASIC authentication; required for monitoring computers and builds (default: zabbix).|Metrics are collected by requests to Metrics API.<br><br>For common metrics: install and configure Metrics plugin parameters according to the [official documentation](https://plugins.jenkins.io/metrics/). Issue an API key for access to the Metrics Servlet, then use it as {$JENKINS.API.KEY} macro value.<br><br>For monitoring computers and builds: create an API token for the Jenkins user that will be used for monitoring, then use it as {$JENKINS.API.TOKEN} macro value. See Jenkins [documentation](https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/) for details.|
|[Microsoft SharePoint by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md)|**{$SHAREPOINT.URL}** - portal page URL, for example *http://sharepoint.companyname.local/* (default: \`\`).<br>**{$SHAREPOINT.ROOT}** - a root directory; only the specified directory and all its subfolders will be monitored (default: /Shared Documents)<br>**{$SHAREPOINT.USER}**, **{$SHAREPOINT.PASSWORD}** - SharePoint login credentials (default: not set).|The template contains additional macros, which can be used to filter out certain dictionaries and types during LLD process (see template's [Readme.md](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md) for the description of available filter macros).|
|[NetApp AFF A700 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/netapp_aff_a700_http/README.md)|**{$URL}** - AFF700 cluster URL address (default: ' ' )<br>**{$USERNAME}**, **{PASSWORD}** - AFF700 login credentials (default: not set).|Create a host for AFF A700 with cluster management IP as the Zabbix agent interface.|
|[NGINX by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nginx_http/README.md)|**{$NGINX.STUB\_STATUS.HOST}** - the hostname or IP address of NGINX stub\_status host or container (default: localhost).<br>**{$NGINX.STUB\_STATUS.PATH}** - the path of NGINX stub\_status page (default: basic\_status).<br>**{$NGINX.STUB\_STATUS.PORT}** - the port of NGINX stub\_status host or container (default: 80).<br>**{$NGINX.STUB\_STATUS.SCHEME}** - the request scheme. Supported: http (default), https.|`'ngx_http_stub_status_module` should be set up (see NGINX [documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html) for details or template's Readme.md for configuration example).<br>To check availability, run:<br>`nginx -V 2>&1 \| grep -o with-http_stub_status_module`|
|[NGINX Plus by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nginx_plus_http/README.md)|**{$NGINX.API.ENDPOINT}** - NGINX Plus API URL in the format `<scheme>://<host>:<port>/<location>/` (default: ' ').|1\. Enable NGINX Plus API (see NGINX [documentation](https://www.nginx.com/products/nginx/live-activity-monitoring/) for details).<br>2. Set the macro {$NGINX.API.ENDPOINT}<br>3. If required, use other template macros to filter out discovery operations and discover only required zones and upstreams.|
|[PHP-FPM by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/php-fpm_agent/README.md)|**{$PHP\_FPM.HOST}** - a hostname or an IP of PHP-FPM status host or container (default: localhost).<br>**{$PHP\_FPM.PING.PAGE}** - PHP-FPM ping page path (default:ping).<br>**{$PHP\_FPM.PORT}** - the port of PHP-FPM status host or container (default: 80).<br>**{$PHP\_FPM.PROCESS\_NAME}** - PHP-FPM process name (default: php-fpm).<br>**{$PHP\_FPM.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$PHP\_FPM.STATUS.PAGE}** - PHP-FPM status page path (default:`status`).|1\. Open the php-fpm configuration file and enable the status page:<br>`pm.status_path = /status`<br>`ping.path = /ping`<br><br>2. Validate the syntax: `$ php-fpm7 -t`<br><br>3. Reload the php-fpm service.<br><br>4. In the Nginx Server Block (virtual host) configuration file, add (see template's *Readme.md* for an expanded example with comments):<br>`location ~ ^/(status\|ping)$ {`<br>`access_log off;`<br>`fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;`<br>`fastcgi_index index.php;`<br>`include fastcgi_params;`<br>`fastcgi_pass 127.0.0.1:9000;`<br>`}`<br><br>5. Check the syntax: `$ nginx -t`<br><br>6. Reload Nginx<br><br>7. Verify: `curl -L 127.0.0.1/status`|
|[RabbitMQ cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/rabbitmq_http/README.md)|**{$RABBITMQ.API.CLUSTER\_HOST}** - the hostname or IP address of RabbitMQ cluster API endpoint (default: 127.0.0.1).<br>**{$RABBITMQ.API.SCHEME}** - the request scheme. Supported: http (default), https.<br>**{$RABBITMQ.API.USER}**, **{$RABBITMQ.API.PASSWORD}** - RabbitMQ login credentials (default username: zbx\_monitor, password: zabbix).|Enable RabbitMQ management plugin (see [RabbitMQ documentation](https://www.rabbitmq.com/management.html)).<br><br>To create a RabbitMQ user with necessary permissions for monitoring, run:<br>'' rabbitmqctl add\_user zbx\_monitor <PASSWORD> ''<br>`rabbitmqctl set_permissions -p / zbx_monitor %% "" "" ".*"%%`<br>`rabbitmqctl set_user_tags zbx_monitor monitoring`<br><br>If the cluster consists of several nodes, it is recommended to assign the cluster template to a separate balancing host. In case of a single-node installation, the cluster template can be assigned to the host with a node template.|
|[TiDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_tidb_http/README.md)|**{$TIDB.PORT}** - The port of TiDB server metrics web endpoint (default: 10080)<br>**{$TIDB.URL}** - TiDB server URL (default: localhost).|This template works with TiDB server of PingCAP TiDB cluster.<br>Internal service metrics are collected from TiDB /metrics endpoint and TiDB monitoring API.|
|[TiDB PD by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_pd_http/README.md)|**{$TIDB.PORT}** - The port of TiDB server metrics web endpoint (default: 2379)<br>**{$TIDB.URL}** - TiDB server URL (default: localhost).|This template works with PD server of PingCAP TiDB cluster.<br>Internal service metrics are collected from PD /metrics endpoint and TiDB monitoring API.|
|[TiDB TiKV by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_tikv_http/README.md)|**{$TIDB.PORT}** - The port of TiDB server metrics web endpoint (default: 20180)<br>**{$TIDB.URL}** - TiDB server URL (default: localhost).|This template works with TiKV server of PingCAP TiDB cluster.<br>Internal service metrics are collected from TiKV /metrics endpoint.|
|[Travis CI by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/travis_http/README.md)|**{$TRAVIS.API.TOKEN}** - Travis API Token (default: not set)<br>**{$TRAVIS.API.URL}** - Travis API URL (default: api.travis-ci.com).|Travis API authentication token can be found in the *User → Settings → API authentication* section.<br>{$TRAVIS.API.URL} format for a private project is *api.travis-ci.com*.<br>{$TRAVIS.API.URL} format for an enterprise project is *api.example.com* (replace example.com with the domain Travis CI is running on).|
|[VMWare SD-WAN VeloCloud by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/net/velocloud_http/README.md)|**{$VELOCLOUD.TOKEN}** - VMware SD-WAN Orchestrator API Token (default: \`\`).<br>**{$VELOCLOUD.URL}** - VMware SD-WAN Orchestrator URL, for example, *velocloud.net* (default: \`\`).|API token should be created in the VMware SD-WAN Orchestrator (see [VMware documentation](https://docs.vmware.com/en/VMware-SD-WAN/4.0/vmware-sd-wan-operator-guide/GUID-C150D536-A75F-47C1-8AFF-17C417F40C1D.html) for details).|
|[ZooKeeper by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zookeeper_http/README.md)|**{$ZOOKEEPER.COMMAND\_URL}** - admin.commandURL; the URL for listing and issuing commands relative to the root URL (default: commands).<br>**{ZOOKEEPER.PORT}** - admin.serverPort; the port the embedded Jetty server listens on (default: 8080).<br>**{$ZOOKEEPER.SCHEME}** - the request scheme. Supported: http (default), https.|Metrics are collected from each ZooKeeper node by requests to AdminServer (enabled by default). See [ZooKeeper documentation](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_adminserver_config) to enable or configure AdminServer.|
# httptest.create
# httptest.create
# httptest.delete
# httptest.delete
# httptest.get
# httptest.get
# httptest.update
# httptest.update
#### Hysteresis
Sometimes an interval is needed between problem and recovery states,
rather than a simple threshold. For example, if we want to define a
trigger that reports a problem when server room temperature goes above
20°C and we want it to stay in the problem state until the temperature
drops below 15°C, a simple trigger threshold at 20°C will not be enough.
Instead, we need to define a trigger expression for the problem event
first (temperature above 20°C). Then we need to define an additional
recovery condition (temperature below 15°C). This is done by defining an
additional *Recovery expression* parameter when
[defining](/manual/config/triggers/trigger) a trigger.
In this case, problem recovery will take place in two steps:
- First, the problem expression (temperature above 20°C) will have to
evaluate to FALSE
- Second, the recovery expression (temperature below 15°C) will have
to evaluate to TRUE
The recovery expression will be evaluated only when the problem event is
resolved first.
::: notewarning
The recovery expression being TRUE alone does not
resolve a problem if the problem expression is still TRUE!
:::
#### 迟滞
有时问题状态与恢复状态之间需要间隔，而非简单阈值。例如，若需定义一个触发器在机房温度超过20°C时报告问题，并希望问题状态持续到温度降至15°C以下，仅设置20°C的简单触发阈值是不够的。
此时需要先定义问题事件的触发表达式（温度高于20°C），然后定义额外的恢复条件（温度低于15°C）。这可通过在[defining](/manual/config/triggers/trigger)触发器时设置*恢复表达式*参数实现。
此场景下问题恢复将分两步进行：
- 首先，问题表达式（温度高于20°C）必须评估为FALSE
- 其次，恢复表达式（温度低于15°C）必须
to evaluate to TRUE
恢复表达式仅在问题事件首次解决后才会被评估。
::: notewarning
若问题表达式仍为TRUE，仅恢复表达式为TRUE并不会解决问题！
:::
##### Icon highlighting
If a map element is in problem status, it is highlighted with a round
circle. The fill color of the circle corresponds to the severity color
of the problem. Only problems on or above the selected severity level
will be displayed with the element. If all problems are acknowledged, a
thick green border around the circle is displayed.
Additionally:
- a host in [maintenance](/manual/maintenance) is highlighted with an
orange, filled square. Note that maintenance highlighting has
priority over the problem severity highlighting (since Zabbix 6.0.5,
only if the map element is host).
- a disabled (not-monitored) host is highlighted with a gray, filled
square.
Highlighting is displayed if the *Icon highlighting* check-box is marked
in map
[configuration](/manual/config/visualization/maps/map#creating_a_map).
##### 图标高亮
如果地图元素处于问题状态，它会被一个圆形圆圈高亮显示。圆圈填充颜色对应问题的严重性颜色。只有达到或超过所选严重性级别的问题才会与该元素一起显示。如果所有问题都已确认，圆圈周围会显示一个粗绿色边框。
此外：
- 一个主机在[maintenance](/manual/maintenance)中会以橙色实心方块高亮显示。请注意维护高亮优先于问题严重性高亮（自Zabbix 6.0.5起，仅当地图元素是主机时适用）。
- 被禁用（未监控）的主机会以灰色实心显示
square.
当在[创建地图](/manual/config/visualization/maps/map#创建地图)中勾选了*图标高亮*复选框时，才会显示高亮效果。
# iconmap.create
# iconmap.create
# iconmap.delete
# iconmap.delete
# iconmap.get
# iconmap.get
### Icon mapping
The icon mapping object defines a specific icon to be used for hosts
with a certain inventory field value. It has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|iconmappingid|string|*(readonly)* ID of the icon map.|
|**iconid**<br>(required)|string|ID of the icon used by the icon mapping.|
|**expression**<br>(required)|string|Expression to match the inventory field against.|
|**inventory\_link**<br>(required)|integer|ID of the host inventory field.<br><br>Refer to the [host inventory object](/manual/api/reference/host/object#host_inventory) for a list of supported inventory fields.|
|iconmapid|string|*(readonly)* ID of the icon map that the icon mapping belongs to.|
|sortorder|integer|*(readonly)* Position of the icon mapping in the icon map.|
### 图标映射
图标映射 object 定义了用于具有特定资产字段值的 主机 的特定图标。它具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| iconmappingid | string | *(只读)* 图标映射的ID。 |
| **iconid**<br>(required) | string | 图标映射使用的图标的ID。 |
| **expression**<br>(required) | string | 用于匹配资产字段的表达式。 |
| **inventory\_link**<br>(required) | integer | 主机 资产字段的ID。<br><br>有关支持的资产字段列表，请参阅 [主机资产清单](/manual/api/reference/host/object#主机资产清单)。 |
| iconmapid | string | *(只读)* 图标映射所属的图标映射集的ID。 |
| sortorder | integer | *(只读)* 图标映射在图标映射集中的位置。 |
### Icon map
The icon map object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|iconmapid|string|*(readonly)* ID of the icon map.|
|**default\_iconid**<br>(required)|string|ID of the default icon.|
|**name**<br>(required)|string|Name of the icon map.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 图标映射
图标映射object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| iconmapid | string | *(只读)* 图标映射的ID。 |
| **default\_iconid**<br>(required) | string | 默认图标的ID。 |
| **name**<br>(required) | string | 图标映射的名称。 |
请注意，对于某些方法(update, delete)，所需/可选参数的组合是不同的。
# iconmap.update
# iconmap.update
If access rights to persistent storage files are removed during agent operation
or other errors occur (e.g. disk full) then errors are logged into the agent log
file but the log item does not become NOTSUPPORTED.
如果在agent操作期间移除了持久存储文件的访问权限
或发生其他错误（例如磁盘已满），则错误会被记录到agent日志
file中，但日志监控项不会变为NOTSUPPORTED状态。
##### If installed as package
Zabbix agent runs as a daemon process. The agent can be started by
executing:
systemctl start zabbix-agent
This will work on most of GNU/Linux systems. On other systems you may
need to run:
/etc/init.d/zabbix-agent start
Similarly, for stopping/restarting/viewing status of Zabbix agent, use
the following commands:
systemctl stop zabbix-agent
systemctl restart zabbix-agent
systemctl status zabbix-agent
##### 若以软件包安装
Zabbix agent 以守护进程方式运行。可通过执行以下命令启动 agent：
systemctl start zabbix-agent
该命令适用于大多数GNU/Linux系统。在其他系统上可能需要使用 run：
/etc/init.d/zabbix-agent start
同理，停止/重启/查看 Zabbix agent 状态时，使用以下命令：
systemctl stop zabbix-agent
systemctl restart zabbix-agent
systemctl status zabbix-agent
##### If installed as package
Zabbix proxy runs as a daemon process. The proxy can be started by
executing:
systemctl start zabbix-proxy
This will work on most of GNU/Linux systems. On other systems you may
need to run:
/etc/init.d/zabbix-proxy start
Similarly, for stopping/restarting/viewing status of Zabbix proxy, use
the following commands:
systemctl stop zabbix-proxy
systemctl restart zabbix-proxy
systemctl status zabbix-proxy
##### 若以软件包安装
Zabbix proxy 以守护进程方式运行。可通过执行以下命令启动proxy:
systemctl start zabbix-proxy
该命令在大多数GNU/Linux系统上有效。在其他系统上可能需要run:
/etc/init.d/zabbix-proxy start
同样地，要停止/重启/查看Zabbix proxy状态，可使用以下命令:
systemctl stop zabbix-proxy
systemctl restart zabbix-proxy
systemctl status zabbix-proxy
##### If installed as package
Zabbix server runs as a daemon process. The server can be started by
executing:
systemctl start zabbix-server
This will work on most of GNU/Linux systems. On other systems you may
need to run:
/etc/init.d/zabbix-server start
Similarly, for stopping/restarting/viewing status, use the following
commands:
systemctl stop zabbix-server
systemctl restart zabbix-server
systemctl status zabbix-server
##### 若以软件包安装
Zabbix server 以守护进程方式运行。可通过执行以下命令启动服务器：
systemctl start zabbix-server
该命令适用于大多数GNU/Linux系统。在其他系统上可能需要使用run：
/etc/init.d/zabbix-server start
同理，停止/重启/查看状态可使用以下命令：
systemctl stop zabbix-server
systemctl restart zabbix-server
systemctl status zabbix-server
##### If the webhook test fails
- *"Media type test failed."* message is displayed, followed by
additional failure details.
##### 如果 webhook 测试失败
- 显示*"媒体类型测试失败。"*消息，随后附上额外的失败详情。
##### If the webhook test is successful
- *"Media type test successful."* message is displayed
- Server response appears in the gray *Response* field
- Response type (JSON or String) is specified below the *Response*
field
##### 如果 webhook 测试成功
- 显示*"媒体类型测试成功。"*消息
- 服务器响应出现在灰色的*响应*字段中
- 响应类型（JSON或string）在*响应*字段下方指定
# image.create
# image.create
# image.delete
# image.delete
# image.get
# image.get
### Image
The image object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|imageid|string|*(readonly)* ID of the image.|
|**name**<br>(required)|string|Name of the image.|
|imagetype|integer|Type of image.<br><br>Possible values:<br>1 - *(default)* icon;<br>2 - background image.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 图像
该object图像具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| imageid | string | *(只读)* 图像的ID。 |
| **name**<br>(required) | string | 图像的名称。 |
| imagetype | integer | 图像类型。<br><br>可能的值:<br>1 - *(默认)* 图标;<br>2 - 背景图像。 |
请注意，对于某些方法(update, delete)，必需/可选参数的组合是不同的。
# image.update
# image.update
### Implementation details
The high availability (HA) cluster is an opt-in solution and it is
supported for Zabbix server. The native HA solution is designed to be
simple in use, it will work across sites and does not have specific
requirements for the databases that Zabbix recognizes. Users are free to
use the native Zabbix HA solution, or a third-party HA solution,
depending on what best suits the high availability requirements in their
environment.
The solution consists of multiple zabbix\_server instances or nodes.
Every node:
- is configured separately
- uses the same database
- may have several modes: active, standby, unavailable, stopped
Only one node can be active (working) at a time. A standby node runs only one
process - the HA manager. A standby node does no data collection,
processing or other regular server activities; they do not listen
on ports; they have minimum database connections.
Both active and standby nodes update their last access time every 5
seconds. Each standby node monitors the last access time of the active
node. If the last access time of the active node is over 'failover
delay' seconds, the standby node switches itself to be the active node
and assigns 'unavailable' status to the previously active node.
The active node monitors its own database connectivity - if it is lost
for more than `failover delay-5` seconds, it must stop all processing
and switch to standby mode. The active node also monitors the status of
the standby nodes - if the last access time of a standby node is over
'failover delay' seconds, the standby node is assigned the 'unavailable'
status.
The nodes are designed to be compatible across minor Zabbix versions.
### 实现细节
高可用性(HA)集群是一项可选解决方案，支持Zabbix server使用。原生HA解决方案设计简洁易用，可跨站点运行，且对Zabbix支持的数据库无特殊要求。用户可根据环境中的高可用性需求，自由选择使用原生Zabbix HA解决方案或第三方HA方案。
该解决方案由多个zabbix\_server实例(节点)组成。每个节点具有以下特性:
- 需单独配置
- 使用同一数据库
- 可能处于多种模式：活跃(active)、备用(standby)、不可用(unavailable)、停止(stopped)
同一时间仅允许一个节点处于活跃(工作)状态。备用节点仅运行HA管理器进程，不执行数据采集、处理等常规服务器活动，不监听端口，且保持最小数据库连接数。
活跃节点与备用节点均需每5秒update其最后访问时间。各备用节点会监控活跃节点的最后访问时间，若超过'故障转移延迟(failover delay)'秒数，备用节点将自行切换为活跃节点，并将原活跃节点标记为'不可用的'状态。
活跃节点会持续监控自身数据库连接状态——若连接中断超过`failover delay-5`秒，必须停止所有处理并切换至备用模式。活跃节点同时监控备用节点状态，若某备用节点的最后访问时间超过'故障转移延迟'秒数，则将该节点标记为'不可用的'状态。
节点设计支持跨Zabbix次要版本兼容。
#### Important notes
- Database monitoring items will become unsupported if no *odbc poller* processes are started in the server or proxy configuration. To activate ODBC pollers, set *StartODBCPollers* parameter in Zabbix [server](/manual/appendix/config/zabbix_server) configuration file or, for checks performed by proxy, in Zabbix [proxy](/manual/appendix/config/zabbix_proxy) configuration file.
- Zabbix does not limit the query execution time. It is up to the user
to choose queries that can be executed in a reasonable amount of
time.
- The [Timeout](/manual/appendix/config/zabbix_server) parameter value
from Zabbix server is used as the ODBC login timeout (note that
depending on ODBC drivers the login timeout setting might be
ignored).
- The SQL command must return a result set like any query with
`select ...`. The query syntax will depend on the RDBMS which will
process them. The syntax of request to a storage procedure must be
started with `call` keyword.
#### 重要说明
- 如果server 或 proxy配置中未启动任何*odbc轮询器*进程，数据库监控监控项将变为不受支持状态。要激活ODBC轮询器，请在Zabbix [server](/manual/appendix/config/zabbix_server)配置file中设置*StartODBCPollers*参数，或对于由proxy执行的检查，在Zabbix [proxy](/manual/appendix/config/zabbix_proxy)配置file中设置。
- Zabbix不限制query的执行时间。用户需自行选择能在合理时间内执行的queries。
- 来自Zabbix server的[Timeout](/manual/appendix/config/zabbix_server)参数值被用作ODBC login超时（注意：根据ODBC驱动程序的不同，login超时设置可能会被忽略）。
- SQL命令必须像任何带有`select ...`的query一样返回结果集。query的语法将取决于处理它们的RDBMS。对存储过程的请求语法必须以`call`关键字开头。
#### Important notes
- If more than one user macro with context exists, Zabbix will try to
match the simple context macros first and then context macros with
regular expressions in an undefined order.
::: notewarning
Do not create different context macros matching the
same string to avoid undefined behavior.
:::
- If a macro with its context is not found on host, linked templates
or globally, then the macro without context is searched for.
- Only low-level discovery macros are supported in the context. Any
other macros are ignored and treated as plain text.
Technically, macro context is specified using rules similar to [item
key](/manual/config/items/item/key) parameters, except macro context is
not parsed as several parameters if there is a `,` character:
- Macro context must be quoted with `"` if the context contains a `}`
character or starts with a `"` character. Quotes inside quoted
context must be escaped with the `\` character.
- The `\` character itself is not escaped, which means it's impossible
to have a quoted context ending with the `\` character - the macro
{$MACRO:"a:\\b\\c\\"} is invalid.
- The leading spaces in context are ignored, the trailing spaces are
not:
- For example {$MACRO:A} is the same as {$MACRO: A}, but not
{$MACRO:A }.
- All spaces before leading quotes and after trailing quotes are
ignored, but all spaces inside quotes are not:
- Macros {$MACRO:"A"}, {$MACRO: "A"}, {$MACRO:"A" } and {$MACRO:
"A" } are the same, but macros {$MACRO:"A"} and {$MACRO:" A "}
are not.
The following macros are all equivalent, because they have the same
context: {$MACRO:A}, {$MACRO: A} and {$MACRO:"A"}. This is in contrast
with item keys, where 'key\[a\]', 'key\[ a\]' and 'key\["a"\]' are the
same semantically, but different for uniqueness purposes.
#### 重要说明
- 如果存在多个带上下文的用户宏，Zabbix将尝试
match the simple context macros first and then context macros with
regular expressions in an undefined order.
::: notewarning
请勿create匹配相同string的不同上下文宏，以避免未定义行为。
:::
- 如果在主机、关联模板或全局范围内未找到带上下文的宏，则会继续查找不带上下文的宏。
- 上下文中仅支持低级发现宏。任何
other macros are ignored and treated as plain text.
从技术上讲，宏上下文使用类似于[item
key](/manual/config/items/item/key)参数的规则进行指定，不同之处在于宏上下文不会因存在`,`字符而被解析为多个参数：
- 若上下文包含`}`字符或以`"`字符开头，则必须用`"`对宏上下文进行引号包裹。引号内的引号必须使用`\`字符进行转义。
- `\`字符本身不会被转义，这意味着无法创建以`\`字符结尾的带引号上下文——宏{$MACRO:"a:\\b\\c\\"}是无效的。
- 上下文开头的空格会被忽略，但结尾的空格不会：
- 例如{$MACRO:A}与{$MACRO: A}相同，但与{$MACRO:A }不同。
- 所有位于前导引号之前和尾随引号之后的空格
ignored, but all spaces inside quotes are not:
- Macros {$MACRO:"A"}, {$MACRO: "A"}, {$MACRO:"A" } and {$MACRO:
"A" } are the same, but macros {$MACRO:"A"} and {$MACRO:" A "}
are not.
以下宏都是等效的，因为它们具有相同的上下文：{$MACRO:A}、{$MACRO: A}和{$MACRO:"A"}。这与监控项键形成对比，其中'key\[a\]'、'key\[ a\]'和'key\["a"\]'在语义上相同，但在唯一性判定时被视为不同。
#### Important notes
- The server and agent keep the trace of a monitored log's size and
last modification time (for logrt) in two counters. Additionally:
- The agent also internally uses inode numbers (on
UNIX/GNU/Linux), file indexes (on Microsoft Windows) and MD5
sums of the first 512 log file bytes for improving decisions
when logfiles get truncated and rotated.
- On UNIX/GNU/Linux systems it is assumed that the file systems
where log files are stored report inode numbers, which can be
used to track files.
- On Microsoft Windows Zabbix agent determines the file system
type the log files reside on and uses:
- On NTFS file systems 64-bit file indexes.
- On ReFS file systems (only from Microsoft Windows
Server 2012) 128-bit file IDs.
- On file systems where file indexes change (e.g. FAT32,
exFAT) a fall-back algorithm is used to take a sensible
approach in uncertain conditions when log file rotation
results in multiple log files with the same last
modification time.
- The inode numbers, file indexes and MD5 sums are internally
collected by Zabbix agent. They are not transmitted to Zabbix
server and are lost when Zabbix agent is stopped.
- Do not modify the last modification time of log files with
'touch' utility, do not copy a log file with later restoration
of the original name (this will change the file inode number).
In both cases the file will be counted as different and will be
analyzed from the start, which may result in duplicated alerts.
- If there are several matching log files for `logrt[]` item and
Zabbix agent is following the most recent of them and this most
recent log file is deleted, a warning message
`"there are no files matching "<regexp mask>" in "<directory>"`
is logged. Zabbix agent ignores log files with modification time
less than the most recent modification time seen by the agent
for the `logrt[]` item being checked.
- The agent starts reading the log file from the point it stopped the
previous time.
- The number of bytes already analyzed (the size counter) and last
modification time (the time counter) are stored in the Zabbix
database and are sent to the agent to make sure the agent starts
reading the log file from this point in cases when the agent is just
started or has received items which were previously disabled or not
supported. However, if the agent has received a non-zero size
counter from server, but the logrt\[\] or logrt.count\[\] item is
unable to find matching files, the size counter is
reset to 0 to analyze from the start if the files appear later.
- Whenever the log file becomes smaller than the log size counter
known by the agent, the counter is reset to zero and the agent
starts reading the log file from the beginning taking the time
counter into account.
- If there are several matching files with the same last modification
time in the directory, then the agent tries to correctly analyze all
log files with the same modification time and avoid skipping data or
analyzing the same data twice, although it cannot be guaranteed in
all situations. The agent does not assume any particular log file
rotation scheme nor determines one. When presented multiple log
files with the same last modification time, the agent will process
them in a lexicographically descending order. Thus, for some
rotation schemes the log files will be analyzed and reported in
their original order. For other rotation schemes the original log
file order will not be honored, which can lead to reporting matched
log file records in altered order (the problem does not happen if
log files have different last modification times).
- Zabbix agent processes new records of a log file once per *Update
interval* seconds.
- Zabbix agent does not send more than **maxlines** of a log file per
second. The limit prevents overloading of network and CPU resources
and overrides the default value provided by **MaxLinesPerSecond**
parameter in the [agent configuration
file](/manual/appendix/config/zabbix_agentd).
- To find the required string Zabbix will process 10 times more new
lines than set in MaxLinesPerSecond. Thus, for example, if a `log[]`
or `logrt[]` item has *Update interval* of 1 second, by default the
agent will analyze no more than 200 log file records and will send
no more than 20 matching records to Zabbix server in one check. By
increasing **MaxLinesPerSecond** in the agent configuration file or
setting **maxlines** parameter in the item key, the limit can be
increased up to 10000 analyzed log file records and 1000 matching
records sent to Zabbix server in one check. If the *Update interval*
is set to 2 seconds the limits for one check would be set 2 times
higher than with *Update interval* of 1 second.
- Additionally, log and log.count values are always limited to 50% of
the agent send buffer size, even if there are no non-log values in
it. So for the **maxlines** values to be sent in one connection (and
not in several connections), the agent
[BufferSize](/manual/appendix/config/zabbix_agentd) parameter must
be at least maxlines x 2. Zabbix agent can upload data during log gathering and thus free the buffer, whereas Zabbix agent 2 will stop log gathering until the data is uploaded and the buffer is freed, which is performed asynchronously.
- In the absence of log items all agent buffer size is used for
non-log values. When log values come in they replace the older
non-log values as needed, up to the designated 50%.
- For log file records longer than 256kB, only the first 256kB are
matched against the regular expression and the rest of the record is
ignored. However, if Zabbix agent is stopped while it is dealing
with a long record the agent internal state is lost and the long
record may be analyzed again and differently after the agent is
started again.
- Special note for "\\" path separators: if file\_format is
"file\\.log", then there should not be a "file" directory, since it
is not possible to unambiguously define whether "." is escaped or is
the first symbol of the file name.
- Regular expressions for `logrt` are supported in filename only,
directory regular expression matching is not supported.
- On UNIX platforms a `logrt[]` item becomes NOTSUPPORTED if a
directory where the log files are expected to be found does not
exist.
- On Microsoft Windows, if a directory does not exist the item will
not become NOTSUPPORTED (for example, if directory is misspelled in
item key).
- An absence of log files for `logrt[]` item does not make it
NOTSUPPORTED. Errors of reading log files for `logrt[]` item are
logged as warnings into Zabbix agent log file but do not make the
item NOTSUPPORTED.
- Zabbix agent log file can be helpful to find out why a `log[]` or
`logrt[]` item became NOTSUPPORTED. Zabbix can monitor its agent log
file, except when at DebugLevel=4 or DebugLevel=5.
- Searching for a question mark using a regular expression, e.g. `\?` may result in false positives if the text file contains NUL symbols, as those are replaced with "?" by Zabbix to continue processing the line until the newline character.
#### 重要说明
- server 和 agent 会记录被监控日志文件的大小变化轨迹
最后修改时间（针对logrt）以两个计数器形式记录。此外：
- agent 内部也使用 inode 编号（在
UNIX/GNU/Linux), file 索引（在 Microsoft Windows 上）和 MD5
前512个日志file字节的总和，用于改进决策
当日志文件get被截断并轮转时。
- 在UNIX/GNU/Linux系统上，假定file系统
日志文件存储位置报告inode编号，该编号可以
用于跟踪文件。
- 在Microsoft Windows上，Zabbix agent决定了file系统
日志文件所在的类型并使用：
- 在NTFS file系统上使用64位 file索引。
- 在ReFS file系统上（仅限Microsoft Windows
Windows Server 2012) 128位file标识符。
- 在file系统上，当file索引发生变化时（例如FAT32，
exFAT) 将使用回退算法来采取合理的
在日志file轮换的不确定条件下的方法
导致多个日志文件具有相同的最后
修改时间。
- inode编号、file索引和MD5校验和在内部
由Zabbix agent收集。它们不会被传输到Zabbix
服务器并在Zabbix agent停止时丢失。
- 不要修改日志文件的最后修改时间
'touch'工具，不要copy日志file并进行后续恢复
原始名称的（这将更改file inode编号）。
在这两种情况下，file 将被视为不同的并且会
从开始分析，可能导致重复警报。
- 如果存在多个匹配的日志文件用于`logrt[]` 监控项 且
Zabbix agent 遵循其中最新的规范
最近日志file已被删除，一条警告消息
`"there are no files matching "<regexp mask>" in "<directory>"`
已记录。Zabbix agent 忽略修改时间的日志文件
早于agent记录的最新修改时间
对于正在检查的`logrt[]` 监控项
- agent开始从上次停止的位置继续读取日志file
之前的时间
- 已分析的字节数（大小计数器）及最后
修改时间（时间计数器）存储在Zabbix中
数据库并被发送到agent以确保agent启动
从这一点开始读取日志file，在agent仅为的情况下
已启动或已接收到之前禁用或未启用的监控项
支持。然而，如果agent接收到非零大小
来自服务器的计数器，但logrt\[\]或logrt.count\[\] 监控项是
无法找到匹配的文件，大小计数器为
如果文件稍后出现，则重置为0以从头开始分析。
- 每当日志file变得小于日志大小计数器时
由agent所知，计数器被重置为零且agent
从日志file的开头开始读取时间
计数器考虑在内。
- 如果有多个匹配文件具有相同的最后修改时间
目录中的时间，然后agent尝试正确分析所有
具有相同修改时间的日志文件，避免跳过数据或
对相同数据进行重复分析，尽管无法完全保证
所有情况下。agent不假定任何特定的日志file
轮换方案也未确定一个。当呈现多个日志时
具有相同最后修改时间的文件，agent将处理
将它们按字典序降序排列。因此，对于某些
日志文件将按照轮换方案进行分析和报告
它们的原始顺序。对于其他轮转方案，原始日志
file 顺序将不被遵循，这可能导致报告匹配
日志 file 记录顺序异常（若...则不会出现此问题
日志文件的最后修改时间不同).
- Zabbix agent 每次 *更新 时处理日志 file 的新记录
interval* 秒。
- Zabbix agent 每次不会发送超过 **maxlines** 行日志 file
second. 该限制可防止网络和CPU资源过载
并覆盖由**MaxLinesPerSecond**提供的默认值
[agent configuration
file](/manual/appendix/config/zabbix_agentd)中的参数
- 为了找到所需的string，Zabbix将处理10倍以上的新数据
每秒钟输出的行数超过MaxLinesPerSecond设置的值。例如，如果`log[]`
或 `logrt[]` 监控项 默认具有1秒的*更新间隔*
agent 最多分析200条日志file记录并将发送
每次检查中不超过20条匹配记录到Zabbix server。
增加**MaxLinesPerSecond**在agent配置file中或
在监控项键中设置**maxlines**参数，可以限制
增加到10000条已分析日志file记录和1000条匹配
在一次检查中发送到Zabbix server的记录数。如果*更新间隔*
设置为2秒时，单次检查的限制将被设定为2倍
高于*更新间隔*为1秒的情况。
- 此外，log和log.count的值始终限制在50%以内
agent发送缓冲区大小，即使其中不包含非日志值
因此，为了在一次连接中发送**maxlines**值（且
不在多个连接中), agent
[BufferSize](/manual/appendix/config/zabbix_agentd) 参数必须
至少为maxlines x 2。Zabbix agent可以在日志收集期间上传数据从而释放缓冲区，而Zabbix agent 2会停止日志收集直到数据上传完成且缓冲区被释放，这一过程是异步执行的。
- 当缺少日志监控项时，所有agent缓冲区大小将被使用
非日志值。当接收到日志值时，它们会替换较旧的
根据需要记录非日志值，最多可达指定的50%。
- 对于超过256kB的日志file记录，仅保留前256kB内容
与正则表达式匹配后，记录的其余部分是
被忽略。然而，如果Zabbix agent在处理过程中被停止
拥有长记录时，agent内部状态会丢失且长
记录可能会在agent之后被再次且以不同方式分析
重新启动。
- 关于"\\"路径分隔符的特殊说明：如果file\_format是
file\\.log"，那么就不应该存在file目录，因为
无法明确界定"."是否被转义
file名称的首个字符。
- `logrt` 支持在文件名中使用正则表达式,
不支持目录正则表达式匹配。
- 在UNIX平台上，当`logrt[]` 监控项变为NOTSUPPORTED时
日志文件预期所在的目录未找到
存在。
- 在Microsoft Windows上，如果目录不存在，监控项将
不会变为NOTSUPPORTED（例如，如果目录名称拼写错误）
监控项 键).
- `logrt[]` 监控项缺少日志文件并不会使其失效
不支持. 读取`logrt[]`监控项日志文件时发生的错误
记录为警告到Zabbix agent日志file但不会使
监控项 不支持。
- Zabbix agent 日志 file 有助于查明为何 `log[]` 或
`logrt[]` 监控项 变为NOTSUPPORTED状态。Zabbix可以监控其agent日志
file，除非处于DebugLevel=4或DebugLevel=5级别时除外。
- 使用正则表达式搜索问号时，例如`\?`，如果文本file包含NUL符号，可能会导致误报，因为这些符号会被Zabbix替换为"?"以继续处理该行直到换行符。
### Important notes
To perform the database upgrade:
1. Stop Zabbix server.
Stopping Zabbix server for the time of the upgrade is strongly recommended.
However, if absolutely necessary, you can perform the upgrade while the server is running (only for MySQL, MariaDB, and PostgreSQL without TimescaleDB).
2. Back up your database.
3. Run the scripts for your database.
4. Start Zabbix server.
::: notewarning
Run the scripts for the server database only. The proxy will not benefit from this upgrade.
:::
If the database uses partitions, contact the DB administrator or Zabbix Support for help.
CSV files can be removed after a successful upgrade to primary keys.
Optionally, Zabbix frontend may be switched to [maintenance mode](/manual/web_interface/maintenance_mode).
### 重要说明
执行数据库升级步骤:
1. 停止Zabbix server服务.
强烈建议在升级期间停止Zabbix server服务.
但在绝对必要时, 可在服务运行时执行升级(仅适用于MySQL、mariadb以及不带TimescaleDB的PostgreSQL).
2. 备份数据库.
3. 运行对应数据库的升级脚本.
4. 启动Zabbix server服务.
::: notewarning
仅需运行服务器数据库的升级脚本. proxy不会从此升级中受益.
:::
若数据库使用了分区, 请联系数据库管理员或Zabbix技术支持获取帮助.
成功升级至主键后, 可移除CSV文件.
可选操作: 可将Zabbix前端切换至[maintenance mode](/manual/web_interface/maintenance_mode).
#### Importing a template
Import the template configuration contained in the XML string.
If any items or triggers in the XML string are missing, they will be deleted from the database, and everything else will be left unchanged.
Request:
```json
{
"jsonrpc": "2.0",
"method": "configuration.import",
"params": {
"format": "xml",
"rules": {
"templates": {
"createMissing": true,
"updateExisting": true
},
"items": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"triggers": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"valueMaps": {
"createMissing": true,
"updateExisting": false
}
},
"source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:00:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter><dt>Server uptime: (.*)</dt></parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>6805d4c39a624a8bab2cc8ab63df1ab3</uuid><name>CPU load</name><key>system.cpu.load</key><value_type>FLOAT</value_type><triggers><trigger><uuid>ab4c2526c2bc42e48a633082255ebcb3</uuid><expression>avg(/New template/system.cpu.load,3m)>2</expression><name>CPU load too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
#### 导入模板
导入XML string中包含的模板配置。
如果XML string中缺少任何监控项或触发器，它们将从数据库中删除，其余内容将保持不变。
请求:
```json
{
"jsonrpc": "2.0",
"method": "configuration.import",
"params": {
"format": "xml",
"rules": {
"templates": {
"createMissing": true,
"updateExisting": true
},
"items": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"triggers": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"valueMaps": {
"createMissing": true,
"updateExisting": false
}
},
"source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:00:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter><dt>Server uptime: (.*)</dt></parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>6805d4c39a624a8bab2cc8ab63df1ab3</uuid><name>CPU load</name><key>system.cpu.load</key><value_type>FLOAT</value_type><triggers><trigger><uuid>ab4c2526c2bc42e48a633082255ebcb3</uuid><expression>avg(/New template/system.cpu.load,3m)>2</expression><name>CPU load too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
##### Importing data
Import initial schema:
# cat /usr/share/zabbix-sql-scripts/mysql/proxy.sql | mysql -uzabbix -p zabbix
For proxy with PostgreSQL (or SQLite):
# cat /usr/share/zabbix-sql-scripts/postgresql/proxy.sql | sudo -u zabbix psql zabbix
# cat /usr/share/zabbix-sql-scripts/sqlite3/proxy.sql | sqlite3 zabbix.db
##### 导入数据
导入初始架构:
# cat /usr/share/zabbix-sql-scripts/mysql/proxy.sql | mysql -uzabbix -p zabbix
对于使用PostgreSQL(或SQLite)的proxy:
# cat /usr/share/zabbix-sql-scripts/postgresql/proxy.sql | sudo -u zabbix psql zabbix
# cat /usr/share/zabbix-sql-scripts/sqlite3/proxy.sql | sqlite3 zabbix.db
##### Importing data
Import initial schema:
cat /usr/share/zabbix-sql-scripts/mysql/proxy.sql | mysql -uzabbix -p zabbix
For proxy with PostgreSQL (or SQLite):
cat /usr/share/zabbix-sql-scripts/postgresql/proxy.sql | sudo -u zabbix psql zabbix
cat /usr/share/zabbix-sql-scripts/sqlite3/proxy.sql | sqlite3 zabbix.db
##### 导入数据
导入初始架构:
cat /usr/share/zabbix-sql-scripts/mysql/proxy.sql | mysql -uzabbix -p zabbix
对于proxy使用PostgreSQL(或SQLite):
cat /usr/share/zabbix-sql-scripts/postgresql/proxy.sql | sudo -u zabbix psql zabbix
cat /usr/share/zabbix-sql-scripts/sqlite3/proxy.sql | sqlite3 zabbix.db
##### Importing data
Import initial schema:
cat /usr/share/zabbix-sql-scripts/mysql/proxy.sql | mysql -uzabbix -p zabbix
For proxy with PostgreSQL (or SQLite):
cat /usr/share/zabbix-sql-scripts/postgresql/proxy.sql | sudo -u zabbix psql zabbix
cat /usr/share/zabbix-sql-scripts/sqlite3/proxy.sql | sqlite3 zabbix.db
##### 导入数据
导入初始架构:
cat /usr/share/zabbix-sql-scripts/mysql/proxy.sql | mysql -uzabbix -p zabbix
对于proxy使用PostgreSQL(或SQLite):
cat /usr/share/zabbix-sql-scripts/postgresql/proxy.sql | sudo -u zabbix psql zabbix
cat /usr/share/zabbix-sql-scripts/sqlite3/proxy.sql | sqlite3 zabbix.db
##### Importing data
Import initial schema:
# zcat /usr/share/doc/zabbix-sql-scripts/mysql/schema.sql.gz | mysql -uzabbix -p zabbix
For proxy with PostgreSQL (or SQLite):
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/schema.sql.gz | sudo -u zabbix psql zabbix
# zcat /usr/share/doc/zabbix-sql-scripts/sqlite3/schema.sql.gz | sqlite3 zabbix.db
##### 数据导入
导入初始架构:
# zcat /usr/share/doc/zabbix-sql-scripts/mysql/schema.sql.gz | mysql -uzabbix -p zabbix
对于带 PostgreSQL（或 SQLite）的proxy:
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/schema.sql.gz | sudo -u zabbix psql zabbix
# zcat /usr/share/doc/zabbix-sql-scripts/sqlite3/schema.sql.gz | sqlite3 zabbix.db
##### Importing data
Import initial schema:
# zcat /usr/share/doc/zabbix-sql-scripts/mysql/schema.sql.gz | mysql -uzabbix -p zabbix
For proxy with PostgreSQL (or SQLite):
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/schema.sql.gz | sudo -u zabbix psql zabbix
# zcat /usr/share/doc/zabbix-sql-scripts/sqlite3/schema.sql.gz | sqlite3 zabbix.db
##### 数据导入
导入初始架构:
# zcat /usr/share/doc/zabbix-sql-scripts/mysql/schema.sql.gz | mysql -uzabbix -p zabbix
对于带 PostgreSQL（或 SQLite）的proxy:
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/schema.sql.gz | sudo -u zabbix psql zabbix
# zcat /usr/share/doc/zabbix-sql-scripts/sqlite3/schema.sql.gz | sqlite3 zabbix.db
#### Importing data
Now import initial schema and data for the **server** with MySQL:
zcat /usr/share/packages/zabbix-sql-scripts/mysql/create.sql.gz | mysql -uzabbix -p zabbix
You will be prompted to enter your newly created database password.
With PostgreSQL:
zcat /usr/share/packages/zabbix-sql-scripts/postgresql/create.sql.gz | sudo -u zabbix psql zabbix
With TimescaleDB, in addition to the previous command, also run:
zcat /usr/share/packages/zabbix-sql-scripts/postgresql/timescaledb.sql.gz | sudo -u <username> psql zabbix
::: notewarning
TimescaleDB is supported with Zabbix server
only.
:::
For proxy, import initial schema:
zcat /usr/share/packages/zabbix-sql-scripts/mysql/schema.sql.gz | mysql -uzabbix -p zabbix
For proxy with PostgreSQL:
zcat /usr/share/packages/zabbix-sql-scripts/postgresql/schema.sql.gz | sudo -u zabbix psql zabbix
#### 导入数据
现在为使用MySQL的**服务器** import 初始架构和数据:
zcat /usr/share/packages/zabbix-sql-scripts/mysql/create.sql.gz | mysql -uzabbix -p zabbix
系统将提示您输入新创建的数据库密码.
对于PostgreSQL:
zcat /usr/share/packages/zabbix-sql-scripts/postgresql/create.sql.gz | sudo -u zabbix psql zabbix
对于TimescaleDB, 除了上述命令外, 还需run:
zcat /usr/share/packages/zabbix-sql-scripts/postgresql/timescaledb.sql.gz | sudo -u <username> psql zabbix
::: notewarning
TimescaleDB仅支持Zabbix server.
:::
对于proxy, import 初始架构:
zcat /usr/share/packages/zabbix-sql-scripts/mysql/schema.sql.gz | mysql -uzabbix -p zabbix
对于使用PostgreSQL的proxy:
zcat /usr/share/packages/zabbix-sql-scripts/postgresql/schema.sql.gz | sudo -u zabbix psql zabbix
#### Importing data with Timescale DB
With TimescaleDB, in addition to the import command for PostgreSQL, also
run:
# cat /usr/share/zabbix-sql-scripts/postgresql/timescaledb.sql | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB is supported with Zabbix server
only.
:::
#### 使用Timescale DB导入数据
使用TimescaleDB时，除了PostgreSQL的import命令外，
还需执行run：
# cat /usr/share/zabbix-sql-scripts/postgresql/timescaledb.sql | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB仅支持与Zabbix server
配合使用。
:::
#### Importing data with Timescale DB
With TimescaleDB, in addition to the import command for PostgreSQL, also
run:
cat /usr/share/zabbix-sql-scripts/postgresql/timescaledb.sql | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB is supported with Zabbix server
only.
:::
#### 使用Timescale DB导入数据
使用TimescaleDB时，除了PostgreSQL的import命令外，
还需执行run：
cat /usr/share/zabbix-sql-scripts/postgresql/timescaledb.sql | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB仅支持与Zabbix server
配合使用。
:::
#### Importing data with Timescale DB
With TimescaleDB, in addition to the import command for PostgreSQL, also
run:
cat /usr/share/zabbix-sql-scripts/postgresql/timescaledb.sql | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB is supported with Zabbix server
only.
:::
#### 使用Timescale DB导入数据
使用TimescaleDB时，除了PostgreSQL的import命令外，
还需执行run:
cat /usr/share/zabbix-sql-scripts/postgresql/timescaledb.sql | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB仅支持Zabbix server。
:::
#### Importing data with Timescale DB
With TimescaleDB, in addition to the import command for PostgreSQL, also
run:
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/timescaledb.sql.gz | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB is supported with Zabbix server
only.
:::
#### 使用 Timescale DB导入数据
对于 TimescaleDB, 除了PostgreSQL的导入的命令外，还可运行:
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/timescaledb.sql.gz | sudo -u zabbix psql zabbix
::: 警示
仅Zabbix server支持TimescaleDB。
:::
#### Importing data with Timescale DB
With TimescaleDB, in addition to the import command for PostgreSQL, also
run:
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/timescaledb.sql.gz | sudo -u zabbix psql zabbix
::: notewarning
TimescaleDB is supported with Zabbix server
only.
:::
#### 使用 Timescale DB导入数据
对于 TimescaleDB, 除了PostgreSQL的导入的命令外, 还可运行:
# zcat /usr/share/doc/zabbix-sql-scripts/postgresql/timescaledb.sql.gz | sudo -u zabbix psql zabbix
::: 警告
仅Zabbix server支持TimescaleDB。
:::
#### Importing
To import hosts, do the following:
- Go to: *Configuration* → *Hosts*
- Click on *Import* to the right
- Select the import file
- Mark the required options in import rules
- Click on *Import*
A success or failure message of the import will be displayed in the
frontend.
Import rules:
|Rule|Description|
|----|-----------|
|*Update existing*|Existing elements will be updated with data taken from the import file. Otherwise they will not be updated.|
|*Create new*|The import will add new elements using data from the import file. Otherwise it will not add them.|
|*Delete missing*|The import will remove existing elements not present in the import file. Otherwise it will not remove them.<br>If *Delete missing* is marked for template linkage, existing template linkage not present in the import file will be unlinked. Since Zabbix 6.0.13, entities (items, triggers, graphs, etc.) inherited from the unlinked templates will not be removed (unless the *Delete missing* option is selected for each entity as well).|
#### 导入
要import主机，请执行以下操作：
- 前往：*Configuration* → *主机*
- 点击右侧的*Import*
- 选择importfile
- 在import规则中标记所需选项
- 点击*Import*
前端将显示import的成功或失败消息。
导入规则：
| 规则 | 描述 |
|----|-----------|
| *更新现有* | 现有元素将使用importfile中的数据更新。否则将不会更新。 |
| *创建新* | import将使用importfile中的数据添加新元素。否则不会添加。 |
| *删除缺失* | import将移除importfile中不存在的现有元素。否则不会移除。<br>如果为模板链接标记了*删除缺失*，则importfile中不存在的现有模板链接将被取消链接。自Zabbix 6.0.13起，从取消链接的模板继承的实体（监控项、触发器、图形等）不会被移除（除非还为每个实体选择了*删除缺失*选项）。 |
#### Importing
To import media types, do the following:
- Go to: *Administration* → *Media types*
- Click on *Import* to the right
- Select the import file
- Mark the required options in import rules
- Click on *Import*
A success or failure message of the import will be displayed in the
frontend.
Import rules:
|Rule|Description|
|----|-----------|
|*Update existing*|Existing elements will be updated with data taken from the import file. Otherwise they will not be updated.|
|*Create new*|The import will add new elements using data from the import file. Otherwise it will not add them.|
|*Delete missing*|The import will remove existing elements not present in the import file. Otherwise it will not remove them.|
#### 导入
要import媒介类型，请执行以下操作：
- 前往：*管理* → *媒介类型*
- 点击右侧的*导入*
- 选择要import的file
- 在import规则中标记所需选项
- 点击*导入*
前端将显示import成功或失败的消息。
导入规则：
| 规则 | 描述 |
|----|-----------|
| *更新现有* | 现有元素将使用import的file中的数据更新。否则将不会更新。 |
| *创建新* | import将使用import的file中的数据添加新元素。否则不会添加。 |
| *删除缺失* | import将移除import的file中不存在的现有元素。否则不会移除。 |
#### Importing
To import network maps, do the following:
- Go to: *Monitoring* → *Maps*
- Click on *Import* to the right
- Select the import file
- Mark the required options in import rules
- Click on *Import*
All mandatory input fields are marked with a red asterisk.
A success or failure message of the import will be displayed in the
frontend.
Import rules:
|Rule|Description|
|----|-----------|
|*Update existing*|Existing maps will be updated with data taken from the import file. Otherwise they will not be updated.|
|*Create new*|The import will add new maps using data from the import file. Otherwise it will not add them.|
If you uncheck both map options and check the respective options for
images, images only will be imported. Image importing is only available
to Super Admin users.
::: notewarning
If replacing an existing image, it will affect all
maps that are using this image.
:::
#### 导入
要import网络地图，请执行以下操作：
- 前往：*Monitoring* → *Maps*
- 点击右侧的*Import*
- 选择要import的file
- 在import规则中标记所需选项
- 点击*Import*
所有必填字段均以红色星号标记。
import操作的成功或失败消息将显示在前端界面。
导入规则：
| 规则 | 描述 |
|----|-----------|
| *更新现有* | 现有地图将使用importfile中的数据更新。否则将保持不变。 |
| *创建新* | import操作将使用importfile中的数据添加新地图。否则不会添加。 |
如果取消勾选两个地图选项并勾选对应的图像选项，则仅导入图像。图像导入功能仅对超级管理员用户可用。
::: notewarning
如果替换现有图像，将影响所有使用该图像的地图。
:::
#### Importing
To import templates, do the following:
- Go to: *Configuration* → *Templates*
- Click on *Import* to the right
- Select the import file
- Mark the required options in import rules
- Click on *Import*
All mandatory input fields are marked with a red asterisk.
Import rules:
|Rule|Description|
|----|-----------|
|*Update existing*|Existing elements will be updated with data taken from the import file. Otherwise, they will not be updated.|
|*Create new*|The import will add new elements using data from the import file. Otherwise, it will not add them.|
|*Delete missing*|The import will remove existing elements not present in the import file. Otherwise, it will not remove them.<br>If *Delete missing* is marked for template linkage, existing template linkage not present in the import file will be unlinked. Since Zabbix 6.0.13, entities (items, triggers, graphs, etc.) inherited from the unlinked templates will not be removed (unless the *Delete missing* option is selected for each entity as well).|
On the next screen, you will be able to view the content of a template
being imported. If this is a new template all elements will be listed in
green. If updating an existing template, new template elements are
highlighted in green; removed template elements are highlighted in red;
elements that have not changed are listed on a gray background.
{width="600"}
The menu on the left can be used to navigate through the list of
changes. Section *Updated* highlights all changes made to existing
template elements. Section *Added* lists new template elements. The
elements in each section are grouped by element type; press on the gray
arrow down to expand or collapse the group of elements.
Review template changes, then press *Import* to perform template import.
A success or failure message of the import will be displayed in the
frontend.
#### 导入
要import模板，请执行以下操作：
- 前往：*Configuration* → *模板*
- 点击右侧的*Import*
- 选择importfile
- 在import规则中标记所需选项
- 点击*Import*
所有必填字段均标有红色星号。
导入规则：
| 规则 | 描述 |
|----|-----------|
| *更新现有* | 现有元素将使用importfile中的数据更新。否则，它们将不会被更新。 |
| *创建新* | import将使用importfile中的数据添加新元素。否则，不会添加它们。 |
| *删除缺失* | import将移除importfile中不存在的现有元素。否则，不会移除它们。<br>如果为模板链接标记了*删除缺失*，则importfile中不存在的现有模板链接将被取消关联。自Zabbix 6.0.13起，从未关联模板继承的实体（监控项、触发器、图形等）不会被移除（除非还为每个实体选择了*删除缺失*选项）。 |
在下一个屏幕上，您将能够查看正在导入的模板内容。如果是新模板，所有元素将以绿色列出。如果是更新现有模板，新模板元素将以绿色高亮显示；移除的模板元素将以红色高亮显示；未更改的元素将在灰色背景下列出。
{width="600"}
左侧菜单可用于导航更改列表。*Updated*部分高亮显示对现有模板元素所做的所有更改。*Added*部分列出新模板元素。每个部分中的元素按元素类型分组；按下灰色向下箭头可展开或折叠元素组。
查看模板更改后，按*Import*执行模板import。
import的成功或失败消息将显示在前端。
### Improved performance of history syncers
The performance of history syncers has been improved by introducing a new read-write lock.
This reduces locking between history syncers, trappers and proxy pollers by using a shared read lock while accessing the configuration cache.
The new lock can be write locked only by the configuration syncer performing a configuration cache reload.
### 历史同步器性能改进
通过引入新的读写锁改进了历史同步器的性能。
这减少了历史同步器、trapper和proxy轮询器之间的锁争用，在访问configuration cache时使用共享读锁。
新锁仅在配置同步器执行configuration cache重载时才会被写锁定。
### Improved performance of history syncers
The performance of history syncers has been improved by introducing a new read-write lock.
This reduces locking between history syncers, trappers and proxy pollers by using a shared read lock while accessing the configuration cache.
The new lock can be write locked only by the configuration syncer performing a configuration cache reload.
### 改进了历史同步器的性能
通过引入新的读写锁提高了历史同步器的性能。这通过在访问配置缓存时使用共享读锁减少了历史同步器、捕获器和代理轮询器之间的锁定。新锁只能由 配置同步器执行配置缓存重新加载。
##### In accepting-side log:
...failed to accept an incoming connection: from 127.0.0.1: support for TLS was not compiled in
##### 在接受端日志中：
...无法接受传入连接：来自127.0.0.1：未编译TLS支持
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Host groups*|Host groups to display data for.|
|*Hosts*|Hosts to display data for.|
|*Host tags*|Specify tags to limit the number of hosts displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br><br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Columns*|Add data [columns](#column-configuration) to display.<br>The column order determines their display from left to right.<br>Columns can be reordered by dragging up and down by the handle before the column name.|
|*Order*|Specify the ordering of rows:<br>**Top N** - in descending order by the *Order column* aggregated value<br>**Bottom N** - in ascending order by the *Order column* aggregated value |
|*Order column*|Specify the column from the defined *Columns* list to use for *Top N* or *Bottom N* ordering.|
|*Host count*|Count of host rows to be shown (1-100).|
除了适用于所有小部件的[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)参数外，您还可以设置以下特定选项：
| | |
|--|--------|
| *主机组* | 要显示数据的主机组。 |
| *主机* | 要显示数据的主机。 |
| *主机标签* | 指定标签以限制小部件中显示的主机数量。可以包含或排除特定标签及标签值。可设置多个条件。标签名称匹配始终区分大小写。<br><br>每个条件有以下几种运算符：<br>**存在** - 包含指定的标签名称<br>**等于** - 包含指定的标签名称和值（区分大小写）<br>**包含** - 包含标签值包含输入string的标签名称（子字符串匹配，不区分大小写）<br>**不存在** - 排除指定的标签名称<br>**不等于** - 排除指定的标签名称和值（区分大小写）<br>**不包含** - 排除标签值包含输入string的标签名称（子字符串匹配，不区分大小写）<br>条件有两种计算类型：<br>**与/或** - 必须满足所有条件，相同标签名的条件将通过或条件分组<br>**或** - 只需满足一个条件 |
| *列* | 添加要显示的数据[列](#column-configuration)。<br>列顺序决定其从左到右的显示方式。<br>可通过拖动列名前的手柄上下移动来重新排序列。 |
| *排序* | 指定行的排序方式：<br>**Top N** - 按*排序列*聚合值降序排列<br>**底部 N** - 按*排序列*聚合值升序排列 |
| *排序列* | 从定义的*列*列表中指定用于*Top N*或*底部 N*排序的列。 |
| *主机数量* | 要显示的主机行数（1-100）。 |
In addition to the parameters that are [common](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#common-parameters)
for all widgets, you may set the following specific options:
| | |
|--|--------|
|*Host groups*|Select host groups to be displayed on the map. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on 'x' to remove selected groups. <br>If nothing is selected in both *Host groups* and *Hosts* fields, all hosts with valid coordinates will be displayed.|
|*Hosts*|Select hosts to be displayed all the map. This field is auto-complete so starting to type the name of a host will offer a dropdown of matching hosts. Scroll down to select. Click on 'x' to remove selected hosts. <br>If nothing is selected in both *Host groups* and *Hosts* fields, all hosts with valid coordinates will be displayed.|
|*Tags*|Specify tags to limit the number of hosts displayed in the widget. It is possible to include as well as exclude specific tags and tag values. Several conditions can be set. Tag name matching is always case-sensitive.<br>There are several operators available for each condition:<br>**Exists** - include the specified tag names<br>**Equals** - include the specified tag names and values (case-sensitive)<br>**Contains** - include the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>**Does not exist** - exclude the specified tag names<br>**Does not equal** - exclude the specified tag names and values (case-sensitive)<br>**Does not contain** - exclude the specified tag names where the tag values contain the entered string (substring match, case-insensitive)<br>There are two calculation types for conditions:<br>**And/Or** - all conditions must be met, conditions having the same tag name will be grouped by the Or condition<br>**Or** - enough if one condition is met|
|*Initial view*|Comma-separated center coordinates and an optional zoom level to display when the widget is initially loaded in the format `<latitude>,<longitude>,<zoom>`<br>If initial zoom is specified, the Geomap widget is loaded at the given zoom level. Otherwise, initial zoom is calculated as half of the [max zoom](/manual/web_interface/frontend_sections/administration/general#geographical_maps) for the particular tile provider.<br>The initial view is ignored if the default view is set (see below).<br>Examples:<br>=> 40.6892494,-74.0466891,14<br>=> 40.6892494,-122.0466891|
除了[通用参数](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#通用参数)的参数之外
对于所有小部件，您可以设置以下特定选项：
| | |
|--|--------|
| *主机 组* | 选择要在地图上显示的主机组。该字段支持自动补全，输入组名开头字符将显示匹配组的下拉列表。滚动选择后点击'x'可移除已选组。<br>若*主机 组*和*主机*字段均未选择，则所有带有效坐标的主机都将显示。 |
| *主机* | 选择要在地图上显示的主机。该字段支持自动补全，输入一个主机名称时会显示匹配的主机下拉列表。滚动选择后点击'x'可移除已选主机。<br>若*主机组*和*主机*字段均未选择，则所有带有效坐标的主机都将显示。 |
| *标签* | 指定标签以限制小部件中显示的主机数量。可以包含或排除特定标签及其值。可设置多个条件。标签名称匹配始终区分大小写。<br>每个条件可使用以下运算符：<br>**存在** - 包含指定的标签名称<br>**等于** - 包含指定的标签名称和值（区分大小写）<br>**包含** - 包含标签值中含有输入string的指定标签名称（子字符串匹配，不区分大小写）<br>**不存在** - 排除指定的标签名称<br>**不等于** - 排除指定的标签名称和值（区分大小写）<br>**不包含** - 排除标签值中含有输入string的指定标签名称（子字符串匹配，不区分大小写）<br>条件有两种计算类型：<br>**与/或** - 必须满足所有条件，相同标签名的条件将通过或条件分组<br>**或** - 只需满足一个条件即可 |
| *初始视图* | 以逗号分隔的中心坐标和可选的缩放级别，用于在小部件初始加载时显示，格式为 `<latitude>,<longitude>,<zoom>`<br>如果指定了初始缩放级别，Geomap小部件将按给定缩放级别加载。否则，初始缩放级别将计算为特定瓦片提供商的[地理地图](/manual/web_interface/frontend_sections/administration/general#地理地图)的一半。<br>如果设置了默认视图（见下文），则忽略初始视图。<br>示例:<br>=> 40.6892494,-74.0466891,14<br>=> 40.6892494,-122.0466891 |
In addition, Zabbix provides the zabbix-selinux-policy package as part of source RPM packages for [RHEL 8](http://repo.zabbix.com/zabbix/6.0/rhel/8/SRPMS/) and [RHEL 7](http://repo.zabbix.com/zabbix/6.0/rhel/7/SRPMS/). This package provides a basic default policy for SELinux and makes zabbix components work out-of-the-box by allowing Zabbix to create and use sockets and enabling httpd connection to PostgreSQL (used by frontend).
The source *zabbix_policy.te* file contains the following rules:
module zabbix_policy 1.2;
require {
type zabbix_t;
type zabbix_port_t;
type zabbix_var_run_t;
type postgresql_port_t;
type httpd_t;
class tcp_socket name_connect;
class sock_file { create unlink };
class unix_stream_socket connectto;
}
#============= zabbix_t ==============
allow zabbix_t self:unix_stream_socket connectto;
allow zabbix_t zabbix_port_t:tcp_socket name_connect;
allow zabbix_t zabbix_var_run_t:sock_file create;
allow zabbix_t zabbix_var_run_t:sock_file unlink;
allow httpd_t zabbix_port_t:tcp_socket name_connect;
#============= httpd_t ==============
allow httpd_t postgresql_port_t:tcp_socket name_connect;
This package has been created to prevent users from turning off SELinux because of the configuration complexity. It contains the default policy that is sufficient to speed up Zabbix deployment and configuration. For maximum security level, it is recommended to set custom SELinux settings.
此外，Zabbix在[RHEL 8](http://repo.zabbix.com/zabbix/6.0/rhel/8/SRPMS/)和[RHEL 7](http://repo.zabbix.com/zabbix/6.0/rhel/7/SRPMS/)的源码RPM包中提供了zabbix-selinux-policy软件包。该软件包为SELinux提供了基本默认策略，通过允许Zabbixcreate和使用套接字，并启用httpd与PostgreSQL的连接（供前端使用），使Zabbix组件能够开箱即用。
源文件 *zabbix_policy.te* file 包含以下规则:
module zabbix_policy 1.2;
require {
type zabbix_t;
类型 zabbix_port_t;
type zabbix_var_run_t;
type postgresql_port_t;
type httpd_t;
class tcp_socket name_connect;
class TCP套接字 name_connect;
class sock_file { create unlink };
class unix_stream_socket connectto;
}
#============= Zabbix技术文档 ==============
允许 zabbix_t 自身：unix_stream_socket 连接至；
允许 zabbix_t zabbix_port_t:tcp_socket name_connect;
allow zabbix_t zabbix_var_run_t:sock_file create;
允许 zabbix_t zabbix_var_run_t:sock_file 取消链接;
允许 httpd_t zabbix_port_t:tcp_socket name_connect;
#============= httpd_t ==============
allow httpd_t postgresql_port_t:tcp_socket name_connect;
该软件包的创建旨在防止用户因配置复杂性而禁用SELinux。它包含的默认策略足以加速Zabbix的部署与配置。若需达到最高安全级别，建议设置自定义SELinux配置。
In addition, Zabbix provides the zabbix-selinux-policy package as part of source RPM packages for [RHEL 8](http://repo.zabbix.com/zabbix/6.0/rhel/8/SRPMS/) and [RHEL 7](http://repo.zabbix.com/zabbix/6.0/rhel/8/SRPMS/). This package provides a basic default policy for SELinux and makes zabbix components work out-of-the-box by allowing Zabbix to create and use sockets and enabling httpd connection to PostgreSQL (used by frontend).
The source *zabbix_policy.te* file contains the following rules:
module zabbix_policy 1.2;
require {
type zabbix_t;
type zabbix_port_t;
type zabbix_var_run_t;
type postgresql_port_t;
type httpd_t;
class tcp_socket name_connect;
class sock_file { create unlink };
class unix_stream_socket connectto;
}
#============= zabbix_t ==============
allow zabbix_t self:unix_stream_socket connectto;
allow zabbix_t zabbix_port_t:tcp_socket name_connect;
allow zabbix_t zabbix_var_run_t:sock_file create;
allow zabbix_t zabbix_var_run_t:sock_file unlink;
allow httpd_t zabbix_port_t:tcp_socket name_connect;
#============= httpd_t ==============
allow httpd_t postgresql_port_t:tcp_socket name_connect;
This package has been created to prevent users from turning off SELinux because of the configuration complexity. It contains the default policy that is sufficient to speed up Zabbix deployment and configuration. For maximum security level, it is recommended to set custom SELinux settings.
此外，Zabbix 提供 zabbix-selinux-policy 包作为 [RHEL 8](http://repo.zabbix.com/zabbix/6.0/rhel/8/SRPMS/) 和 [RHEL 7](http://repo.zabbix.com/zabbix/6.0/rhel/8/SRPMS/) 源 RPM 包的一部分。这个包为 SELinux 提供了一个基本的默认策略，并通过允许 Zabbix 创建和使用套接字并启用与 PostgreSQL 的 httpd 连接（由前端使用）使 zabbix 组件开箱即用。
源 *zabbix_policy.te*文件包含以下规则：
module zabbix_policy 1.2;
require {
type zabbix_t;
type zabbix_port_t;
type zabbix_var_run_t;
type postgresql_port_t;
type httpd_t;
class tcp_socket name_connect;
class sock_file { create unlink };
class unix_stream_socket connectto;
}
#============= zabbix_t ==============
allow zabbix_t self:unix_stream_socket connectto;
allow zabbix_t zabbix_port_t:tcp_socket name_connect;
allow zabbix_t zabbix_var_run_t:sock_file create;
allow zabbix_t zabbix_var_run_t:sock_file unlink;
allow httpd_t zabbix_port_t:tcp_socket name_connect;
#============= httpd_t ==============
allow httpd_t postgresql_port_t:tcp_socket name_connect;
创建这个包是为了防止用户因为配置复杂而关闭 SELinux。它包含足以加速 Zabbix 部署和配置的默认策略。为获得最高安全级别，建议设置自定义 SELinux 设置。
##### Incoming connections
It is a bit more complicated with incoming connections because rules are
specific for components and configuration.
For Zabbix **agent**:
|Agent connection setup|Cipher configuration|
|----------------------|--------------------|
|TLSConnect=cert|TLSCipherCert, TLSCipherCert13|
|TLSConnect=psk|TLSCipherPSK, TLSCipherPSK13|
|TLSAccept=cert|TLSCipherCert, TLSCipherCert13|
|TLSAccept=psk|TLSCipherPSK, TLSCipherPSK13|
|TLSAccept=cert,psk|TLSCipherAll, TLSCipherAll13|
For Zabbix **server** and **proxy**:
|Connection setup|Cipher configuration|
|----------------|--------------------|
|Outgoing connections using PSK|TLSCipherPSK, TLSCipherPSK13|
|Incoming connections using certificates|TLSCipherAll, TLSCipherAll13|
|Incoming connections using PSK if server has no certificate|TLSCipherPSK, TLSCipherPSK13|
|Incoming connections using PSK if server has certificate|TLSCipherAll, TLSCipherAll13|
Some pattern can be seen in the two tables above:
- TLSCipherAll and TLSCipherAll13 can be specified only if a combined
list of certificate- **and** PSK-based ciphersuites is used. There
are two cases when it takes place: server (proxy) with a configured
certificate (PSK ciphersuites are always configured on server, proxy
if crypto library supports PSK), agent configured to accept both
certificate- and PSK-based incoming connections
- in other cases TLSCipherCert\* and/or TLSCipherPSK\* are sufficient
The following tables show the `TLSCipher*` built-in default values. They
could be a good starting point for your own custom values.
|Parameter|GnuTLS 3.6.12|
|--|--------|
|TLSCipherCert|NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509|
|TLSCipherPSK|NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL|
|TLSCipherAll|NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509|
|Parameter|OpenSSL 1.1.1d ^**1**^|
|--|--------|
|TLSCipherCert13|<|
|TLSCipherCert|EECDH+aRSA+AES128:RSA+aRSA+AES128|
|TLSCipherPSK13|TLS\_CHACHA20\_POLY1305\_SHA256:TLS\_AES\_128\_GCM\_SHA256|
|TLSCipherPSK|kECDHEPSK+AES128:kPSK+AES128|
|TLSCipherAll13|<|
|TLSCipherAll|EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128|
^**1**^ Default values are different for older OpenSSL versions (1.0.1,
1.0.2, 1.1.0), for LibreSSL and if OpenSSL is compiled without PSK
support.
**Examples of user-configured ciphersuites**
See below the following examples of user-configured ciphersuites:
- [Testing cipher strings and allowing only PFS
ciphersuites](#testing_cipher_strings_and_allowing_only_pfs_ciphersuites)
- [Switching from AES128 to AES256](#switching_from_aes128_to_aes256)
##### 传入连接
对于传入连接来说稍微复杂一些，因为规则是
特定于组件和配置。
对于Zabbix **agent**:
Agent 连接设置 | 密码配置 |
|----------------------|--------------------|
| TLSConnect=cert | TLSCipherCert, TLSCipherCert13 |
| TLSConnect=psk | TLSCipherPSK, TLSCipherPSK13 |
| TLSAccept=cert | TLSCipherCert, TLSCipherCert13 |
| TLSAccept=psk | TLSCipherPSK, TLSCipherPSK13 |
| TLSAccept=cert,psk | TLSCipherAll, TLSCipherAll13 |
对于Zabbix **服务器**和**proxy**:
| 连接设置 | 密码配置 |
|----------------|--------------------|
| 使用PSK的出站连接 | TLSCipherPSK, TLSCipherPSK13 |
| 使用证书的传入连接 | TLSCipherAll, TLSCipherAll13 |
| 当服务器无证书时使用PSK的传入连接 | TLSCipherPSK, TLSCipherPSK13 |
| 当服务器拥有证书时使用PSK的传入连接 | TLSCipherAll, TLSCipherAll13 |
从上述两个表格中可以看出一些规律:
- 仅当使用组合密码套件时，才能指定TLSCipherAll和TLSCipherAll13
基于证书**和**PSK的密码套件列表被使用。
有两种情况会发生：配置了服务器(proxy)时
证书（PSK密码套件始终在服务器上配置，proxy
如果加密库支持PSK)，agent 配置为同时接受
基于证书和PSK的入站连接
- 在其他情况下，TLSCipherCert\* 和/或 TLSCipherPSK\* 已足够
以下表格展示了`TLSCipher*`内置的默认值。它们
可以作为您自定义值的良好起点。
| 参数 | GnuTLS 3.6.12 |
|--|--------|
| TLSCipherCert | 无:+支持TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+所有曲线:+空压缩:+所有签名:+证书类型X.509 |
| TLSCipherPSK | NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL |
| TLSCipherAll | 无:+支持TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+支持所有曲线:+空压缩:+支持所有签名:+证书类型X.509 |
| 参数 | OpenSSL 1.1.1d ^**1**^ |
|--|--------|
| TLSCipherCert13 | < |
| TLSCipherCert | EECDH+aRSA+AES128:RSA+aRSA+AES128 |
| TLSCipherPSK13 | TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256 |
| TLSCipherPSK | kECDHEPSK+AES128:kPSK+AES128 |
| TLSCipherAll13 | < |
| TLSCipherAll | EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128 |
^**1**^ 旧版OpenSSL（1.0.1）的默认值有所不同
1.0.2, 1.1.0), 对于LibreSSL以及当OpenSSL编译时未包含PSK支持的情况
支持
**用户配置的加密套件示例**
请参阅以下用户配置的加密套件示例：
- [Testing cipher strings and allowing only PFS
ciphersuites](#testing_cipher_strings_and_allowing_only_pfs_ciphersuites)
- [从AES128切换至AES256](#switching_from_aes128_to_aes256)
##### In connecting-side log:
Linux:
...In zbx_tls_init_child()
...OpenSSL library (version OpenSSL 1.1.1 11 Sep 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK test sender"
...End of zbx_tls_connect():FAIL error:'connection closed by peer'
...send value error: TCP successful, cannot establish TLS to [[localhost]:10051]: connection closed by peer
Windows:
...OpenSSL library (version OpenSSL 1.1.1a 20 Nov 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK test sender"
...zbx_psk_client_cb() requested PSK identity "PSK test sender"
...End of zbx_tls_connect():FAIL error:'SSL_connect() I/O error: [0x00000000] The operation completed successfully.'
...send value error: TCP successful, cannot establish TLS to [[192.168.1.2]:10051]: SSL_connect() I/O error: [0x00000000] The operation completed successfully.
##### 在连接端日志中：
Linux:
...In zbx_tls_init_child()
...OpenSSL library (version OpenSSL 1.1.1 11 Sep 2018) initialized
...
...In zbx_tls_connect(): psk_identity:"PSK test sender"
...End of zbx_tls_connect():FAIL error:'connection closed by peer'
...send value error: TCP successful, cannot establish TLS to [[localhost]:10051]: connection closed by peer
Windows:
...OpenSSL库(version OpenSSL 1.1.1a 2018年11月20日)已初始化
...
...在zbx_tls_connect()中: psk_identity:"PSK测试发送方"
...zbx_psk_client_cb()请求了PSK身份"PSK测试发送方"
...zbx_tls_connect()结束:失败 错误:'SSL_connect() I/O错误: [0x00000000] 操作成功完成'
...发送值错误: TCP成功，但无法与[[192.168.1.2]:10051]建立TLS连接: SSL_connect() I/O错误: [0x00000000] 操作成功完成
#### Incorrect information from nested host groups in maps
Information from nested host groups is incorrectly displayed in maps, for example:
- Host group label displays the problem summary not including all hosts in nested host groups;
- "Host group elements" view does not display a separate map element for each host in the nested host groups;
- Map label displays summary of all problems not including those in nested host groups.
#### 地图中嵌套主机组信息不正确
嵌套主机组的信息在地图中显示不正确，例如：
- 主机组标签显示的问题摘要未包含嵌套主机组中的所有主机；
- "主机组元素"视图未为嵌套主机组中的每个主机显示单独的地图元素；
- 地图标签显示的所有问题摘要未包含嵌套主机组中的问题。
#### Incorrect request method parameter in items
The request method parameter, used only in HTTP checks, may be
incorrectly set to '1', a non-default value for all items as a result of
upgrade from a pre-4.0 Zabbix version. For details on how to fix this
situation, see [ZBX-19308](https://support.zabbix.com/browse/ZBX-19308).
#### 监控项中错误的请求方法参数
请求方法参数（仅用于HTTP检查）可能在从4.0版本之前的Zabbix version升级时被错误地设置为'1'（所有监控项的非默认值）。有关如何修复此情况的详细信息，请参阅[ZBX-19308](https://support.zabbix.com/browse/ZBX-19308)。
#### Indexed macros
The indexed macro syntax of {MACRO**<1-9>**} works only in the
context of **trigger expressions**. It can be used to reference hosts or
functions in the order in which they appear in the expression. Macros
like {HOST.IP1}, {HOST.IP2}, {HOST.IP3} will resolve to the IP of the
first, second, and third host in the trigger expression (providing the
trigger expression contains those hosts). Macros like {FUNCTION.VALUE1},
{FUNCTION.VALUE2}, {FUNCTION.VALUE3} will resolve to the value of the
first, second, and third item-based function in the trigger expression
at the time of the event (providing the trigger expression contains
those functions).
Additionally the {HOST.HOST<1-9>} macro is also supported within
the `{?func(/host/key,param)}` expression macro in **graph names**. For
example, `{?func(/{HOST.HOST2}/key,param)}` in the graph name will refer
to the host of the second item in the graph.
::: notewarning
Indexed macros will not resolve in any other
context, except the two cases mentioned here. For other contexts, use
macros **without** index (i. e.{HOST.HOST}, {HOST.IP}, etc)
instead.
:::
#### 索引宏
索引宏语法{MACRO**<1-9>**}仅在**触发器表达式**上下文中生效。该语法可用于按表达式中的出现顺序引用主机或函数。例如{HOST.IP1}、{HOST.IP2}、{HOST.IP3}将分别解析为触发器表达式中第一、第二、第三个主机的IP地址（前提是触发器表达式中包含这些主机）。而{FUNCTION.VALUE1}、{FUNCTION.VALUE2}、{FUNCTION.VALUE3}将解析为事件发生时触发器表达式中第一、第二、第三个监控项类函数的值（前提是触发器表达式中包含这些函数）。
此外，在**图表名称**的`{?func(/host/key,param)}`表达式宏中也支持{主机.主机<1-9>}宏语法。例如图表名称中的`{?func(/{HOST.HOST2}/key,param)}`将指向图表中第二个监控项的主机。
::: notewarning
索引宏仅在上述两种场景下有效，其他所有上下文环境均不支持解析。其他场景请使用**无索引**宏（如{HOST.HOST}、{HOST.IP}等）。
:::
#### Index lookup caching
When a dynamic index item is requested, Zabbix retrieves and caches
whole SNMP table under base OID for index, even if a match would be
found sooner. This is done in case another item would refer to the same
base OID later - Zabbix would look up index in the cache, instead of
querying the monitored host again. Note that each poller process uses
separate cache.
In all subsequent value retrieval operations only the found index is
verified. If it has not changed, value is requested. If it has changed,
cache is rebuilt - each poller that encounters a changed index walks the
index SNMP table again.
#### 索引查询缓存
当请求动态索引监控项时，Zabbix会检索并缓存索引基础OID下的整个SNMP表，即使可能更早找到匹配项。这样做的目的是防止后续另一个监控项引用相同的基础OID时，Zabbix可以直接查询缓存中的索引，而无需再次轮询受监控的主机。请注意每个轮询器进程使用独立的缓存。
在所有后续的值获取操作中，仅验证已找到的索引。如果索引未变化，则请求该值。如果索引发生变化，则重建缓存——每个遇到索引变化的轮询器会再次遍历索引SNMP表。
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[EXAMPLES](#lbAF)
[SEE ALSO](#lbAG)
------------------------------------------------------------------------
This document was created on: 21:23:35 GMT, March 18, 2020
## 索引
[名称](#lbAB)
[概要](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[示例](#lbAF)
[参见](#lbAG)
------------------------------------------------------------------------
本文档创建于: 2020年3月18日 GMT时间 21:23:35
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[FILES](#lbAF)
[SEE ALSO](#lbAG)
[AUTHOR](#lbAH)
------------------------------------------------------------------------
This document was created on: 12:58:30 GMT, June 11, 2021
## 索引
[名称](#lbAB)
[概述](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[文件](#lbAF)
[参见](#lbAG)
[作者](#lbAH)
------------------------------------------------------------------------
本文档创建于: 2021年6月11日 GMT时间 12:58:30
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[](#lbAF)
[EXAMPLES](#lbAG)
[SEE ALSO](#lbAH)
[AUTHOR](#lbAI)
------------------------------------------------------------------------
This document was created on: 08:42:29 GMT, June 11, 2021
## 索引
[名称](#lbAB)
[概要](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[](#lbAF)
[示例](#lbAG)
[参见](#lbAH)
[作者](#lbAI)
------------------------------------------------------------------------
本文档创建于: 2021年6月11日 GMT 08:42:29
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[](#lbAF)
[EXIT STATUS](#lbAG)
[EXAMPLES](#lbAH)
[SEE ALSO](#lbAI)
[AUTHOR](#lbAJ)
------------------------------------------------------------------------
This document was created on: 08:42:39 GMT, June 11, 2021
## 索引
[名称](#lbAB)
[概述](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[](#lbAF)
[退出状态](#lbAG)
[示例](#lbAH)
[参见](#lbAI)
[作者](#lbAJ)
------------------------------------------------------------------------
本文档创建于: 2021年6月11日 GMT时间 08:42:39
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[](#lbAF)
[FILES](#lbAG)
[SEE ALSO](#lbAH)
[AUTHOR](#lbAI)
------------------------------------------------------------------------
This document was created on: 14:07:57 GMT, November 22, 2021
## 索引
[名称](#lbAB)
[概要](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[](#lbAF)
[文件](#lbAG)
[参见](#lbAH)
[作者](#lbAI)
------------------------------------------------------------------------
本文档创建于: 2021年11月22日 GMT 14:07:57
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[](#lbAF)
[](#lbAG)
[FILES](#lbAH)
[SEE ALSO](#lbAI)
[AUTHOR](#lbAJ)
------------------------------------------------------------------------
This document was created on: 16:12:14 GMT, September 04, 2020
## 索引
[名称](#lbAB)
[概要](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[](#lbAF)
[](#lbAG)
[文件](#lbAH)
[参见](#lbAI)
[作者](#lbAJ)
------------------------------------------------------------------------
本文档创建于: 2020年9月4日 GMT 16:12:14
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[](#lbAF)
[](#lbAG)
[FILES](#lbAH)
[SEE ALSO](#lbAI)
[AUTHOR](#lbAJ)
------------------------------------------------------------------------
This document was created on: 16:12:22 GMT, September 04, 2020
## 索引
[名称](#lbAB)
[概要](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[](#lbAF)
[](#lbAG)
[文件](#lbAH)
[参见](#lbAI)
[作者](#lbAJ)
------------------------------------------------------------------------
本文档创建于: 2020年9月4日 GMT时间 16:12:22
## Index
[NAME](#lbAB)
[SYNOPSIS](#lbAC)
[DESCRIPTION](#lbAD)
[OPTIONS](#lbAE)
[](#lbAF)
[](#lbAG)
[FILES](#lbAH)
[SEE ALSO](#lbAI)
[AUTHOR](#lbAJ)
------------------------------------------------------------------------
This document was created on: 20:50:13 GMT, November 22, 2021
## 索引
[名称](#lbAB)
[概要](#lbAC)
[描述](#lbAD)
[选项](#lbAE)
[](#lbAF)
[](#lbAG)
[文件](#lbAH)
[参见](#lbAI)
[作者](#lbAJ)
------------------------------------------------------------------------
本文档创建于: 2021年11月22日 GMT时间 20:50:13
#### Individual migration of history tables
* Prepare directories for Data Pump for each history table.
Data Pump must have read and write permissions to these directories.
Example:
``` {.bash}
mkdir -pv /export/history /export/history_uint /export/history_str /export/history_log /export/history_text
chown -R oracle:oracle /export
```
* Create a directory object and grant read and write permissions to this object to the user used for Zabbix authentication ('zabbix' in the example below). Under *sysdba* role, run:
``` {.sql}
create directory history as '/export/history';
grant read,write on directory history to zabbix;
create directory history_uint as '/export/history_uint';
grant read,write on directory history_uint to zabbix;
create directory history_str as '/export/history_str';
grant read,write on directory history_str to zabbix;
create directory history_log as '/export/history_log';
grant read,write on directory history_log to zabbix;
create directory history_text as '/export/history_text';
grant read,write on directory history_text to zabbix;
```
* Export and import each table. Replace N with the desired thread count.
``` {.bash}
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history TABLES=history_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history TABLES=history_old REMAP_TABLE=history_old:history data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_uint TABLES=history_uint_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_uint TABLES=history_uint_old REMAP_TABLE=history_uint_old:history_uint data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_str TABLES=history_str_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_str TABLES=history_str_old REMAP_TABLE=history_str_old:history_str data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_log TABLES=history_log_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_log TABLES=history_log_old REMAP_TABLE=history_log_old:history_log data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_text TABLES=history_text_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_text TABLES=history_text_old REMAP_TABLE=history_text_old:history_text data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
```
* Follow [post-migration instructions](#post-migration) to drop the old tables.
#### 历史表单独迁移
* 为每个历史表准备Data Pump目录
Data Pump必须对这些目录具有读写权限
示例:
```{.bash}
mkdir -pv /export/history /export/history_uint /export/history_str /export/history_log /export/history_text
chown -R oracle:oracle /export
```
* 创建目录object并授予Zabbix认证用户(下例中的'zabbix')对该object的读写权限。在*sysdba*角色下，run:
```{.sql}
create directory history as '/export/history';
grant read,write on directory history to zabbix;
create directory history_uint as '/export/history_uint';
grant read,write on directory history_uint to zabbix;
create directory history_str as '/export/history_str';
grant read,write on directory history_str to zabbix;
create directory history_log as '/export/history_log';
grant read,write on directory history_log to zabbix;
create directory history_text as '/export/history_text';
grant read,write on directory history_text to zabbix;
```
* 导出并import每个表。将N替换为所需的线程数
```{.bash}
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history TABLES=history_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history TABLES=history_old REMAP_TABLE=history_old:history data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_uint TABLES=history_uint_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_uint TABLES=history_uint_old REMAP_TABLE=history_uint_old:history_uint data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_str TABLES=history_str_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_str TABLES=history_str_old REMAP_TABLE=history_str_old:history_str data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_log TABLES=history_log_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_log TABLES=history_log_old REMAP_TABLE=history_log_old:history_log data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
expdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_text TABLES=history_text_old PARALLEL=N
impdp zabbix/password@oracle_host:1521/xe DIRECTORY=history_text TABLES=history_text_old REMAP_TABLE=history_text_old:history_text data_options=SKIP_CONSTRAINT_ERRORS table_exists_action=APPEND PARALLEL=N CONTENT=data_only
```
* 按照[迁移后说明](#post-migration)删除旧表
### Informational
### 信息类
##### Informix
Standard Informix utility **onstat** can be used for monitoring of
virtually every aspect of Informix database. Also, Zabbix can retrieve
information provided by Informix SNMP agent.
##### Informix
标准 Informix 实用程序 **onstat** 可用于监视 Informix 数据库的几乎所有方面。此外，Zabbix 可以检索 Informix SNMP 代理提供的信息。
#### Initial configuration
After downloading the images, start the containers by executing `docker run` command followed by additional arguments to specify required [environment variables](#environment-variables) and/or [mount points](#volumes). Some [configuration examples](#examples) are provided below.
:::noteimportant
Zabbix must not be run as PID1/as an init process in containers.
:::
#### 初始配置
下载镜像后，通过执行`docker run`命令启动容器，后接指定所需[环境变量](#environment-variables)和/或[挂载点](#volumes)的附加参数。下方提供了一些[配置示例](#examples)。
:::noteimportant
Zabbix不得在容器中作为PID1/初始化进程run运行。
:::
##### Input data
``` {.java}
{
"books": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95,
"id": 1
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99,
"id": 2
},
{
"category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99,
"id": 3
},
{
"category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99,
"id": 4
}
],
"services": {
"delivery": {
"servicegroup": 1000,
"description": "Next day delivery in local town",
"active": true,
"price": 5
},
"bookbinding": {
"servicegroup": 1001,
"description": "Printing and assembling book in A5 format",
"active": true,
"price": 154.99
},
"restoration": {
"servicegroup": 1002,
"description": "Various restoration methods",
"active": false,
"methods": [
{
"description": "Chemical cleaning",
"price": 46
},
{
"description": "Pressing pages damaged by moisture",
"price": 24.5
},
{
"description": "Rebinding torn book",
"price": 99.49
}
]
}
},
"filters": {
"price": 10,
"category": "fiction",
"no filters": "no \"filters\""
},
"closed message": "Store is closed",
"tags": [
"a",
"b",
"c",
"d",
"e"
]
}
```
|JSONPath|Type|Result|Comments|
|--|--|------|------|
|`$.filters.price`|definite|10| |
|`$.filters.category`|definite|fiction| |
|`$.filters['no filters']`|definite|no "filters"| |
|`$.filters`|definite|{<br>"price": 10,<br>"category": "fiction",<br>"no filters": "no \\"filters\\""<br>}| |
|`$.books[1].title`|definite|Sword of Honour| |
|`$.books[-1].author`|definite|J. R. R. Tolkien| |
|`$.books.length()`|definite|4| |
|`$.tags[:]`|indefinite|\["a", "b", "c", "d", "e" \]| |
|`$.tags[2:]`|indefinite|\["c", "d", "e" \]| |
|`$.tags[:3]`|indefinite|\["a", "b", "c"\]| |
|`$.tags[1:4]`|indefinite|\["b", "c", "d"\]| |
|`$.tags[-2:]`|indefinite|\["d", "e"\]| |
|`$.tags[:-3]`|indefinite|\["a", "b"\]| |
|`$.tags[:-3].length()`|definite|2| |
|`$.books[0, 2].title`|indefinite|\["Moby Dick", "Sayings of the Century"\]| |
|`$.books[1]['author', "title"]`|indefinite|\["Sword of Honour", "Evelyn Waugh"\]| |
|`$..id`|indefinite|\[1, 2, 3, 4\]| |
|`$.services..price`|indefinite|\[154.99, 5, 46, 24.5, 99.49\]| |
|`$.books[?(@.id == 4 - 0.4 * 5)].title`|indefinite|\["Sword of Honour"\]|This query shows that arithmetical operations can be used in queries. Of course this query can be simplified to `$.books[?(@.id == 2)].title`|
|`$.books[?(@.id == 2 \|\| @.id == 4)].title`|indefinite|\["Sword of Honour", "The Lord of the Rings"\]| |
|`$.books[?(!(@.id == 2))].title`|indefinite|\["Sayings of the Century", "Moby Dick", "The Lord of the Rings"\]| |
|`$.books[?(@.id != 2)].title`|indefinite|\["Sayings of the Century", "Moby Dick", "The Lord of the Rings"\]| |
|`$.books[?(@.title =~ " of ")].title`|indefinite|\["Sayings of the Century", "Sword of Honour", "The Lord of the Rings"\]| |
|`$.books[?(@.price > 12.99)].title`|indefinite|\["The Lord of the Rings"\]| |
|`$.books[?(@.author > "Herman Melville")].title`|indefinite|\["Sayings of the Century", "The Lord of the Rings"\]| |
|`$.books[?(@.price > $.filters.price)].title`|indefinite|\["Sword of Honour", "The Lord of the Rings"\]| |
|`$.books[?(@.category == $.filters.category)].title`|indefinite|\["Sword of Honour","Moby Dick","The Lord of the Rings"\]| |
|`$.books[?(@.category == "fiction" && @.price < 10)].title`|indefinite|\["Moby Dick"\]| |
|`$..[?(@.id)]`|indefinite|\[<br>{<br>"price": 8.95,<br>"id": 1,<br>"category": "reference",<br>"author": "Nigel Rees",<br>"title": "Sayings of the Century"<br>},<br>{<br>"price": 12.99,<br>"id": 2,<br>"category": "fiction",<br>"author": "Evelyn Waugh",<br>"title": "Sword of Honour"<br>},<br>{<br>"price": 8.99,<br>"id": 3,<br>"category": "fiction",<br>"author": "Herman Melville",<br>"title": "Moby Dick",<br>"isbn": "0-553-21311-3"<br>},<br>{<br>"price": 22.99,<br>"id": 4,<br>"category": "fiction",<br>"author": "J. R. R. Tolkien",<br>"title": "The Lord of the Rings",<br>"isbn": "0-395-19395-8"<br>}<br>\]| |
|`$.services..[?(@.price > 50)].description`|indefinite|'\["Printing and assembling book in A5 format", "Rebinding torn book"\]| |
|`$..id.length()`|definite|4| |
|`$.books[?(@.id == 2)].title.first()`|definite|Sword of Honour| |
|`$..tags.first().length()`|definite|5|$..tags is indefinite path, so it returns an array of matched elements - \[\["a", "b", "c", "d", "e" \]\], first() returns the first element - \["a", "b", "c", "d", "e" \] and finally length() calculates its length - 5.|
|`$.books[*].price.min()`|definite|8.95| |
|`$..price.max()`|definite|154.99| |
|`$.books[?(@.category == "fiction")].price.avg()`|definite|14.99| |
|`$.books[?(@.category == $.filters.xyz)].title`|indefinite| |A query without match returns NULL for definite and indefinite paths.|
|`$.services[?(@.active=="true")].servicegroup`|indefinite|\[1001,1000\]|Text constants must be used in boolean value comparisons.|
|`$.services[?(@.active=="false")].servicegroup`|indefinite|\[1002\]|Text constants must be used in boolean value comparisons.|
|`$.services[?(@.servicegroup=="1002")]~.first()`|definite|restoration| |
##### 输入数据
```{.java}
{
"books": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95,
"id": 1
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99,
"id": 2
},
{
"category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99,
"id": 3
},
{
"category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99,
"id": 4
}
],
"services": {
"delivery": {
"servicegroup": 1000,
"description": "Next day delivery in local town",
"active": true,
"price": 5
},
"bookbinding": {
"servicegroup": 1001,
"description": "Printing and assembling book in A5 format",
"active": true,
"price": 154.99
},
"restoration": {
"servicegroup": 1002,
"description": "Various restoration methods",
"active": false,
"methods": [
{
"description": "Chemical cleaning",
"price": 46
},
{
"description": "Pressing pages damaged by moisture",
"price": 24.5
},
{
"description": "Rebinding torn book",
"price": 99.49
}
]
}
},
"filters": {
"price": 10,
"category": "fiction",
"no filters": "no \"filters\""
},
"closed message": "Store is closed",
"tags": [
"a",
"b",
"c",
"d",
"e"
]
}
```
| JSON路径 | 类型 | 结果 | 说明 |
|--|--|------|------|
| `$.filters.price` | definite | 10 | |
| `$.filters.category` | definite | fiction | |
| `$.filters['no filters']` | definite | no "filters" | |
| `$.filters` | definite | {<br>"price": 10,<br>"category": "fiction",<br>"no filters": "no \\"filters\\""<br>} | |
| `$.books[1].title` | definite | Sword of Honour | |
| `$.books[-1].author` | definite | J. R. R. Tolkien | |
| `$.books.length()` | definite | 4 | |
| `$.tags[:]` | indefinite | \["a", "b", "c", "d", "e" \] | |
| `$.tags[2:]` | indefinite | \["c", "d", "e" \] | |
| `$.tags[:3]` | indefinite | \["a", "b", "c"\] | |
| `$.tags[1:4]` | indefinite | \["b", "c", "d"\] | |
| `$.tags[-2:]` | indefinite | \["d", "e"\] | |
| `$.tags[:-3]` | indefinite | \["a", "b"\] | |
| `$.tags[:-3].length()` | definite | 2 | |
| `$.books[0, 2].title` | indefinite | \["Moby Dick", "Sayings of the Century"\] | |
| `$.books[1]['author', "title"]` | indefinite | \["Sword of Honour", "Evelyn Waugh"\] | |
| `$..id` | indefinite | \[1, 2, 3, 4\] | |
| `$.services..price` | indefinite | \[154.99, 5, 46, 24.5, 99.49\] | |
| `$.books[?(@.id == 4 - 0.4 * 5)].title` | indefinite | \["Sword of Honour"\] | 此query表明算术运算可用于queries。当然这个query可以简化为`$.books[?(@.id == 2)].title` |
| `$.books[?(@.id == 2 \|\| @.id == 4)].title` | indefinite | \["Sword of Honour", "The Lord of the Rings"\] | |
| `$.books[?(!(@.id == 2))].title` | indefinite | \["Sayings of the Century", "Moby Dick", "The Lord of the Rings"\] | |
| `$.books[?(@.id != 2)].title` | indefinite | \["Sayings of the Century", "Moby Dick", "The Lord of the Rings"\] | |
| `$.books[?(@.title =~ " of ")].title` | indefinite | \["Sayings of the Century", "Sword of Honour", "The Lord of the Rings"\] | |
| `$.books[?(@.price > 12.99)].title` | indefinite | \["The Lord of the Rings"\] | |
| `$.books[?(@.author > "Herman Melville")].title` | indefinite | \["Sayings of the Century", "The Lord of the Rings"\] | |
| `$.books[?(@.price > $.filters.price)].title` | indefinite | \["Sword of Honour", "The Lord of the Rings"\] | |
| `$.books[?(@.category == $.filters.category)].title` | indefinite | \["Sword of Honour","Moby Dick","The Lord of the Rings"\] | |
| `$.books[?(@.category == "fiction" && @.price < 10)].title` | indefinite | \["Moby Dick"\] | |
| `$..[?(@.id)]` | indefinite | \[<br>{<br>"price": 8.95,<br>"id": 1,<br>"category": "reference",<br>"author": "Nigel Rees",<br>"title": "Sayings of the Century"<br>},<br>{<br>"price": 12.99,<br>"id": 2,<br>"category": "fiction",<br>"author": "Evelyn Waugh",<br>"title": "Sword of Honour"<br>},<br>{<br>"price": 8.99,<br>"id": 3,<br>"category": "fiction",<br>"author": "Herman Melville",<br>"title": "Moby Dick",<br>"isbn": "0-553-21311-3"<br>},<br>{<br>"price": 22.99,<br>"id": 4,<br>"category": "fiction",<br>"author": "J. R. R. Tolkien",<br>"title": "The Lord of the Rings",<br>"isbn": "0-395-19395-8"<br>}<br>\] | |
| `$.services..[?(@.price > 50)].description` | indefinite | '\["Printing and assembling book in A5 format", "Rebinding torn book"\] | |
| `$..id.length()` | definite | 4 | |
| `$.books[?(@.id == 2)].title.first()` | definite | Sword of Honour | |
| `$..tags.first().length()` | definite | 5 | $..tags是不定路径，因此返回匹配元素的array - \[\["a", "b", "c", "d", "e" \]\], first()返回第一个元素 - \["a", "b", "c", "d", "e" \]，最后length()计算其长度 - 5。 |
| `$.books[*].price.min()` | definite | 8.95 | |
| `$..price.max()` | definite | 154.99 | |
| `$.books[?(@.category == "fiction")].price.avg()` | definite | 14.99 | |
| `$.books[?(@.category == $.filters.xyz)].title` | indefinite | | 无匹配的query对于确定和不确定路径返回NULL。 |
| `$.services[?(@.active=="true")].servicegroup` | indefinite | \[1001,1000\] | 文本常量必须用于boolean值比较。 |
| `$.services[?(@.active=="false")].servicegroup` | indefinite | \[1002\] | 文本常量必须用于boolean值比较。 |
| `$.services[?(@.servicegroup=="1002")]~.first()` | definite | restoration | |
## Installation
## 安装
##### Installation
After this is done use the following command to install Zabbix agent as
Windows service:
C:\> c:\zabbix\zabbix_agentd.exe -c c:\zabbix\zabbix_agentd.conf -i
Now you should be able to configure "Zabbix agent" service normally as
any other Windows service.
See [more
details](/manual/appendix/install/windows_agent#installing_agent_as_windows_service)
on installing and running Zabbix agent on Windows.
##### 安装
完成此操作后，使用以下命令将Zabbix agent安装为
Windows服务：
C:\> c:\zabbix\zabbix_agentd.exe -c c:\zabbix\zabbix_agentd.conf -i
现在您应该能够像配置其他Windows服务一样
正常配置"Zabbix agent"服务。
参阅[将-agent-安装为-windows-服务](/manual/appendix/install/windows_agent#将-agent-安装为-windows-服务)
了解在Windows上安装和运行Zabbix agent的相关信息。
#### Installation
A new [Zabbix web service](/manual/concepts/web_service) process and Google Chrome browser should be installed to enable generation of scheduled reports. The web service may be installed on the same machine where the Zabbix server is installed or on a different machine. Google Chrome browser should be installed on the same machine, where the web service is installed.
#### 安装
需要安装新的[Zabbix web service](/manual/concepts/web_service)进程和Google Chrome浏览器以启用计划报告生成功能。该Web服务可安装在Zabbix server所在机器或不同机器上。Google Chrome浏览器必须与Web服务安装在同一台机器上。
##### Installation from packages
An official zabbix-web-service package is available for RHEL/CentOS 8,
SLES 15, Debian 10, Ubuntu 18.04, Ubuntu 20.04 in the [Zabbix
repository](http://repo.zabbix.com/). Google Chrome browser is not
included into these packages and has to be installed separately.
##### Installation from packages
An official zabbix-web-service package is available for RHEL/CentOS 8,
SLES 15, Debian 10, Ubuntu 18.04, Ubuntu 20.04 in the [Zabbix
repository](http://repo.zabbix.com/). Google Chrome browser is not
included into these packages and has to be installed separately.
##### Installation from sources
A configured Go version 1.13+ environment is required for building
Zabbix agent 2.
To compile Zabbix web service from sources, run the `./configure` script
with `--enable-webservice` option (see [Installing Zabbix web
service](/manual/installation/install#installing_zabbix_web_service) for
additional details).
A sample ./configure command for installing or upgrading Zabbix with
addition of Zabbix web service may look like this:
./configure --enable-server --enable-proxy --enable-agent --enable-webservice --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-unixodbc --with-libxml2 --with-openssl
##### Installation from sources
A configured Go version 1.13+ environment is required for building
Zabbix agent 2.
To compile Zabbix web service from sources, run the `./configure` script
with `--enable-webservice` option (see [Installing Zabbix web
service](/manual/installation/install#installing_zabbix_web_service) for
additional details).
A sample ./configure command for installing or upgrading Zabbix with
addition of Zabbix web service may look like this:
./configure --enable-server --enable-proxy --enable-agent --enable-webservice --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-unixodbc --with-libxml2 --with-openssl
#### Installation
Please always read the installation manual for a particular module. It
is recommended to install new modules one by one to catch failures
easily.
Just before you install a module:
- Make sure you have downloaded the module from a trusted source.
Installation of harmful code may lead to consequences, such as data
loss
- Different versions of the same module (same ID) can be installed in
parallel, but only a single version can be enabled at once
Steps to install a module:
- Unpack your module within its own folder in the `modules` folder of
the Zabbix frontend
- Ensure that your module folder contains at least the manifest.json
file
- Navigate to [Module
administration](/manual/web_interface/frontend_sections/administration/general#modules)
and click the *Scan directory* button
- New module will appear in the list along with its version, author,
description and status
- Enable module by clicking on its status
Troubleshooting:
|Problem|Solution|
|---------|----------------------------------------|
|*Module did not appear in the list*|Make sure that the manifest.json file exists in `modules/your-module/` folder of the Zabbix frontend. If it does that means the module does not suit the current Zabbix version. If manifest.json file does not exist, you have probably unpacked in the wrong directory.|
|*Frontend crashed*|The module code is not compatible with the current Zabbix version or server configuration. Please delete module files and reload the frontend. You'll see a notice that some modules are absent. Go to [Module administration](/manual/web_interface/frontend_sections/administration/general#modules) and click *Scan directory* again to remove non-existent modules from the database.|
|*Error message about identical namespace, ID or actions appears*|New module tried to register a namespace, ID or actions which are already registered by other enabled modules. Disable the conflicting module (mentioned in error message) prior to enabling the new one.|
|*Technical error messages appear*|Report errors to the developer of the module.|
#### 安装
请务必阅读特定模块的安装手册。
建议逐个安装新模块以便轻松捕获故障。
在安装模块前请注意：
- 确保从可信来源下载模块。
安装有害代码可能导致数据丢失等后果
- 相同模块的不同版本（相同ID）可以安装在
parallel, but only a single version can be enabled at once
模块安装步骤：
- 将模块解压到Zabbix前端`modules`文件夹内的独立目录中
- 确保模块目录至少包含manifest.json文件
file
- 访问[模块](/manual/web_interface/frontend_sections/administration/general#模块)
并点击*扫描目录*按钮
- 新模块将出现在列表中，显示其version、作者、
描述和状态信息
- 点击状态启用模块
故障排除：
| 问题 | 解决方案 |
|---------|----------------------------------------|
| *模块未出现在列表中* | 确保Zabbix前端的`modules/your-module/`目录中存在manifest.json文件file。若存在则表示模块不兼容当前Zabbixversion。若manifest.jsonfile不存在，可能是解压到了错误目录。 |
| *前端崩溃* | 模块代码与当前Zabbixversion或服务器配置不兼容。请delete模块文件并重新加载前端。您将看到某些模块缺失的提示。访问[模块](/manual/web_interface/frontend_sections/administration/general#模块)再次点击*扫描目录*以从数据库中移除不存在的模块。 |
| *出现关于重复命名空间、ID或操作的错误消息* | 新模块尝试注册的命名空间、ID或操作已被其他启用模块占用。根据错误提示先禁用冲突模块再启用新模块。 |
| *出现技术错误消息* | 将错误报告给模块开发者。 |
#### Installation
Please refer to [Oracle
documentation](https://www.oracle.com/database/technologies/releasenote-odbc-ic.html)
for all the necessary instructions.
For some additional information please refer to: [Installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/).
#### 安装
请参阅[Oracle
documentation](https://www.oracle.com/database/technologies/releasenote-odbc-ic.html)
获取所有必要的操作说明。
如需更多补充信息，请参考：[Installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/)。
#### Installation
- **Red Hat Enterprise Linux**:
```bash
dnf install mariadb-connector-odbc
```
- **Debian/Ubuntu**:
Please refer to [MySQL documentation](https://dev.mysql.com/downloads/connector/odbc/) (for `mysql-connector-odbc`), or [MariaDB documentation](https://mariadb.com/kb/en/mariadb-connector-odbc/) (for `mariadb-connector-odbc`) to download necessary database driver for the corresponding platform.
For some additional information please refer to: [installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/).
#### 安装
- **Red Hat Enterprise Linux**:
```bash
dnf install mariadb-connector-odbc
```
- **Debian/Ubuntu**:
请参考[MySQL documentation](https://dev.mysql.com/downloads/connector/odbc/)（适用于`mysql-connector-odbc`）或[MariaDB documentation](https://mariadb.com/kb/en/mariadb-connector-odbc/)（适用于`mariadb-connector-odbc`）下载对应平台所需的数据库驱动。
更多信息请参阅：[installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/)。
#### Installation
- **Red Hat Enterprise Linux**:
```bash
dnf install postgresql-odbc
```
- **Debian/Ubuntu**:
Please refer to [PostgreSQL
documentation](https://www.postgresql.org/download/linux/ubuntu/) to
download necessary database driver for the corresponding platform.
For some additional information please refer to: [installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/).
#### 安装
- **Red Hat Enterprise Linux**:
```bash
dnf install postgresql-odbc
```
- **Debian/Ubuntu**:
请参考[PostgreSQL
documentation](https://www.postgresql.org/download/linux/ubuntu/)下载对应平台所需的数据库驱动。
更多相关信息请参阅：[installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/)。
#### Installation
- **Red Hat Enterprise Linux** ([EPEL](https://docs.fedoraproject.org/en-US/epel/) packages):
```bash
dnf install epel-release
dnf install freetds
```
- **Debian/Ubuntu**:
Please refer to [FreeTDS user guide](http://www.freetds.org/userguide/)
to download necessary database driver for the corresponding platform.
For some additional information please refer to: [installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/).
#### 安装
- **Red Hat Enterprise Linux** ([EPEL](https://docs.fedoraproject.org/en-US/epel/) 软件包):
```bash
dnf install epel-release
dnf install freetds
```
- **Debian/Ubuntu**:
请参考 [FreeTDS user guide](http://www.freetds.org/userguide/)
下载对应平台所需的数据库驱动.
更多信息请参考: [installing
unixODBC](/manual/config/items/itemtypes/odbc_checks/).
##### Installation
See the [package
installation](/manual/installation/install_from_packages) section for
instructions on how to install Zabbix agent as package.
Alternatively see instructions for [manual
installation](/manual/installation/install#installing_zabbix_daemons) if
you do not want to use packages.
::: noteimportant
In general, 32bit Zabbix agents will work on 64bit
systems, but may fail in some cases.
:::
##### 安装
有关如何以软件包形式安装Zabbix agent的说明，
请参阅[package
installation](/manual/installation/install_from_packages)章节。
若不希望使用软件包，可参考[安装-zabbix-守护进程](/manual/installation/install#安装-zabbix-守护进程)的安装说明。
::: noteimportant
通常情况下，32位Zabbix agents可在64位系统上运行，
但在某些情况下可能会失败。
:::
#### Installation steps
To install, double-click the downloaded MSI file.
Accept the license to proceed to the next step.
Specify the following parameters.
|Parameter|Description|
|--|--------|
|*Host name*|Specify host name.|
|*Zabbix server IP/DNS*|Specify IP/DNS of Zabbix server.|
|*Agent listen port*|Specify agent listen port (10050 by default).|
|*Server or Proxy for active checks*|Specify IP/DNS of Zabbix server/proxy for active agent checks.|
|*Enable PSK*|Mark the checkbox to enable TLS support via pre-shared keys.|
|*Add agent location to the PATH*|Add agent location to the PATH variable.|
Enter pre-shared key identity and value. This step is only available if
you checked *Enable PSK* in the previous step.
Select Zabbix components to install - [Zabbix agent
daemon](/manual/concepts/agent), [Zabbix
sender](/manual/concepts/sender), [Zabbix get](/manual/concepts/get).
Zabbix components along with the configuration file will be installed in
a *Zabbix Agent* folder in Program Files. zabbix\_agentd.exe will be set
up as Windows service with automatic startup.
#### 安装步骤
要安装，请双击下载的MSI file。
接受许可协议以继续下一步。
指定以下参数。
| 参数 | 描述 |
|--|--------|
| *Host name* | 指定 主机名。 |
| *Zabbix server IP/DNS* | 指定 Zabbix server 的IP/DNS。 |
| *Agent listen port* | 指定 agent 监听端口（默认为10050）。 |
| *Server or Proxy for active checks* | 为主动式 agent 检查指定 Zabbix server/proxy 的IP/DNS。 |
| *Enable PSK* | 勾选复选框以启用通过预共享密钥的TLS支持。 |
| *Add agent location to the PATH* | 将 agent 位置添加到PATH变量中。 |
输入预共享密钥标识和值。此步骤仅在
上一步中勾选了*启用PSK*时可用。
选择要安装的Zabbix组件 - [Zabbix agent
daemon](/manual/concepts/agent), [Zabbix
sender](/manual/concepts/sender), [Zabbix get](/manual/concepts/get)。
Zabbix组件及配置 file 将被安装到
Program Files中的*Zabbix Agent*文件夹。zabbix\_agentd.exe将被
设置为自动启动的Windows服务。
#### Installation
The official zabbix-web-service package is available in the [Zabbix repository](https://repo.zabbix.com/zabbix/).
To compile Zabbix web service [from sources](/manual/installation/install#installing_zabbix_web_service), specify the `--enable-webservice` configure option.
To configure Zabbix web service, update the [`zabbix_web_service.conf`](/manual/appendix/config/zabbix_web_service) configuration file parameters.
::: noteimportant
It is strongly recommended to set up encryption between Zabbix server and Zabbix web service [using certificates](/manual/encryption/using_certificates).
By default, data transmitted between Zabbix server and Zabbix web service is not encrypted, which can lead to unauthorized access.
:::
#### 安装
官方zabbix-web-service软件包可在[Zabbix repository](https://repo.zabbix.com/zabbix/)获取。
要编译Zabbix web服务[安装zabbix-web服务](/manual/installation/install#安装zabbix-web服务)，需指定`--enable-webservice`配置选项。
配置Zabbix web服务时，需update[`zabbix_web_service.conf`](/manual/appendix/config/zabbix_web_service)配置文件中的file参数。
::: noteimportant
强烈建议在Zabbix server与Zabbix web服务[using certificates](/manual/encryption/using_certificates)之间设置加密传输。
默认情况下，Zabbix server与Zabbix web服务间的数据传输未加密，可能导致未授权访问。
:::
#### Installation
To install Zabbix agent 2, the following options are available:
Windows:
- from a pre-compiled binary - download the binary and follow the instructions on the [Windows agent installation from MSI](/manual/installation/install_from_packages/win_msi) page
- from sources - see [Building Zabbix agent 2 on Windows](/manual/installation/install/building_zabbix_agent_2_on_windows)
Linux:
- from distribution packages - follow the instructions on the [Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=alma_linux&os_version=9&components=agent_2&db=&ws=) page, available by choosing your distribution and the Agent 2 component
- from sources - see [Installation from sources](/manual/installation/install#configure-the-sources); note that you must configure the sources by specifying the `--enable-agent2` configuration option
::: noteclassic
Zabbix agent 2 monitoring capabilities can be extended with plugins.
While built-in plugins are available out-of-the-box, loadable plugins must be installed separately.
For more information, see [Plugins](/manual/config/items/plugins#loadable).
:::
#### 安装
安装Zabbix agent 2有以下几种可选方式:
Windows系统:
- 使用预编译二进制文件 - 下载二进制文件并按照[Windows agent installation from MSI](/manual/installation/install_from_packages/win_msi)页面上的说明操作
- 从源代码编译 - 参考[Building Zabbix agent 2 on Windows](/manual/installation/install/building_zabbix_agent_2_on_windows)
Linux系统:
- 使用发行版软件包 - 按照[Zabbix packages](https://www.zabbix.com/download?zabbix=6.0&os_distribution=alma_linux&os_version=9&components=agent_2&db=&ws=)页面的说明操作，选择您的发行版和Agent 2组件
- 从源代码编译 - 参考[4-配置源代码](/manual/installation/install#4-配置源代码); 注意必须通过指定`--enable-agent2`配置选项来配置源代码
::: noteclassic
Zabbix agent 2的监控功能可以通过插件进行扩展。
内置插件开箱即用，可加载插件需要单独安装。
更多信息请参阅[可加载](/manual/config/items/plugins#可加载)。
:::
# Installation with OpenShift
# OpenShift 环境安装
#### Install
If installing Zabbix from sources, download the configuration file and
place it under conf/ in the webserver HTML documents subdirectory where
you copied Zabbix PHP files to.
{width="550"}
{width="350"}
::: notetip
Providing the webserver user has write access to conf/
directory the configuration file would be saved automatically and it
would be possible to proceed to the next step right away.
:::
Finish the installation.
{width="550"}
#### 安装
如果从源代码安装Zabbix，请下载配置文件file并
将其放置到您复制Zabbix PHP文件的web服务器HTML文档子目录下的conf/目录中。
{width="550"}
{width="350"}
::: notetip
如果web服务器用户对conf/目录具有写权限，
配置文件file将自动保存，
并且可以立即进行下一步操作。
:::
完成安装。
{width="550"}
#### Installing agent as Windows service
To install a single instance of Zabbix agent with the default
configuration file `c:\zabbix_agentd.conf`:
zabbix_agentd.exe --install
::: noteimportant
On a 64-bit system, a 64-bit Zabbix agent version
is required for all checks related to running 64-bit processes to work
correctly.
:::
If you wish to use a configuration file other than
`c:\zabbix_agentd.conf`, you should use the following command for
service installation:
zabbix_agentd.exe --config <your_configuration_file> --install
A full path to the configuration file should be specified.
Multiple instances of Zabbix agent can be installed as services like
this:
zabbix_agentd.exe --config <configuration_file_for_instance_1> --install --multiple-agents
zabbix_agentd.exe --config <configuration_file_for_instance_2> --install --multiple-agents
...
zabbix_agentd.exe --config <configuration_file_for_instance_N> --install --multiple-agents
The installed service should now be visible in Control Panel.
#### 将 agent 安装为 Windows 服务
要安装具有默认配置file `c:\zabbix_agentd.conf`的Zabbix agent单实例:
zabbix_agentd.exe --install
::: noteimportant
在64位系统上，所有与运行64位进程相关的检查都需要64位Zabbix agent version才能正常工作。
:::
如果希望使用`c:\zabbix_agentd.conf`以外的配置file，应使用以下命令进行服务安装:
zabbix_agentd.exe --config <your_configuration_file> --install
必须指定配置file的完整路径。
可以像这样安装多个Zabbix agent实例作为服务:
zabbix_agentd.exe --config <configuration_file_for_instance_1> --install --multiple-agents
zabbix_agentd.exe --config <configuration_file_for_instance_2> --install --multiple-agents
...
zabbix_agentd.exe --config <configuration_file_for_instance_N> --install --multiple-agents
安装的服务现在应该可以在控制面板中看到。
#### Installing agent
The agent can be installed using the graphical user interface or from
the command line, for example:
sudo installer -pkg zabbix_agent-6.0.12-macos-amd64-openssl.pkg -target /
Make sure to use the correct Zabbix package version in the command. It
must match the name of the downloaded package.
#### 安装agent
agent可通过图形用户界面或命令行安装，例如：
sudo installer -pkg zabbix_agent-6.0.12-macos-amd64-openssl.pkg -target /
请确保在命令中使用正确的Zabbix软件包version。它必须与下载的软件包名称匹配。
### Installing debuginfo packages
::: noteclassic
Debuginfo packages are currently available for RHEL/CentOS
versions 7, 6 and 5.
::: To enable debuginfo repository edit
*/etc/yum.repos.d/zabbix.repo* file. Change `enabled=0` to `enabled=1`
for zabbix-debuginfo repository.
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.4/rhel/8/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
This will allow you to install the zabbix-debuginfo package.
# yum install zabbix-debuginfo
This single package contains debug information for all binary Zabbix
components.
### 安装debuginfo包
::: noteclassic
Debuginfo包目前适用于 RHEL/CentOS 7, 6和5版本.
::: 为 zabbix-debuginfo 存储库启用debuginfo 存储库编辑
*/etc/yum.repos.d/zabbix.repo* file. 将 `enabled=0` 改为 `enabled=1`
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.4/rhel/8/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
就可以安装 zabbix-debuginfo包了。
# yum install zabbix-debuginfo
这个包包含所有二进制Zabbix组件的调试信息。
### Installing debuginfo packages
:::noteclassic
Debuginfo packages are currently available for RHEL/CentOS
versions 7, 6 and 5.
:::
To enable debuginfo repository, edit
*/etc/yum.repos.d/zabbix.repo* file. Change `enabled=0` to `enabled=1`
for zabbix-debuginfo repository.
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.4/rhel/8/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
This will allow you to install the zabbix-debuginfo package.
# yum install zabbix-debuginfo
This single package contains debug information for all binary Zabbix
components.
### 安装debuginfo包
:::noteclassic
Debuginfo软件包目前可用于 RHEL/CentOS 版本7, 6 和 5。
:::
要启用 debuginfo存储库，请编辑
*/etc/yum.repos.d/zabbix.repo* 文件。将 `enabled=0` 改为`enabled=1` 用于 zabbix-debuginfo 存储库。
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.4/rhel/8/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
然后就可以安装zabbix-debuginfo软件包了。
# yum install zabbix-debuginfo
这个包包含所有二进制Zabbix组件的debug信息。
### Installing debuginfo packages
:::noteclassic
Debuginfo packages are currently available for RHEL/CentOS
versions 7, 6 and 5.
:::
To enable debuginfo repository, edit
*/etc/yum.repos.d/zabbix.repo* file. Change `enabled=0` to `enabled=1`
for zabbix-debuginfo repository.
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.5/rhel/7/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
This will allow you to install the zabbix-debuginfo package.
# yum install zabbix-debuginfo
This single package contains debug information for all binary Zabbix
components.
### 安装debuginfo包
:::noteclassic
Debuginfo软件包目前可用于 RHEL/CentOS 版本7, 6 和 5。
:::
要启用 debuginfo 软件源，请编辑 */etc/yum.repos.d/zabbix.repo* 文件。将 `enabled=0` 改为`enabled=1` 用于 zabbix-debuginfo 存储库。
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.4/rhel/8/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
然后就可以安装zabbix-debuginfo软件包了。
# yum install zabbix-debuginfo
这个软件包里包含所有二进制 Zabbix 组件的 debug 信息。
### Installing debuginfo packages
:::noteclassic
Debuginfo packages are currently available for RHE versions 7, 6 and 5.
:::
To enable debuginfo repository, edit
*/etc/yum.repos.d/zabbix.repo* file. Change `enabled=0` to `enabled=1`
for zabbix-debuginfo repository.
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.5/rhel/7/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
This will allow you to install the zabbix-debuginfo package.
dnf install zabbix-debuginfo
This single package contains debug information for all binary Zabbix
components.
### 安装debuginfo包
:::noteclassic
Debuginfo软件包目前适用于RHE版本7、6和5。
:::
要启用debuginfo仓库，请编辑
*/etc/yum.repos.d/zabbix.repo* file。将`enabled=0`修改为`enabled=1`
以启用zabbix-debuginfo仓库。
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo - $basearch
baseurl=http://repo.zabbix.com/zabbix/5.5/rhel/7/$basearch/debuginfo/
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-ZABBIX-A14FE591
gpgcheck=1
这将允许您安装zabbix-debuginfo软件包。
dnf install zabbix-debuginfo
该单一软件包包含所有Zabbix二进制组件的调试信息。
### Installing debuginfo packages
To enable debuginfo repository edit */etc/zypp/repos.d/zabbix.repo*
file. Change `enabled=0` to `enabled=1` for zabbix-debuginfo repository.
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo
type=rpm-md
baseurl=http://repo.zabbix.com/zabbix/6.0/sles/15/x86_64/debuginfo/
gpgcheck=1
gpgkey=http://repo.zabbix.com/zabbix/6.0/sles/15/x86_64/debuginfo/repodata/repomd.xml.key
enabled=0
update=1
This will allow you to install zabbix-***<component>***-debuginfo
packages.
### 安装debuginfo包
要启用debuginfo仓库，请编辑 */etc/zypp/repos.d/zabbix.repo*
file。将 `enabled=0` 修改为 `enabled=1` 以启用zabbix-debuginfo仓库。
[zabbix-debuginfo]
name=Zabbix Official Repository debuginfo
type=rpm-md
baseurl=http://repo.zabbix.com/zabbix/6.0/sles/15/x86_64/debuginfo/
gpgcheck=1
gpgkey=http://repo.zabbix.com/zabbix/6.0/sles/15/x86_64/debuginfo/repodata/repomd.xml.key
enabled=0
update=1
这将允许您安装zabbix-***<组件>***-debuginfo
软件包。
##### Installing Elasticsearch and creating mapping
Final two steps of making things work are installing Elasticsearch
itself and creating mapping process.
To install Elasticsearch, please refer to [Elasticsearch installation
guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html).
::: noteclassic
Mapping is a data structure in Elasticsearch (similar to a
table in a database). Mapping for all history data types is available
here: `database/elasticsearch/elasticsearch.map`.
:::
::: notewarning
Creation of mapping is mandatory. Some functionality
will be broken if mapping is not created according to the
instruction.
:::
To create mapping for `text` type, send the following request to
Elasticsearch:
``` {.java}
curl -X PUT \
http://your-elasticsearch.here:9200/text \
-H 'content-type:application/json' \
-d '{
"settings": {
"index": {
"number_of_replicas": 1,
"number_of_shards": 5
}
},
"mappings": {
"properties": {
"itemid": {
"type": "long"
},
"clock": {
"format": "epoch_second",
"type": "date"
},
"value": {
"fields": {
"analyzed": {
"index": true,
"type": "text",
"analyzer": "standard"
}
},
"index": false,
"type": "text"
}
}
}
}'
```
Similar request is required to be executed for `Character` and `Log`
history values mapping creation with corresponding type correction.
::: noteclassic
To work with Elasticsearch, please refer to the [Requirements](/manual/installation/requirements#serverproxy) for additional
information.
:::
::: noteclassic
[Housekeeper](/manual/web_interface/frontend_sections/administration/general#housekeeper)
is not deleting any data from Elasticsearch.
:::
##### 安装Elasticsearch并创建映射
实现功能运作的最后两个步骤是安装Elasticsearch本身以及创建映射过程。
要安装Elasticsearch，请参考[Elasticsearch installation
guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html)。
::: noteclassic
映射是Elasticsearch中的一种数据结构（类似于数据库中的表）。所有历史数据类型的映射可在此处获取：`database/elasticsearch/elasticsearch.map`。
:::
::: notewarning
创建映射是强制性的。如果未按照说明创建映射，某些功能将无法正常工作。
:::
要为`text`类型create映射，请向Elasticsearch发送以下请求：
```{.java}
curl -X PUT \
http://your-elasticsearch.here:9200/text \
-H 'content-type:application/json' \
-d '{
"settings": {
"index": {
"number_of_replicas": 1,
"number_of_shards": 5
}
},
"mappings": {
"properties": {
"itemid": {
"type": "long"
},
"clock": {
"format": "epoch_second",
"type": "date"
},
"value": {
"fields": {
"analyzed": {
"index": true,
"type": "text",
"analyzer": "standard"
}
},
"index": false,
"type": "text"
}
}
}
}'
```
对于`Character`和`Log`历史值映射的创建，需要执行类似的请求，并相应修正类型。
::: noteclassic
要使用Elasticsearch，请参阅[serverproxy](/manual/installation/requirements#serverproxy)获取更多信息。
:::
::: noteclassic
[管家服务](/manual/web_interface/frontend_sections/administration/general#管家服务)
不会从Elasticsearch中删除任何数据。
:::
##### Installing frontend
Please see [Web interface installation](/manual/installation/frontend)
page for information about Zabbix frontend installation wizard.
##### 安装前端
请参阅[Web interface installation](/manual/installation/frontend)页面了解Zabbix前端安装向导的相关信息。
#### Installing locales
To list all installed languages, run:
locale -a
If some languages that are needed are not listed, open the
*/etc/locale.gen* file and uncomment the required locales. Since Zabbix
uses UTF-8 encoding, you need to select locales with UTF-8 charset.
Now, run:
locale-gen
Restart the web server.
The locales should now be installed. It may be required to reload Zabbix
frontend page in browser using Ctrl + F5 for new languages to appear.
#### 安装区域设置
要列出所有已安装的语言，run：
locale -a
如果所需语言未列出，请打开
*/etc/locale.gen* file 并取消注释所需的区域设置。由于Zabbix
使用UTF-8编码，需选择带有UTF-8字符集的区域设置。
现在，run：
locale-gen
重启Web服务器。
区域设置现在应已安装。可能需要使用Ctrl + F5在浏览器中重新加载Zabbix
前端页面以使新语言显示。
#### Installing MIB files
On Debian-based systems:
apt install snmp-mibs-downloader
download-mibs
On RedHat-based systems:
dnf install net-snmp-libs
#### 安装MIB文件
在基于Debian的系统上:
apt install snmp-mibs-downloader
download-mibs
在基于RedHat的系统上:
dnf install net-snmp-libs
#### Installing MinGW Compiler
1\. Download MinGW-w64 with SJLJ (set jump/long jump) Exception Handling
and Windows threads (for example
*x86\_64-8.1.0-release-win32-sjlj-rt\_v6-rev0.7z*)\
2. Extract and move to *c:\\mingw*\
3. Setup environmental variable
@echo off
set PATH=%PATH%;c:\mingw\bin
cmd
When compiling use Windows prompt instead of MSYS terminal provided by
MinGW
#### 安装MinGW编译器
1\. 下载带有SJLJ（set jump/long jump）异常处理
和Windows线程的MinGW-w64（例如
*x86\_64-8.1.0-release-win32-sjlj-rt\_v6-rev0.7z*)\
2. 解压并移动到*c:\\mingw*\
3. 设置环境变量
@echo off
set PATH=%PATH%;c:\mingw\bin
cmd
编译时使用Windows命令提示符而非MinGW提供的MSYS终端
#### Installing unixODBC drivers
A unixODBC database driver should be installed for the database, which
will be monitored. unixODBC has a list of supported databases and
drivers: <http://www.unixodbc.org/drivers.html>. In some Linux
distributions database drivers are included in package repositories.
Installing MySQL database driver on Ubuntu/Debian systems using the *apt* package manager:
apt install odbc-mariadb
Installing MySQL database driver on RedHat/Fedora-based systems using the *dnf* package manager:
dnf install mariadb-connector-odbc
Installing MySQL database driver on SUSE-based systems using the *zypper* package manager:
zypper in mariadb-connector-odbc
#### 安装 unixODBC 驱动
对于需要监控的数据库，应安装相应的unixODBC数据库驱动。unixODBC官网提供了支持的数据库及驱动列表：<http://www.unixodbc.org/drivers.html>。部分Linux发行版的软件仓库中已包含数据库驱动包。
在Ubuntu/Debian系统上使用*apt*包管理器安装MySQL数据库驱动：
apt install odbc-mariadb
在基于RedHat/Fedora的系统上使用*dnf*包管理器安装MySQL数据库驱动：
dnf install mariadb-connector-odbc
在基于SUSE的系统上使用*zypper*包管理器安装MySQL数据库驱动：
zypper in mariadb-connector-odbc
#### Installing unixODBC
The suggested way of installing unixODBC is to use the Linux operating
system default package repositories. In the most popular Linux
distributions unixODBC is included in the package repository by default.
If it's not available, it can be obtained at the unixODBC homepage:
<http://www.unixodbc.org/download.html>.
Installing unixODBC on Ubuntu/Debian systems using the *apt* package manager:
apt install unixodbc unixodbc-dev
Installing unixODBC on RedHat/Fedora-based systems using the *dnf* package manager:
dnf install unixODBC unixODBC-devel
Installing unixODBC on SUSE-based systems using the *zypper* package manager:
zypper in unixODBC-devel
::: noteclassic
The unixodbc-dev or unixODBC-devel package is needed to compile Zabbix with
unixODBC support.
:::
#### 安装 unixODBC
建议的unixODBC安装方式是使用Linux操作系统默认的软件包仓库。在大多数主流Linux发行版中，unixODBC默认已包含在软件仓库中。若不可用，可从unixODBC官网获取：
<http://www.unixodbc.org/download.html>.
在Ubuntu/Debian系统上使用*apt*包管理器安装unixODBC：
apt install unixodbc unixodbc-dev
在基于RedHat/Fedora的系统上使用*dnf*包管理器安装unixODBC：
dnf install unixODBC unixODBC-devel
在基于SUSE的系统上使用*zypper*包管理器安装unixODBC：
zypper in unixODBC-devel
::: noteclassic
编译支持unixODBC的Zabbix时需要unixodbc-dev或unixODBC-devel软件包。
:::
#### Installing Zabbix
If installing Zabbix directly from [Zabbix git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse),
translation files should be generated manually. To generate translation
files, run:
make gettext
locale/make_mo.sh
This step is not needed when installing Zabbix from packages or source
tar.gz files.
#### 安装Zabbix
如果直接从[Zabbix git
repository](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse)安装Zabbix，
则需要手动生成翻译文件。要generate翻译
文件，请run：
make gettext
locale/make_mo.sh
当从软件包或源代码tar.gz文件安装Zabbix时，
不需要此步骤。
#### Installing Zabbix Operator
#### 安装 Zabbix Operator
### Integer history
The integer history object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|clock|timestamp|Time when that value was received.|
|itemid|string|ID of the related item.|
|ns|integer|Nanoseconds when the value was received.|
|value|integer|Received value.|
### 历史数据
integer历史object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| clock | timestamp | 接收该值的时间。 |
| itemid | string | 相关监控项的ID。 |
| ns | integer | 接收该值的纳秒时间。 |
| value | integer | 接收到的值。 |
### Integer trend
The integer trend object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|clock|timestamp|Timestamp of an hour for which the value was calculated. E. g. timestamp of 04:00:00 means values calculated for period 04:00:00-04:59:59.|
|itemid|integer|ID of the related item.|
|num|integer|Number of values that were available for the hour.|
|value\_min|integer|Hourly minimum value.|
|value\_avg|integer|Hourly average value.|
|value\_max|integer|Hourly maximum value.|
### 整型趋势
integer趋势object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| clock | timestamp | 计算值对应的小时时间戳。例如04:00:00的时间戳表示计算04:00:00-04:59:59期间的值。 |
| itemid | integer | 关联监控项的ID。 |
| num | integer | 该小时内可用的数值数量。 |
| value\_min | integer | 每小时最小值。 |
| value\_avg | integer | 每小时平均值。 |
| value\_max | integer | 每小时最大值。 |
##### Interface creation when adding hosts
When hosts are added as a result of network discovery, they get
interfaces created according to these rules:
- the services detected - for example, if an SNMP check succeeded, an
SNMP interface will be created
- if a host responded both to Zabbix agent and SNMP requests, both
types of interfaces will be created
- if uniqueness criteria are Zabbix agent or SNMP-returned data, the
first interface found for a host will be created as the default one.
Other IP addresses will be added as additional interfaces.
Action's conditions (such as Host IP) do not impact adding interfaces.
*Note* that this will work if all interfaces are discovered by the
same discovery rule. If a different discovery rule discovers
a different interface of the same host, an additional host will be added.
- if a host responded to agent checks only, it will be created with an
agent interface only. If it would start responding to SNMP later,
additional SNMP interfaces would be added.
- if 3 separate hosts were initially created, having been discovered
by the "IP" uniqueness criteria, and then the discovery rule is
modified so that hosts A, B and C have identical uniqueness criteria
result, B and C are created as additional interfaces for A, the
first host. The individual hosts B and C remain. In *Monitoring →
Discovery* the added interfaces will be displayed in the "Discovered
device" column, in black font and indented, but the "Monitored host"
column will only display A, the first created host.
"Uptime/Downtime" is not measured for IPs that are considered to be
additional interfaces.
##### 添加主机时的接口创建
当主机作为网络发现的结果被添加时，它们get
根据以下规则创建接口：
- 检测到的服务 - 例如，如果SNMP检查成功，将创建一个SNMP接口
- 如果一个主机同时响应Zabbix agent和SNMP请求，则会创建两种类型的接口
- 如果唯一性标准是Zabbix agent或SNMP返回的数据，则将为一个主机找到的第一个接口创建为默认接口。其他IP地址将作为附加接口添加。
操作条件（如主机 IP）不会影响接口的添加。
*注意*：这仅在所有接口都由同一发现规则发现时有效。如果不同的发现规则发现同一主机的不同接口，则会添加额外的主机。
- 如果一个主机仅响应agent检查，则它将仅创建agent接口。如果之后开始响应SNMP，则会添加额外的SNMP接口。
- 如果最初通过"IP"唯一性标准发现了3个独立的主机，然后修改发现规则使得主机 A、B和C具有相同的唯一性标准结果，则B和C将作为A（第一个主机）的附加接口创建。单独的主机 B和C仍然存在。在*监控 → 发现*中，添加的接口将以黑色字体和缩进显示在"已发现设备"列中，但"受监控主机"列仅显示A（第一个创建的主机）。
对于被视为附加接口的IP，不测量"运行时间/停机时间"。
### Internal authentication
The *Authentication* tab allows defining custom password complexity
requirements for internal Zabbix users.
The following password policy options can be configured:
|Parameter|Description|
|--|--------|
|*Minimum password length*|By default, the minimum password length is set to 8. Supported range: 1-70. Note that passwords longer than 72 characters will be truncated.|
|*Password must contain*|Mark one or several checkboxes to require usage of specified characters in a password:<br>-an uppercase and a lowercase Latin letter<br>-a digit<br>-a special character<br><br>Hover over the question mark to see a hint with the list of characters for each option.|
|*Avoid easy-to-guess passwords*|If marked, a password will be checked against the following requirements:<br>- must not contain user's name, surname, or username<br>- must not be one of the common or context-specific passwords.<br><br>The list of common and context-specific passwords is generated automatically from the list of NCSC "Top 100k passwords", the list of SecLists "Top 1M passwords" and the list of Zabbix context-specific passwords. Internal users will not be allowed to set passwords included in this list as such passwords are considered weak due to their common use.|
Changes in password complexity requirements will not affect existing
user passwords, but if an existing user chooses to change a password,
the new password will have to meet current requirements. A hint with the
list of requirements will be displayed next to the *Password* field in
the [user profile](/manual/web_interface/user_profile) and in the [user
configuration form](/manual/config/users_and_usergroups/user) accessible
from the *Administration→Users* menu.
### 内部认证
*认证*选项卡允许为Zabbix内部用户定义自定义密码复杂度要求
可配置以下密码策略选项:
| 参数 | 描述 |
|--|--------|
| *Minimum password length* | 默认最小密码长度为8. 支持范围:1-70. 注意超过72个字符的密码将被截断. |
| *Password must contain* | 勾选一个或多个复选框以要求密码中包含指定字符类型:<br>- 大写和小写拉丁字母<br>- 数字<br>- 特殊字符<br><br>将鼠标悬停在问号上可查看每个选项对应的字符列表提示. |
| *Avoid easy-to-guess passwords* | 若勾选，密码将检查是否符合以下要求:<br>- 不得包含用户姓名或用户名<br>- 不得是常见或上下文相关密码<br><br>常见及上下文相关密码列表自动生成自NCSC "Top 100k密码"清单、SecLists "Top 1M密码"清单以及Zabbix上下文相关密码清单. 系统将禁止内部用户设置该列表中的密码，因这些密码由于普遍使用而被视为弱密码. |
密码复杂度要求的变更不会影响现有用户密码，但当现有用户选择修改密码时，新密码必须符合当前要求. 在[user profile](/manual/web_interface/user_profile)及通过*管理→用户*菜单访问的[user
configuration form](/manual/config/users_and_usergroups/user)中，*密码*字段旁将显示包含要求列表的提示信息.
#### Internal event actions
The following conditions can be set for actions based on internal
events:
|Condition type|Supported operators|Description|
|--|--|------|
|*Event type*|equals|**Item in "not supported" state** - matches events where an item goes from a 'normal' to 'not supported' state<br>**Low-level discovery rule in "not supported" state** - matches events where a low-level discovery rule goes from a 'normal' to 'not supported' state<br>**Trigger in "unknown" state** - matches events where a trigger goes from a 'normal' to 'unknown' state|
|*Host group*|equals<br>does not equal|Specify host groups or host groups to exclude.<br>**equals** - event belongs to this host group.<br>**does not equal** - event does not belong to this host group.|
|*Tag name*|equals<br>does not equal<br>contains<br>does not contain|Specify event tag or event tag to exclude.<br>**equals** - event has this tag<br>**does not equal** - event does not have this tag<br>**contains** - event has a tag containing this string<br>**does not contain** - event does not have a tag containing this string|
|*Tag value*|equals<br>does not equal<br>contains<br>does not contain|Specify event tag and value combination or tag and value combination to exclude.<br>**equals** - event has this tag and value<br>**does not equal** - event does not have this tag and value<br>**contains** - event has a tag and value containing these strings<br>**does not contain** - event does not have a tag and value containing these strings|
|*Template*|equals<br>does not equal|Specify templates or templates to exclude.<br>**equals** - event belongs to an item/trigger/low-level discovery rule inherited from this template.<br>**does not equal** - event does not belong to an item/trigger/low-level discovery rule inherited from this template.|
|*Host*|equals<br>does not equal|Specify hosts or hosts to exclude.<br>**equals** - event belongs to this host.<br>**does not equal** - event does not belong to this host.|
#### 内部事件动作
基于内部事件可设置以下动作条件:
| 条件类型 | 支持的操作符 | 描述 |
|--|--|------|
| *Event type* | equals | **监控项处于"不支持"状态** - 匹配监控项从'正常'变为'不支持'状态的事件<br>**低阶发现规则处于"不支持"状态** - 匹配低阶发现规则从'正常'变为'不支持'状态的事件<br>**触发器处于"未知"状态** - 匹配触发器从'正常'变为'未知'状态的事件 |
| *Host group* | equals<br>does not equal | 指定主机组或要排除的主机组<br>**等于** - 事件属于该主机组<br>**不等于** - 事件不属于该主机组 |
| *Tag name* | equals<br>does not equal<br>contains<br>does not contain | 指定事件标签或要排除的事件标签<br>**等于** - 事件具有此标签<br>**不等于** - 事件不具有此标签<br>**包含** - 事件具有包含此string的标签<br>**不包含** - 事件不具有包含此string的标签 |
| *Tag value* | equals<br>does not equal<br>contains<br>does not contain | 指定事件标签与值组合或要排除的标签与值组合<br>**等于** - 事件具有此标签和值<br>**不等于** - 事件不具有此标签和值<br>**包含** - 事件具有包含这些字符串的标签和值<br>**不包含** - 事件不具有包含这些字符串的标签和值 |
| *Template* | equals<br>does not equal | 指定模板或要排除的模板<br>**等于** - 事件属于从此模板继承的监控项/触发器/低阶发现规则<br>**不等于** - 事件不属于从此模板继承的监控项/触发器/低阶发现规则 |
| *Host* | equals<br>does not equal | 指定主机或要排除的主机<br>**等于** - 事件属于该主机<br>**不等于** - 事件不属于该主机 |
#### Internal item for monitoring high-availability manager
The `ha manager` (high-availability manager) process now can be monitored by the zabbix[process*] [internal item](/manual/config/items/itemtypes/internal#supported-checks).
#### 高可用性管理器监控的内部 监控项
`ha manager` (高可用性管理器) 进程现在可以通过 zabbix[process*] [支持的检查](/manual/config/items/itemtypes/internal#支持的检查) 进行监控.
#### Internal queue items
There are also another two items specifically allowing to remote query
internal queue stats on another Zabbix instance:
- `zabbix[stats,<ip>,<port>,queue,<from>,<to>]` internal item - for
direct internal queue queries to remote Zabbix server/proxy
- `zabbix.stats[<ip>,<port>,queue,<from>,<to>]` agent item - for
agent-based internal queue queries to remote Zabbix server/proxy
See also: [Internal items](/manual/config/items/itemtypes/internal),
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
#### 内部队列 监控项
还有另外两个监控项专门允许远程query
另一个Zabbix实例的内部队列统计信息:
- `zabbix[stats,<ip>,<port>,queue,<from>,<to>]` 内部监控项 - 用于
直接内部队列queries到远程Zabbix server/proxy
- `zabbix.stats[<ip>,<port>,queue,<from>,<to>]` agent 监控项 - 用于
agent-based internal queue queries to remote Zabbix server/proxy
另请参阅: [Internal items](/manual/config/items/itemtypes/internal),
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
#### Internal workings of bulk processing
Zabbix server and proxy query SNMP devices for
multiple values in a single request. This affects several types of SNMP
items:
- regular SNMP items
- SNMP items [with dynamic
indexes](/manual/config/items/itemtypes/snmp/dynamicindex)
- SNMP [low-level discovery
rules](/manual/discovery/low_level_discovery/examples/snmp_oids)
All SNMP items on a single interface with identical parameters are
scheduled to be queried at the same time. The first two types of items
are taken by pollers in batches of at most 128 items, whereas low-level
discovery rules are processed individually, as before.
On the lower level, there are two kinds of operations performed for
querying values: getting multiple specified objects and walking an OID
tree.
For "getting", a GetRequest-PDU is used with at most 128 variable
bindings. For "walking", a GetNextRequest-PDU is used for SNMPv1 and
GetBulkRequest with "max-repetitions" field of at most 128 is used for
SNMPv2 and SNMPv3.
Thus, the benefits of bulk processing for each SNMP item type are
outlined below:
- regular SNMP items benefit from "getting" improvements;
- SNMP items with dynamic indexes benefit from both "getting" and
"walking" improvements: "getting" is used for index verification and
"walking" for building the cache;
- SNMP low-level discovery rules benefit from "walking" improvements.
However, there is a technical issue that not all devices are capable of
returning 128 values per request. Some always return a proper response,
but others either respond with a "tooBig(1)" error or do not respond at
all once the potential response is over a certain limit.
In order to find an optimal number of objects to query for a given
device, Zabbix uses the following strategy. It starts cautiously with
querying 1 value in a request. If that is successful, it queries 2
values in a request. If that is successful again, it queries 3 values in
a request and continues similarly by multiplying the number of queried
objects by 1.5, resulting in the following sequence of request sizes: 1,
2, 3, 4, 6, 9, 13, 19, 28, 42, 63, 94, 128.
However, once a device refuses to give a proper response (for example,
for 42 variables), Zabbix does two things.
First, for the current item batch it halves the number of objects in a
single request and queries 21 variables. If the device is alive, then
the query should work in the vast majority of cases, because 28
variables were known to work and 21 is significantly less than that.
However, if that still fails, then Zabbix falls back to querying values
one by one. If it still fails at this point, then the device is
definitely not responding and request size is not an issue.
The second thing Zabbix does for subsequent item batches is it starts
with the last successful number of variables (28 in our example) and
continues incrementing request sizes by 1 until the limit is hit. For
example, assuming the largest response size is 32 variables, the
subsequent requests will be of sizes 29, 30, 31, 32, and 33. The last
request will fail and Zabbix will never issue a request of size 33
again. From that point on, Zabbix will query at most 32 variables for
this device.
If large queries fail with this number of variables, it can mean one of
two things. The exact criteria that a device uses for limiting response
size cannot be known, but we try to approximate that using the number of
variables. So the first possibility is that this number of variables is
around the device's actual response size limit in the general case:
sometimes response is less than the limit, sometimes it is greater than
that. The second possibility is that a UDP packet in either direction
simply got lost. For these reasons, if Zabbix gets a failed query, it
reduces the maximum number of variables to try to get deeper into the
device's comfortable range, but (starting from 2.2.8) only up to two
times.
In the example above, if a query with 32 variables happens to fail,
Zabbix will reduce the count to 31. If that happens to fail, too, Zabbix
will reduce the count to 30. However, Zabbix will not reduce the count
below 30, because it will assume that further failures are due to UDP
packets getting lost, rather than the device's limit.
If, however, a device cannot handle bulk requests properly for other
reasons and the heuristic described above does not work, since Zabbix
2.4 there is a "Use bulk requests" setting for each interface that
allows to disable bulk requests for that device.
#### 批量处理的内部工作原理
Zabbix server和proxyquerySNMP设备
单个请求中的多个值。这会影响多种类型的SNMP
监控项:
- 常规SNMP 监控项
- SNMP 监控项 [with dynamic
indexes](/manual/config/items/itemtypes/snmp/dynamicindex)
- SNMP [low-level discovery
rules](/manual/discovery/low_level_discovery/examples/snmp_oids)
单个接口上所有具有相同参数的SNMP 监控项
计划在同一时间进行查询。前两种类型的监控项
由轮询器批量获取，每批最多128个监控项，而低级
发现规则将如之前一样单独处理。
在底层，执行的操作主要分为两类
查询数值：获取多个指定的objects并遍历OID
tree.
对于"获取"操作，使用最多包含128个变量的GetRequest-PDU
对于"walking"操作，SNMPv1使用GetNextRequest-PDU而
使用"max-repetitions"字段值最大为128的GetBulkRequest进行
SNMPv2 和 SNMPv3.
因此，每种SNMP 监控项类型的批量处理优势在于
如下所述：
- 常规SNMP 监控项受益于"获取"改进;
- 具有动态索引的SNMP 监控项同时受益于"获取"和
"walking"改进：使用"getting"进行索引验证
"walking"用于构建缓存;
- SNMP低级发现规则受益于"walking"改进。
然而，存在一个技术问题，即并非所有设备都具备此能力
每个请求返回128个值。其中一些总是返回正确的响应,
但其他设备要么返回"tooBig(1)"错误，要么根本不响应
一旦潜在响应超过某个限制。
为了找到给定情况下最佳的objects数量以query
设备，Zabbix采用以下策略。它首先谨慎地开始
在一个请求中查询1个值。如果成功，则queries 2
请求中的值。如果再次成功，它将queries 3个值
一个请求并继续类似地乘以查询的数量
objects 乘以 1.5，得到以下请求大小序列：1,
2, 3, 4, 6, 9, 13, 19, 28, 42, 63, 94, 128.
然而，一旦设备拒绝提供正确响应（例如，
对于42个变量，Zabbix会执行两项操作。
首先，对于当前的监控项批次，它将objects的数量减半
单次请求和queries 21个变量。如果设备处于活动状态，则
query在绝大多数情况下应该都能正常工作，因为28
已知可正常工作的变量数量远超过21个。
然而，如果仍然失败，Zabbix将回退到查询值
逐个尝试。如果此时仍然失败，则该设备
未响应且请求大小不是问题
Zabbix为后续的监控项批次所做的第二件事是开始
带有最后一次成功的变量数量（在我们的示例中为28）和
继续以1为增量递增请求大小，直到达到限制为止。对于
例如，假设最大响应大小为32个变量
后续请求的大小将为29、30、31、32和33。最后一个
请求将失败且Zabbix永远不会问题大小为33的请求
再次. 从那时起, Zabbix将最多query32个变量
此设备。
如果大型queries在此变量数量下失败，可能意味着以下情况之一
两件事。设备用于限制响应的确切标准
大小无法确定，但我们尝试通过数量来近似估算
变量。因此第一种可能性是这个变量数量
在一般情况下围绕设备的实际响应大小限制:
有时响应小于限制值，有时则超过限制值
那。第二种可能性是任一方向的UDP数据包
只是丢失了。因此，如果Zabbix收到一个失败的query，它
减少尝试get更深层次时的最大变量数
设备的舒适范围，但（从2.2.8版本开始）最多仅限两个
时间
在上面的示例中，如果包含32个变量的query恰好失败，
Zabbix会将计数减少到31。如果这次也失败，Zabbix
将计数减少至30。然而，Zabbix不会减少计数
低于30，因为它会假定后续故障是由于UDP导致的
数据包丢失，而非设备限制。
然而，如果设备因其他原因无法正确处理批量请求
由于Zabbix的原因以及上述启发式方法失效
2.4 每个接口都有一个"使用批量请求"设置
允许禁用该设备的批量请求。
In [trigger action](/manual/config/notifications/action/conditions#trigger-actions) configuration, the condition type *Trigger name* has been renamed *Event name* to better describe its function.
Note that by default, the event name matches the trigger name unless a custom event name is specified in [trigger configuration](/manual/config/triggers/trigger).
在[触发器动作](/manual/config/notifications/action/conditions#触发器动作)配置中，条件类型*Trigger name*已更名为*Event name*以更准确地描述其功能。
请注意，默认情况下事件名称与触发器名称一致，除非在[trigger configuration](/manual/config/triggers/trigger)中指定了自定义事件名称。
#### Introduction
MIB stands for the Management Information Base. MIB files allow to use textual representation of an OID (Object Identifier).
It is possible to use raw OIDs when monitoring SNMP devices with Zabbix,
but if you feel more comfortable using textual representation, you need to install MIB files.
For example,
ifHCOutOctets
is textual representation of the OID
1.3.6.1.2.1.31.1.1.1.10
#### 介绍
MIB代表管理信息库。MIB文件允许使用OID(object标识符)的文本表示形式。
在使用Zabbix监控SNMP设备时可以直接使用原始OID，
但如果您更习惯使用文本表示形式，则需要安装MIB文件。
例如，
ifHCOutOctets
是OID
1.3.6.1.2.1.31.1.1.1.10
的文本表示形式
Introduction of loadable plugins caused the following configuration parameter changes:
- *Plugins.\<PluginName>.Path* parameter has been moved to *Plugins.\<PluginName>.System.Path*.
- *Plugins.\<PluginName>.Capacity* parameter, while still supported, has been deprecated, please use
*Plugins.\<PluginName>.System.Capacity* instead.
可加载插件的引入导致了以下配置参数变更：
- *Plugins.\<PluginName>.Path* 参数已移至 *Plugins.\<PluginName>.System.Path*。
- *Plugins.\<PluginName>.Capacity* 参数虽然仍受支持，但已被弃用，请改用
*Plugins.\<PluginName>.System.Capacity*。
#### Invalid regular expression in proc.* items
**proc.\*** agent items will now become 'not supported' if an invalid regular expression is supplied.
#### proc.* 中的正则表达式无效 监控项
**proc.\*** agent 监控项 在提供无效正则表达式时将变为"不受支持"状态.
#### Invalid regular expressions after switching to PCRE2
In Zabbix 6.0 support for PCRE2 has been added. Even though PCRE is still supported, Zabbix installation packages for RHEL 7 and newer, SLES (all versions), Debian 9 and newer, Ubuntu 16.04 and newer have been updated to use PCRE2. While providing many benefits, switching to PCRE2 may cause certain existing PCRE regexp patterns becoming invalid or behaving differently. In particular, this affects the pattern *\^[\\w-\\.]*. In order to make this regexp valid again without affecting semantics, change the expression to *\^[-\\w\\.]* . This happens due to the fact that PCRE2 treats the dash sign as a delimiter, creating a range inside a character class.
The following Zabbix installation packages have been updated and now use PCRE2: RHEL 7 and newer, SLES (all versions), Debian 9 and newer, Ubuntu 16.04 and newer.
#### 切换到PCRE2后无效的正则表达式
在Zabbix 6.0中增加了对PCRE2的支持。尽管PCRE仍然受支持，但针对RHEL 7及以上版本、SLES（所有版本）、Debian 9及以上版本、Ubuntu 16.04及以上版本的Zabbix安装包已更新为使用PCRE2。虽然带来诸多优势，但切换到PCRE2可能导致某些现有的PCRE正则表达式模式失效或行为异常。特别是这会影响到模式*\^[\\w-\\.]*。要使该正则表达式重新生效且不影响语义，需将表达式修改为*\^[-\\w\\.]*。这是由于PCRE2将短横线视为分隔符，在字符类内部创建范围所致。
以下Zabbix安装包已更新并开始使用PCRE2：RHEL 7及以上版本、SLES（所有版本）、Debian 9及以上版本、Ubuntu 16.04及以上版本。
#### Invalid regular expressions after switching to PCRE2
In Zabbix 6.0 support for PCRE2 has been added. Even though PCRE is still supported, Zabbix installation packages for RHEL/CentOS 7 and newer, SLES (all versions), Debian 9 and newer, Ubuntu 16.04 and newer have been updated to use PCRE2. While providing many benefits, switching to PCRE2 may cause certain existing PCRE regexp patterns becoming invalid or behaving differently. In particular, this affects the pattern *^[\w-\.]*. In order to make this regexp valid again without affecting semantics, change the expression to *^[-\w\.]* . This happens due to the fact that PCRE2 treats the dash sign as a delimiter, creating a range inside a character class.
The following Zabbix installation packages have been updated and now use PCRE2:
#### Invalid regular expressions after switching to PCRE2
In Zabbix 6.0 support for PCRE2 has been added. Even though PCRE is still supported, all Zabbix installation packages have been updated to use PCRE2. While providing many benefits, switching to PCRE2 may cause certain existing PCRE regexp patterns becoming invalid or behaving differently. In particular, this affects the pattern *^[\w-\.]*. In order to make this regexp valid again without affecting semantics, change the expression to *^[-\w\.]* . This happens due to the fact that PCRE2 treats the dash sign as a delimiter, creating a range inside a character class.
#### Inventory details
The **Overview** tab contains some general information about the host, latest
monitoring data, and host configuration options:
{width="600"}
The **Details** tab contains all available inventory details for the
host:
{width="600"}
The completeness of inventory data depends on how much inventory
information is maintained with the host. If no information is
maintained, the *Details* tab is disabled.
#### 资产清单详情
**概览**选项卡包含有关主机的一些常规信息、最新监控数据以及主机配置选项：
{width="600"}
**详情**选项卡包含该主机的所有可用资产清单详细信息：
{width="600"}
资产清单数据的完整性取决于主机维护了多少资产清单信息。如果未维护任何信息，则*详情*选项卡将被禁用。
#### Inventory macros
There are host inventory macros {INVENTORY.\*} available for use in
notifications, for example:
"Server in {INVENTORY.LOCATION1} has a problem, responsible person is
{INVENTORY.CONTACT1}, phone number {INVENTORY.POC.PRIMARY.PHONE.A1}."
For more details, see the [Supported macros](/manual/appendix/macros/supported_by_location) page.
#### 资产清单宏
在通知中可使用主机资产宏{INVENTORY.\*}，例如：
"位于{INVENTORY.LOCATION1}的服务器出现问题，负责人是
{INVENTORY.CONTACT1}，联系电话{INVENTORY.POC.PRIMARY.PHONE.A1}。"
更多详情请参阅[Supported macros](/manual/appendix/macros/supported_by_location)页面。
##### Inventory mode selection
Inventory mode can be selected in the host configuration form.
Inventory mode by default for new hosts is selected based on the
*Default host inventory mode* setting in *Administration* → *General* →
*[Other](/manual/web_interface/frontend_sections/administration/general#other_parameters)*.
For hosts added by network discovery or autoregistration actions, it is
possible to define a *Set host inventory mode* operation selecting
manual or automatic mode. This operation overrides the *Default host
inventory mode* setting.
##### 资产清单模式选择
资产清单模式可在主机配置表单中选择.
新主机的默认资产清单模式基于
*管理* → *常规* → *[其他参数](/manual/web_interface/frontend_sections/administration/general#其他参数)*中的
*默认主机资产清单模式*设置.
对于通过网络发现或自动注册操作添加的主机,
可以定义*设置主机资产清单模式*操作来选择
手动或自动模式. 此操作会覆盖*默认主机
资产清单模式*设置.
#### Inventory overview
The details of all existing inventory data are available in the
*Inventory* menu.
In *Inventory → Overview* you can get a host count by various fields of
the inventory.
In *Inventory → Hosts* you can see all hosts that have inventory
information. Clicking on the host name will reveal the inventory details
in a form.
{width="600"}
The **Overview** tab shows:
|Parameter|Description|
|--|--------|
|*Host name*|Name of the host.<br>Clicking on the name opens a menu with the scripts defined for the host.<br>Host name is displayed with an orange icon, if the host is in maintenance.|
|*Visible name*|Visible name of the host (if defined).|
|*Host (Agent, SNMP, JMX, IPMI)<br>interfaces*|This block provides details of the interfaces configured for the host.|
|*OS*|Operating system inventory field of the host (if defined).|
|*Hardware*|Host hardware inventory field (if defined).|
|*Software*|Host software inventory field (if defined).|
|*Description*|Host description.|
|*Monitoring*|Links to monitoring sections with data for this host: *Web*, *Latest data*, *Problems*, *Graphs*, *Dashboards*.|
|*Configuration*|Links to configuration sections for this host: *Host*, *Items*, *Triggers*, *Graphs*, *Discovery*, *Web*.<br>The number of configured entities is listed after each link.|
The **Details** tab shows all inventory fields that are populated (are
not empty).
#### 资产清单概览
所有现有资产数据的详细信息可在
*资产*菜单中查看。
在*资产 → 概览*中，您可以get按资产各字段统计一个主机数量。
在*资产 → 主机*中，您可以查看所有包含资产
信息的主机。点击主机名称将以表单形式显示资产详情。
{width="600"}
**概览**标签页显示：
| 参数 | 说明 |
|--|--------|
| *Host name* | 主机名称。<br>点击名称将打开为该主机定义的脚本菜单。<br>若主机处于维护状态，主机名会显示橙色图标。 |
| *Visible name* | 主机的可见名称（如已定义）。 |
| *Host (Agent, SNMP, JMX, IPMI)<br>interfaces* | 本区块提供为主机配置的接口详情。 |
| *OS* | 主机的操作系统资产字段（如已定义）。 |
| *Hardware* | 主机硬件资产字段（如已定义）。 |
| *Software* | 主机软件资产字段（如已定义）。 |
| *Description* | 主机描述。 |
| *Monitoring* | 指向该主机数据监控部分的链接：*Web*、*最新数据*、*问题*、*图表*、*仪表板*。 |
| *Configuration* | 指向该主机配置部分的链接：*主机*、*监控项*、*触发器*、*图表*、*自动发现*、*Web*。<br>每个链接后显示已配置实体的数量。 |
**详情**标签页显示所有已填写（非空）的资产字段。
#### IPMI checks
IPMI checks will not work with the standard OpenIPMI library package on
Debian prior to 9 (stretch) and Ubuntu prior to 16.04 (xenial). To fix
that, recompile OpenIPMI library with OpenSSL enabled as discussed in
[ZBX-6139](https://support.zabbix.com/browse/ZBX-6139).
#### IPMI检查
在Debian 9(stretch)之前和Ubuntu 16.04(xenial)之前的版本中，IPMI检查无法与标准的OpenIPMI库包配合工作。要解决此问题，需按照[ZBX-6139](https://support.zabbix.com/browse/ZBX-6139)中的讨论重新编译启用OpenSSL的OpenIPMI库。
#### IPMI remote commands
For IPMI remote commands the following syntax should be used:
<command> [<value>]
where
- <command> - one of IPMI commands without spaces
- <value> - 'on', 'off' or any unsigned integer. <value>
is an optional parameter.
#### IPMI 远程命令
对于IPMI远程命令，应使用以下语法：
<command> [<value>]
其中
- <command> - 不带空格的IPMI命令之一
- <value> - 'on'、'off'或任意无符号integer。<value>
为可选参数。
#### IPv6 address issue in SNMPv3 traps
Due to a net-snmp bug, IPv6 address may not be correctly displayed when
using SNMPv3 in SNMP traps. For more details and a possible workaround,
see [ZBX-14541](https://support.zabbix.com/browse/ZBX-14541).
#### SNMPv3陷阱中的IPv6地址问题
由于net-snmp的一个bug，当在SNMP陷阱中使用SNMPv3时，IPv6地址可能无法正确显示。
有关更多详情及可能的解决方案，请参阅[ZBX-14541](https://support.zabbix.com/browse/ZBX-14541)。
#### Issues in Zabbix 6.0.11
##### JSONPath parsing errors
JSONPath parsing errors occur in case of leading whitespace and empty array/object. Fixed in Zabbix 6.0.12.
##### AND/OR evaluation in LLD filters
The evaluation of AND/OR expressions in the low-level discovery filters/overrides may fail in this version. Fixed in Zabbix 6.0.12.
#### Zabbix 6.0.11 中的 问题
##### JSONPath 解析错误
当存在前导空格或空的array/object时，JSONPath解析会出现错误。该问题已在Zabbix 6.0.12中修复。
##### LLD 过滤器中的 AND/OR 逻辑运算
在此version中，低级发现过滤器/覆盖的AND/OR表达式评估可能会失败。该问题已在Zabbix 6.0.12中修复。
#### Item changes
Native support for the [items](/manual/config/items/itemtypes/zabbix_agent) **net.dns** and **net.dns.record** has been added to Zabbix agent 2. On Zabbix agent 2 for Windows, these items now allow custom DNS IP addresses in the `ip` parameter and no longer ignore `timeout` and `count` parameters.
#### 监控项变化
Zabbix agent 2 中添加了对 [监控项](/manual/config/items/itemtypes/zabbix_agent) **net.dns** 和 **net.dns.record** 的原生支持。在 Zabbix agent 2 for Windows 中，这些监控项现在允许在 `ip` 参数中自定义 DNS IP 地址，并且不再忽略 `timeout` 和 `count` 参数。
##### Item configuration
Actual command(s) to be executed must be placed in the *Executed script*
field in the item configuration.
Multiple commands can be executed one after another by placing them on a
new line. In this case returned values will also be formatted as multilined.
{width="600"}
All mandatory input fields are marked with a red asterisk.
The fields that require specific information for SSH items are:
|Parameter|Description|Comments|
|--|------|------|
|*Type*|Select **SSH agent** here.| |
|*Key*|Unique (per host) item key in the format **ssh.run\[unique short description,<ip>,<port>,<encoding>,<ssh options>\]**|**unique short description** is required and should be unique for each SSH item per host.<br><br>Default port is 22, not the port specified in the interface to which this item is assigned.<br><br>**ssh options** (supported since version 6.0.25; require libssh of version 0.9.0 and higher or libssh2) allow passing additional SSH options in the format *key1=value1;key2=value2,value3*. Multiple values for one key can be passed separated by comma (in this case, the parameter must be [quoted](/manual/config/items/item/key#parameter---quoted-string)); multiple option keys can be passed separated by semicolon.<br><br>The following option keys are supported: `KexAlgorithms`, `HostkeyAlgorithms`, `Ciphers`, `MACs`. Option key and value support depends on the SSH library; if an option is not supported, an error will be returned, and the item will become unsupported.<br><br>Note that "+" sign for appending cipher settings and "!" for disabling specific cipher settings (as in GnuTLS and OpenSSL) are not supported.<br><br>Examples:<br>=> `ssh.run[KexAlgorithms,127.0.0.1,,,Ciphers=aes128-ctr]`<br>=> `ssh.run[KexAlgorithms,,,,"KexAlgorithms=diffie-hellman-group1-sha1;HostkeyAlgorithms=ssh-rsa,ssh-dss,ecdh-sha2-nistp256"]`|
|*Authentication method*|One of the "Password" or "Public key".| |
|*User name*|User name to authenticate on remote host. Required.| |
|*Public key file*|File name of public key if *Authentication method* is "Public key". Required.|Example: *id\_rsa.pub* - default public key file name generated by a command [ssh-keygen](http://en.wikipedia.org/wiki/Ssh-keygen).|
|*Private key file*|File name of private key if *Authentication method* is "Public key". Required.|Example: *id\_rsa* - default private key file name.|
|*Password* or<br>*Key passphrase*|Password to authenticate or<br>Passphrase **if** it was used for the private key.|Leave the *Key passphrase* field empty if passphrase was not used.<br>See also [known issues](/manual/installation/known_issues#ssh_checks) regarding passphrase usage.|
|*Executed script*|Executed shell command(s) using SSH remote session.|The return value of the executed shell command(s) is limited to 16MB (including trailing whitespace that is truncated); [database limits](/manual/config/items/item#text_data_limits) also apply.<br><br>Note that the libssh2 library may truncate executable scripts to \~32kB.<br><br>Examples:<br>*date +%s*<br>*systemctl status mysql-server*<br>*ps auxww \| grep httpd \| wc -l*|
##### 监控项配置
实际执行的命令必须放置在监控项配置的*Executed script*字段中。
通过将多个命令放置在新行上可以依次执行多个命令。这种情况下返回值也将以多行格式呈现。
{width="600"}
所有必填字段均以红色星号标记。
SSH 监控项需要特定信息的字段包括：
| 参数 | 描述 | 备注 |
|--|------|------|
| *Type* | 在此选择**SSH agent**。 | |
| *Key* | 格式为**ssh.run\[唯一简短描述,<ip>,<端口>,<编码>,<ssh选项>\]**的唯一（每个主机）监控项键 | **唯一简短描述**是必填项，且每个主机的SSH 监控项应保持唯一。<br><br>默认端口为22，而非此监控项所分配接口中指定的端口。<br><br>**ssh选项**（自version 6.0.25起支持；要求version的libssh版本0.9.0及以上或libssh2）允许以*key1=value1;key2=value2,value3*格式传递额外SSH选项。单个键的多个值可用逗号分隔传递（此时参数必须[参数引用字符串](/manual/config/items/item/key#参数引用字符串)）；多个选项键可用分号分隔。<br><br>支持的选项键包括：`KexAlgorithms`、`HostkeyAlgorithms`、`Ciphers`、`MACs`。选项键和值的支持取决于SSH库；若选项不受支持将返回错误，且监控项将变为不支持状态。<br><br>注意：不支持用于追加密码设置的"+"符号和禁用特定密码设置的"!"符号（如GnuTLS和OpenSSL中的用法）。<br><br>示例：<br>=> `ssh.run[KexAlgorithms,127.0.0.1,,,Ciphers=aes128-ctr]`<br>=> `ssh.run[KexAlgorithms,,,,"KexAlgorithms=diffie-hellman-group1-sha1;HostkeyAlgorithms=ssh-rsa,ssh-dss,ecdh-sha2-nistp256"]` |
| *Authentication method* | 选择"Password"或"Public key"之一。 | |
| *User name* | 用于远程主机认证的用户名。必填。 | |
| *Public key file* | 当*Authentication method*为"Public key"时的公钥文件名。必填。 | 示例：*id\_rsa.pub* - 由[ssh-keygen](http://en.wikipedia.org/wiki/Ssh-keygen)命令生成的默认公钥file名称。 |
| *Private key file* | 当*Authentication method*为"Public key"时的私钥文件名。必填。 | 示例：*id\_rsa* - 默认私钥file名称。 |
| *Password* or<br>*Key passphrase* | 用于认证的密码或<br>**若**私钥使用时的密钥口令。 | 若未使用口令，请保持*Key passphrase*字段为空。<br>另见[ssh检查](/manual/installation/known_issues#ssh检查)关于口令使用的说明。 |
| *Executed script* | 通过SSH远程会话执行的shell命令。 | 执行的shell命令返回值限制为16MB（包括被截断的尾部空格）；[文本数据限制](/manual/config/items/item#文本数据限制)同样适用。<br><br>注意：libssh2库可能将可执行脚本截断至约32kB。<br><br>示例：<br>*date +%s*<br>*systemctl status mysql-server*<br>*ps auxww \ | grep httpd \ | wc -l* |
#### Item configuration
A dependent item depends on its master item for data. That is why the
**master item** must be configured (or exist) first:
- Go to: *Configuration* → *Hosts*
- Click on *Items* in the row of the host
- Click on *Create item*
- Enter parameters of the item in the form
All mandatory input fields are marked with a red asterisk.
Click on *Add* to save the master item.
Then you can configure a **dependent item**.
All mandatory input fields are marked with a red asterisk.
The fields that require specific information for dependent items are:
| | |
|--|--------|
|*Type*|Select **Dependent item** here.|
|*Key*|Enter a key that will be used to recognize the item.|
|*Master item*|Select the master item. Master item value will be used to populate dependent item value.|
|*Type of information*|Select the type of information that will correspond the format of data that will be stored.|
You may use item value
[preprocessing](/manual/config/items/item#item_value_preprocessing) to
extract the required part of the master item value.
{width="600"}
Without preprocessing, the dependent item value will be exactly the same
as the master item value.
Click on *Add* to save the dependent item.
A shortcut to creating a dependent item quicker can be accessed by clicking on the  button in the item list
and selecting *Create dependent item*.
#### 监控项 配置
一个依赖监控项依赖其主监控项获取数据。因此必须首先配置（或存在）**主监控项**：
- 前往：*配置* → *主机*
- 在主机行中点击*监控项*
- 点击*创建监控项*
- 在表单中输入监控项的参数
所有必填字段均以红色星号标记。
点击*添加*保存主监控项。
随后可配置**依赖监控项**。
所有必填字段均以红色星号标记。
依赖监控项需特殊配置的字段包括：
| | |
|--|--------|
| *类型* | 此处选择**依赖监控项**。 |
| *键值* | 输入用于识别监控项的键值。 |
| *主监控项* | 选择主监控项。主监控项的值将用于填充依赖监控项的值。 |
| *信息类型* | 选择与存储数据格式对应的信息类型。 |
可使用监控项值
[监控项-值预处理](/manual/config/items/item#监控项-值预处理)来
提取主监控项值的所需部分。
{width="600"}
未经预处理时，依赖监控项的值将与主监控项的值完全相同。
点击*添加*保存依赖监控项。
在监控项列表中点击按钮并选择*创建依赖监控项*可快速创建依赖监控项。
##### Item configuration
Configure a log monitoring [item](/manual/config/items/item#overview).
All mandatory input fields are marked with a red asterisk.
Specifically for log monitoring items you enter:
| | |
|--|--------|
|*Type*|Select **Zabbix agent (active)** here.|
|*Key*|Use one of the following item keys:<br>**log\[\]** or **logrt\[\]**:<br>These two item keys allow to monitor logs and filter log entries by the content regexp, if present.<br>For example: `log[/var/log/syslog,error]`. Make sure that the file has read permissions for the 'zabbix' user otherwise the item status will be set to 'unsupported'.<br>**log.count\[\]** or **logrt.count\[\]**:<br>These two item keys allow to return the number of matching lines only.<br>See supported [Zabbix agent item](zabbix_agent#supported_item_keys) key section for details on using these item keys and their parameters.|
|*Type of information*|Prefilled automatically:<br>For log\[\] or logrt\[\] items - `Log`;<br>For log.count\[\] or logrt.count\[\] items - `Numeric (unsigned)`.<br>If optionally using the `output` parameter, you may manually select the appropriate type of information other than `Log`.<br>Note that choosing a non-Log type of information will lead to the loss of local timestamp.|
|*Update interval (in sec)*|The parameter defines how often Zabbix agent will check for any changes in the log file. Setting it to 1 second will make sure that you get new records as soon as possible.|
|*Log time format*|In this field you may optionally specify the pattern for parsing the log line timestamp. Supported placeholders:<br>\* **y**: *Year (1970-2038)*<br>\* **M**: *Month (01-12)*<br>\* **d**: *Day (01-31)*<br>\* **h**: *Hour (00-23)*<br>\* **m**: *Minute (00-59)*<br>\* **s**: *Second (00-59)*<br>If left blank, the timestamp will be set to 0 in Unix time, representing January 1, 1970.<br>For example, consider the following line from the Zabbix agent log file:<br>" 23480:20100328:154718.045 Zabbix agent started. Zabbix 1.8.2 (revision 11211)."<br>It begins with six character positions for PID, followed by date, time, and the rest of the message.<br>The log time format for this line would be "pppppp:yyyyMMdd:hhmmss".<br>Note that "p" and ":" characters are placeholders and can be any character except "yMdhms".|
##### 监控项配置
配置日志监控[概述](/manual/config/items/item#概述).
所有必填字段均以红色星号标记.
针对日志监控监控项需填写以下内容:
| | |
|--|--------|
| *类型* | 此处选择**Zabbix agent (主动式)**. |
| *键值* | 使用以下监控项键值之一:<br>**log\[\]** 或 **logrt\[\]**:<br>这两个监控项键值允许监控日志并通过正则表达式过滤日志条目(如果存在).<br>例如: `log[/var/log/syslog,error]`. 确保file对'zabbix'用户具有读取权限,否则监控项状态将被设为'不支持'.<br>**log.count\[\]** 或 **logrt.count\[\]**:<br>这两个监控项键值仅返回匹配行数.<br>详情请参阅支持的[支持的-监控项-键](zabbix_agent#支持的-监控项-键)键值部分了解这些监控项键值及其参数的使用方法. |
| *信息类型* | 自动预填:<br>对于log\[\]或logrt\[\]监控项 - `Log`;<br>对于log.count\[\]或logrt.count\[\]监控项 - `Numeric (unsigned)`.<br>如果可选使用`output`参数,您可以手动选择除`Log`外的其他合适信息类型.<br>注意选择非日志类型信息将导致本地时间戳丢失. |
| *更新间隔(秒)* | 该参数定义Zabbix agent检查日志file变化的频率.设置为1秒可确保尽快get新记录. |
| *日志时间格式* | 在此字段中可选指定日志行时间戳的解析模式.支持的占位符:<br>\* **y**: *年(1970-2038)*<br>\* **M**: *月(01-12)*<br>\* **d**: *日(01-31)*<br>\* **h**: *时(00-23)*<br>\* **m**: *分(00-59)*<br>\* **s**: *秒(00-59)*<br>如果留空,时间戳将被设为Unix时间的0,即1970年1月1日.<br>例如,考虑Zabbix agent日志file中的以下行:<br>"23480:20100328:154718.045 Zabbix agent started. Zabbix 1.8.2 (revision 11211)."<br>它以6个字符位置的PID开头,后跟日期、时间和消息其余部分.<br>此行对应的日志时间格式应为"pppppp:yyyyMMdd:hhmmss".<br>注意"p"和":"字符是占位符,可以是除"yMdhms"外的任何字符. |
#### Item configuration in Zabbix frontend
Configure a database monitoring
[item](/manual/config/items/item#overview).
All mandatory input fields are marked with a red asterisk.
Specifically for database monitoring items you must enter:
| | |
|--|--------|
|*Type*|Select *Database monitor* here.|
|*Key*|Enter one of the supported item keys:<br>**db.odbc.select**\[<unique short description>,<dsn>,<connection string>\] - this item is designed to return one value, i.e. the first column of the first row of the SQL query result. If a query returns more than one column, only the first column is read. If a query returns more than one line, only the first line is read.<br>**db.odbc.get**\[<unique short description>,<dsn>,<connection string>\] - this item is capable of returning multiple rows/columns in JSON format. Thus it may be used as a master item that collects all data in one system call, while JSONPath preprocessing may be used in dependent items to extract individual values. For more information, see an [example](/manual/discovery/low_level_discovery/examples/sql_queries#using-db.odbc.get) of the returned format, used in low-level discovery. This item is supported since Zabbix 4.4.<br>The unique description will serve to identify the item in triggers, etc.<br>Although `dsn` and `connection string` are optional parameters, at least one of them should be present. If both data source name (DSN) and connection string are defined, the DSN will be ignored.<br>The data source name, if used, must be set as specified in odbc.ini.<br>The connection string may contain driver-specific arguments.<br>**db.odbc.discovery**[<unique short description>,<dsn>,<connection string>] - this item returns [low-level discovery](/manual/discovery/low_level_discovery/examples/sql_queries) data.<br><br>Example (connection for MySQL ODBC driver 5):<br>=> db.odbc.get\[MySQL example,,"Driver=/usr/local/lib/libmyodbc5a.so;Database=master;Server=127.0.0.1;Port=3306"\]|
|*User name*|Enter the database user name<br>This parameter is optional if user is specified in odbc.ini.<br>If connection string is used, and *User name* field is not empty, it is appended to the connection string as `UID=<user>`|
|*Password*|Enter the database user password<br>This parameter is optional if password is specified in odbc.ini.<br>If connection string is used, and *Password* field is not empty, it is appended to the connection string as `PWD=<password>`.<br>Since Zabbix 6.0.34, special characters are supported in this field.<br><br>Before Zabbix 6.0.34, if the password contains a semicolon, it should be wrapped in curly brackets, for example, `{P?;)*word}`. After 6.0.34, wrapping the password in this case is still supported, but not required. The password will be appended to connection string after the username as `UID=<username>;PWD={P?;)*word}`. To test the resulting string, you can run the following command:<br>`isql -v -k 'Driver=libmaodbc.so;Database=zabbix;UID=zabbix;PWD={P?;)*word}'`|
|*SQL query*|Enter the SQL query.<br>Note that with the `db.odbc.select[]` item the query must return one value only.|
|*Type of information*|It is important to know what type of information will be returned by the query, so that it is selected correctly here. With an incorrect *type of information* the item will turn unsupported.|
#### Zabbix前端中的监控项配置
配置数据库监控
[概述](/manual/config/items/item#概述).
所有必填字段均以红色星号标记。
针对数据库监控监控项，您必须输入：
| | |
|--|--------|
| *类型* | 在此处选择 *数据库监控* |
| *键值* | 输入以下任一支持的监控项键值:<br>**db.odbc.select**\[<唯一简短描述>,<dsn>,<连接string>\] - 该监控项设计用于返回单个值，即SQLquery结果中第一行的第一列。若query返回多列，仅读取第一列；若query返回多行，仅读取第一行。<br>**db.odbc.get**\[<唯一简短描述>,<dsn>,<连接string>\] - 该监控项能以JSON格式返回多行/多列数据，因此可作为主监控项在一次系统调用中收集所有数据，而依赖项监控项可通过JSONPath预处理提取独立值。详见低阶发现中的[示例](/manual/discovery/low_level_discovery/examples/sql_queries#using-db.odbc.get)返回格式。此监控项自Zabbix 4.4起支持。<br>唯一描述将用于在触发器等场景中标识监控项。<br>虽然`dsn`和`connection string`是可选参数，但至少需指定其一。若同时定义数据源名称(DSN)和连接string，DSN将被忽略。<br>数据源名称(如使用)必须按odbc.ini中的规范设置。<br>连接string可包含驱动程序特定参数。<br>**db.odbc.discovery**[<唯一简短描述>,<dsn>,<连接string>] - 该监控项返回[low-level discovery](/manual/discovery/low_level_discovery/examples/sql_queries)数据。<br><br>示例(MySQL ODBC驱动5连接):<br>=> db.odbc.get\[MySQL示例,,"Driver=/usr/local/lib/libmyodbc5a.so;Database=master;Server=127.0.0.1;Port=3306"\] |
| *用户名* | 输入数据库用户名<br>如果在odbc.ini中指定了用户，则该参数可选。<br>若使用连接string且*用户名*字段非空时，会以`UID=<user>`格式附加到连接string中 |
| *Password* | 输入数据库用户密码<br>如果在odbc.ini中指定了密码，则该参数可选。<br>如果使用连接string且*Password*字段非空，该密码会以`PWD=<password>`格式附加到连接string中。<br>从Zabbix 6.0.34开始，此字段支持特殊字符。<br><br>在Zabbix 6.0.34之前，若密码包含分号需用花括号包裹，例如`{P?;)*word}`。6.0.34版本后仍支持此包裹方式但不再强制要求。密码会以`UID=<username>;PWD={P?;)*word}`格式附加在用户名后构成连接string。要测试生成的string，可run以下命令：<br>`isql -v -k 'Driver=libmaodbc.so;Database=zabbix;UID=zabbix;PWD={P?;)*word}'` |
| *SQL query* | 输入SQL query.<br>注意使用`db.odbc.select[]` 监控项时，query必须仅返回一个值. |
| *信息类型* | 了解query将返回何种信息类型至关重要，以便在此处正确选择。若*信息类型*设置错误，监控项将变为不受支持状态。 |
##### Item configuration
To configure a trapper item:
- Go to: *Configuration* → *Hosts*
- Click on *Items* in the row of the host
- Click on *Create item*
- Enter parameters of the item in the form
All mandatory input fields are marked with a red asterisk.
The fields that require specific information for trapper items are:
| | |
|--|--------|
|*Type*|Select **Zabbix trapper** here.|
|*Key*|Enter a key that will be used to recognize the item when sending in data.|
|*Type of information*|Select the type of information that will correspond the format of data that will be sent in.|
|*Allowed hosts*|List of comma delimited IP addresses, optionally in CIDR notation, or DNS names.<br>If specified, incoming connections will be accepted only from the hosts listed here.<br>If IPv6 support is enabled then '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' are treated equally and '::/0' will allow any IPv4 or IPv6 address.<br>'0.0.0.0/0' can be used to allow any IPv4 address.<br>Note that "IPv4-compatible IPv6 addresses" (0000::/96 prefix) are supported but deprecated by [RFC4291](https://tools.ietf.org/html/rfc4291#section-2.5.5).<br>Example: 127.0.0.1, 192.168.1.0/24, 192.168.3.1-255, 192.168.1-10.1-255, ::1,2001:db8::/32, mysqlserver1, zabbix.example.com, {HOST.HOST}<br>Spaces and [user macros](/manual/config/macros/user_macros) are allowed in this field since Zabbix 2.2.0.<br>Host macros {HOST.HOST}, {HOST.NAME}, {HOST.IP}, {HOST.DNS}, {HOST.CONN} are allowed in this field since Zabbix 4.0.2.|
::: noteclassic
You may have to wait up to 60 seconds after saving the item
until the server picks up the changes from a configuration cache update,
before you can send in values.
:::
##### 监控项配置
配置一个trapper 监控项:
- 前往: *Configuration* → *主机*
- 在主机所在行点击*监控项*
- 点击*创建监控项*
- 在表单中输入监控项的参数
所有必填字段都用红色星号标记。
trapper 监控项需要特定信息的字段包括:
| | |
|--|--------|
| *Type* | 在此选择**Zabbix trapper**。 |
| *Key* | 输入一个键值，用于在发送数据时识别监控项。 |
| *Type of information* | 选择与将要发送的数据格式相对应的信息类型。 |
| *Allowed 主机* | 以逗号分隔的IP地址列表，可选CIDR表示法或DNS名称。<br>如果指定，则只接受来自此处列出的主机的传入连接。<br>如果启用了IPv6支持，则'127.0.0.1'、'::127.0.0.1'、'::ffff:127.0.0.1'被视为等同，'::/0'将允许任何IPv4或IPv6地址。<br>'0.0.0.0/0'可用于允许任何IPv4地址。<br>注意"IPv4兼容的IPv6地址"(0000::/96前缀)受支持但已被[RFC4291](https://tools.ietf.org/html/rfc4291#section-2.5.5)弃用。<br>示例: 127.0.0.1, 192.168.1.0/24, 192.168.3.1-255, 192.168.1-10.1-255, ::1,2001:db8::/32, mysqlserver1, zabbix.example.com, {HOST.HOST}<br>自Zabbix 2.2.0起，此字段允许空格和[user macros](/manual/config/macros/user_macros)。<br>主机宏 {HOST.HOST}, {HOST.NAME}, {HOST.IP}, {HOST.DNS}, {HOST.CONN}自Zabbix 4.0.2起允许在此字段中使用。 |
::: noteclassic
保存监控项后，您可能需要等待最多60秒，
直到服务器从update的configuration cache中获取更改，
然后才能发送值。
:::
##### Item configuration
When [configuring an item](/manual/config/items/item) on a host level:
- Select 'IPMI agent' as the *Type*
- Enter an item [key](/manual/config/items/item/key) that is unique
within the host (say, ipmi.fan.rpm)
- For *Host interface* select the relevant IPMI interface (IP and
port). Note that an IPMI interface must exist on the host.
- Specify the *IPMI sensor* (for example 'FAN MOD 1A RPM' on Dell
Poweredge) to retrieve the metric from. By default, the sensor ID
should be specified. It is also possible to use prefixes before the
value:
- `id:` - to specify sensor ID;
- `name:` - to specify sensor full name. This can be useful in
situations when sensors can only be distinguished by specifying
the full name.
- Select the respective type of information ('Numeric (float)' in this
case; for discrete sensors - 'Numeric (unsigned)'), units (most
likely 'rpm') and any other required item attributes
##### 监控项配置
当在一个主机级别配置[configuring an item](/manual/config/items/item)时：
- 选择'IPMI agent'作为*类型*
- 输入一个在主机内唯一的监控项[key](/manual/config/items/item/key)（例如ipmi.fan.rpm）
- 对于*主机接口*选择相关的IPMI接口（IP和端口）。注意主机上必须存在IPMI接口。
- 指定*IPMI传感器*（例如Dell Poweredge上的'FAN MOD 1A RPM'）以获取指标。默认情况下应指定传感器ID。也可以在值前使用前缀：
- `id:` - 指定传感器ID；
- `name:` - 指定传感器全名。这在只能通过全名区分传感器的情况下非常有用。
- 选择相应的信息类型（本例中为'Numeric (float)'；对于离散传感器选择'Numeric (unsigned)'）、单位（很可能是'rpm'）以及其他必要的监控项属性
# item.create
# item.create
# item.delete
# item.delete
##### Item filter syntax
The item filter:
/host/key[parameters]?[conditions]
consists of four parts, where:
* host - host name
* key - item key (without parameters)
* parameters - item key parameters
* conditions - host group and/or item tag based conditions (as expression)
Spaces are allowed only inside the conditions expression.
**Wildcard usage**
* Wildcard can be used to replace the host name, item key or an individual item key parameter.
* Either the host or item key must be specified without wildcard. So `/host/*` and `/*/key` are valid filters, but `/*/*` is invalid.
* Wildcard cannot be used for a *part* of host name, item key, item key parameter.
* Wildcard does not match more than a single item key parameter. So a wildcard must be specified for each parameter in separation (i.e. `key[abc,*,*]`).
**Conditions expression**
The conditions expression supports:
* operands:
* group - host group
* tag - item tag
* `"<text>"` - string constant, with the `\` escape character to escape `"` and `\`
* case-sensitive string comparison operators: `=`, `<>`
* logical operators: `and`, `or`, `not`
* grouping with parentheses: `(` `)`
Quotation of string constants is mandatory. Only case-sensitive full string comparison is supported.
:::notewarning
When specifying tags in the filter (i.e. `tag="tagname:value"`), the colon ":" is used as a delimiter.
Everything after it is considered the tag value. Thus it is currently not supported to specify a tag name containing ":" in it.
:::
**Examples**
A complex filter may be used, referencing the item key, host group and
tags, as illustrated by the examples:
|Syntax example|Description|
|--|--|
|`/host/key[abc,*]`|Matches similar items on this host.|
|`/*/key`|Matches the same item of any host.|
|`/*/key?[group="ABC" and tag="tagname:value"]`|Matches the same item of any host from the ABC group having 'tagname:value' tags.|
|`/*/key[a,*,c]?[(group="ABC" and tag="Tag1") or (group="DEF" and (tag="Tag2" or tag="Tag3:value"))]`|Matches similar items of any host from the ABC or DEF group with the respective tags.|
All referenced items must exist and collect data. Only enabled items on
enabled hosts are included in the calculations.
::: noteimportant
If the item key of a referenced item is changed,
the filter must be updated manually.
:::
Specifying a parent host group includes the parent group and all nested
host groups with their items.
##### 监控项 过滤器语法
监控项过滤器:
/host/key[parameters]?[conditions]
由以下四个部分组成：
* 主机 - 主机名
* key - 监控项 键（不带参数）
* parameters - 监控项 关键参数
* conditions - 主机组 和/或 监控项 基于标签的条件（作为表达式）
条件表达式内部仅允许存在空格
**通配符用法**
* 通配符可用于替换主机名称、监控项键或单个监控项键参数。
* 必须指定不带通配符的主机或监控项键。因此`/host/*`和`/*/key`是有效过滤器，但`/*/*`无效。
* 通配符不能用于主机名的*部分*、监控项键、监控项键参数。
* 通配符不能匹配多个监控项键参数。因此必须为每个参数单独指定通配符（即`key[abc,*,*]`）。
**条件表达式**
条件表达式支持：
* 操作数:
* group - 主机组
* tag - 监控项 tag
* `"<text>"` - string常量，使用`\`转义字符来转义`"`和`\`
* 区分大小写 string 比较运算符: `=`, `<>`
* 逻辑运算符: `and`, `or`, `not`
* 使用括号分组: `(` `)`
引用string常量时必须加引号。仅支持区分大小写的完整string比较。
::: notewarning
在过滤器中指定标签时（即`tag="tagname:value"`），冒号":"被用作分隔符。
冒号之后的所有内容均被视为标签值。因此，当前不支持在标签名称中包含":"。
:::
**示例**
可以使用复杂过滤器，引用监控项键、主机组和
标签，如示例所示：
| 语法示例 | 描述 |
|--|--|
| `/host/key[abc,*]` | 匹配此主机上的类似监控项. |
| `/*/key` | 匹配任意主机的相同监控项。 |
| `/*/key?[group="ABC" and tag="tagname:value"]` | 匹配ABC组中任何具有'tagname:value'标签的监控项的相同主机。 |
| `/*/key[a,*,c]?[(group="ABC" and tag="Tag1") or (group="DEF" and (tag="Tag2" or tag="Tag3:value"))]` | 匹配来自ABC或DEF组的任何主机的相似监控项及其相应标签。 |
所有引用的监控项必须存在并收集数据。仅启用监控项上的
启用的 主机 被包含在计算中。
::: noteimportant
如果引用的监控项的监控项键被更改，
过滤器必须手动更新。
:::
指定父级主机组包含父组及其所有嵌套
主机 组及其 监控项
# item.get
# item.get
#### Item key
In [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule)
configuration, select **JMX agent** in the *Type* field.
Two item keys are supported for JMX object discovery - jmx.discovery\[\]
and jmx.get\[\]:
|**Item key**|<|<|<|
|-|--------|--------|----------|
|<|Return value|Parameters|Comment|
|**jmx.discovery**\[<discovery mode>,<object name>,<unique short description>\]|<|<|<|
|<|This item returns a JSON array with LLD macros describing MBean objects or their attributes.|**discovery mode** - one of the following: *attributes* (retrieve JMX MBean attributes, default) or *beans* (retrieve JMX MBeans)<br>**object name** - object name pattern (see [documentation](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html)) identifying the MBean names to be retrieved (empty by default, retrieving all registered beans)<br>**unique short description** - a unique description that allows multiple JMX items with the same discovery mode and object name on the host (optional)|Examples:<br>→ jmx.discovery - retrieve all JMX MBean attributes<br>→ jmx.discovery\[beans\] - retrieve all JMX MBeans<br>→ jmx.discovery\[attributes,"\*:type=GarbageCollector,name=\*"\] - retrieve all garbage collector attributes<br>→ jmx.discovery\[beans,"\*:type=GarbageCollector,name=\*"\] - retrieve all garbage collectors<br><br>There are some [limitations](#limitations) to what MBean properties this item can return based on limited characters that are supported in macro name generation (supported characters can be described by the following regular expression: `A-Z0-9_\.`). So, for example, to discover MBean properties with a hyphenated word or non-ASCII characters, you need to use `jmx.get[]`.<br><br>Supported since Zabbix Java gateway 3.4.|
|**jmx.get**\[<discovery mode>,<object name>,<unique short description>\]|<|<|<|
|<|This item returns a JSON array with MBean objects or their attributes.<br><br>Compared to `jmx.discovery[]` it does not define LLD macros.|**discovery mode** - one of the following: *attributes* (retrieve JMX MBean attributes, default) or *beans* (retrieve JMX MBeans)<br>**object name** - object name pattern (see [documentation](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html)) identifying the MBean names to be retrieved (empty by default, retrieving all registered beans)<br>**unique short description** - a unique description that allows multiple JMX items with the same discovery mode and object name on the host (optional)|When using this item, it is needed to define custom low-level discovery macros, pointing to values extracted from the returned JSON using JSONPath.<br><br>Supported since Zabbix Java gateway 4.4.|
::: noteimportant
If no parameters are passed, all MBean attributes
from JMX are requested. Not specifying parameters for JMX discovery or
trying to receive all attributes for a wide range like `*:type=*,name=*`
may lead to potential performance problems.
:::
#### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)
配置中，于*类型*字段选择**JMX agent**。
JMX object发现支持两种监控项键 - jmx.discovery\[\]
和jmx.get\[\]:
| **监控项键** | < | < | < |
|-|--------|--------|----------|
| < | 返回值 | 参数 | 注释 |
| **jmx.discovery**\[<discovery mode>,<object name>,<unique short description>\] | < | < | < |
| < | 该监控项返回包含LLD宏的JSON array，用于描述MBean objects或其属性。 | **发现模式** - 以下之一：*attributes*（获取JMX MBean属性，默认）或*beans*（获取JMX MBeans）<br>**object名称** - 标识要获取的MBean名称的object名称模式（参见[documentation](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html)）（默认为空，获取所有注册的beans）<br>**唯一简短描述** - 允许在主机上使用相同发现模式和object名称的多个JMX 监控项的唯一描述（可选） | 示例：<br>→ jmx.discovery - 获取所有JMX MBean属性<br>→ jmx.discovery\[beans\] - 获取所有JMX MBeans<br>→ jmx.discovery\[attributes,"\*:type=GarbageCollector,name=\*"\] - 获取所有垃圾收集器属性<br>→ jmx.discovery\[beans,"\*:type=GarbageCollector,name=\*"\] - 获取所有垃圾收集器<br><br>由于宏名称生成支持的字符有限（支持的字符可用正则表达式`A-Z0-9_\.`描述），该监控项能返回的MBean属性存在一些[限制](#limitations)。例如，要发现带有连字符或非ASCII字符的MBean属性，需使用`jmx.get[]`。<br><br>自Zabbix Java网关3.4起支持。 |
| **jmx.get**\[<discovery mode>,<object name>,<unique short description>\] | < | < | < |
| < | 该监控项返回包含MBean objects或其属性的JSON array。<br><br>与`jmx.discovery[]`相比，它不定义LLD宏。 | **发现模式** - 以下之一：*attributes*（获取JMX MBean属性，默认）或*beans*（获取JMX MBeans）<br>**object名称** - 标识要获取的MBean名称的object名称模式（参见[documentation](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html)）（默认为空，获取所有注册的beans）<br>**唯一简短描述** - 允许在主机上使用相同发现模式和object名称的多个JMX 监控项的唯一描述（可选） | 使用此监控项时，需定义自定义低级发现宏，指向使用JSONPath从返回的JSON中提取的值。<br><br>自Zabbix Java网关4.4起支持。 |
::: noteimportant
若未传递参数，将请求JMX中的所有MBean属性。不为JMX发现指定参数或尝试获取广泛范围（如`*:type=*,name=*`）的所有属性可能导致性能问题。
:::
#### Item key
SQL queries are performed using a "Database monitor" item type.
Therefore, most of the instructions on [ODBC
monitoring](/manual/config/items/itemtypes/odbc_checks) page apply in
order to get a working "Database monitor" discovery rule.
Two item keys may be used in "Database monitor" discovery rules:
- **db.odbc.discovery**\[<unique short
description>,<dsn>,<connection string>\] - this item
transforms the SQL query result into a JSON array, turning the
column names from the query result into low-level discovery macro
names paired with the discovered field values. These macros can be
used in creating item, trigger, etc prototypes. See also: [Using
db.odbc.discovery](#using_dbodbcdiscovery).
```{=html}
<!-- -->
```
- **db.odbc.get**\[<unique short
description>,<dsn>,<connection string>\] - this item
transforms the SQL query result into a JSON array, keeping the
original column names from the query result as a field name in JSON
paired with the discovered values. Compared to
`db.odbc.discovery[]`, this item does not create low-level discovery
macros in the returned JSON, therefore there is no need to check if
the column names can be valid macro names. The low-level discovery
macros can be defined as an additional step as required, using the
[custom LLD
macro](/manual/discovery/low_level_discovery#custom_macros)
functionality with JSONPath pointing to the discovered values in the
returned JSON. See also: [Using db.odbc.get](#using_dbodbcget).
#### 监控项键
SQL queries 通过"Database monitor" 监控项 类型执行
因此，[ODBC
monitoring](/manual/config/items/itemtypes/odbc_checks)页面上的大部分说明同样适用于
为了get一个正常工作的"数据库监控"发现规则。
在"数据库监控"发现规则中可以使用两个监控项键:
- **db.odbc.discovery**\[<unique short
description>,<dsn>,<connection string>\] - this item
transforms the SQL query result into a JSON array, turning the
column names from the query result into low-level discovery macro
names paired with the discovered field values. These macros can be
used in creating item, trigger, etc prototypes. See also: [Using
db.odbc.discovery](#using_dbodbcdiscovery).
```{=html}
<!-- -->
```
- **db.odbc.get**\[<unique short
description>,<dsn>,<connection string>\] - this 监控项
将SQL query结果转换为JSON array，同时保留
来自query结果的原始列名作为JSON中的字段名
与发现的值配对。相比
`db.odbc.discovery[]`, 该 监控项 不 create 低级发现
返回的JSON中的宏，因此无需检查是否
列名可以是有效的宏名称。低级发现
宏可以根据需要作为额外步骤进行定义，使用
[自定义宏](/manual/discovery/low_level_discovery#自定义宏)
功能通过JSONPath指向发现的值
返回的JSON。另请参阅：[使用db.odbc.get](#using_dbodbcget)。
#### Item keys
The table provides details on the item keys that you can use with Zabbix
agent 2 only.
See also: [Plugins supplied
out-of-the-box](/manual/config/items/plugins#plugins_supplied_out-of-the-box)
::: noteclassic
Parameters without angle brackets are mandatory. Parameters
marked with angle brackets **<** **>** are optional.
:::
|Key|<|<|<|<|
|---|-|-|-|-|
|<|**Description**|**Return value**|**Parameters**|**Comments**|
|ceph.df.details \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Cluster’s data usage and distribution among pools.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.osd.stats \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Aggregated and per OSD statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.osd.discovery \[connString, <user>, <apikey>\]|<|<|<|<|
|<|List of discovered OSDs. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.osd.dump \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Usage thresholds and statuses of OSDs.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.ping \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Tests whether a connection to Ceph can be established.|0 - connection is broken (if there is any error presented including AUTH and configuration issues)<br>1 - connection is successful.|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.pool.discovery \[connString, <user>, <apikey>\]|<|<|<|<|
|<|List of discovered pools. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.status \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Overall cluster's status.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|docker.container\_info \[<ID>\]|<|<|<|<|
|<|Low-level information about a container.|An output of the [ContainerInspect](https://docs.docker.com/engine/api/v1.28/#operation/ContainerInspect) API call serialized as JSON|**ID** - ID or name of the container|This item is supported since Zabbix 5.0.0 for the Docker plugin.<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.container\_stats \[<ID>\]|<|<|<|<|
|<|Container resource usage statistics.|An output of the [ContainerStats](https://docs.docker.com/engine/api/v1.28/#operation/ContainerStats) API call and CPU usage percentage serialized as JSON|**ID** - ID or name of the container|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.containers|<|<|<|<|
|<|A list of containers.|An output of the [ContainerList](https://docs.docker.com/engine/api/v1.28/#operation/ContainerList) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.containers.discovery\[<options>\]|<|<|<|<|
|<|A list of containers. Used for [low-level discovery](/manual/discovery/low_level_discovery/).|JSON object.|**options** - specifies whether all or only running containers should be discovered. Supported values:<br>*true* - return all containers;<br>*false* - return only running containers (default).|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.data\_usage|<|<|<|<|
|<|Information about current data usage.|An output of the [SystemDataUsage](https://docs.docker.com/engine/api/v1.28/#operation/SystemDataUsage) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.images|<|<|<|<|
|<|A list of images.|An output of the [ImageList](https://docs.docker.com/engine/api/v1.28/#operation/ImageList) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.images.discovery|<|<|<|<|
|<|A list of images. Used for [low-level discovery](/manual/discovery/low_level_discovery/).|JSON object.|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.info|<|<|<|<|
|<|System information.|An output of the [SystemInfo](https://docs.docker.com/engine/api/v1.28/#operation/SystemInfo) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.ping|<|<|<|<|
|<|Test if a Docker daemon is alive or not.|1 - connection is alive<br><br>0 - connection is broken|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|memcached.ping\[connString,<user>,<password>\]|<|<|<|<|
|<|Test if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues)|**connString** - URI or session name.|This item is supported for the [Memchached plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|memcached.stats\[connString,<user>,<password>,<type>\]|<|<|<|<|
|<|Gets the output of the STATS command.|JSON - output is serialized as JSON|**connString** - URI or session name.<br>**user, password** - Memchached login credentials.<br>**type** - stat type to be returned: *items*, *sizes*, *slabs* or *settings* (empty by default, returns general statistics).|This item is supported for the [Memchached plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.collection.stats\[connString,<user>,<password>,<database>,collection\]|<|<|<|<|
|<|Returns a variety of storage statistics for a given collection.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.<br>**database** - database name (default: admin).<br>**collection** — collection name.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.collections.discovery\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a list of discovered collections. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.collections.usage\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns usage statistics for collections.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.connpool.stats\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns information regarding the open outgoing connections from the current database instance to other members of the sharded cluster or replica set.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.db.stats\[connString,<user>,<password>,<database>\]|<|<|<|<|
|<|Returns statistics reflecting a given database system state.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.<br>**database** - database name (default: admin).|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.db.discovery\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a list of discovered databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.jumbo\_chunks.count\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns count of jumbo chunks.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.oplog.stats\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a status of the replica set, using data polled from the oplog.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.ping\[connString,<user>,<password>\]|<|<|<|<|
|<|Tests if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues).|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.rs.config\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a current configuration of the replica set.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.rs.status\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a replica set status from the point of view of the member where the method is run.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.server.status\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns database state.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.sh.discovery\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a list of discovered shards present in the cluster.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mqtt.get\[<broker\_url>,topic,<username>,<password>\]|<|<|<|<|
|<|Subscribes to a specific topic or topics (with wildcards) of the provided broker and waits for publications.|Depending on topic content.<br><br>If wildcards are used, returns topic content as JSON.|**broker\_url** - MQTT broker URL (if empty, *localhost* with port 1883 is used).<br>**topic** - MQTT topic (mandatory). Wildcards (+,\#) are supported.<br>**username,password** - authentication credentials (if required)|This item is supported for the [MQTT plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The item must be configured as an [active check](/manual/appendix/items/activepassive#active_checks) ('Zabbix agent (active)' item type).<br><br>TLS encryption certificates can be used by saving them into a default location (e.g. `/etc/ssl/certs/` directory for Ubuntu). For TLS, use the `tls://` scheme.|
|mysql.db.discovery\[connString, <username>, <password>\]|<|<|<|<|
|<|List of MySQL databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|Result of the "show databases" SQL query in LLD JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.db.size\[connString, <username>, <password>,dbName\]|<|<|<|<|
|<|Database size in bytes.|Result of the "select coalesce(sum(data\_length + index\_length),0) as size from information\_schema.tables where table\_schema=?" SQL query for specific database in bytes.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.<br>**dbName** - Database name.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.get\_status\_variables\[connString, <username>, <password>\]|<|<|<|<|
|<|Values of global status variables.|Result of the "show global status" SQL query in JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.ping\[connString, <username>, <password>\]|<|<|<|<|
|<|Test if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues).|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.replication.discovery\[connString, <username>, <password>\]|<|<|<|<|
|<|List of MySQL replications. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|Result of the "show slave status" SQL query in LLD JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.replication.get\_slave\_status\[connString, <username>, <password>, <masterHost>\]|<|<|<|<|
|<|Replication status.|Result of the "show slave status" SQL query in JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.<br>**masterHost** - Replication master host name.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.version\[connString, <username>, <password>\]|<|<|<|<|
|<|MySQL version.|String with MySQL instance version.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.diskgroups.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|ASM disk groups statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.diskgroups.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of ASM disk groups. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.archive.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Archive logs statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.cdb.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|CDBs info.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.custom.query\[connString,<user>,<password>,<service>, queryName, <args...>\]|<|<|<|<|
|<|Result of a custom query.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**queryName** — name of a custom query (must be equal to a name of an sql file without an extension).<br>**args...** — one or several comma-separated arguments to pass to a query.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.datafiles.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Data files statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.db.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.fra.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|FRA statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.instance.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Instance statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.pdb.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|PDBs info.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.pdb.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of PDBs. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.pga.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|PGA statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.ping\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Tests whether a connection to Oracle can be established.|0 - connection is broken (if there is any error presented including AUTH and configuration issues)<br>1 - connection is successful.|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.proc.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Processes statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.redolog.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Log file information from the control file.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sga.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|SGA statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sessions.stats\[connString,<user>,<password>,<service>,<lockMaxTime>\]|<|<|<|<|
|<|Sessions statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**lockMaxTime** - maximum session lock duration in seconds to count the session as a prolongedly locked. Default: 600 seconds.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sys.metrics\[connString,<user>,<password>,<service>,<duration>\]|<|<|<|<|
|<|A set of system metric values.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**duration** - capturing interval (in seconds) of system metric values. Possible values: *60* — long duration (default), *15* — short duration.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sys.params\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|A set of system parameter values.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.ts.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Tablespaces statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.ts.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of tablespaces. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.user.info\[connString,<user>,<password>,<username>\]|<|<|<|<|
|<|List of tablespaces. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**username** - a username, for which the information is needed. Lowercase usernames are not supported. Default: current user.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.autovacuum.count\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The number of autovacuum workers.|SQL query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.archive\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Information about archived files.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.archive.count\_archived\_files** - the number of WAL files that have been successfully archived.<br>**pgsql.archive.failed\_trying\_to\_archive** - the number of failed attempts for archiving WAL files.<br>**pgsql.archive.count\_files\_to\_archive** - the number of files to archive.<br>**pgsql.archive.size\_files\_to\_archive** -the size of files to archive.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.bgwriter\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Combined number of checkpoints for the database cluster, broken down by checkpoint type.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.bgwriter.buffers\_alloc** - the number of buffers allocated.<br>**pgsql.bgwriter.buffers\_backend** -the number of buffers written directly by a backend.<br>**pgsql.bgwriter.maxwritten\_clean** - the number of times the background writer stopped a cleaning scan, because it had written too many buffers.<br>**pgsql.bgwriter.buffers\_backend\_fsync** -the number of times a backend had to execute its own fsync call instead of the background writer.<br>**pgsql.bgwriter.buffers\_clean** - the number of buffers written by the background writer.<br>**pgsql.bgwriter.buffers\_checkpoint** - the number of buffers written during checkpoints.<br>**pgsql.bgwriter.checkpoints\_timed** - the number of scheduled checkpoints that have been performed.<br>**pgsql.bgwriter.checkpoints\_req** - the number of requested checkpoints that have been performed.<br>**pgsql.bgwriter.checkpoint\_write\_time** - the total amount of time spent in the portion of checkpoint processing where files are written to disk, in milliseconds.<br>**pgsql.bgwriter.sync\_time** - the total amount of time spent in the portion of checkpoint processing where files are synchronized with disk.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.cache.hit\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|PostgreSQL buffer cache hit rate.|SQL query in percentage.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.connections\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Connections by type.|JSON object.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.connections.active** - the backend is executing a query.<br>**pgsql.connections.fastpath\_function\_call** -the backend is executing a fast-path function.<br>**pgsql.connections.idle** - the backend is waiting for a new client command.<br>**pgsql.connections.idle\_in\_transaction** - the backend is in a transaction, but is not currently executing a query.<br>**pgsql.connections.prepared** - the number of prepared connections.<br>**pgsql.connections.total** - the total number of connections.<br>**pgsql.connections.total\_pct** - percantange of total connections in respect to ‘max\_connections’ setting of the PostgreSQL server.<br>**pgsql.connections.waiting** - number of connections in a query.<br>**pgsql.connections.idle\_in\_transaction\_aborted** - the backend is in a transaction, but is not currently executing a query and one of the statements in the transaction caused an error.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.dbstat\[uri,<username>,<password>, dbName\]|<|<|<|<|
|<|Collects statistics per database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.dbstat.numbackends\["{\#DBNAME}"\]** - time spent reading data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.blk\_read\_time\["{\#DBNAME}"\]** - time spent reading data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.blk\_write\_time\["{\#DBNAME}"\]** - time spent writing data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.checksum\_failures\["{\#DBNAME}"\]** - the number of data page checksum failures detected (or on a shared object), or NULL if data checksums are not enabled.(PostgreSQL version 12 only)<br>**pgsql.dbstat.blks\_read.rate\["{\#DBNAME}"\]** - the number of disk blocks read in this database.<br>**pgsql.dbstat.deadlocks.rate\["{\#DBNAME}"\]** - the number of deadlocks detected in this database.<br>**pgsql.dbstat.blks\_hit.rate\["{\#DBNAME}"\]** - the number of times disk blocks were found already in the buffer cache, so that a read was not necessary (this only includes hits in the PostgreSQL Pro buffer cache, not the operating system's file system cache).<br>**pgsql.dbstat.xact\_rollback.rate\["{\#DBNAME}"\]** - the number of transactions in this database that have been rolled back.<br>**pgsql.dbstat.xact\_commit.rate\["{\#DBNAME}"\]** - the number of transactions in this database that have been committed.<br>**pgsql.dbstat.tup\_updated.rate\["{\#DBNAME}"\]** - the number of rows updated by queries in this database.<br>**pgsql.dbstat.tup\_returned.rate\["{\#DBNAME}"\]** - the number of rows returned by queries in this database.<br>**pgsql.dbstat.tup\_inserted.rate\["{\#DBNAME}"\]** - the number of rows inserted by queries in this database.<br>**pgsql.dbstat.tup\_fetched.rate\["{\#DBNAME}"\]** - the number of rows fetched by queries in this database.<br>**pgsql.dbstat.tup\_deleted.rate\["{\#DBNAME}"\]** - the number of rows deleted by queries in this database.<br>**pgsql.dbstat.conflicts.rate\["{\#DBNAME}"\]** - the number of queries canceled due to conflicts with recovery in this database (the conflicts occur only on standby servers).<br>**pgsql.dbstat.temp\_files.rate\["{\#DBNAME}"\]** - the number of temporary files created by queries in this database. All temporary files are counted, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br>**pgsql.dbstat.temp\_bytes.rate\["{\#DBNAME}"\]** - the total amount of data written to temporary files by queries in this database. Includes data from all temporary files, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.dbstat.sum\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Summarized data for all databases in a cluster.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by the dependent items:<br>**pgsql.dbstat.numbackends** - the number of backends currently connected to this database.<br>**pgsql.dbstat.sum.blk\_read\_time** - time spent reading data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.blk\_write\_time** - time spent writing data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.checksum\_failures** - the number of data page checksum failures detected (or on a shared object), or NULL if data checksums are not enabled (PostgreSQL version 12 only).<br>**pgsql.dbstat.sum.xact\_commit** - the number of transactions in this database that have been committed.<br>**pgsql.dbstat.sum.conflicts** - database statistics about query cancels due to conflict with recovery on standby servers.<br>**pgsql.dbstat.sum.deadlocks** - the number of deadlocks detected in this database.<br>**pgsql.dbstat.sum.blks\_read** - the number of disk blocks read in this database.<br>**pgsql.dbstat.sum.blks\_hit** - the number of times disk blocks were found already in the buffer cache, so a read was not necessary (only hits in the PostgreSQL Pro buffer cache are included).<br>**pgsql.dbstat.sum.temp\_bytes** - the total amount of data written to temporary files by queries in this database. Includes data from all temporary files, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br>**pgsql.dbstat.sum.temp\_files** - the number of temporary files created by queries in this database. All temporary files are counted, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br>**pgsql.dbstat.sum.xact\_rollback** - the number of rolled-back transactions in this database.<br>**pgsql.dbstat.sum.tup\_deleted** - the number of rows deleted by queries in this database.<br>**pgsql.dbstat.sum.tup\_fetched** - the number of rows fetched by queries in this database.<br>**pgsql.dbstat.sum.tup\_inserted** - the number of rows inserted by queries in this database.<br>**pgsql.dbstat.sum.tup\_returned** - the number of rows returned by queries in this database.<br>**pgsql.dbstat.sum.tup\_updated** - the number of rows updated by queries in this database.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.age\[uri,<username>,<password>, dbName\]|<|<|<|<|
|<|Age of the oldest FrozenXID of the database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query for specific database in transactions.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.bloating\_tables\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The number of bloating tables per database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.discovery\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|List of the PostgreSQL databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query in the LLD JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.size\[uri,<username>,<password>, dbName\]|<|<|<|<|
|<|Database size in bytes. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query for specific database in bytes.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.locks\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Information about granted locks per database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQl query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.locks.shareupdateexclusive\["{\#DBNAME}"\]** - the number of share update exclusive locks.<br>**pgsql.locks.accessexclusive\["{\#DBNAME}"\]** - the number of access exclusive locks.<br>**pgsql.locks.accessshare\["{\#DBNAME}"\]** - the number of access share locks.<br>**pgsql.locks.exclusive\["{\#DBNAME}"\]** - the number of exclusive locks.<br>**pgsql.locks.rowexclusive\["{\#DBNAME}"\]** - the number of row exclusive locks.<br>**pgsql.locks.rowshare\["{\#DBNAME}"\]** - the number of row share locks.<br>**pgsql.locks.share\["{\#DBNAME}"\]** - the number of shared locks.<br>**pgsql.locks.sharerowexclusive\["{\#DBNAME}"\]** - the number of share row exclusive locks.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.oldest.xid\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Age of the oldest XID.|SQl query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.ping\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Tests whether a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues).|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication.count\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The number of standby servers.|SQL query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication.recovery\_role\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Recovery status.|0 - master mode<br>1 - recovery is still in progress (standby mode)|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication.status\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The status of replication.|0 - streaming is down<br>1 - streaming is up<br>2 - master mode|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication\_lag.b\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Replication lag in bytes.|SQL query in bytes.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication\_lag.sec\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Replication lag in seconds.|SQL query in seconds.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.uptime\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|PostgreSQL uptime in milliseconds.|SQL query in milliseconds.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.wal.stat\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|WAL statistics.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.wal.count** — the number of WAL files.<br>**pgsql.wal.write** - the WAL lsn used (in bytes).<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.config\[connString,<password>,<pattern>\]|<|<|<|<|
|<|Gets the configuration parameters of a Redis instance that match the pattern.|JSON - if a glob-style pattern was used<br><br>single value - if a pattern did not contain any wildcard character|**connString** - URI or session name.<br>**password** - Redis password.<br>**pattern** - glob-style pattern (*\** by default).|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.info\[connString,<password>,<section>\]|<|<|<|<|
|<|Gets the output of the INFO command.|JSON - output is serialized as JSON|**connString** - URI or session name.<br>**password** - Redis password.<br>**section** - [section](https://redis.io/commands/info) of information (*default* by default).|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.ping\[connString,<password>\]|<|<|<|<|
|<|Test if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues)|**connString** - URI or session name.<br>**password** - Redis password.|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.slowlog.count\[connString,<password>\]|<|<|<|<|
|<|The number of slow log entries since Redis was started.|Integer|**connString** - URI or session name.<br>**password** - Redis password.|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|smart.attribute.discovery|<|<|<|<|
|<|Returns a list of S.M.A.R.T. device attributes.|JSON object|<|The following macros and their values are returned: {\#NAME}, {\#DISKTYPE}, {\#ID}, {\#ATTRNAME}, {\#THRESH}.<br>HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID. {\#NAME} will have an add-on in case of RAID, e.g: {"{\#NAME}": "/dev/sda cciss,2"}<br><br>This item is supported for the [Smart plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|smart.disk.discovery|<|<|<|<|
|<|Returns a list of S.M.A.R.T. devices.|JSON object|<|The following macros and their values are returned: {\#NAME}, {\#DISKTYPE}, {\#MODEL}, {\#SN}.<br>HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID. {\#NAME} will have an add-on in case of RAID, e.g: {"{\#NAME}": "/dev/sda cciss,2"}<br><br>This item is supported for the [Smart plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|smart.disk.get|<|<|<|<|
|<|Returns all available properties of S.M.A.R.T. devices.|JSON object|<|HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID.<br>The data includes smartctl version and call arguments, and additional fields:<br>*disk\_name* - holds the name with the required add-ons for RAID discovery, e.g: {"disk\_name": "/dev/sda cciss,2"}<br>*disk\_type* - holds the disk type HDD, SSD, or NVME, e.g: {"disk\_type": "ssd"})<br><br>This item is supported for the [Smart plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|systemd.unit.get\[unit name,<interface>\]|<|<|<|<|
|<|Returns all properties of a systemd unit.|JSON object|**unit name** - unit name (you may want to use the {\#UNIT.NAME} macro in item prototype to discover the name)<br>**interface** - unit interface type, possible values: *Unit* (default), *Service*, *Socket*, *Device*, *Mount*, *Automount*, *Swap*, *Target*, *Path*|This item is supported for the [Systemd plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box) on Linux platform only.<br><br>LoadState, ActiveState and UnitFileState for Unit interface are returned as text and integer:<br>`"ActiveState":{"state":1,"text":"active"}`|
|systemd.unit.info\[unit name,<property>,<interface>\]|<|<|<|<|
|<|Systemd unit information.|String|**unit name** - unit name (you may want to use the {\#UNIT.NAME} macro in item prototype to discover the name)<br>**property** - unit property (e.g. ActiveState (default), LoadState, Description)<br>**interface** - unit interface type (e.g. Unit (default), Socket, Service)|This item allows to retrieve a specific property from specific type of interface as described in [dbus API](https://www.freedesktop.org/wiki/Software/systemd/dbus/).<br><br>This item is supported for the [Systemd plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box) on Linux platform only.<br><br>Examples:<br>=> systemd.unit.info\["{\#UNIT.NAME}"\] - collect active state (active, reloading, inactive, failed, activating, deactivating) info on discovered systemd units<br>=> systemd.unit.info\["{\#UNIT.NAME}",LoadState\] - collect load state info on discovered systemd units<br>=> systemd.unit.info\[mysqld.service,Id\] - retrieve service technical name (mysqld.service)<br>=> systemd.unit.info\[mysqld.service,Description\] - retrieve service description (MySQL Server)<br>=> systemd.unit.info\[mysqld.service,ActiveEnterTimestamp\] - retrieve the last time the service entered the active state (1562565036283903)<br>=> systemd.unit.info\[dbus.socket,NConnections,Socket\] - collect the number of connections from this socket unit|
|systemd.unit.discovery\[<type>\]|<|<|<|<|
|<|List of systemd units and their details. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**type** - possible values: *all*, *automount*, *device*, *mount*, *path*, *service* (default), *socket*, *swap*, *target*|This item is supported for the [Systemd plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box) on Linux platform only.|
|web.certificate.get\[hostname,<port>,<address>\]|<|<|<|<|
|<|Validates certificates and returns certificate details.|JSON object|**hostname** - can be either IP or DNS.<br>May contain the URL scheme (*https* only), path (it will be ignored), and port.<br>If a port is provided in both the first and the second parameters, their values must match.<br>If address (the 3rd parameter) is specified, the hostname is only used for SNI and hostname verification.<br>**port** - port number (default is 443 for HTTPS).<br>**address** - can be either IP or DNS. If specified, it will be used for connection, and hostname (the 1st parameter) will be used for SNI, and host verification.<br>In case, the 1st parameter is an IP and the 3rd parameter is DNS, the 1st parameter will be used for connection, and the 3rd parameter will be used for SNI and host verification.|This item turns unsupported if the resource specified in `host` does not exist or is unavailable or if TLS handshake fails with any error except an invalid certificate.<br><br>Currently, AIA (Authority Information Access) X.509 extension, CRLs and OCSP (including OCSP stapling), Certificate Transparency, and custom CA trust store are not supported.|
#### Item keys
The table provides details on the item keys that you can use with Zabbix
agent 2 only.
See also: [Plugins supplied
out-of-the-box](/manual/config/items/plugins#plugins_supplied_out-of-the-box)
::: noteclassic
Parameters without angle brackets are mandatory. Parameters
marked with angle brackets **<** **>** are optional.
:::
|Key|<|<|<|<|
|---|-|-|-|-|
|<|**Description**|**Return value**|**Parameters**|**Comments**|
|ceph.df.details \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Cluster’s data usage and distribution among pools.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.osd.stats \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Aggregated and per OSD statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.osd.discovery \[connString, <user>, <apikey>\]|<|<|<|<|
|<|List of discovered OSDs. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.osd.dump \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Usage thresholds and statuses of OSDs.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.ping \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Tests whether a connection to Ceph can be established.|0 - connection is broken (if there is any error presented including AUTH and configuration issues)<br>1 - connection is successful.|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.pool.discovery \[connString, <user>, <apikey>\]|<|<|<|<|
|<|List of discovered pools. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|ceph.status \[connString, <user>, <apikey>\]|<|<|<|<|
|<|Overall cluster's status.|JSON object|**connString** - URI or session name.<br>**user, password** - Ceph login credentials.|This item is supported for the [Ceph plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|docker.container\_info \[<ID>\]|<|<|<|<|
|<|Low-level information about a container.|An output of the [ContainerInspect](https://docs.docker.com/engine/api/v1.28/#operation/ContainerInspect) API call serialized as JSON|**ID** - ID or name of the container|This item is supported since Zabbix 5.0.0 for the Docker plugin.<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.container\_stats \[<ID>\]|<|<|<|<|
|<|Container resource usage statistics.|An output of the [ContainerStats](https://docs.docker.com/engine/api/v1.28/#operation/ContainerStats) API call and CPU usage percentage serialized as JSON|**ID** - ID or name of the container|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.containers|<|<|<|<|
|<|A list of containers.|An output of the [ContainerList](https://docs.docker.com/engine/api/v1.28/#operation/ContainerList) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.containers.discovery\[<options>\]|<|<|<|<|
|<|A list of containers. Used for [low-level discovery](/manual/discovery/low_level_discovery/).|JSON object.|**options** - specifies whether all or only running containers should be discovered. Supported values:<br>*true* - return all containers;<br>*false* - return only running containers (default).|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.data\_usage|<|<|<|<|
|<|Information about current data usage.|An output of the [SystemDataUsage](https://docs.docker.com/engine/api/v1.28/#operation/SystemDataUsage) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.images|<|<|<|<|
|<|A list of images.|An output of the [ImageList](https://docs.docker.com/engine/api/v1.28/#operation/ImageList) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.images.discovery|<|<|<|<|
|<|A list of images. Used for [low-level discovery](/manual/discovery/low_level_discovery/).|JSON object.|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.info|<|<|<|<|
|<|System information.|An output of the [SystemInfo](https://docs.docker.com/engine/api/v1.28/#operation/SystemInfo) API call serialized as JSON|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|docker.ping|<|<|<|<|
|<|Test if a Docker daemon is alive or not.|1 - connection is alive<br><br>0 - connection is broken|\-|This item is supported for the [Docker plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The Agent2 user ('zabbix') must be added to the 'docker' [group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for sufficient privileges. Otherwise the check will fail.|
|memcached.ping\[connString,<user>,<password>\]|<|<|<|<|
|<|Test if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues)|**connString** - URI or session name.|This item is supported for the [Memchached plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|memcached.stats\[connString,<user>,<password>,<type>\]|<|<|<|<|
|<|Gets the output of the STATS command.|JSON - output is serialized as JSON|**connString** - URI or session name.<br>**user, password** - Memchached login credentials.<br>**type** - stat type to be returned: *items*, *sizes*, *slabs* or *settings* (empty by default, returns general statistics).|This item is supported for the [Memchached plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.collection.stats\[connString,<user>,<password>,<database>,collection\]|<|<|<|<|
|<|Returns a variety of storage statistics for a given collection.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.<br>**database** - database name (default: admin).<br>**collection** — collection name.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.collections.discovery\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a list of discovered collections. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.collections.usage\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns usage statistics for collections.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.connpool.stats\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns information regarding the open outgoing connections from the current database instance to other members of the sharded cluster or replica set.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.db.stats\[connString,<user>,<password>,<database>\]|<|<|<|<|
|<|Returns statistics reflecting a given database system state.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.<br>**database** - database name (default: admin).|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.db.discovery\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a list of discovered databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.jumbo\_chunks.count\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns count of jumbo chunks.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.oplog.stats\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a status of the replica set, using data polled from the oplog.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.ping\[connString,<user>,<password>\]|<|<|<|<|
|<|Tests if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues).|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.rs.config\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a current configuration of the replica set.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.rs.status\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a replica set status from the point of view of the member where the method is run.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.server.status\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns database state.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mongodb.sh.discovery\[connString,<user>,<password>\]|<|<|<|<|
|<|Returns a list of discovered shards present in the cluster.|JSON object|**connString** - URI or session name.<br>**user, password** - MongoDB login credentials.|This item is supported for the [MongoDB plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mqtt.get\[<broker\_url>,topic,<username>,<password>\]|<|<|<|<|
|<|Subscribes to a specific topic or topics (with wildcards) of the provided broker and waits for publications.|Depending on topic content.<br><br>If wildcards are used, returns topic content as JSON.|**broker\_url** - MQTT broker URL (if empty, *localhost* with port 1883 is used).<br>**topic** - MQTT topic (mandatory). Wildcards (+,\#) are supported.<br>**username,password** - authentication credentials (if required)|This item is supported for the [MQTT plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).<br><br>The item must be configured as an [active check](/manual/appendix/items/activepassive#active_checks) ('Zabbix agent (active)' item type).<br><br>TLS encryption certificates can be used by saving them into a default location (e.g. `/etc/ssl/certs/` directory for Ubuntu). For TLS, use the `tls://` scheme.|
|mysql.db.discovery\[connString, <username>, <password>\]|<|<|<|<|
|<|List of MySQL databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|Result of the "show databases" SQL query in LLD JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.db.size\[connString, <username>, <password>,dbName\]|<|<|<|<|
|<|Database size in bytes.|Result of the "select coalesce(sum(data\_length + index\_length),0) as size from information\_schema.tables where table\_schema=?" SQL query for specific database in bytes.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.<br>**dbName** - Database name.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.get\_status\_variables\[connString, <username>, <password>\]|<|<|<|<|
|<|Values of global status variables.|Result of the "show global status" SQL query in JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.ping\[connString, <username>, <password>\]|<|<|<|<|
|<|Test if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues).|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.replication.discovery\[connString, <username>, <password>\]|<|<|<|<|
|<|List of MySQL replications. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|Result of the "show slave status" SQL query in LLD JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.replication.get\_slave\_status\[connString, <username>, <password>, <masterHost>\]|<|<|<|<|
|<|Replication status.|Result of the "show slave status" SQL query in JSON format.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.<br>**masterHost** - Replication master host name.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|mysql.version\[connString, <username>, <password>\]|<|<|<|<|
|<|MySQL version.|String with MySQL instance version.|**connString** - URI or session name.<br>**username, password** - MySQL login credentials.|This item is supported for the [MySQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.diskgroups.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|ASM disk groups statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.diskgroups.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of ASM disk groups. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.archive.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Archive logs statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.cdb.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|CDBs info.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.custom.query\[connString,<user>,<password>,<service>, queryName, <args...>\]|<|<|<|<|
|<|Result of a custom query.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**queryName** — name of a custom query (must be equal to a name of an sql file without an extension).<br>**args...** — one or several comma-separated arguments to pass to a query.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.datafiles.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Data files statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.db.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.fra.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|FRA statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.instance.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Instance statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.pdb.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|PDBs info.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.pdb.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of PDBs. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.pga.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|PGA statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.ping\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Tests whether a connection to Oracle can be established.|0 - connection is broken (if there is any error presented including AUTH and configuration issues)<br>1 - connection is successful.|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.proc.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Processes statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.redolog.info\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Log file information from the control file.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sga.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|SGA statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sessions.stats\[connString,<user>,<password>,<service>,<lockMaxTime>\]|<|<|<|<|
|<|Sessions statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**lockMaxTime** - maximum session lock duration in seconds to count the session as a prolongedly locked. Default: 600 seconds.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sys.metrics\[connString,<user>,<password>,<service>,<duration>\]|<|<|<|<|
|<|A set of system metric values.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**duration** - capturing interval (in seconds) of system metric values. Possible values: *60* — long duration (default), *15* — short duration.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.sys.params\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|A set of system parameter values.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.ts.stats\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|Tablespaces statistics.|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.ts.discovery\[connString,<user>,<password>,<service>\]|<|<|<|<|
|<|List of tablespaces. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|oracle.user.info\[connString,<user>,<password>,<username>\]|<|<|<|<|
|<|List of tablespaces. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**connString** - URI or session name.<br>**user, password** - Oracle login credentials.<br>**service** - Oracle service name.<br>**username** - a username, for which the information is needed. Lowercase usernames are not supported. Default: current user.|This item is supported for the [Oracle plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.autovacuum.count\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The number of autovacuum workers.|SQL query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.archive\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Information about archived files.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.archive.count\_archived\_files** - the number of WAL files that have been successfully archived.<br>**pgsql.archive.failed\_trying\_to\_archive** - the number of failed attempts for archiving WAL files.<br>**pgsql.archive.count\_files\_to\_archive** - the number of files to archive.<br>**pgsql.archive.size\_files\_to\_archive** -the size of files to archive.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.bgwriter\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Combined number of checkpoints for the database cluster, broken down by checkpoint type.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.bgwriter.buffers\_alloc** - the number of buffers allocated.<br>**pgsql.bgwriter.buffers\_backend** -the number of buffers written directly by a backend.<br>**pgsql.bgwriter.maxwritten\_clean** - the number of times the background writer stopped a cleaning scan, because it had written too many buffers.<br>**pgsql.bgwriter.buffers\_backend\_fsync** -the number of times a backend had to execute its own fsync call instead of the background writer.<br>**pgsql.bgwriter.buffers\_clean** - the number of buffers written by the background writer.<br>**pgsql.bgwriter.buffers\_checkpoint** - the number of buffers written during checkpoints.<br>**pgsql.bgwriter.checkpoints\_timed** - the number of scheduled checkpoints that have been performed.<br>**pgsql.bgwriter.checkpoints\_req** - the number of requested checkpoints that have been performed.<br>**pgsql.bgwriter.checkpoint\_write\_time** - the total amount of time spent in the portion of checkpoint processing where files are written to disk, in milliseconds.<br>**pgsql.bgwriter.sync\_time** - the total amount of time spent in the portion of checkpoint processing where files are synchronized with disk.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.cache.hit\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|PostgreSQL buffer cache hit rate.|SQL query in percentage.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.connections\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Connections by type.|JSON object.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.connections.active** - the backend is executing a query.<br>**pgsql.connections.fastpath\_function\_call** -the backend is executing a fast-path function.<br>**pgsql.connections.idle** - the backend is waiting for a new client command.<br>**pgsql.connections.idle\_in\_transaction** - the backend is in a transaction, but is not currently executing a query.<br>**pgsql.connections.prepared** - the number of prepared connections.<br>**pgsql.connections.total** - the total number of connections.<br>**pgsql.connections.total\_pct** - percantange of total connections in respect to ‘max\_connections’ setting of the PostgreSQL server.<br>**pgsql.connections.waiting** - number of connections in a query.<br>**pgsql.connections.idle\_in\_transaction\_aborted** - the backend is in a transaction, but is not currently executing a query and one of the statements in the transaction caused an error.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.dbstat\[uri,<username>,<password>, dbName\]|<|<|<|<|
|<|Collects statistics per database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.dbstat.numbackends\["{\#DBNAME}"\]** - time spent reading data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.blk\_read\_time\["{\#DBNAME}"\]** - time spent reading data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.blk\_write\_time\["{\#DBNAME}"\]** - time spent writing data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.checksum\_failures\["{\#DBNAME}"\]** - the number of data page checksum failures detected (or on a shared object), or NULL if data checksums are not enabled.(PostgreSQL version 12 only)<br>**pgsql.dbstat.blks\_read.rate\["{\#DBNAME}"\]** - the number of disk blocks read in this database.<br>**pgsql.dbstat.deadlocks.rate\["{\#DBNAME}"\]** - the number of deadlocks detected in this database.<br>**pgsql.dbstat.blks\_hit.rate\["{\#DBNAME}"\]** - the number of times disk blocks were found already in the buffer cache, so that a read was not necessary (this only includes hits in the PostgreSQL Pro buffer cache, not the operating system's file system cache).<br>**pgsql.dbstat.xact\_rollback.rate\["{\#DBNAME}"\]** - the number of transactions in this database that have been rolled back.<br>**pgsql.dbstat.xact\_commit.rate\["{\#DBNAME}"\]** - the number of transactions in this database that have been committed.<br>**pgsql.dbstat.tup\_updated.rate\["{\#DBNAME}"\]** - the number of rows updated by queries in this database.<br>**pgsql.dbstat.tup\_returned.rate\["{\#DBNAME}"\]** - the number of rows returned by queries in this database.<br>**pgsql.dbstat.tup\_inserted.rate\["{\#DBNAME}"\]** - the number of rows inserted by queries in this database.<br>**pgsql.dbstat.tup\_fetched.rate\["{\#DBNAME}"\]** - the number of rows fetched by queries in this database.<br>**pgsql.dbstat.tup\_deleted.rate\["{\#DBNAME}"\]** - the number of rows deleted by queries in this database.<br>**pgsql.dbstat.conflicts.rate\["{\#DBNAME}"\]** - the number of queries canceled due to conflicts with recovery in this database (the conflicts occur only on standby servers).<br>**pgsql.dbstat.temp\_files.rate\["{\#DBNAME}"\]** - the number of temporary files created by queries in this database. All temporary files are counted, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br>**pgsql.dbstat.temp\_bytes.rate\["{\#DBNAME}"\]** - the total amount of data written to temporary files by queries in this database. Includes data from all temporary files, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.dbstat.sum\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Summarized data for all databases in a cluster.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by the dependent items:<br>**pgsql.dbstat.numbackends** - the number of backends currently connected to this database.<br>**pgsql.dbstat.sum.blk\_read\_time** - time spent reading data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.blk\_write\_time** - time spent writing data file blocks by backends in this database, in milliseconds.<br>**pgsql.dbstat.sum.checksum\_failures** - the number of data page checksum failures detected (or on a shared object), or NULL if data checksums are not enabled (PostgreSQL version 12 only).<br>**pgsql.dbstat.sum.xact\_commit** - the number of transactions in this database that have been committed.<br>**pgsql.dbstat.sum.conflicts** - database statistics about query cancels due to conflict with recovery on standby servers.<br>**pgsql.dbstat.sum.deadlocks** - the number of deadlocks detected in this database.<br>**pgsql.dbstat.sum.blks\_read** - the number of disk blocks read in this database.<br>**pgsql.dbstat.sum.blks\_hit** - the number of times disk blocks were found already in the buffer cache, so a read was not necessary (only hits in the PostgreSQL Pro buffer cache are included).<br>**pgsql.dbstat.sum.temp\_bytes** - the total amount of data written to temporary files by queries in this database. Includes data from all temporary files, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br>**pgsql.dbstat.sum.temp\_files** - the number of temporary files created by queries in this database. All temporary files are counted, regardless of the log\_temp\_files settings and reasons for which the temporary file was created (e.g., sorting or hashing).<br>**pgsql.dbstat.sum.xact\_rollback** - the number of rolled-back transactions in this database.<br>**pgsql.dbstat.sum.tup\_deleted** - the number of rows deleted by queries in this database.<br>**pgsql.dbstat.sum.tup\_fetched** - the number of rows fetched by queries in this database.<br>**pgsql.dbstat.sum.tup\_inserted** - the number of rows inserted by queries in this database.<br>**pgsql.dbstat.sum.tup\_returned** - the number of rows returned by queries in this database.<br>**pgsql.dbstat.sum.tup\_updated** - the number of rows updated by queries in this database.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.age\[uri,<username>,<password>, dbName\]|<|<|<|<|
|<|Age of the oldest FrozenXID of the database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query for specific database in transactions.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.bloating\_tables\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The number of bloating tables per database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.discovery\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|List of the PostgreSQL databases. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query in the LLD JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.db.size\[uri,<username>,<password>, dbName\]|<|<|<|<|
|<|Database size in bytes. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQL query for specific database in bytes.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.locks\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Information about granted locks per database. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|SQl query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.locks.shareupdateexclusive\["{\#DBNAME}"\]** - the number of share update exclusive locks.<br>**pgsql.locks.accessexclusive\["{\#DBNAME}"\]** - the number of access exclusive locks.<br>**pgsql.locks.accessshare\["{\#DBNAME}"\]** - the number of access share locks.<br>**pgsql.locks.exclusive\["{\#DBNAME}"\]** - the number of exclusive locks.<br>**pgsql.locks.rowexclusive\["{\#DBNAME}"\]** - the number of row exclusive locks.<br>**pgsql.locks.rowshare\["{\#DBNAME}"\]** - the number of row share locks.<br>**pgsql.locks.share\["{\#DBNAME}"\]** - the number of shared locks.<br>**pgsql.locks.sharerowexclusive\["{\#DBNAME}"\]** - the number of share row exclusive locks.<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.oldest.xid\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Age of the oldest XID.|SQl query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.ping\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Tests whether a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues).|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication.count\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The number of standby servers.|SQL query.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication.recovery\_role\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Recovery status.|0 - master mode<br>1 - recovery is still in progress (standby mode)|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication.status\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|The status of replication.|0 - streaming is down<br>1 - streaming is up<br>2 - master mode|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication\_lag.b\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Replication lag in bytes.|SQL query in bytes.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.replication\_lag.sec\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|Replication lag in seconds.|SQL query in seconds.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.uptime\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|PostgreSQL uptime in milliseconds.|SQL query in milliseconds.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|pgsql.wal.stat\[uri,<username>,<password>, <dbName>\]|<|<|<|<|
|<|WAL statistics.|SQL query in JSON format.|**uri** - URI or session name.<br>**username, password** - PostgreSQL credentials.<br>**dbName** - Database name.|Returned data are processed by dependent items:<br>**pgsql.wal.count** — the number of WAL files.<br>**pgsql.wal.write** - the WAL lsn used (in bytes).<br><br>This item is supported since Zabbix 5.0.1 for the [PostgreSQL plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.config\[connString,<password>,<pattern>\]|<|<|<|<|
|<|Gets the configuration parameters of a Redis instance that match the pattern.|JSON - if a glob-style pattern was used<br><br>single value - if a pattern did not contain any wildcard character|**connString** - URI or session name.<br>**password** - Redis password.<br>**pattern** - glob-style pattern (*\** by default).|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.info\[connString,<password>,<section>\]|<|<|<|<|
|<|Gets the output of the INFO command.|JSON - output is serialized as JSON|**connString** - URI or session name.<br>**password** - Redis password.<br>**section** - [section](https://redis.io/commands/info) of information (*default* by default).|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.ping\[connString,<password>\]|<|<|<|<|
|<|Test if a connection is alive or not.|1 - connection is alive<br><br>0 - connection is broken (if there is any error presented including AUTH and configuration issues)|**connString** - URI or session name.<br>**password** - Redis password.|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|redis.slowlog.count\[connString,<password>\]|<|<|<|<|
|<|The number of slow log entries since Redis was started.|Integer|**connString** - URI or session name.<br>**password** - Redis password.|This item is supported since Zabbix 4.4.5 for the [Redis plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|smart.attribute.discovery|<|<|<|<|
|<|Returns a list of S.M.A.R.T. device attributes.|JSON object|<|The following macros and their values are returned: {\#NAME}, {\#DISKTYPE}, {\#ID}, {\#ATTRNAME}, {\#THRESH}.<br>HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID. {\#NAME} will have an add-on in case of RAID, e.g: {"{\#NAME}": "/dev/sda cciss,2"}<br><br>This item is supported for the [Smart plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|smart.disk.discovery|<|<|<|<|
|<|Returns a list of S.M.A.R.T. devices.|JSON object|<|The following macros and their values are returned: {\#NAME}, {\#DISKTYPE}, {\#MODEL}, {\#SN}.<br>HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID. {\#NAME} will have an add-on in case of RAID, e.g: {"{\#NAME}": "/dev/sda cciss,2"}<br><br>This item is supported for the [Smart plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|smart.disk.get|<|<|<|<|
|<|Returns all available properties of S.M.A.R.T. devices.|JSON object|<|HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID.<br>The data includes smartctl version and call arguments, and additional fields:<br>*disk\_name* - holds the name with the required add-ons for RAID discovery, e.g: {"disk\_name": "/dev/sda cciss,2"}<br>*disk\_type* - holds the disk type HDD, SSD, or NVME, e.g: {"disk\_type": "ssd"})<br><br>This item is supported for the [Smart plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box).|
|systemd.unit.get\[unit name,<interface>\]|<|<|<|<|
|<|Returns all properties of a systemd unit.|JSON object|**unit name** - unit name (you may want to use the {\#UNIT.NAME} macro in item prototype to discover the name)<br>**interface** - unit interface type, possible values: *Unit* (default), *Service*, *Socket*, *Device*, *Mount*, *Automount*, *Swap*, *Target*, *Path*|This item is supported for the [Systemd plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box) on Linux platform only.<br><br>LoadState, ActiveState and UnitFileState for Unit interface are returned as text and integer:<br>`"ActiveState":{"state":1,"text":"active"}`|
|systemd.unit.info\[unit name,<property>,<interface>\]|<|<|<|<|
|<|Systemd unit information.|String|**unit name** - unit name (you may want to use the {\#UNIT.NAME} macro in item prototype to discover the name)<br>**property** - unit property (e.g. ActiveState (default), LoadState, Description)<br>**interface** - unit interface type (e.g. Unit (default), Socket, Service)|This item allows to retrieve a specific property from specific type of interface as described in [dbus API](https://www.freedesktop.org/wiki/Software/systemd/dbus/).<br><br>This item is supported for the [Systemd plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box) on Linux platform only.<br><br>Examples:<br>=> systemd.unit.info\["{\#UNIT.NAME}"\] - collect active state (active, reloading, inactive, failed, activating, deactivating) info on discovered systemd units<br>=> systemd.unit.info\["{\#UNIT.NAME}",LoadState\] - collect load state info on discovered systemd units<br>=> systemd.unit.info\[mysqld.service,Id\] - retrieve service technical name (mysqld.service)<br>=> systemd.unit.info\[mysqld.service,Description\] - retrieve service description (MySQL Server)<br>=> systemd.unit.info\[mysqld.service,ActiveEnterTimestamp\] - retrieve the last time the service entered the active state (1562565036283903)<br>=> systemd.unit.info\[dbus.socket,NConnections,Socket\] - collect the number of connections from this socket unit|
|systemd.unit.discovery\[<type>\]|<|<|<|<|
|<|List of systemd units and their details. Used for [low-level discovery](/manual/discovery/low_level_discovery/examples/systemd).|JSON object|**type** - possible values: *all*, *automount*, *device*, *mount*, *path*, *service* (default), *socket*, *swap*, *target*|This item is supported for the [Systemd plugin](/manual/config/items/plugins#plugins_supplied_out-of-the-box) on Linux platform only.|
|web.certificate.get\[hostname,<port>,<address>\]|<|<|<|<|
|<|Validates certificates and returns certificate details.|JSON object|**hostname** - can be either IP or DNS.<br>May contain the URL scheme (*https* only), path (it will be ignored), and port.<br>If a port is provided in both the first and the second parameters, their values must match.<br>If address (the 3rd parameter) is specified, the hostname is only used for SNI and hostname verification.<br>**port** - port number (default is 443 for HTTPS).<br>**address** - can be either IP or DNS. If specified, it will be used for connection, and hostname (the 1st parameter) will be used for SNI, and host verification.<br>In case, the 1st parameter is an IP and the 3rd parameter is DNS, the 1st parameter will be used for connection, and the 3rd parameter will be used for SNI and host verification.|This item turns unsupported if the resource specified in `host` does not exist or is unavailable or if TLS handshake fails with any error except an invalid certificate.<br><br>Currently, AIA (Authority Information Access) X.509 extension, CRLs and OCSP (including OCSP stapling), Certificate Transparency, and custom CA trust store are not supported.|
#### Item keys
The table provides details on the simple checks that can be used to
monitor [VMware environments](/manual/vm_monitoring).
Parameters without angle brackets are mandatory. Parameters marked with angle brackets **<** **>** are optional.
|Key|<|<|<|<|
|-|------|--|------|------|
|<|Description|Return value|Parameters|Comments|
|vmware.cl.perfcounter\[url,id,path,<instance>\]|<|<|<|<|
|<|VMware cluster performance counter metrics.|Integer|**url** - VMware service URL<br>**id** - VMware cluster ID<br>**path** - performance counter path ^**[1](vmware_keys#footnotes)**^<br>**instance** - performance counter instance|`id` can be received from vmware.cluster.discovery\[\] as {\#CLUSTER.ID}|
|vmware.cluster.discovery\[url\]|<|<|<|<|
|<|Discovery of VMware clusters.|JSON object|**url** - VMware service URL|<|
|vmware.cluster.status\[url,name\]|<|<|<|<|
|<|VMware cluster status.|Integer:<br>0 - gray;<br>1 - green;<br>2 - yellow;<br>3 - red|**url** - VMware service URL<br>**name** - VMware cluster name|<|
|vmware.datastore.discovery\[url\]|<|<|<|<|
|<|Discovery of VMware datastores.|JSON object|**url** - VMware service URL|<|
|vmware.datastore.hv.list\[url,datastore\]|<|<|<|<|
|<|List of datastore hypervisors.|JSON object|**url** - VMware service URL<br>**datastore** - datastore name|<|
|vmware.datastore.read\[url,datastore,<mode>\]|<|<|<|<|
|<|Amount of time for a read operation from the datastore (milliseconds).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**datastore** - datastore name<br>**mode** - latency (average value, default), maxlatency (maximum value)|<|
|vmware.datastore.size\[url,datastore,<mode>\]|<|<|<|<|
|<|VMware datastore space in bytes or in percentage from total.|Integer - for bytes<br>Float - for percentage|**url** - VMware service URL<br>**datastore** - datastore name<br>**mode** - possible values:<br>total (default), free, pfree (free, percentage), uncommitted|<|
|vmware.datastore.write\[url,datastore,<mode>\]|<|<|<|<|
|<|Amount of time for a write operation to the datastore (milliseconds).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**datastore** - datastore name<br>**mode** - latency (average value, default), maxlatency (maximum value)|<|
|vmware.dc.discovery\[url\]|<|<|<|<|
|<|Discovery of VMware datacenters.|JSON object|**url** - VMware service URL|<|
|vmware.eventlog\[url,<mode>\]|<|<|<|<|
|<|VMware event log.|Log|**url** - VMware service URL<br>**mode** - *all* (default), *skip* - skip processing of older data|There must be only one vmware.eventlog\[\] item key per URL.<br><br>See also: [example of filtering](/manual/config/items/preprocessing/examples#filtering_vmware_event_log_records) VMware event log records.|
|vmware.fullname\[url\]|<|<|<|<|
|<|VMware service full name.|String|**url** - VMware service URL|<|
|vmware.hv.cluster.name\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor cluster name.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.cpu.usage\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor processor usage (Hz).|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.cpu.usage.perf\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor processor usage as a percentage during the interval.|Float|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.cpu.utilization\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor processor usage as a percentage during the interval, depends on power management or HT.|Float|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.datacenter.name\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor datacenter name.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.datastore.discovery\[url,uuid\]|<|<|<|<|
|<|Discovery of VMware hypervisor datastores.|JSON object|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.datastore.list\[url,uuid\]|<|<|<|<|
|<|List of VMware hypervisor datastores.|JSON object|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.datastore.multipath\[url,uuid,<datastore>,<partitionid>\]|<|<|<|<|
|<|Number of available datastore paths.|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**datastore** - datastore UUID or name<br>**partitionid** - internal ID of physical device from vmware.hv.datastore.discovery|<|
|vmware.hv.datastore.read\[url,uuid,datastore,<mode>\]|<|<|<|<|
|<|Average amount of time for a read operation from the datastore (milliseconds).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**datastore** - datastore UUID or name<br>**mode** - latency (default)|<|
|vmware.hv.datastore.size\[url,uuid,datastore,<mode>\]|<|<|<|<|
|<|VMware datastore space in bytes or in percentage from total.|Integer - for bytes<br>Float - for percentage|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**datastore** - datastore UUID or name<br>**mode** - possible values:<br>total (default), free, pfree (free, percentage), uncommitted|<|
|vmware.hv.datastore.write\[url,uuid,datastore,<mode>\]|<|<|<|<|
|<|Average amount of time for a write operation to the datastore (milliseconds).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**datastore** - datastore UUID or name<br>**mode** - latency (default)|<|
|vmware.hv.discovery\[url\]|<|<|<|<|
|<|Discovery of VMware hypervisors.|JSON object|**url** - VMware service URL|<|
|vmware.hv.fullname\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor name.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.cpu.freq\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor processor frequency (Hz).|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.cpu.model\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor processor model.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.cpu.num\[url,uuid\]|<|<|<|<|
|<|Number of processor cores on VMware hypervisor.|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.cpu.threads\[url,uuid\]|<|<|<|<|
|<|Number of processor threads on VMware hypervisor.|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.memory\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor total memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.model\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor model.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.uuid\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor BIOS UUID.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.hw.vendor\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor vendor name.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.maintenance\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor maintenance status.|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|Returns '0' - not in maintenance or '1' - in maintenance|
|vmware.hv.memory.size.ballooned\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor ballooned memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.memory.used\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor used memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.network.in\[url,uuid,<mode>\]|<|<|<|<|
|<|VMware hypervisor network input statistics (bytes per second).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**mode** - bps (default)|<|
|vmware.hv.network.out\[url,uuid,<mode>\]|<|<|<|<|
|<|VMware hypervisor network output statistics (bytes per second).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**mode** - bps (default)|<|
|vmware.hv.perfcounter\[url,uuid,path,<instance>\]|<|<|<|<|
|<|VMware hypervisor performance counter value.|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**path** - performance counter path ^**[1](vmware_keys#footnotes)**^<br>**instance** - performance counter instance. Use empty instance for aggregate values (default)|<|
|vmware.hv.power\[url,uuid,<max>\]|<|<|<|<|
|<|VMware hypervisor power usage (W).|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier<br>**max** - maximum allowed power usage|<|
|vmware.hv.sensor.health.state\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor health state rollup sensor.|Integer:<br>0 - gray;<br>1 - green;<br>2 - yellow;<br>3 - red|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|The item might not work in the VMware vSphere 6.5 and newer, because VMware has deprecated the *VMware Rollup Health State* sensor. |
|vmware.hv.sensors.get\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor HW vendor state sensors.|JSON|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.status\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor status.|Integer:<br>0 - gray;<br>1 - green;<br>2 - yellow;<br>3 - red|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|Uses the host system overall status property.|
|vmware.hv.uptime\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor uptime (seconds).|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.version\[url,uuid\]|<|<|<|<|
|<|VMware hypervisor version.|String|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.hv.vm.num\[url,uuid\]|<|<|<|<|
|<|Number of virtual machines on VMware hypervisor.|Integer|**url** - VMware service URL<br>**uuid** - VMware hypervisor global unique identifier|<|
|vmware.version\[url\]|<|<|<|<|
|<|VMware service version.|String|**url** - VMware service URL|<|
|vmware.vm.cluster.name\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine name.|String|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.cpu.latency\[url,uuid\]|<|<|<|<|
|<|Percentage of time the virtual machine is unable to run because it is contending for access to the physical CPU(s).|Float|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.cpu.num\[url,uuid\]|<|<|<|<|
|<|Number of processors on VMware virtual machine.|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.cpu.readiness\[url,uuid,<instance>\]|<|<|<|<|
|<|Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.|Float|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - CPU instance|<|
|vmware.vm.cpu.ready\[url,uuid\]|<|<|<|<|
|<|Time (in milliseconds) that the virtual machine was ready, but could not get scheduled to run on the physical CPU. CPU ready time is dependent on the number of virtual machines on the host and their CPU loads (%).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.cpu.swapwait\[url,uuid,<instance>\]|<|<|<|<|
|<|Percentage of CPU time spent waiting for swap-in.|Float|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - CPU instance|<|
|vmware.vm.cpu.usage\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine processor usage (Hz).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.cpu.usage.perf\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine processor usage as a percentage during the interval.|Float|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.datacenter.name\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine datacenter name.|String|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.discovery\[url\]|<|<|<|<|
|<|Discovery of VMware virtual machines.|JSON object|**url** - VMware service URL|<|
|vmware.vm.guest.memory.size.swapped\[url,uuid\]|<|<|<|<|
|<|Amount of guest physical memory that is swapped out to the swap space (KB).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.guest.osuptime\[url,uuid\]|<|<|<|<|
|<|Total time elapsed since the last operating system boot-up (in seconds).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.hv.name\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine hypervisor name.|String|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine total memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.ballooned\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine ballooned memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.compressed\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine compressed memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.consumed\[url,uuid\]|<|<|<|<|
|<|Amount of host physical memory consumed for backing up guest physical memory pages (KB).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.private\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine private memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.shared\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine shared memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.swapped\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine swapped memory size (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.usage.guest\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine guest memory usage (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.size.usage.host\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine host memory usage (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.memory.usage\[url,uuid\]|<|<|<|<|
|<|Percentage of host physical memory that has been consumed.|Float|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.net.if.discovery\[url,uuid\]|<|<|<|<|
|<|Discovery of VMware virtual machine network interfaces.|JSON object|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.net.if.in\[url,uuid,instance,<mode>\]|<|<|<|<|
|<|VMware virtual machine network interface input statistics (bytes/packets per second).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - network interface instance<br>**mode** - bps (default)/pps - bytes/packets per second|<|
|vmware.vm.net.if.out\[url,uuid,instance,<mode>\]|<|<|<|<|
|<|VMware virtual machine network interface output statistics (bytes/packets per second).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - network interface instance<br>**mode** - bps (default)/pps - bytes/packets per second|<|
|vmware.vm.net.if.usage\[url,uuid,<instance>\]|<|<|<|<|
|<|VMware virtual machine network utilization (combined transmit-rates and receive-rates) during the interval (KBps).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - network interface instance|<|
|vmware.vm.perfcounter\[url,uuid,path,<instance>\]|<|<|<|<|
|<|VMware virtual machine performance counter value.|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**path** - performance counter path ^**[1](vmware_keys#footnotes)**^<br>**instance** - performance counter instance. Use empty instance for aggregate values (default)|<|
|vmware.vm.powerstate\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine power state.|Integer:<br>0 - poweredOff;<br>1 - poweredOn;<br>2 - suspended|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.storage.committed\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine committed storage space (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.storage.readoio\[url,uuid,instance\]|<|<|<|<|
|<|Average number of outstanding read requests to the virtual disk during the collection interval.|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - disk device instance (mandatory)|<|
|vmware.vm.storage.totalreadlatency\[url,uuid,instance\]|<|<|<|<|
|<|The average time a read from the virtual disk takes (milliseconds).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - disk device instance (mandatory)|<|
|vmware.vm.storage.totalwritelatency\[url,uuid,instance\]|<|<|<|<|
|<|The average time a write to the virtual disk takes (milliseconds).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - disk device instance (mandatory)|<|
|vmware.vm.storage.uncommitted\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine uncommitted storage space (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.storage.unshared\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine unshared storage space (bytes).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.storage.writeoio\[url,uuid,instance\]|<|<|<|<|
|<|Average number of outstanding write requests to the virtual disk during the collection interval.|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - disk device instance (mandatory)|<|
|vmware.vm.uptime\[url,uuid\]|<|<|<|<|
|<|VMware virtual machine uptime (seconds).|Integer|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.vfs.dev.discovery\[url,uuid\]|<|<|<|<|
|<|Discovery of VMware virtual machine disk devices.|JSON object|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|<|
|vmware.vm.vfs.dev.read\[url,uuid,instance,<mode>\]|<|<|<|<|
|<|VMware virtual machine disk device read statistics (bytes/operations per second).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - disk device instance<br>**mode** - bps (default)/ops - bytes/operations per second|<|
|vmware.vm.vfs.dev.write\[url,uuid,instance,<mode>\]|<|<|<|<|
|<|VMware virtual machine disk device write statistics (bytes/operations per second).|Integer ^**[2](vmware_keys#footnotes)**^|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**instance** - disk device instance<br>**mode** - bps (default)/ops - bytes/operations per second|<|
|vmware.vm.vfs.fs.discovery\[url,uuid\]|<|<|<|<|
|<|Discovery of VMware virtual machine file systems.|JSON object|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier|VMware Tools must be installed on the guest virtual machine.|
|vmware.vm.vfs.fs.size\[url,uuid,fsname,<mode>\]|<|<|<|<|
|<|VMware virtual machine file system statistics (bytes/percentages).|Integer - for bytes<br>Float - for percentage|**url** - VMware service URL<br>**uuid** - VMware virtual machine global unique identifier<br>**fsname** - file system name<br>**mode** - total/free/used/pfree/pused|VMware Tools must be installed on the guest virtual machine.|
#### 监控项 键
该表格提供了可用于简单检查的详细信息
监控 [VMware environments](/manual/vm_monitoring).
不带尖括号的参数是必选的。带尖括号**<** **>**的参数是可选的。
| 键 | < | < | < | < |
|-|------|--|------|------|
| < | 描述 | 返回值 | 参数 | 备注 |
| vmware.cl.perfcounter\[url,id,path,<instance>\] | < | < | < | < |
| < | VMware集群性能计数器指标 | integer | **url** - VMware服务URL<br>**id** - VMware集群ID<br>**path** - 性能计数器路径 ^**[1](vmware_keys#脚注)**^<br>**instance** - 性能计数器实例 | `id` 可通过vmware.cluster.discovery[]获取为{\#CLUSTER.ID} |
| vmware.cluster.discovery\[url\] | < | < | < | < |
| < | VMware集群发现 | JSON object | **url** - VMware服务URL | < |
| vmware.cluster.status[url,name] | < | < | < | < |
| < | VMware集群状态。 | integer:<br>0 - 灰色;<br>1 - 绿色;<br>2 - 黄色;<br>3 - 红色 | **url** - VMware服务URL<br>**name** - VMware集群名称 | < |
| vmware.datastore.discovery\[url\] | < | < | < | < |
| < | VMware数据存储的发现 | JSON object | **url** - VMware服务URL | < |
| vmware.datastore.hv.list\[url,datastore\] | < | < | < | < |
| < | 数据存储虚拟机监控程序列表 | JSON object | **url** - VMware服务URL<br>**datastore** - 数据存储名称 | < |
| vmware.datastore.read\[url,datastore,<mode>\] | < | < | < | < |
| < | 从数据存储读取操作所需时间（毫秒）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**datastore** - 数据存储名称<br>**mode** - 延迟（平均值，默认值），maxlatency（最大值） | < |
| vmware.datastore.size\[url,datastore,<mode>\] | < | < | < | < |
| < | VMware数据存储空间大小（以字节或占总空间的百分比表示）。 | integer - 字节单位<br>float - 百分比单位 | **url** - VMware服务URL<br>**datastore** - 数据存储名称<br>**mode** - 可选值：<br>total（默认值）、free、pfree（空闲空间百分比）、uncommitted | < |
| vmware.datastore.write\[url,datastore,<mode>\] | < | < | < | < |
| < | 写入数据存储操作所需时间（毫秒）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**datastore** - 数据存储名称<br>**mode** - 延迟（平均值，默认值），maxlatency（最大值） | < |
| vmware.dc.discovery\[url\] | < | < | < | < |
| < | VMware数据中心发现 | JSON object | **url** - VMware服务URL | < |
| vmware.eventlog[url,<mode>] | < | < | < | < |
| < | VMware事件日志 | 日志 | **url** - VMware服务URL<br>**mode** - *all*（默认）, *skip* - 跳过旧数据处理 | 每个URL只能有一个vmware.eventlog[]监控项键值。<br><br>另请参阅：[过滤vmware事件日志记录](/manual/config/items/preprocessing/examples#过滤vmware事件日志记录) VMware事件日志记录。 |
| vmware.fullname\[url\] | < | < | < | < |
| < | VMware服务全称 | string | **url** - VMware服务URL | < |
| vmware.hv.cluster.name[url,uuid] | < | < | < | < |
| < | VMware虚拟机管理程序集群名称。 | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符 | < |
| vmware.hv.cpu.usage[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序处理器使用率（Hz）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.cpu.usage.perf\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序在时间间隔内的处理器使用百分比。 | float | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.cpu.utilization\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序在间隔期间的处理器使用百分比，取决于电源管理或超线程技术。 | float | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.datacenter.name[url,uuid] | < | < | < | < |
| < | VMware虚拟机管理程序数据中心名称。 | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符 | < |
| vmware.hv.datastore.discovery[url,uuid] | < | < | < | < |
| < | VMware虚拟机管理程序数据存储的发现. | JSON object | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符 | < |
| vmware.hv.datastore.list\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机管理程序数据存储列表 | JSON object | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符 | < |
| vmware.hv.datastore.multipath\[url,uuid,<datastore>,<partitionid>\] | < | < | < | < |
| < | 可用数据存储路径数量。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符<br>**datastore** - 数据存储UUID或名称<br>**partitionid** - vmware.hv.datastore.discovery中物理设备的内部ID | < |
| vmware.hv.datastore.read[url,uuid,datastore,<模式>] | < | < | < | < |
| < | 从数据存储读取操作的平均时间（毫秒）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符<br>**datastore** - 数据存储UUID或名称<br>**mode** - 延迟（默认） | < |
| vmware.hv.datastore.size\[url,uuid,datastore,<mode>\] | < | < | < | < |
| < | VMware数据存储空间，以字节或占总空间的百分比表示。 | integer - 字节单位<br>float - 百分比单位 | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符<br>**datastore** - 数据存储UUID或名称<br>**mode** - 可选值:<br>total (默认), free, pfree (空闲空间百分比), uncommitted | < |
| vmware.hv.datastore.write[url,uuid,datastore,<mode>] | < | < | < | < |
| < | 写入数据存储操作的平均时间（毫秒）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符<br>**datastore** - 数据存储UUID或名称<br>**mode** - 延迟（默认） | < |
| vmware.hv.discovery[url] | < | < | < | < |
| < | VMware虚拟机监控程序的发现 | JSON object | **url** - VMware服务URL | < |
| vmware.hv.fullname\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序名称。 | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.hw.cpu.freq\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序处理器频率（Hz）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.hw.cpu.model\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序处理器型号。 | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.hw.cpu.num\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机管理程序上的处理器核心数量。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符 | < |
| vmware.hv.hw.cpu.threads[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序上的处理器线程数。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.hw.memory[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序总memory大小（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.hw.model\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机管理程序模型. | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符 | < |
| vmware.hv.hw.uuid\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机管理程序BIOS UUID. | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机管理程序全局唯一标识符 | < |
| vmware.hv.hw.vendor\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序供应商名称 | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.maintenance\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序维护状态。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | 返回'0'表示未处于维护状态，或'1'表示处于维护状态 |
| vmware.hv.memory.size.ballooned[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序膨胀memory大小（字节） | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.memory.used\[url,uuid\] | < | < | < | < |
| < | 使用的VMware虚拟机监控程序memory大小（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.network.in[url,uuid,<模式>] | < | < | < | < |
| < | VMware虚拟机监控程序网络输入统计（每秒字节数）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符<br>**mode** - bps（默认） | < |
| vmware.hv.network.out[url,uuid,<mode>] | < | < | < | < |
| < | VMware虚拟机监控程序网络输出统计（每秒字节数）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符<br>**mode** - bps（默认） | < |
| vmware.hv.perfcounter\[url,uuid,path,<instance>\] | < | < | < | < |
| < | VMware虚拟机监控程序性能计数器值。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符<br>**path** - 性能计数器路径 ^**[1](vmware_keys#脚注)**^<br>**instance** - 性能计数器实例。对于聚合值使用空实例（默认） | < |
| vmware.hv.power\[url,uuid,<max>\] | < | < | < | < |
| < | VMware虚拟机监控程序功耗（W）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符<br>**max** - 允许的最大功耗 | < |
| vmware.hv.sensor.health.state[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序健康状态汇总传感器 | integer:<br>0 - 灰色;<br>1 - 绿色;<br>2 - 黄色;<br>3 - 红色 | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | 由于VMware已弃用*VMware Rollup Health State*传感器，监控项在VMware vSphere 6.5及更新版本中可能无法工作 |
| vmware.hv.sensors.get[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序硬件供应商状态传感器. | JSON | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.status[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序状态 | integer:<br>0 - 灰色;<br>1 - 绿色;<br>2 - 黄色;<br>3 - 红色 | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | 使用主机系统整体状态属性 |
| vmware.hv.uptime\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序运行时间（秒）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.version\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机监控程序version. | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.hv.vm.num[url,uuid] | < | < | < | < |
| < | VMware虚拟机监控程序上的虚拟机数量。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机监控程序全局唯一标识符 | < |
| vmware.version\[url\] | < | < | < | < |
| < | VMware服务version. | string | **url** - VMware服务URL | < |
| vmware.vm.cluster.name[url,uuid] | < | < | < | < |
| < | VMware虚拟机名称. | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.cpu.latency\[url,uuid\] | < | < | < | < |
| < | 虚拟机因争用物理CPU访问权而无法run的时间百分比 | float | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.cpu.num\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机上的处理器数量。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.cpu.readiness[url,uuid,<instance>] | < | < | < | < |
| < | 虚拟机已就绪但无法get调度到物理CPUrun的时间百分比 | float | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - CPU实例 | < |
| vmware.vm.cpu.ready\[url,uuid\] | < | < | < | < |
| < | 虚拟机已就绪但无法get调度到run物理CPU上的时间（毫秒）。CPU就绪时间取决于主机上虚拟机数量及其CPU负载（%）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.cpu.swapwait[url,uuid,<instance>] | < | < | < | < |
| < | CPU等待交换进入的时间百分比。 | float | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - CPU实例 | < |
| vmware.vm.cpu.usage\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机处理器使用率（Hz）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.cpu.usage.perf\[url,uuid\] | < | < | < | < |
| < | 虚拟机处理器使用率（以百分比表示该时间间隔内的使用情况）。 | float | **url** - VMware服务URL<br>**uuid** - 虚拟机全局唯一标识符 | < |
| vmware.vm.datacenter.name\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机数据中心名称。 | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.discovery\[url\] | < | < | < | < |
| < | VMware虚拟机的发现 | JSON object | **url** - VMware服务URL | < |
| vmware.vm.guest.memory.size.swapped\[url,uuid\] | < | < | < | < |
| < | 被交换到交换空间的客户机物理内存memory量（KB）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.guest.osuptime\[url,uuid\] | < | < | < | < |
| < | 自操作系统上次启动以来经过的总时间（以秒为单位）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.hv.name[url,uuid] | < | < | < | < |
| < | VMware虚拟机管理程序名称. | string | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size[url,uuid] | < | < | < | < |
| < | VMware虚拟机总memory大小（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.ballooned[url,uuid] | < | < | < | < |
| < | VMware虚拟机膨胀memory大小（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.compressed\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机压缩memory大小（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.consumed[url,uuid] | < | < | < | < |
| < | 用于备份客户机物理memory页面的主机物理memory消耗量(KB) | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.private\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机私有memory大小（字节） | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.shared[url,uuid] | < | < | < | < |
| < | VMware虚拟机共享memory大小（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.swapped\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机交换memory大小（字节） | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.usage.guest[url,uuid] | < | < | < | < |
| < | VMware虚拟机客户机memory使用量（字节） | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.size.usage.主机\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机主机memory使用量(字节) | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.memory.usage\[url,uuid\] | < | < | < | < |
| < | 已消耗的主机物理memory百分比 | float | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.net.if.discovery[url,uuid] | < | < | < | < |
| < | VMware虚拟机网络接口的发现 | JSON object | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.net.if.in[url,uuid,instance,<mode>] | < | < | < | < |
| < | VMware虚拟机网络接口输入统计（每秒字节数/数据包数）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 网络接口实例<br>**mode** - bps（默认）/pps - 每秒字节数/数据包数 | < |
| vmware.vm.net.if.out[url,uuid,instance,<mode>] | < | < | < | < |
| < | VMware虚拟机网络接口输出统计（每秒字节数/数据包数）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 网络接口实例<br>**mode** - bps（默认）/pps - 每秒字节数/数据包数 | < |
| vmware.vm.net.if.usage\[url,uuid,<instance>\] | < | < | < | < |
| < | VMware虚拟机在时间间隔内的网络利用率（发送速率和接收速率合计值，单位KBps）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 网络接口实例 | < |
| vmware.vm.perfcounter\[url,uuid,path,<instance>\] | < | < | < | < |
| < | VMware虚拟机性能计数器值。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**path** - 性能计数器路径 ^**[1](vmware_keys#脚注)**^<br>**instance** - 性能计数器实例。对于聚合值使用空实例（默认） | < |
| vmware.vm.powerstate[url,uuid] | < | < | < | < |
| < | VMware虚拟机电源状态 | integer:<br>0 - 已关机;<br>1 - 已开机;<br>2 - 已挂起 | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.storage.committed\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机已提交存储空间（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.storage.readoio[url,uuid,instance] | < | < | < | < |
| < | 虚拟磁盘在收集间隔期间未完成读取请求的平均数量。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 磁盘设备实例（必填） | < |
| vmware.vm.storage.totalreadlatency\[url,uuid,instance\] | < | < | < | < |
| < | 虚拟磁盘读取操作的平均耗时（毫秒）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 磁盘设备实例（必填） | < |
| vmware.vm.storage.totalwritelatency\[url,uuid,instance\] | < | < | < | < |
| < | 虚拟磁盘写入操作的平均耗时（毫秒）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 磁盘设备实例（必填项） | < |
| vmware.vm.storage.uncommitted\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机未提交存储空间（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.storage.unshared\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机未共享存储空间（字节）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.storage.writeoio[url,uuid,instance] | < | < | < | < |
| < | 收集间隔期间虚拟磁盘上未完成的写入请求的平均数量。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 磁盘设备实例（必填） | < |
| vmware.vm.uptime\[url,uuid\] | < | < | < | < |
| < | VMware虚拟机运行时间（秒）。 | integer | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.vfs.dev.discovery[url,uuid] | < | < | < | < |
| < | VMware虚拟机磁盘设备的发现 | JSON object | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | < |
| vmware.vm.vfs.dev.read\[url,uuid,instance,<mode>\] | < | < | < | < |
| < | VMware虚拟机磁盘设备读取统计（每秒字节数/操作数）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 磁盘设备实例<br>**mode** - bps（默认）/ops - 每秒字节数/操作数 | < |
| vmware.vm.vfs.dev.write\[url,uuid,instance,<mode>\] | < | < | < | < |
| < | VMware虚拟机磁盘设备写入统计（每秒字节数/操作数）。 | integer ^**[2](vmware_keys#脚注)**^ | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**instance** - 磁盘设备实例<br>**mode** - bps（默认）/ops - 每秒字节数/操作数 | < |
| vmware.vm.vfs.fs.discovery[url,uuid] | < | < | < | < |
| < | VMware虚拟机系统发现file | JSON object | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符 | 客户虚拟机上必须安装VMware Tools |
| vmware.vm.vfs.fs.size\[url,uuid,fsname,<mode>\] | < | < | < | < |
| < | VMware虚拟机file系统统计信息（字节/百分比）。 | integer - 字节单位<br>float - 百分比单位 | **url** - VMware服务URL<br>**uuid** - VMware虚拟机全局唯一标识符<br>**fsname** - file系统名称<br>**mode** - 总量/空闲/已用/空闲百分比/已用百分比 | 必须在客户虚拟机上安装VMware Tools。 |
#### Item key
The item key to use in the [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule) is
net.if.discovery
This item is supported since Zabbix agent 2.0.
#### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)中使用的监控项密钥是
net.if.discovery
该监控项自Zabbix agent 2.0版本起支持
#### Item key
The item key to use in the [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule) is
system.cpu.discovery
This item is supported since Zabbix agent 2.4.
#### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)中使用的监控项密钥为
system.cpu.discovery
该监控项自Zabbix agent 2.4版本起支持
#### Item key
The item key to use in the [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule) is
vfs.dev.discovery
This item is supported on Linux platforms only, since Zabbix agent 4.4.
You may create discovery rules using this discovery item and:
- filter: **{\#DEVNAME} matches `sd[\D]$`** - to discover devices
named "sd0", "sd1", "sd2", ...
- filter: **{\#DEVTYPE} matches `disk` AND {\#DEVNAME} does not match
`^loop.*`** - to discover disk type devices whose name does not
start with "loop"
#### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)中使用的监控项键为
vfs.dev.discovery
该监控项仅支持Linux平台，自Zabbix agent 4.4起。
您可以使用此发现监控项来create发现规则，并通过以下方式：
- 过滤器：**{\#DEVNAME} 匹配 `sd[\D]$`** - 用于发现名为"sd0"、"sd1"、"sd2"等的设备
- 过滤器：**{\#DEVTYPE} 匹配 `disk` 且 {\#DEVNAME} 不匹配 `^loop.*`** - 用于发现名称不以"loop"开头的磁盘类型设备
#### Item key
The item to use in the [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule) is
service.discovery
This item is supported since Zabbix Windows agent 3.0.
#### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)中使用的监控项为
service.discovery
该监控项自Zabbix Windows agent 3.0版本起支持。
### Item key
The item to use in the [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule) is the
systemd.unit.discovery
::: noteimportant
This
[item](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2) key is
only supported in Zabbix agent 2.
:::
This item returns a JSON with information about systemd units, for
example:
[{
"{#UNIT.NAME}": "mysqld.service",
"{#UNIT.DESCRIPTION}": "MySQL Server",
"{#UNIT.LOADSTATE}": "loaded",
"{#UNIT.ACTIVESTATE}": "active",
"{#UNIT.SUBSTATE}": "running",
"{#UNIT.FOLLOWED}": "",
"{#UNIT.PATH}": "/org/freedesktop/systemd1/unit/mysqld_2eservice",
"{#UNIT.JOBID}": 0,
"{#UNIT.JOBTYPE}": "",
"{#UNIT.JOBPATH}": "/",
"{#UNIT.UNITFILESTATE}": "enabled"
}, {
"{#UNIT.NAME}": "systemd-journald.socket",
"{#UNIT.DESCRIPTION}": "Journal Socket",
"{#UNIT.LOADSTATE}": "loaded",
"{#UNIT.ACTIVESTATE}": "active",
"{#UNIT.SUBSTATE}": "running",
"{#UNIT.FOLLOWED}": "",
"{#UNIT.PATH}": "/org/freedesktop/systemd1/unit/systemd_2djournald_2esocket",
"{#UNIT.JOBID}": 0,
"{#UNIT.JOBTYPE}": "",
"{#UNIT.JOBPATH}": "/",
"{#UNIT.UNITFILESTATE}": "enabled"
}]
### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)中使用的监控项是
systemd.unit.discovery
::: noteimportant
此
[item](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2)键仅
在Zabbix agent 2中受支持.
:::
该监控项返回一个包含systemd单元信息的JSON,例如:
[{
"{#UNIT.NAME}": "mysqld.service",
"{#UNIT.DESCRIPTION}": "MySQL Server",
"{#UNIT.LOADSTATE}": "loaded",
"{#UNIT.ACTIVESTATE}": "active",
"{#UNIT.SUBSTATE}": "running",
"{#UNIT.FOLLOWED}": "",
"{#UNIT.PATH}": "/org/freedesktop/systemd1/unit/mysqld_2eservice",
"{#UNIT.JOBID}": 0,
"{#UNIT.JOBTYPE}": "",
"{#UNIT.JOBPATH}": "/",
"{#UNIT.UNITFILESTATE}": "enabled"
}, {
"{#UNIT.NAME}": "systemd-journald.socket",
"{#UNIT.DESCRIPTION}": "Journal Socket",
"{#UNIT.LOADSTATE}": "loaded",
"{#UNIT.ACTIVESTATE}": "active",
"{#UNIT.SUBSTATE}": "running",
"{#UNIT.FOLLOWED}": "",
"{#UNIT.PATH}": "/org/freedesktop/systemd1/unit/systemd_2djournald_2esocket",
"{#UNIT.JOBID}": 0,
"{#UNIT.JOBTYPE}": "",
"{#UNIT.JOBPATH}": "/",
"{#UNIT.UNITFILESTATE}": "enabled"
}]
#### Item key
The item to use in the [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule) is the
zabbix[host,discovery,interfaces]
internal item. This item is supported since Zabbix server 3.4.
This item returns a JSON with the description of interfaces, including:
- IP address/DNS hostname (depending on the “Connect to” host setting)
- Port number
- Interface type (Zabbix agent, SNMP, JMX, IPMI)
- If it is the default interface or not
- If the bulk request feature is enabled - for SNMP interfaces only.
For example:
[{"{#IF.CONN}":"192.168.3.1","{#IF.IP}":"192.168.3.1","{#IF.DNS}":"","{#IF.PORT}":"10050","{#IF.TYPE}":"AGENT","{#IF.DEFAULT}":1}]
With multiple interfaces their records in JSON are ordered by:
- Interface type,
- Default - the default interface is put before non-default
interfaces,
- Interface ID (in ascending order).
#### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)中使用的监控项是
zabbix[host,discovery,interfaces]
内部监控项. 该监控项自Zabbix server 3.4版本起支持.
此监控项返回包含接口描述的JSON, 包括:
- IP地址/DNS主机名(取决于"Connect to"主机设置)
- 端口号
- 接口类型(Zabbix agent, SNMP, JMX, IPMI)
- 是否为默认接口
- 是否启用批量请求功能 - 仅适用于SNMP接口.
例如:
[{"{#IF.CONN}":"192.168.3.1","{#IF.IP}":"192.168.3.1","{#IF.DNS}":"","{#IF.PORT}":"10050","{#IF.TYPE}":"AGENT","{#IF.DEFAULT}":1}]
对于多个接口, 它们在JSON中的记录按以下顺序排列:
- 接口类型,
- 默认 - 默认接口排在非默认接口之前,
- 接口ID(升序排列).
#### Item key
The item to use in the [discovery
rule](/manual/discovery/low_level_discovery#discovery_rule) is
wmi.getall[<namespace>,<query>]
This [item](/manual/config/items/itemtypes/zabbix_agent/win_keys)
transforms the query result into a JSON array. For example:
select * from Win32_DiskDrive where Name like '%PHYSICALDRIVE%'
may return something like this:
```json
[
{
"DeviceID" : "\\.\PHYSICALDRIVE0",
"BytesPerSector" : 512,
"Capabilities" : [
3,
4
],
"CapabilityDescriptions" : [
"Random Access",
"Supports Writing"
],
"Caption" : "VBOX HARDDISK ATA Device",
"ConfigManagerErrorCode" : 0,
"ConfigManagerUserConfig" : "False",
"CreationClassName" : "Win32_DiskDrive",
"Description" : "Disk drive",
"FirmwareRevision" : "1.0",
"Index" : 0,
"InterfaceType" : "IDE"
},
{
"DeviceID" : "\\.\PHYSICALDRIVE1",
"BytesPerSector" : 512,
"Capabilities" : [
3,
4
],
"CapabilityDescriptions" : [
"Random Access",
"Supports Writing"
],
"Caption" : "VBOX HARDDISK ATA Device",
"ConfigManagerErrorCode" : 0,
"ConfigManagerUserConfig" : "False",
"CreationClassName" : "Win32_DiskDrive",
"Description" : "Disk drive",
"FirmwareRevision" : "1.0",
"Index" : 1,
"InterfaceType" : "IDE"
}
]
```
This item is supported since Zabbix Windows agent 4.4.
#### 监控项键
在[发现规则](/manual/discovery/low_level_discovery#发现规则)中使用的监控项是
wmi.getall[<namespace>,<query>]
这个[item](/manual/config/items/itemtypes/zabbix_agent/win_keys)
将query结果转换为JSON array。例如：
select * from Win32_DiskDrive where Name like '%PHYSICALDRIVE%'
可能返回如下内容：
```json
[
{
"DeviceID" : "\\.\PHYSICALDRIVE0",
"BytesPerSector" : 512,
"Capabilities" : [
3,
4
],
"CapabilityDescriptions" : [
"Random Access",
"Supports Writing"
],
"Caption" : "VBOX HARDDISK ATA Device",
"ConfigManagerErrorCode" : 0,
"ConfigManagerUserConfig" : "False",
"CreationClassName" : "Win32_DiskDrive",
"Description" : "Disk drive",
"FirmwareRevision" : "1.0",
"Index" : 0,
"InterfaceType" : "IDE"
},
{
"DeviceID" : "\\.\PHYSICALDRIVE1",
"BytesPerSector" : 512,
"Capabilities" : [
3,
4
],
"CapabilityDescriptions" : [
"Random Access",
"Supports Writing"
],
"Caption" : "VBOX HARDDISK ATA Device",
"ConfigManagerErrorCode" : 0,
"ConfigManagerUserConfig" : "False",
"CreationClassName" : "Win32_DiskDrive",
"Description" : "Disk drive",
"FirmwareRevision" : "1.0",
"Index" : 1,
"InterfaceType" : "IDE"
}
]
```
该监控项自Zabbix Windows agent 4.4版本起支持。
#### Item key
To configure the [discovery rule](/manual/discovery/low_level_discovery#discovery_rule), use the following item:
- `perf_instance.discovery[object]`
Note that the object name may be localized. For example:
```bash
perf_instance.discovery[Processor] # The object name is in English.
perf_instance.discovery[Processador] # The object name is in Portuguese.
```
Alternatively, to ensure that the object name is provided in English, independent of OS localization, use the following item:
- `perf_instance_en.discovery[object]`
For example:
```bash
perf_instance_en.discovery[Processor]
perf_instance_en.discovery[Memory]
```
These items are supported since Zabbix Windows agent 5.0.1.
#### 监控项键
要配置[发现规则](/manual/discovery/low_level_discovery#发现规则)，请使用以下监控项：
- `perf_instance.discovery[object]`
请注意object名称可能已本地化。例如：
```bash
perf_instance.discovery[Processor] # The object name is in English.
perf_instance.discovery[Processador] # The object name is in Portuguese.
```
或者，为确保object名称以英语提供（不受操作系统本地化影响），请使用以下监控项：
- `perf_instance_en.discovery[object]`
例如：
```bash
perf_instance_en.discovery[Processor]
perf_instance_en.discovery[Memory]
```
这些监控项自Zabbix Windows agent 5.0.1版本起受支持。
#### Item key
Unlike with file system and network interface discovery, the item does
not necessarily has to have an "snmp.discovery" key - item type of SNMP
agent is sufficient.
To configure the discovery rule, do the following:
- Go to: *Configuration* → *Templates*
- Click on *Discovery* in the row of an appropriate template
- Click on *Create discovery rule* in the upper right corner of the
screen
- Fill in the discovery rule form with the required details as in the
screenshot below
All mandatory input fields are marked with a red asterisk.
The OIDs to discover are defined in SNMP OID field in the following
format: `discovery[{#MACRO1}, oid1, {#MACRO2}, oid2, …,]`
where *{\#MACRO1}*, *{\#MACRO2}* … are valid lld macro names and *oid1*,
*oid2*... are OIDs capable of generating meaningful values for these
macros. A built-in macro *{\#SNMPINDEX}* containing index of the
discovered OID is applied to discovered entities. The discovered
entities are grouped by *{\#SNMPINDEX}* macro value.
To understand what we mean, let us perform few snmpwalks on our switch:
$ snmpwalk -v 2c -c public 192.168.1.1 IF-MIB::ifDescr
IF-MIB::ifDescr.1 = STRING: WAN
IF-MIB::ifDescr.2 = STRING: LAN1
IF-MIB::ifDescr.3 = STRING: LAN2
$ snmpwalk -v 2c -c public 192.168.1.1 IF-MIB::ifPhysAddress
IF-MIB::ifPhysAddress.1 = STRING: 8:0:27:90:7a:75
IF-MIB::ifPhysAddress.2 = STRING: 8:0:27:90:7a:76
IF-MIB::ifPhysAddress.3 = STRING: 8:0:27:2b:af:9e
And set SNMP OID to:
`discovery[{#IFDESCR}, ifDescr, {#IFPHYSADDRESS}, ifPhysAddress]`
Now this rule will discover entities with {\#IFDESCR} macros set to
**WAN**, **LAN1** and **LAN2**, {\#IFPHYSADDRESS} macros set to
**8:0:27:90:7a:75**, **8:0:27:90:7a:76**, and **8:0:27:2b:af:9e**,
{\#SNMPINDEX} macros set to the discovered OIDs indexes **1**, **2** and
**3**:
``` {.java}
[
{
"{#SNMPINDEX}": "1",
"{#IFDESCR}": "WAN",
"{#IFPHYSADDRESS}": "8:0:27:90:7a:75"
},
{
"{#SNMPINDEX}": "2",
"{#IFDESCR}": "LAN1",
"{#IFPHYSADDRESS}": "8:0:27:90:7a:76"
},
{
"{#SNMPINDEX}": "3",
"{#IFDESCR}": "LAN2",
"{#IFPHYSADDRESS}": "8:0:27:2b:af:9e"
}
]
```
If an entity does not have the specified OID, then the corresponding
macro will be omitted for this entity. For example if we have the
following data:
ifDescr.1 "Interface #1"
ifDescr.2 "Interface #2"
ifDescr.4 "Interface #4"
ifAlias.1 "eth0"
ifAlias.2 "eth1"
ifAlias.3 "eth2"
ifAlias.5 "eth4"
Then in this case SNMP discovery
`discovery[{#IFDESCR}, ifDescr, {#IFALIAS}, ifAlias]` will return the
following structure:
``` {.java}
[
{
"{#SNMPINDEX}": 1,
"{#IFDESCR}": "Interface #1",
"{#IFALIAS}": "eth0"
},
{
"{#SNMPINDEX}": 2,
"{#IFDESCR}": "Interface #2",
"{#IFALIAS}": "eth1"
},
{
"{#SNMPINDEX}": 3,
"{#IFALIAS}": "eth2"
},
{
"{#SNMPINDEX}": 4,
"{#IFDESCR}": "Interface #4"
},
{
"{#SNMPINDEX}": 5,
"{#IFALIAS}": "eth4"
}
]
```
#### 监控项键
与file系统和网络接口发现不同，监控项并不强制要求包含"snmp.discovery"键值 - 只要监控项属于SNMPagent类型即可满足条件。
配置发现规则的步骤如下：
- 前往：*配置* → *模板*
- 在对应模板行中点击*发现*
- 点击屏幕右上角的*创建发现规则*
- 按照
screenshot below
中的要求填写发现规则表单
所有必填字段均以红色星号标记。
待发现的OID在SNMP OID字段中按以下格式定义：`discovery[{#MACRO1}, oid1, {#MACRO2}, oid2, …,]`
其中*{\#MACRO1}*、*{\#MACRO2}*...是有效的LLD宏名称，而*oid1*、*oid2*...是能为这些宏生成有效值的OID。系统会为发现的实体应用内置宏*{\#SNMPINDEX}*（包含被发现OID的索引值），发现的实体按*{\#SNMPINDEX}*宏值进行分组。
为便于理解，我们在交换机上执行几个snmpwalk命令：
$ snmpwalk -v 2c -c public 192.168.1.1 IF-MIB::ifDescr
IF-MIB::ifDescr.1 = STRING: WAN
IF-MIB::ifDescr.2 = STRING: LAN1
IF-MIB::ifDescr.3 = STRING: LAN2
$ snmpwalk -v 2c -c public 192.168.1.1 IF-MIB::ifPhysAddress
IF-MIB::ifPhysAddress.1 = STRING: 8:0:27:90:7a:75
IF-MIB::ifPhysAddress.2 = STRING: 8:0:27:90:7a:76
IF-MIB::ifPhysAddress.3 = STRING: 8:0:27:2b:af:9e
并将SNMP OID设置为：
`discovery[{#IFDESCR}, ifDescr, {#IFPHYSADDRESS}, ifPhysAddress]`
现在该规则将发现以下实体：{\#IFDESCR}宏设为**WAN**、**LAN1**和**LAN2**，{\#IFPHYSADDRESS}宏设为**8:0:27:90:7a:75**、**8:0:27:90:7a:76**和**8:0:27:2b:af:9e**，{\#SNMPINDEX}宏设为被发现OID的索引值**1**、**2**和**3**：
```{.java}
[
{
"{#SNMPINDEX}": "1",
"{#IFDESCR}": "WAN",
"{#IFPHYSADDRESS}": "8:0:27:90:7a:75"
},
{
"{#SNMPINDEX}": "2",
"{#IFDESCR}": "LAN1",
"{#IFPHYSADDRESS}": "8:0:27:90:7a:76"
},
{
"{#SNMPINDEX}": "3",
"{#IFDESCR}": "LAN2",
"{#IFPHYSADDRESS}": "8:0:27:2b:af:9e"
}
]
```
若实体不包含指定的OID，则该实体会省略对应宏。例如以下数据：
ifDescr.1 "Interface #1"
ifDescr.2 "Interface #2"
ifDescr.4 "Interface #4"
ifAlias.1 "eth0"
ifAlias.2 "eth1"
ifAlias.3 "eth2"
ifAlias.5 "eth4"
此时SNMP发现
`discovery[{#IFDESCR}, ifDescr, {#IFALIAS}, ifAlias]`将返回以下结构：
```{.java}
[
{
"{#SNMPINDEX}": 1,
"{#IFDESCR}": "Interface #1",
"{#IFALIAS}": "eth0"
},
{
"{#SNMPINDEX}": 2,
"{#IFDESCR}": "Interface #2",
"{#IFALIAS}": "eth1"
},
{
"{#SNMPINDEX}": 3,
"{#IFALIAS}": "eth2"
},
{
"{#SNMPINDEX}": 4,
"{#IFDESCR}": "Interface #4"
},
{
"{#SNMPINDEX}": 5,
"{#IFALIAS}": "eth4"
}
]
```
#### Item net.tcp.service parameters
**ftp**
Creates a TCP connection and expects the first 4 characters of the
response to be "220 ", then sends "QUIT\\r\\n". Default port 21 is used
if not specified.
**http**
Creates a TCP connection without expecting and sending anything. Default
port 80 is used if not specified.
**https**
Uses (and only works with) libcurl, does not verify the authenticity of
the certificate, does not verify the host name in the SSL certificate,
only fetches the response header (HEAD request). Default port 443 is
used if not specified.
**imap**
Creates a TCP connection and expects the first 4 characters of the
response to be "\* OK", then sends "a1 LOGOUT\\r\\n". Default port 143
is used if not specified.
**ldap**
Opens a connection to an LDAP server and performs an LDAP search
operation with filter set to (objectClass=\*). Expects successful
retrieval of the first attribute of the first entry. Default port 389 is
used if not specified.
**nntp**
Creates a TCP connection and expects the first 3 characters of the
response to be "200" or "201", then sends "QUIT\\r\\n". Default port 119
is used if not specified.
**pop**
Creates a TCP connection and expects the first 3 characters of the
response to be "+OK", then sends "QUIT\\r\\n". Default port 110 is used
if not specified.
**smtp**
Creates a TCP connection and expects the first 3 characters of the
response to be "220", followed by a space, the line ending or a dash.
The lines containing a dash belong to a multiline response and the
response will be re-read until a line without the dash is received. Then
sends "QUIT\\r\\n". Default port 25 is used if not specified.
**ssh**
Creates a TCP connection. If the connection has been established, both
sides exchange an identification string (SSH-major.minor-XXXX), where
major and minor are protocol versions and XXXX is a string. Zabbix
checks if the string matching the specification is found and then sends
back the string "SSH-major.minor-zabbix\_agent\\r\\n" or "0\\n" on
mismatch. Default port 22 is used if not specified.
**tcp**
Creates a TCP connection without expecting and sending anything. Unlike
the other checks requires the port parameter to be specified.
**telnet**
Creates a TCP connection and expects a login prompt (':' at the end).
Default port 23 is used if not specified.
#### 监控项 net.tcp.service 参数
**ftp**
建立TCP连接并期望响应前4个字符为"220 "，然后发送"QUIT\\r\\n"。若未指定端口则默认使用21端口。
**http**
建立TCP连接但不期待也不发送任何数据。若未指定端口则默认使用80端口。
**https**
使用(且仅支持)libcurl库，不验证证书真实性，不检查SSL证书中的主机名称，仅获取响应头(HEAD请求)。若未指定端口则默认使用443端口。
**imap**
建立TCP连接并期望响应前4个字符为"\* OK"，然后发送"a1 LOGOUT\\r\\n"。若未指定端口则默认使用143端口。
**ldap**
连接LDAP服务器并执行过滤器设为(objectClass=\*)的LDAP搜索操作。期望成功获取第一个条目的第一个属性。若未指定端口则默认使用389端口。
**nntp**
建立TCP连接并期望响应前3个字符为"200"或"201"，然后发送"QUIT\\r\\n"。若未指定端口则默认使用119端口。
**pop**
建立TCP连接并期望响应前3个字符为"+OK"，然后发送"QUIT\\r\\n"。若未指定端口则默认使用110端口。
**smtp**
建立TCP连接并期望响应前3个字符为"220"，后接空格、行结束符或破折号。包含破折号的行属于多行响应，将重新读取响应直到收到不含破折号的行。然后发送"QUIT\\r\\n"。若未指定端口则默认使用25端口。
**ssh**
建立TCP连接。若连接成功，双方交换标识string(SSH-major.minor-XXXX)，其中major和minor是协议版本，XXXX是string。Zabbix检查是否找到符合规范的string，然后返回string"SSH-major.minor-zabbix\_agent\\r\\n"或不匹配时发送"0\\n"。若未指定端口则默认使用22端口。
**tcp**
建立TCP连接但不期待也不发送任何数据。与其他检查不同，此检查必须指定端口参数。
**telnet**
建立TCP连接并期待login提示符(末尾的':')。若未指定端口则默认使用23端口。
#### Item net.udp.service parameters
**ntp**
Sends an SNTP packet over UDP and validates the response according to
[RFC 4330, section 5](http://tools.ietf.org/html/rfc4330#section-5).
Default port 123 is used if not specified.
#### 监控项 net.udp.service 参数
**ntp**
通过UDP发送SNTP数据包，并根据[RFC 4330, section 5](http://tools.ietf.org/html/rfc4330#section-5)验证响应。
如果未指定端口，则使用默认端口123。
### Item
::: noteclassic
Web items cannot be directly created, updated or deleted via
the Zabbix API.
:::
The item object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|itemid|string|*(readonly)* ID of the item.|
|**delay**<br>(required)|string|Update interval of the item. Accepts seconds or a time unit with suffix (30s,1m,2h,1d).<br>Optionally one or more [custom intervals](/manual/config/items/item/custom_intervals) can be specified either as flexible intervals or scheduling.<br>Multiple intervals are separated by a semicolon.<br>User macros may be used. A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.<br>Flexible intervals may be written as two macros separated by a forward slash (e.g. `{$FLEX_INTERVAL}/{$FLEX_PERIOD}`).<br><br>Optional for Zabbix trapper, dependent items and for Zabbix agent (active) with `mqtt.get` key.|
|**hostid**<br>(required)|string|ID of the host or template that the item belongs to.<br><br>For update operations this field is *readonly*.|
|**interfaceid**<br>(required)|string|ID of the item's host interface.<br><br>Used only for host items. Not required for Zabbix agent (active), Zabbix internal, Zabbix trapper, calculated, dependent, database monitor and script items. Optional for HTTP agent items.|
|**key\_**<br>(required)|string|Item key.|
|**name**<br>(required)|string|Name of the item.|
|**type**<br>(required)|integer|Type of the item.<br><br>Possible values:<br>0 - Zabbix agent;<br>2 - Zabbix trapper;<br>3 - Simple check;<br>5 - Zabbix internal;<br>7 - Zabbix agent (active);<br>9 - Web item;<br>10 - External check;<br>11 - Database monitor;<br>12 - IPMI agent;<br>13 - SSH agent;<br>14 - Telnet agent;<br>15 - Calculated;<br>16 - JMX agent;<br>17 - SNMP trap;<br>18 - Dependent item;<br>19 - HTTP agent;<br>20 - SNMP agent;<br>21 - Script|
|**url**<br>(required)|string|URL string, required only for HTTP agent item type. Supports user macros, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.|
|**value\_type**<br>(required)|integer|Type of information of the item.<br><br>Possible values:<br>0 - numeric float;<br>1 - character;<br>2 - log;<br>3 - numeric unsigned;<br>4 - text.|
|allow\_traps|integer|HTTP agent item field. Allow to populate value as in trapper item type also.<br><br>0 - *(default)* Do not allow to accept incoming data.<br>1 - Allow to accept incoming data.|
|authtype|integer|Used only by SSH agent items or HTTP agent items.<br><br>SSH agent authentication method possible values:<br>0 - *(default)* password;<br>1 - public key.<br><br>HTTP agent authentication method possible values:<br>0 - *(default)* none<br>1 - basic<br>2 - NTLM<br>3 - Kerberos|
|description|string|Description of the item.|
|error|string|*(readonly)* Error text if there are problems updating the item value.|
|flags|integer|*(readonly)* Origin of the item.<br><br>Possible values:<br>0 - a plain item;<br>4 - a discovered item.|
|follow\_redirects|integer|HTTP agent item field. Follow response redirects while polling data.<br><br>0 - Do not follow redirects.<br>1 - *(default)* Follow redirects.|
|headers|object|HTTP agent item field. Object with HTTP(S) request headers, where header name is used as key and header value as value.<br><br>Example:<br>{ "User-Agent": "Zabbix" }|
|history|string|A time unit of how long the history data should be stored. Also accepts user macro.<br><br>Default: 90d.|
|http\_proxy|string|HTTP agent item field. HTTP(S) proxy connection string.|
|inventory\_link|integer|ID of the host inventory field that is populated by the item.<br><br>Refer to the [host inventory page](/manual/api/reference/host/object#host_inventory) for a list of supported host inventory fields and their IDs.<br><br>Default: 0.|
|ipmi\_sensor|string|IPMI sensor. Used only by IPMI items.|
|jmx\_endpoint|string|JMX agent custom connection string.<br><br>Default value:<br>service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi|
|lastclock|timestamp|*(readonly)* Time when the item value was last updated.<br><br>By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of *Max history display period* parameter in the *[Administration → General](/manual/web_interface/frontend_sections/administration/general#gui)* menu section.|
|lastns|integer|*(readonly)* Nanoseconds when the item value was last updated.<br><br>By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of *Max history display period* parameter in the *[Administration → General](/manual/web_interface/frontend_sections/administration/general#gui)* menu section.|
|lastvalue|string|*(readonly)* Last value of the item.<br><br>By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of *Max history display period* parameter in the *[Administration → General](/manual/web_interface/frontend_sections/administration/general#gui)* menu section.|
|logtimefmt|string|Format of the time in log entries. Used only by log items.|
|master\_itemid|integer|Master item ID.<br>Recursion up to 3 dependent items and maximum count of dependent items equal to 29999 are allowed.<br><br>Required by dependent items.|
|output\_format|integer|HTTP agent item field. Should response be converted to JSON.<br><br>0 - *(default)* Store raw.<br>1 - Convert to JSON.|
|params|string|Additional parameters depending on the type of the item:<br>- executed script for SSH and Telnet items;<br>- SQL query for database monitor items;<br>- formula for calculated items;<br>- the script for script item.|
|parameters|array|Additional parameters for script items. Array of objects with 'name' and 'value' properties, where name must be unique.|
|password|string|Password for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items.<br>When used by JMX, username should also be specified together with password or both properties should be left blank.|
|post\_type|integer|HTTP agent item field. Type of post data body stored in posts property.<br><br>0 - *(default)* Raw data.<br>2 - JSON data.<br>3 - XML data.|
|posts|string|HTTP agent item field. HTTP(S) request body data. Used with post\_type.|
|prevvalue|string|*(readonly)* Previous value of the item.<br><br>By default, only values that fall within the last 24 hours are displayed. You can extend this time period by changing the value of *Max history display period* parameter in the *[Administration → General](/manual/web_interface/frontend_sections/administration/general#gui)* menu section.|
|privatekey|string|Name of the private key file.|
|publickey|string|Name of the public key file.|
|query\_fields|array|HTTP agent item field. Query parameters. Array of objects with 'key':'value' pairs, where value can be empty string.|
|request\_method|integer|HTTP agent item field. Type of request method.<br><br>0 - *(default)* GET<br>1 - POST<br>2 - PUT<br>3 - HEAD|
|retrieve\_mode|integer|HTTP agent item field. What part of response should be stored.<br><br>0 - *(default)* Body.<br>1 - Headers.<br>2 - Both body and headers will be stored.<br><br>For request\_method HEAD only 1 is allowed value.|
|snmp\_oid|string|SNMP OID.|
|ssl\_cert\_file|string|HTTP agent item field. Public SSL Key file path.|
|ssl\_key\_file|string|HTTP agent item field. Private SSL Key file path.|
|ssl\_key\_password|string|HTTP agent item field. Password for SSL Key file.|
|state|integer|*(readonly)* State of the item.<br><br>Possible values:<br>0 - *(default)* normal;<br>1 - not supported.|
|status|integer|Status of the item.<br><br>Possible values:<br>0 - *(default)* enabled item;<br>1 - disabled item.|
|status\_codes|string|HTTP agent item field. Ranges of required HTTP status codes separated by commas. Also supports user macros as part of comma separated list.<br><br>Example: 200,200-{$M},{$M},200-400|
|templateid|string|(readonly) ID of the parent template item.<br><br>*Hint*: Use the `hostid` property to specify the template that the item belongs to.|
|timeout|string|Item data polling request timeout. Used for HTTP agent and script items. Supports user macros.<br><br>default: 3s<br>maximum value: 60s|
|trapper\_hosts|string|Allowed hosts. Used by trapper items or HTTP agent items.|
|trends|string|A time unit of how long the trends data should be stored. Also accepts user macro.<br><br>Default: 365d.|
|units|string|Value units.|
|username|string|Username for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items.<br><br>Required by SSH and Telnet items.<br>When used by JMX, password should also be specified together with username or both properties should be left blank.|
|uuid|string|Universal unique identifier, used for linking imported item to already existing ones. Used only for items on templates. Auto-generated, if not given.|
|valuemapid|string|ID of the associated value map.|
|verify\_host|integer|HTTP agent item field. Whether to validate that the host name for the connection matches the one in the host's certificate.<br><br>0 - *(default)* Do not validate.<br>1 - Validate.|
|verify\_peer|integer|HTTP agent item field. Whether to validate that the host's certificate is authentic.<br><br>0 - *(default)* Do not validate.<br>1 - Validate.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 监控项
::: noteclassic
Web 监控项 无法直接通过创建、更新或删除
Zabbix API
:::
监控项 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| itemid | string | *(只读)* 监控项的ID。 |
| **delay**<br>(required) | string | 监控项的更新间隔。接受秒数或带后缀的时间单位（30s,1m,2h,1d）。<br>可选择性地指定一个或多个[custom intervals](/manual/config/items/item/custom_intervals)作为灵活间隔或调度设置。<br>多个间隔用分号分隔。<br>可使用用户宏。单个宏必须填满整个字段，不支持字段中包含多个宏或宏与文本混合使用。<br>灵活间隔可写成两个由斜杠分隔的宏（例如`{$FLEX_INTERVAL}/{$FLEX_PERIOD}`）。<br><br>对于Zabbix trapper、依赖型监控项以及使用`mqtt.get`键的Zabbix agent（主动式）为可选参数。 |
| **hostid**<br>(required) | string | 主机或模板的ID，该监控项所属的实体。<br><br>对于update操作，此字段为*只读*。 |
| **interfaceid**<br>(required) | string | 监控项的主机接口ID。<br><br>仅用于主机 监控项。对于Zabbix agent（主动式）、Zabbix内部、Zabbix trapper、计算型、依赖型、数据库监控和脚本监控项无需此参数。HTTP agent 监控项为可选参数。 |
| **key\_**<br>(required) | string | 监控项 键。 |
| **name**<br>(required) | string | 监控项名称 |
| **type**<br>(required) | integer | 监控项的类型.<br><br>可能取值:<br>0 - Zabbix agent;<br>2 - Zabbix trapper;<br>3 - 简单检查;<br>5 - Zabbix内部;<br>7 - Zabbix agent (主动式);<br>9 - Web 监控项;<br>10 - 外部检查;<br>11 - 数据库监控;<br>12 - IPMI agent;<br>13 - SSH agent;<br>14 - Telnet agent;<br>15 - 计算型;<br>16 - JMX agent;<br>17 - SNMP trap;<br>18 - 依赖型 监控项;<br>19 - HTTP agent;<br>20 - SNMP agent;<br>21 - 脚本 |
| **url**<br>(required) | string | URL string, 仅HTTP agent 监控项类型需要. 支持用户宏, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
| **value\_type**<br>(required) | integer | 监控项的信息类型.<br><br>可选值:<br>0 - 数值型float;<br>1 - 字符型;<br>2 - 日志型;<br>3 - 无符号数值型;<br>4 - 文本型. |
| allow\_traps | integer | HTTP agent 监控项 字段。允许像 trapper 监控项 类型一样填充值。<br><br>0 - *(默认)* 不允许接收传入数据。<br>1 - 允许接收传入数据。
| authtype | integer | 仅用于SSH agent 监控项或HTTP agent 监控项.<br><br>SSH agent认证方法可选值:<br>0 - *(默认)* 密码;<br>1 - 公钥.<br><br>HTTP agent认证方法可选值:<br>0 - *(默认)* 无<br>1 - 基础认证<br>2 - NTLM<br>3 - Kerberos |
| description | string | 监控项的描述。 |
| error | string | *(只读)* 更新监控项值时出现问题的错误文本。 |
| flags | integer | *(只读)* 监控项的来源.<br><br>可能值:<br>0 - 普通监控项;<br>4 - 发现的监控项. |
| follow\_redirects | integer | HTTP agent 监控项 字段. 在轮询数据时跟随响应重定向.<br><br>0 - 不跟随重定向.<br>1 - *(默认)* 跟随重定向. |
| headers | object | HTTP agent 监控项 字段. object 包含HTTP(S)请求头, 其中头名称作为键, 头值作为值.<br><br>示例:<br>{ "User-Agent": "Zabbix" } |
| history | string | 历史数据应存储的时间单位。也接受用户宏。<br><br>默认值：90d。 |
| http\_proxy | string | HTTP agent 监控项 字段. HTTP(S) proxy 连接 string. |
| inventory\_link | integer | 由监控项填充的主机资产清单字段ID.<br><br>参考[主机资产清单](/manual/api/reference/host/object#主机资产清单)获取支持的主机资产清单字段及其ID列表.<br><br>默认值: 0. |
| ipmi\_sensor | string | IPMI传感器。仅用于IPMI 监控项。 |
| jmx\_endpoint | string | JMX agent 自定义连接 string.<br><br>默认值:<br>service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| lastclock | timestamp | *(只读)* 最近一次更新监控项值的时间戳。<br><br>默认仅显示过去24小时内的数值。可通过修改*[图形用户界面](/manual/web_interface/frontend_sections/administration/general#图形用户界面)*菜单章节中的*最大历史显示周期*参数来延长该时间段。 |
| lastns | integer | *(只读)* 上次更新监控项值的纳秒时间戳。<br><br>默认仅显示过去24小时内的数值。可通过修改*[图形用户界面](/manual/web_interface/frontend_sections/administration/general#图形用户界面)*菜单章节中的*最大历史显示周期*参数来延长该时间段。 |
| lastvalue | string | *(只读)* 监控项的最近值。<br><br>默认仅显示过去24小时内的数值。可通过修改*[图形用户界面](/manual/web_interface/frontend_sections/administration/general#图形用户界面)*菜单部分中的*最大历史显示周期*参数来延长该时间段。 |
| logtimefmt | string | 日志条目中的时间格式。仅由日志监控项使用。 |
| master\_itemid | integer | 主监控项 ID.<br>允许递归最多3层依赖监控项，且依赖监控项的最大数量为29999.<br><br>被依赖监控项所必需. |
| output\_format | integer | HTTP agent 监控项 字段。是否应将响应转换为JSON。<br><br>0 - *(默认)* 存储原始数据。<br>1 - 转换为JSON。 |
| params | string | 根据监控项类型所需的附加参数:<br>- SSH和Telnet 监控项的执行脚本;<br>- 数据库监控监控项的SQL query;<br>- 计算型监控项的公式;<br>- 脚本型监控项的脚本. |
| parameters | array | 脚本 监控项 的附加参数. 包含 objects 和 '名称' 以及 'value' 属性的 array 对象, 其中名称必须唯一. |
| password | string | 用于身份验证的密码。适用于简单检查、SSH、Telnet、数据库监控、JMX和HTTP agent 监控项。<br>当用于JMX时，用户名应与密码同时指定，或两者属性均留空。 |
| post\_type | integer | HTTP agent 监控项 字段。存储在posts属性中的post数据体类型。<br><br>0 - *(默认)* 原始数据。<br>2 - JSON数据。<br>3 - XML数据。 |
| posts | string | HTTP agent 监控项 字段。HTTP(S)请求体数据。需与post\_type配合使用。 |
| prevvalue | string | *(只读)* 监控项的先前值。<br><br>默认情况下，仅显示过去24小时内的值。您可以通过修改*[图形用户界面](/manual/web_interface/frontend_sections/administration/general#图形用户界面)*菜单部分中的*最大历史显示周期*参数来延长此时间段。 |
| privatekey | string | 私钥名称 file. |
| publickey | string | 公钥名称 file. |
| query\_fields | array | HTTP agent 监控项 字段。 query 参数。 array 包含 'key':'value' 键值对的 objects，其中值可为空 string。 |
| request\_method | integer | HTTP agent 监控项 字段。请求方法的类型。<br><br>0 - *(默认)* GET<br>1 - POST<br>2 - PUT<br>3 - HEAD |
| retrieve\_mode | integer | HTTP agent 监控项 字段。应存储响应的哪部分内容。<br><br>0 - *(默认)* 正文。<br>1 - 头部信息。<br>2 - 同时存储正文和头部信息。<br><br>对于 request\_method 为 HEAD 的情况，仅允许使用值 1。 |
| snmp\_oid | string | SNMP OID. |
| ssl\_cert\_file | string | HTTP agent 监控项 字段. Public SSL Key file 路径. |
| ssl\_key\_file | string | HTTP agent 监控项 字段。私有SSL密钥 file 路径。 |
| ssl\_key\_password | string | HTTP agent 监控项 字段. SSL密钥file的密码. |
| state | integer | *(只读)* 监控项的状态。<br><br>可能取值:<br>0 - *(默认)* 正常;<br>1 - 不支持。 |
| status | integer | 监控项的状态.<br><br>可选值:<br>0 - *(默认)* 启用监控项;<br>1 - 禁用监控项. |
| status\_codes | string | HTTP agent 监控项 字段。以逗号分隔的所需HTTP状态码范围。支持将用户宏作为逗号分隔列表的一部分。<br><br>示例：200,200-{$M},{$M},200-400 |
| templateid | string | (只读) 父模板监控项的ID.<br><br>*提示*: 使用`hostid`属性来指定监控项所属的模板. |
| timeout | string | 监控项 数据轮询请求超时。用于HTTP agent 和脚本 监控项。支持用户宏。<br><br>默认值: 3s<br>最大值: 60s |
| trapper\_hosts | string | 允许的主机。被trapper 监控项或HTTP agent 监控项使用。 |
| trends | string | 趋势数据应存储的时间单位。也接受用户宏。<br><br>默认值: 365d. |
| units | string | 数值单位 |
| username | string | 用于身份验证的用户名。被简单检查、SSH、Telnet、数据库监控、JMX和HTTP agent 监控项所使用。<br><br>SSH和Telnet 监控项必须提供此字段。<br>当被JMX使用时，密码应与用户名同时指定，或两者属性均留空。 |
| uuid | string | 通用唯一标识符，用于将导入的监控项与现有项关联。仅适用于模板上的监控项。若未提供则自动生成。 |
| valuemapid | string | 关联值映射的ID。 |
| verify\_host | integer | HTTP agent 监控项 字段。是否验证连接的主机名称与主机证书中的名称匹配。<br><br>0 - *(默认)* 不验证。<br>1 - 验证。 |
| verify\_peer | integer | HTTP agent 监控项 字段。是否验证 主机 的证书真实性。<br><br>0 - *(默认)* 不验证。<br>1 - 验证。 |
请注意，某些方法（update、delete）所需的必选/可选参数组合有所不同。
### Item preprocessing
The item preprocessing object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**type**<br>(required)|integer|The preprocessing option type.<br><br>Possible values:<br>1 - Custom multiplier;<br>2 - Right trim;<br>3 - Left trim;<br>4 - Trim;<br>5 - Regular expression matching;<br>6 - Boolean to decimal;<br>7 - Octal to decimal;<br>8 - Hexadecimal to decimal;<br>9 - Simple change;<br>10 - Change per second;<br>11 - XML XPath;<br>12 - JSONPath;<br>13 - In range;<br>14 - Matches regular expression;<br>15 - Does not match regular expression;<br>16 - Check for error in JSON;<br>17 - Check for error in XML;<br>18 - Check for error using regular expression;<br>19 - Discard unchanged;<br>20 - Discard unchanged with heartbeat;<br>21 - JavaScript;<br>22 - Prometheus pattern;<br>23 - Prometheus to JSON;<br>24 - CSV to JSON;<br>25 - Replace;<br>26 - Check unsupported;<br>27 - XML to JSON.|
|**params**<br>(required)|string|Additional parameters used by preprocessing option. Multiple parameters are separated by LF (\\n) character.|
|**error\_handler**<br>(required)|integer|Action type used in case of preprocessing step failure.<br><br>Possible values:<br>0 - Error message is set by Zabbix server;<br>1 - Discard value;<br>2 - Set custom value;<br>3 - Set custom error message.|
|**error\_handler\_params**<br>(required)|string|Error handler parameters. Used with `error_handler`.<br><br>Must be empty, if `error_handler` is 0 or 1.<br>Can be empty if, `error_handler` is 2.<br>Cannot be empty, if `error_handler` is 3.|
The following parameters and error handlers are supported for each
preprocessing type.
|Preprocessing type|Name|Parameter 1|Parameter 2|Parameter 3|Supported error handlers|
|------------------|----|-----------|-----------|-----------|------------------------|
|1|Custom multiplier|number^1,\ 6^|<|<|0, 1, 2, 3|
|2|Right trim|list of characters^2^|<|<|<|
|3|Left trim|list of characters^2^|<|<|<|
|4|Trim|list of characters^2^|<|<|<|
|5|Regular expression|pattern^3^|output^2^|<|0, 1, 2, 3|
|6|Boolean to decimal|<|<|<|0, 1, 2, 3|
|7|Octal to decimal|<|<|<|0, 1, 2, 3|
|8|Hexadecimal to decimal|<|<|<|0, 1, 2, 3|
|9|Simple change|<|<|<|0, 1, 2, 3|
|10|Change per second|<|<|<|0, 1, 2, 3|
|11|XML XPath|path^4^|<|<|0, 1, 2, 3|
|12|JSONPath|path^4^|<|<|0, 1, 2, 3|
|13|In range|min^1,\ 6^|max^1,\ 6^|<|0, 1, 2, 3|
|14|Matches regular expression|pattern^3^|<|<|0, 1, 2, 3|
|15|Does not match regular expression|pattern^3^|<|<|0, 1, 2, 3|
|16|Check for error in JSON|path^4^|<|<|0, 1, 2, 3|
|17|Check for error in XML|path^4^|<|<|0, 1, 2, 3|
|18|Check for error using regular expression|pattern^3^|output^2^|<|0, 1, 2, 3|
|19|Discard unchanged|<|<|<|<|
|20|Discard unchanged with heartbeat|seconds^5,\ 6^|<|<|<|
|21|JavaScript|script^2^|<|<|<|
|22|Prometheus pattern|pattern^6,\ 7^|output^6,\ 8^|<|0, 1, 2, 3|
|23|Prometheus to JSON|pattern^6,\ 7^|<|<|0, 1, 2, 3|
|24|CSV to JSON|character^2^|character^2^|0,1|0, 1, 2, 3|
|25|Replace|search string^2^|replacement^2^|<|<|
|26|Check unsupported|<|<|<|1, 2, 3|
|27|XML to JOSN|<|<|<|0, 1, 2, 3|
^1^ integer or floating-point number\
^2^ string\
^3^ regular expression\
^4^ JSONPath or XML XPath\
^5^ positive integer (with support of time suffixes, e.g. 30s, 1m, 2h,
1d)\
^6^ user macro\
^7^ Prometheus pattern following the syntax:
`<metric name>{<label name>="<label value>", ...} == <value>`. Each
Prometheus pattern component (metric, label name, label value and metric
value) can be user macro.\
^8^ Prometheus output following the syntax: `<label name>`.
### Item preprocessing 监控项预处理
The item preprocessing object has the following properties.
监控项预处理对象有如下属性。
|Property|Type|Description|
|--------|----|-----------|
|**type**<br>(required)|integer|The preprocessing option type.<br><br>Possible values:<br>1 - Custom multiplier;<br>2 - Right trim;<br>3 - Left trim;<br>4 - Trim;<br>5 - Regular expression matching;<br>6 - Boolean to decimal;<br>7 - Octal to decimal;<br>8 - Hexadecimal to decimal;<br>9 - Simple change;<br>10 - Change per second.|
|**params**<br>(required)|string|Additional parameters used by preprocessing option. Multiple parameters are separated by LF (\\n) character.|
# itemprototype.create
# itemprototype.create
# itemprototype.delete
# itemprototype.delete
# itemprototype.get
# itemprototype.get
### Item prototype preprocessing
The item prototype preprocessing object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**type**<br>(required)|integer|The preprocessing option type.<br><br>Possible values:<br>1 - Custom multiplier;<br>2 - Right trim;<br>3 - Left trim;<br>4 - Trim;<br>5 - Regular expression matching;<br>6 - Boolean to decimal;<br>7 - Octal to decimal;<br>8 - Hexadecimal to decimal;<br>9 - Simple change;<br>10 - Change per second;<br>11 - XML XPath;<br>12 - JSONPath;<br>13 - In range;<br>14 - Matches regular expression;<br>15 - Does not match regular expression;<br>16 - Check for error in JSON;<br>17 - Check for error in XML;<br>18 - Check for error using regular expression;<br>19 - Discard unchanged;<br>20 - Discard unchanged with heartbeat;<br>21 - JavaScript;<br>22 - Prometheus pattern;<br>23 - Prometheus to JSON;<br>24 - CSV to JSON;<br>25 - Replace;<br>26 - Check unsupported;<br>27 - XML to JSON.|
|**params**<br>(required)|string|Additional parameters used by preprocessing option. Multiple parameters are separated by LF (\\n) character.|
|**error\_handler**<br>(required)|integer|Action type used in case of preprocessing step failure.<br><br>Possible values:<br>0 - Error message is set by Zabbix server;<br>1 - Discard value;<br>2 - Set custom value;<br>3 - Set custom error message.|
|**error\_handler\_params**<br>(required)|string|Error handler parameters. Used with `error_handler`.<br><br>Must be empty, if `error_handler` is 0 or 1.<br>Can be empty if, `error_handler` is 2.<br>Cannot be empty, if `error_handler` is 3.|
The following parameters and error handlers are supported for each
preprocessing type.
|Preprocessing type|Name|Parameter 1|Parameter 2|Parameter 3|Supported error handlers|
|------------------|----|-----------|-----------|-----------|------------------------|
|1|Custom multiplier|number^1,\ 6^|<|<|0, 1, 2, 3|
|2|Right trim|list of characters^2^|<|<|<|
|3|Left trim|list of characters^2^|<|<|<|
|4|Trim|list of characters^2^|<|<|<|
|5|Regular expression|pattern^3^|output^2^|<|0, 1, 2, 3|
|6|Boolean to decimal|<|<|<|0, 1, 2, 3|
|7|Octal to decimal|<|<|<|0, 1, 2, 3|
|8|Hexadecimal to decimal|<|<|<|0, 1, 2, 3|
|9|Simple change|<|<|<|0, 1, 2, 3|
|10|Change per second|<|<|<|0, 1, 2, 3|
|11|XML XPath|path^4^|<|<|0, 1, 2, 3|
|12|JSONPath|path^4^|<|<|0, 1, 2, 3|
|13|In range|min^1,\ 6^|max^1,\ 6^|<|0, 1, 2, 3|
|14|Matches regular expression|pattern^3^|<|<|0, 1, 2, 3|
|15|Does not match regular expression|pattern^3^|<|<|0, 1, 2, 3|
|16|Check for error in JSON|path^4^|<|<|0, 1, 2, 3|
|17|Check for error in XML|path^4^|<|<|0, 1, 2, 3|
|18|Check for error using regular expression|pattern^3^|output^2^|<|0, 1, 2, 3|
|19|Discard unchanged|<|<|<|<|
|20|Discard unchanged with heartbeat|seconds^5,\ 6^|<|<|<|
|21|JavaScript|script^2^|<|<|<|
|22|Prometheus pattern|pattern^6,\ 7^|output^6,\ 8^|<|0, 1, 2, 3|
|23|Prometheus to JSON|pattern^6,\ 7^|<|<|0, 1, 2, 3|
|24|CSV to JSON|character^2^|character^2^|0,1|0, 1, 2, 3|
|25|Replace|search string^2^|replacement^2^|<|<|
|26|Check unsupported|<|<|<|1, 2, 3|
|27|XML to JSON|<|<|<|0, 1, 2, 3|
^1^ integer or floating-point number\
^2^ string\
^3^ regular expression\
^4^ JSONPath or XML XPath\
^5^ positive integer (with support of time suffixes, e.g. 30s, 1m, 2h,
1d)\
^6^ user macro, LLD macro\
^7^ Prometheus pattern following the syntax:
`<metric name>{<label name>="<label value>", ...} == <value>`. Each
Prometheus pattern component (metric, label name, label value and metric
value) can be user macro or LLD macro.\
^8^ Prometheus output following the syntax: `<label name>`.
### Item prototype preprocessing
The item prototype preprocessing object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**type**<br>(required)|integer|The preprocessing option type.<br><br>Possible values:<br>1 - Custom multiplier;<br>2 - Right trim;<br>3 - Left trim;<br>4 - Trim;<br>5 - Regular expression matching;<br>6 - Boolean to decimal;<br>7 - Octal to decimal;<br>8 - Hexadecimal to decimal;<br>9 - Simple change;<br>10 - Change per second;<br>11 - XML XPath;<br>12 - JSONPath;<br>13 - In range;<br>14 - Matches regular expression;<br>15 - Does not match regular expression;<br>16 - Check for error in JSON;<br>17 - Check for error in XML;<br>18 - Check for error using regular expression;<br>19 - Discard unchanged;<br>20 - Discard unchanged with heartbeat;<br>21 - JavaScript;<br>22 - Prometheus pattern;<br>23 - Prometheus to JSON;<br>24 - CSV to JSON;<br>25 - Replace;<br>26 - Check unsupported;<br>27 - XML to JSON.|
|**params**<br>(required)|string|Additional parameters used by preprocessing option. Multiple parameters are separated by LF (\\n) character.|
|**error\_handler**<br>(required)|integer|Action type used in case of preprocessing step failure.<br><br>Possible values:<br>0 - Error message is set by Zabbix server;<br>1 - Discard value;<br>2 - Set custom value;<br>3 - Set custom error message.|
|**error\_handler\_params**<br>(required)|string|Error handler parameters. Used with `error_handler`.<br><br>Must be empty, if `error_handler` is 0 or 1.<br>Can be empty if, `error_handler` is 2.<br>Cannot be empty, if `error_handler` is 3.|
The following parameters and error handlers are supported for each
preprocessing type.
|Preprocessing type|Name|Parameter 1|Parameter 2|Parameter 3|Supported error handlers|
|------------------|----|-----------|-----------|-----------|------------------------|
|1|Custom multiplier|number^1,\ 6^|<|<|0, 1, 2, 3|
|2|Right trim|list of characters^2^|<|<|<|
|3|Left trim|list of characters^2^|<|<|<|
|4|Trim|list of characters^2^|<|<|<|
|5|Regular expression|pattern^3^|output^2^|<|0, 1, 2, 3|
|6|Boolean to decimal|<|<|<|0, 1, 2, 3|
|7|Octal to decimal|<|<|<|0, 1, 2, 3|
|8|Hexadecimal to decimal|<|<|<|0, 1, 2, 3|
|9|Simple change|<|<|<|0, 1, 2, 3|
|10|Change per second|<|<|<|0, 1, 2, 3|
|11|XML XPath|path^4^|<|<|0, 1, 2, 3|
|12|JSONPath|path^4^|<|<|0, 1, 2, 3|
|13|In range|min^1,\ 6^|max^1,\ 6^|<|0, 1, 2, 3|
|14|Matches regular expression|pattern^3^|<|<|0, 1, 2, 3|
|15|Does not match regular expression|pattern^3^|<|<|0, 1, 2, 3|
|16|Check for error in JSON|path^4^|<|<|0, 1, 2, 3|
|17|Check for error in XML|path^4^|<|<|0, 1, 2, 3|
|18|Check for error using regular expression|pattern^3^|output^2^|<|0, 1, 2, 3|
|19|Discard unchanged|<|<|<|<|
|20|Discard unchanged with heartbeat|seconds^5,\ 6^|<|<|<|
|21|JavaScript|script^2^|<|<|<|
|22|Prometheus pattern|pattern^6,\ 7^|output^6,\ 8^|<|0, 1, 2, 3|
|23|Prometheus to JSON|pattern^6,\ 7^|<|<|0, 1, 2, 3|
|24|CSV to JSON|character^2^|character^2^|0,1|0, 1, 2, 3|
|25|Replace|search string^2^|replacement^2^|<|<|
|26|Check unsupported|<|<|<|1, 2, 3|
|27|XML to JSON|<|<|<|0, 1, 2, 3|
^1^ integer or floating-point number\
^2^ string\
^3^ regular expression\
^4^ JSONPath or XML XPath\
^5^ positive integer (with support of time suffixes, e.g. 30s, 1m, 2h,
1d)\
^6^ user macro, LLD macro\
^7^ Prometheus pattern following the syntax:
`<metric name>{<label name>="<label value>", ...} == <value>`. Each
Prometheus pattern component (metric, label name, label value and metric
value) can be user macro or LLD macro.\
^8^ Prometheus output following the syntax: `<label name>`.
### Item prototypes
Item prototypes that can be created based on systemd service discovery
include, for example:
- Item name: `{#UNIT.DESCRIPTION} active state info`; item key:
`systemd.unit.info["{#UNIT.NAME}"]`
- Item name: `{#UNIT.DESCRIPTION} load state info`; item key:
`systemd.unit.info["{#UNIT.NAME}",LoadState]`
`systemd.unit.info` [agent
items](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2) are
supported since Zabbix 4.4.
### 监控项原型
基于systemd服务发现可创建的监控项原型
包括例如:
- 监控项名称: `{#UNIT.DESCRIPTION} active state info`; 监控项键:
`systemd.unit.info["{#UNIT.NAME}"]`
- 监控项名称: `{#UNIT.DESCRIPTION} load state info`; 监控项键:
`systemd.unit.info["{#UNIT.NAME}",LoadState]`
`systemd.unit.info["{#UNIT.NAME}",LoadState]`
`systemd.unit.info` [agent
items](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2)
从Zabbix 4.4版本开始支持。
#### Item prototypes
The following screenshot illustrates how we can use these macros in item
prototypes:
You can create as many item prototypes as needed:
{width="600"}
#### 监控项原型
以下截图展示了如何在监控项原型中使用这些宏:
您可以根据需要create任意数量的监控项原型:
{width="600"}
### Item prototype tag
The item prototype tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**tag**<br>(required)|string|Item prototype tag name.|
|value|string|Item prototype tag value.|
### 监控项 原型标签
监控项原型标签object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **tag**<br>(required) | string | 监控项原型标签名称. |
| value | string | 监控项原型标签值. |
### Item prototype
The item prototype object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|itemid|string|*(readonly)* ID of the item prototype.|
|**delay**<br>(required)|string|Update interval of the item prototype. Accepts seconds or a time unit with suffix (30s,1m,2h,1d).<br>Optionally one or more [custom intervals](/manual/config/items/item/custom_intervals) can be specified either as flexible intervals or scheduling.<br>Multiple intervals are separated by a semicolon.<br>User macros and LLD macros may be used. A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.<br>Flexible intervals may be written as two macros separated by a forward slash (e.g. `{$FLEX_INTERVAL}/{$FLEX_PERIOD}`).<br><br>Optional for Zabbix trapper, dependent items and for Zabbix agent (active) with `mqtt.get` key.|
|**hostid**<br>(required)|string|ID of the host that the item prototype belongs to.<br><br>For update operations this field is *readonly*.|
|**ruleid**<br>(required)|string|ID of the LLD rule that the item belongs to.<br><br>For update operations this field is *readonly*.|
|**interfaceid**<br>(required)|string|ID of the item prototype's host interface. Used only for host item prototypes.<br><br>Not required for Zabbix agent (active), Zabbix internal, Zabbix trapper, calculated, dependent, database monitor and script item prototypes. Optional for HTTP agent item prototypes.|
|**key\_**<br>(required)|string|Item prototype key.|
|**name**<br>(required)|string|Name of the item prototype.|
|**type**<br>(required)|integer|Type of the item prototype.<br><br>Possible values:<br>0 - Zabbix agent;<br>2 - Zabbix trapper;<br>3 - simple check;<br>5 - Zabbix internal;<br>7 - Zabbix agent (active);<br>10 - external check;<br>11 - database monitor;<br>12 - IPMI agent;<br>13 - SSH agent;<br>14 - TELNET agent;<br>15 - calculated;<br>16 - JMX agent;<br>17 - SNMP trap;<br>18 - Dependent item;<br>19 - HTTP agent;<br>20 - SNMP agent;<br>21 - Script.|
|**url**<br>(required)|string|URL string required only for HTTP agent item prototypes. Supports LLD macros, user macros, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.|
|**value\_type**<br>(required)|integer|Type of information of the item prototype.<br><br>Possible values:<br>0 - numeric float;<br>1 - character;<br>2 - log;<br>3 - numeric unsigned;<br>4 - text.|
|allow\_traps|integer|HTTP agent item prototype field. Allow to populate value as in trapper item type also.<br><br>0 - *(default)* Do not allow to accept incoming data.<br>1 - Allow to accept incoming data.|
|authtype|integer|Used only by SSH agent item prototypes or HTTP agent item prototypes.<br><br>SSH agent authentication method possible values:<br>0 - *(default)* password;<br>1 - public key.<br><br>HTTP agent authentication method possible values:<br>0 - *(default)* none<br>1 - basic<br>2 - NTLM<br>3 - Kerberos|
|description|string|Description of the item prototype.|
|follow\_redirects|integer|HTTP agent item prototype field. Follow response redirects while polling data.<br><br>0 - Do not follow redirects.<br>1 - *(default)* Follow redirects.|
|headers|object|HTTP agent item prototype field. Object with HTTP(S) request headers, where header name is used as key and header value as value.<br><br>Example:<br>{ "User-Agent": "Zabbix" }|
|history|string|A time unit of how long the history data should be stored. Also accepts user macro and LLD macro.<br><br>Default: 90d.|
|http\_proxy|string|HTTP agent item prototype field. HTTP(S) proxy connection string.|
|ipmi\_sensor|string|IPMI sensor. Used only by IPMI item prototypes.|
|jmx\_endpoint|string|JMX agent custom connection string.<br><br>Default value:<br>service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi|
|logtimefmt|string|Format of the time in log entries. Used only by log item prototypes.|
|master\_itemid|integer|Master item ID.<br>Recursion up to 3 dependent items and item prototypes and maximum count of dependent items and item prototypes equal to 29999 are allowed.<br><br>Required by Dependent items.|
|output\_format|integer|HTTP agent item prototype field. Should response be converted to JSON.<br><br>0 - *(default)* Store raw.<br>1 - Convert to JSON.|
|params|string|Additional parameters depending on the type of the item prototype:<br>- executed script for SSH and Telnet item prototypes;<br>- SQL query for database monitor item prototypes;<br>- formula for calculated item prototypes.|
|parameters|array|Additional parameters for script item prototypes. Array of objects with 'name' and 'value' properties, where name must be unique.|
|password|string|Password for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent item prototypes.|
|post\_type|integer|HTTP agent item prototype field. Type of post data body stored in posts property.<br><br>0 - *(default)* Raw data.<br>2 - JSON data.<br>3 - XML data.|
|posts|string|HTTP agent item prototype field. HTTP(S) request body data. Used with post\_type.|
|privatekey|string|Name of the private key file.|
|publickey|string|Name of the public key file.|
|query\_fields|array|HTTP agent item prototype field. Query parameters. Array of objects with 'key':'value' pairs, where value can be empty string.|
|request\_method|integer|HTTP agent item prototype field. Type of request method.<br><br>0 - *(default)* GET<br>1 - POST<br>2 - PUT<br>3 - HEAD|
|retrieve\_mode|integer|HTTP agent item prototype field. What part of response should be stored.<br><br>0 - *(default)* Body.<br>1 - Headers.<br>2 - Both body and headers will be stored.<br><br>For request\_method HEAD only 1 is allowed value.|
|snmp\_oid|string|SNMP OID.|
|ssl\_cert\_file|string|HTTP agent item prototype field. Public SSL Key file path.|
|ssl\_key\_file|string|HTTP agent item prototype field. Private SSL Key file path.|
|ssl\_key\_password|string|HTTP agent item prototype field. Password for SSL Key file.|
|status|integer|Status of the item prototype.<br><br>Possible values:<br>0 - *(default)* enabled item prototype;<br>1 - disabled item prototype;<br>3 - unsupported item prototype.|
|status\_codes|string|HTTP agent item prototype field. Ranges of required HTTP status codes separated by commas. Also supports user macros or LLD macros as part of comma separated list.<br><br>Example: 200,200-{$M},{$M},200-400|
|templateid|string|(readonly) ID of the parent template item prototype.|
|timeout|string|Item data polling request timeout. Used for HTTP agent and script item prototypes. Supports user macros and LLD macros.<br><br>default: 3s<br>maximum value: 60s|
|trapper\_hosts|string|Allowed hosts. Used by trapper item prototypes or HTTP item prototypes.|
|trends|string|A time unit of how long the trends data should be stored. Also accepts user macro and LLD macro.<br><br>Default: 365d.|
|units|string|Value units.|
|username|string|Username for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent item prototypes.<br><br>Required by SSH and Telnet item prototypes.|
|uuid|string|Universal unique identifier, used for linking imported item prototypes to already existing ones. Used only for item prototypes on templates. Auto-generated, if not given.|
|valuemapid|string|ID of the associated value map.|
|verify\_host|integer|HTTP agent item prototype field. Whether to validate that the host name for the connection matches the one in the host's certificate.<br><br>0 - *(default)* Do not validate.<br>1 - Validate.<br>|
|verify\_peer|integer|HTTP agent item prototype field. Whether to validate that the host's certificate is authentic.<br><br>0 - *(default)* Do not validate.<br>1 - Validate.|
|discover|integer|Item prototype discovery status.<br><br>Possible values:<br>0 - *(default)* new items will be discovered;<br>1 - new items will not be discovered and existing items will be marked as lost.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 监控项原型
监控项原型object具有以下属性
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| itemid | string | *(只读)* 监控项原型的ID。 |
| **delay**<br>(required) | string | 监控项原型的更新间隔。接受秒数或带后缀的时间单位（30s,1m,2h,1d）。<br>可选择性地指定一个或多个[custom intervals](/manual/config/items/item/custom_intervals)作为灵活间隔或调度计划。<br>多个间隔用分号分隔。<br>可使用用户宏和LLD宏。单个宏必须填满整个字段，不支持字段中包含多个宏或宏与文本混合使用。<br>灵活间隔可写成两个由斜杠分隔的宏（例如`{$FLEX_INTERVAL}/{$FLEX_PERIOD}`）。<br><br>对于Zabbix trapper、依赖监控项以及使用`mqtt.get`键的Zabbix agent（主动模式）为可选配置。 |
| **hostid**<br>(required) | string | 监控项原型所属的主机 ID。<br><br>对于update操作，此字段为*只读*。 |
| **ruleid**<br>(required) | string | 该监控项所属的LLD规则ID。<br><br>对于update操作，此字段为*只读*。 |
| **interfaceid**<br>(required) | string | 监控项原型主机接口的ID。仅用于主机监控项原型。<br><br>不适用于Zabbix agent(主动式)、Zabbix内置、Zabbix捕捉器、计算型、依赖型、数据库监控和脚本监控项原型。HTTPagent监控项原型为可选字段。 |
| **key\_**<br>(required) | string | 监控项 原型键. |
| **name**<br>(required) | string | 监控项原型名称。 |
| **type**<br>(required) | integer | 监控项原型的类型.<br><br>可能的值:<br>0 - Zabbix agent;<br>2 - Zabbix trapper;<br>3 - simple check;<br>5 - Zabbix internal;<br>7 - Zabbix agent (active);<br>10 - external check;<br>11 - database monitor;<br>12 - IPMI agent;<br>13 - SSH agent;<br>14 - TELNET agent;<br>15 - calculated;<br>16 - JMX agent;<br>17 - SNMP trap;<br>18 - Dependent 监控项;<br>19 - HTTP agent;<br>20 - SNMP agent;<br>21 - Script. |
| **url**<br>(required) | string | URL string 仅HTTP agent 监控项原型需要. 支持LLD宏、用户宏、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}. |
| **value\_type**<br>(required) | integer | 监控项原型的信息类型。<br><br>可选值：<br>0 - 数值型float;<br>1 - 字符型;<br>2 - 日志型;<br>3 - 无符号数值型;<br>4 - 文本型。 |
| allow\_traps | integer | HTTP agent 监控项 原型字段. 允许像trapper 监控项类型一样填充值.<br><br>0 - *(默认)* 不允许接收传入数据.<br>1 - 允许接收传入数据. |
| authtype | integer | 仅用于SSH agent 监控项原型或HTTP agent 监控项原型.<br><br>SSH agent认证方法可能取值:<br>0 - *(默认)* 密码;<br>1 - 公钥.<br><br>HTTP agent认证方法可能取值:<br>0 - *(默认)* 无<br>1 - basic<br>2 - NTLM<br>3 - Kerberos |
| description | string | 监控项原型描述. |
| follow\_redirects | integer | HTTP agent 监控项 原型字段。在轮询数据时跟随响应重定向。<br><br>0 - 不跟随重定向。<br>1 - *(默认)* 跟随重定向。 |
| headers | object | HTTP agent 监控项 原型字段. object 包含HTTP(S)请求头, 其中头名称作为键, 头值作为值.<br><br>示例:<br>{ "User-Agent": "Zabbix" } |
| history | string | 历史数据应存储的时间单位. 支持用户宏和LLD宏.<br><br>默认值: 90d. |
| http\_proxy | string | HTTP agent 监控项 原型字段. HTTP(S) proxy 连接 string. |
| ipmi\_sensor | string | IPMI传感器。仅由IPMI 监控项原型使用。 |
| jmx\_endpoint | string | JMX agent 自定义连接 string.<br><br>默认值:<br>service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| logtimefmt | string | 日志条目中的时间格式。仅由日志 监控项原型 使用。 |
| master\_itemid | integer | 主监控项 ID.<br>允许递归最多3层依赖监控项和监控项原型，且依赖监控项和监控项原型的最大数量为29999.<br><br>依赖监控项所需字段. |
| output\_format | integer | HTTP agent 监控项 原型字段。是否应将响应转换为JSON。<br><br>0 - *(默认)* 存储原始数据。<br>1 - 转换为JSON。 |
| params | string | 根据监控项原型类型所需的附加参数:<br>- SSH和Telnet监控项原型的执行脚本;<br>- 数据库监控监控项原型的SQLquery;<br>- 计算型监控项原型的公式。 |
| parameters | array | 脚本 监控项原型 的附加参数。包含 objects 的 array，需具有 '名称' 和 'value' 属性，其中名称必须唯一。 |
| password | string | 用于身份验证的密码。被简单检查、SSH、Telnet、数据库监控、JMX和HTTP agent 监控项原型使用。 |
| post\_type | integer | HTTP agent 监控项 原型字段. 存储在posts属性中的post数据体类型.<br><br>0 - *(默认)* 原始数据.<br>2 - JSON数据.<br>3 - XML数据. |
| posts | string | HTTP agent 监控项 原型字段。HTTP(S)请求体数据。需与post_type配合使用。 |
| privatekey | string | 私钥名称 file. |
| publickey | string | 公钥名称 file. |
| query\_fields | array | HTTP agent 监控项 原型字段。 query 参数。 array 的 objects 包含 'key':'value' 键值对，其中值可为空 string。 |
| request\_method | integer | HTTP agent 监控项 原型字段. 请求方法类型.<br><br>0 - *(默认)* GET<br>1 - POST<br>2 - PUT<br>3 - HEAD |
| retrieve\_mode | integer | HTTP agent 监控项 原型字段。应存储响应的哪部分内容。<br><br>0 - *(默认)* 正文<br>1 - 头部信息<br>2 - 同时存储正文和头部信息<br><br>对于 request\_method HEAD 仅允许值为1 |
| snmp\_oid | string | SNMP OID. |
| ssl\_cert\_file | string | HTTP agent 监控项 原型字段. 公钥SSL file 路径. |
| ssl\_key\_file | string | HTTP agent 监控项 原型字段。私有SSL密钥 file 路径。 |
| ssl\_key\_password | string | HTTP agent 监控项 原型字段. SSL密钥密码 file. |
| status | integer | 监控项原型状态.<br><br>可能取值:<br>0 - *(默认)* 启用监控项原型;<br>1 - 禁用监控项原型;<br>3 - 不支持的监控项原型. |
| status\_codes | string | HTTP agent 监控项 原型字段。以逗号分隔的所需HTTP状态码范围。支持用户宏或LLD宏作为逗号分隔列表的一部分。<br><br>示例：200,200-{$M},{$M},200-400 |
| templateid | string | (只读) 父模板 监控项 原型ID。 |
| timeout | string | 监控项 数据轮询请求超时。用于HTTP agent 和脚本 监控项原型。支持用户宏和LLD宏。<br><br>默认值: 3秒<br>最大值: 60秒 |
| trapper\_hosts | string | 允许的 主机。用于 trapper 监控项原型 或 HTTP 监控项原型。 |
| trends | string | 趋势数据应存储的时间单位。同时支持用户宏和LLD宏。<br><br>默认值: 365d. |
| units | string | 数值单位 |
| username | string | 用于认证的用户名. 被简单检查、SSH、Telnet、数据库监控、JMX和HTTP agent 监控项原型使用.<br><br>SSH和Telnet 监控项原型必填字段. |
| uuid | string | 通用唯一标识符，用于将导入的监控项原型与已存在的关联。仅适用于模板上的监控项原型。若未提供则自动生成。 |
| valuemapid | string | 关联值映射的ID。 |
| verify\_host | integer | HTTP agent 监控项 原型字段。是否验证连接的 主机 名称与 主机 证书中的名称匹配。<br><br>0 - *(默认)* 不验证。<br>1 - 验证。<br> |
| verify\_peer | integer | HTTP agent 监控项 原型字段。是否验证 主机 的证书真实性。<br><br>0 - *(默认)* 不验证。<br>1 - 验证。 |
| discover | integer | 监控项 原型发现状态。<br><br>可能取值：<br>0 - *(默认)* 新 监控项 将被发现；<br>1 - 新 监控项 将不被发现且现有 监控项 将被标记为丢失。 |
请注意，某些方法（update、delete）所需/可选参数的组合有所不同。
# itemprototype.update
# itemprototype.update
##### Item prototype
You may want to create an item prototype like this:
with preprocessing options:
##### 监控项原型
您可能需要create一个这样的监控项原型:
包含预处理选项:
## Items
## 监控项
## Items
## 监控项
## Items
## 监控项
## Items
## 监控项
## Items
## 监控项
## Items
## 监控项
## Items
## 监控项
#### Items
Define items to monitor.
[Item API](/manual/api/reference/item)
#### 监控项
定义 监控项 进行监控.
[Item API](/manual/api/reference/item)
### Items
##### docker.container_stats
The [docker.container_stats](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#docker) item on Zabbix agent 2 now also returns a `pids_stats` property with the current number of processes/threads on the container.
### 监控项
##### docker.container_stats
[docker.container_stats](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#docker) 监控项 在 Zabbix agent 2 上现在还会返回一个 `pids_stats` 属性，其中包含容器当前的进程/线程数。
#### Items / item prototypes
In an [item](/manual/config/items/item) or an [item
prototype](/manual/discovery/low_level_discovery/item_prototypes)
configuration, user macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|-|------------------------------|----------|
|Item key parameters|<|yes|
|Update interval|<|no|
|Custom intervals|<|no|
|History storage period|<|no|
|Trend storage period|<|no|
|Description|<|yes|
|*Calculated/aggregate item*|<|<|
| |Formula (expression constants and function parameters; item key parameters; (*aggregate item only*) filter conditions (host group name and tag name))|yes|
|*Database monitor*|<|<|
| |Username|yes|
|^|Password|yes|
|^|SQL query|yes|
|*HTTP agent*|<|<|
| |URL^[3](supported_by_location_user#footnotes)^|yes|
|^|Query fields|yes|
|^|Timeout|no|
|^|Request body|yes|
|^|Headers (names and values)|yes|
|^|Required status codes|yes|
|^|HTTP proxy|yes|
|^|HTTP authentication username|yes|
|^|HTTP authentication password|yes|
|^|SSl certificate file|yes|
|^|SSl key file|yes|
|^|SSl key password|yes|
|^|Allowed hosts|yes|
|*JMX agent*|<|<|
| |JMX endpoint|yes|
|*Script item*|<|<|
| |Parameter names and values|yes|
|*SNMP agent*|<|<|
| |SNMP OID|yes|
|*SSH agent*|<|<|
| |Username|yes|
|^|Public key file|yes|
|^|Private key file|yes|
|^|Password|yes|
|^|Script|yes|
|*TELNET agent*|<|<|
| |Username|yes|
|^|Password|yes|
|^|Script|yes|
|*Zabbix trapper*|<|<|
| |Allowed hosts|yes|
|*Tags*^[2](supported_by_location_user#footnotes)^|<|<|
| |Tag names|yes|
|^|Tag values|yes|
|*Preprocessing*|<|<|
| |Step parameters (including custom scripts)|yes|
#### 监控项/监控项原型
在[item](/manual/config/items/item)或[item
prototype](/manual/discovery/low_level_discovery/item_prototypes)配置中
用户宏可用于以下字段：
| 位置 | < | 多宏/与文本混合^[1](supported_by_location_user#脚注)^ |
|-|------------------------------|----------|
| 监控项键参数 | < | 是 |
| 更新间隔 | < | 否 |
| 自定义间隔 | < | 否 |
| 历史存储周期 | < | 否 |
| 趋势存储周期 | < | 否 |
| 描述 | < | 是 |
| *计算/聚合监控项* | < | < |
| | 公式（表达式常量和函数参数；监控项键参数；(*仅聚合监控项*)过滤条件(主机组名称和标签名)) | 是 |
| *数据库监控* | < | < |
| | 用户名 | 是 |
| ^ | 密码 | 是 |
| ^ | SQL query | 是 |
| *HTTP agent* | < | < |
| | URL^[3](supported_by_location_user#脚注)^ | 是 |
| ^ | query字段 | 是 |
| ^ | 超时 | 否 |
| ^ | 请求体 | 是 |
| ^ | 头部（名称和值） | 是 |
| ^ | 必需状态码 | 是 |
| ^ | HTTP proxy | 是 |
| ^ | HTTP认证用户名 | 是 |
| ^ | HTTP认证密码 | 是 |
| ^ | SSL证书file | 是 |
| ^ | SSL密钥file | 是 |
| ^ | SSL密钥密码 | 是 |
| ^ | 允许主机 | 是 |
| *JMX agent* | < | < |
| | JMX端点 | 是 |
| *脚本监控项* | < | < |
| | 参数名和值 | 是 |
| *SNMP agent* | < | < |
| | SNMP OID | 是 |
| *SSH agent* | < | < |
| | 用户名 | 是 |
| ^ | 公钥file | 是 |
| ^ | 私钥file | 是 |
| ^ | 密码 | 是 |
| ^ | 脚本 | 是 |
| *TELNET agent* | < | < |
| | 用户名 | 是 |
| ^ | 密码 | 是 |
| ^ | 脚本 | 是 |
| *Zabbix trapper* | < | < |
| | 允许主机 | 是 |
| *标签*^[2](supported_by_location_user#脚注)^ | < | < |
| | 标签名 | 是 |
| ^ | 标签值 | 是 |
| *预处理* | < | < |
| | 步骤参数（包括自定义脚本） | 是 |
#### Items
To configure querying of internal stats on another Zabbix instance, you
may use two items:
- `zabbix[stats,<ip>,<port>]` internal item - for direct remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
- `zabbix.stats[<ip>,<port>]` agent item - for agent-based remote
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
See also: [Internal items](/manual/config/items/itemtypes/internal),
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
The following diagram illustrates the use of either item depending on
the context.
-  - Server
→ external Zabbix instance (`zabbix[stats,<ip>,<port>]`)
-  - Server →
proxy → external Zabbix instance (`zabbix[stats,<ip>,<port>]`)
-  - Server →
agent → external Zabbix instance (`zabbix.stats[<ip>,<port>]`)
-  - Server →
proxy → agent → external Zabbix instance
(`zabbix.stats[<ip>,<port>]`)
To make sure that the target instance allows querying it by the external
instance, list the address of the external instance in the
'StatsAllowedIP' parameter on the target instance.
#### 监控项
要配置对另一个Zabbix实例的内部统计信息查询，
您可以使用两种监控项：
- `zabbix[stats,<ip>,<port>]` 内部监控项 - 用于直接远程queries
Zabbix server/proxy。<ip>和<port>用于标识目标实例
- `zabbix.stats[<ip>,<port>]` agent 监控项 - 用于基于agent的远程查询
queries of Zabbix server/proxy. <ip> and <port> are used
to identify the target instance.
另请参阅：[Internal items](/manual/config/items/itemtypes/internal)，
[Zabbix agent items](/manual/config/items/itemtypes/zabbix_agent)
下图展示了根据上下文使用不同监控项的场景。
-  - 服务器
→ 外部Zabbix实例(`zabbix[stats,<ip>,<port>]`)
-  - 服务器 →
proxy → 外部Zabbix实例(`zabbix[stats,<ip>,<port>]`)
-  - 服务器 →
agent → 外部Zabbix实例(`zabbix.stats[<ip>,<port>]`)
-  - 服务器 →
proxy → agent → external Zabbix instance
(`zabbix.stats[<ip>,<port>]`)
`zabbix.stats[<ip>,<port>]`)
为确保目标实例允许外部实例查询，
需在目标实例的'StatsAllowedIP'参数中列出外部实例的地址。
### Item tag
The item tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**tag**<br>(required)|string|Item tag name.|
|value|string|Item tag value.|
### 监控项 标签
监控项标签object具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **tag**<br>(required) | string | 监控项标签名称. |
| value | string | 监控项标签值. |
##### Item
To begin with, you may want to set up an item that monitors a log file,
for example:
log[/var/log/syslog]
With the item set up, wait a minute for the configuration changes to be
picked up and then go to [Latest
data](/manual/web_interface/frontend_sections/monitoring/latest_data) to
make sure that the item has started collecting data.
##### 监控项
首先，您可能需要设置一个监控项来监控日志file，
例如：
log[/var/log/syslog]
设置好监控项后，等待一分钟让配置变更生效，
然后前往[Latest
data](/manual/web_interface/frontend_sections/monitoring/latest_data)确认
监控项已开始收集数据。
# item.update
# item.update
#### Item value
An *Item value* widget has been added to dashboard widgets.
This type of widget is useful for displaying values of single items prominently. Different visual styles of display are
possible:
For more information, see
[Item value widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/item_value).
#### 监控项 值
仪表板小部件中新增了*监控项值*小部件。
该类型小部件适用于突出显示单个监控项的数值。支持多种可视化显示样式：
更多信息请参阅
[Item value widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/item_value)。
##### Item value preprocessing
The **Preprocessing** tab allows to define [transformation
rules](/manual/config/items/preprocessing) for the received values.
##### 监控项 值预处理
**预处理**选项卡允许为接收到的值定义[transformation
rules](/manual/config/items/preprocessing)。
#### Item value preprocessing
To visualize the data preprocessing process, we can use the following
simplified diagram:
The diagram above shows only processes, objects and main actions related
to item value preprocessing in a **simplified** form. The diagram does
not show conditional direction changes, error handling or loops. Only
one preprocessing worker is shown on this diagram (multiple
preprocessing workers can be used in real-life scenarios), only one item
value is being processed and we assume that this item requires to
execute at least one preprocessing step. The aim of this diagram is to
show the idea behind item value preprocessing pipeline.
- Item data and item value is passed to preprocessing manager using
socket-based IPC mechanism.
- Item is placed in the preprocessing queue.
::: noteclassic
Item can be placed at the end or at the beginning of the
preprocessing queue. Zabbix internal items are always placed at the
beginning of preprocessing queue, while other item types are enqueued at
the end.
:::
- At this point data flow stops until there is at least one unoccupied
(that is not executing any tasks) preprocessing worker.
- When preprocessing worker is available, preprocessing task is being
sent to it.
- After preprocessing is done (both failed and successful execution of
preprocessing steps), preprocessed value is being passed back to
preprocessing manager.
- Preprocessing manager converts result to desired format (defined by
item value type) and places result in preprocessing queue. If there
are dependent items for current item, then dependent items are added
to preprocessing queue as well. Dependent items are enqueued in
preprocessing queue right after the master item, but only for master
items with value set and not in NOT SUPPORTED state.
#### 监控项 值预处理
为了可视化数据预处理过程，我们可以使用以下
简化示意图:
上图仅展示了与objects相关的主要流程和核心操作
以**简化**形式对监控项值进行预处理。该图表未
不显示条件方向变更、错误处理或循环。仅
图中显示了一个预处理工作进程（多个
预处理工作器可在实际场景中使用时，仅有一个监控项
值正在处理中，我们假设此监控项需要
execute 至少需要一个预处理步骤。该图的目的是
展示 监控项 值预处理流水线背后的设计理念
- 监控项 数据和 监控项 值通过预处理管理器传递
基于套接字的IPC机制。
- 监控项 被放入预处理队列。
::: noteclassic
监控项 可以放置在末尾或开头
预处理队列。Zabbix内部监控项始终被置于
预处理队列的开头，而其他监控项类型则被排入
结束
:::
- 此时数据流将停止，直到至少有一个空闲位置出现
（未执行任何任务的）预处理工作进程。
- 当预处理工作器可用时，预处理任务正在执行
发送给它。
- 预处理完成后（无论执行成功或失败）
预处理步骤), 预处理后的值将被传回
预处理管理器
- 预处理管理器将结果转换为所需格式（由
监控项 值类型)并将结果放入预处理队列。如果
是当前监控项的依赖监控项，那么依赖监控项会被添加
进入预处理队列。依赖的监控项也会被加入队列
预处理队列紧接在主监控项之后，但仅适用于主节点
监控项 已设置值且不处于不支持状态。
#### Item value processing
To visualize the data flow from data source to the Zabbix database, we
can use the following simplified diagram:
The diagram above shows only processes, objects and actions related to
item value processing in a **simplified** form. The diagram does not
show conditional direction changes, error handling or loops. Local data
cache of preprocessing manager is not shown either because it doesn't
affect data flow directly. The aim of this diagram is to show processes
involved in item value processing and the way they interact.
- Data gathering starts with raw data from a data source. At this
point, data contains only ID, timestamp and value (can be multiple
values as well)
- No matter what type of data gatherer is used, the idea is the same
for active or passive checks, for trapper items and etc, as it only
changes the data format and the communication starter (either data
gatherer is waiting for a connection and data, or data gatherer
initiates the communication and requests the data). Raw data is
validated, item configuration is retrieved from configuration cache
(data is enriched with the configuration data).
- Socket-based IPC mechanism is used to pass data from data gatherers
to preprocessing manager. At this point data gatherer continue to
gather data without waiting for the response from preprocessing
manager.
- Data preprocessing is performed. This includes execution of
preprocessing steps and dependent item processing.
::: noteclassic
Item can change its state to NOT SUPPORTED while
preprocessing is performed if any of preprocessing steps
fail.
:::
- History data from local data cache of preprocessing manager is being
flushed into history cache.
- At this point data flow stops until the next synchronization of
history cache (when history syncer process performs data
synchronization).
- Synchronization process starts with data normalization storing data
in Zabbix database. Data normalization performs conversions to
desired item type (type defined in item configuration), including
truncation of textual data based on predefined sizes allowed for
those types (HISTORY\_STR\_VALUE\_LEN for string,
HISTORY\_TEXT\_VALUE\_LEN for text and HISTORY\_LOG\_VALUE\_LEN for
log values). Data is being sent to Zabbix database after
normalization is done.
::: noteclassic
Item can change its state to NOT SUPPORTED if data
normalization fails (for example, when textual value cannot be converted
to number).
:::
- Gathered data is being processed - triggers are checked, item
configuration is updated if item becomes NOT SUPPORTED, etc.
- This is considered the end of data flow from the point of view of
item value processing.
#### 监控项值处理
为了可视化从数据源到Zabbix数据库的数据流，我们可以使用以下简化示意图：
上图仅以**简化**形式展示了与监控项值处理相关的进程、objects和操作。该示意图未显示条件方向变更、错误处理或循环。预处理管理器的本地数据缓存也未显示，因为它不会直接影响数据流。此示意图的目的是展示参与监控项值处理的进程及其交互方式。
- 数据采集始于数据源的原始数据。此时数据仅包含ID、时间戳和值（也可能是多个值）
- 无论使用何种类型的数据采集器，对于主动或被动检查、trapper 监控项等都采用相同原理，因为这只会改变数据格式和通信发起方（数据采集器要么等待连接和数据，要么主动发起通信并请求数据）。原始数据经过验证后，从configuration cache中检索监控项配置（数据会被配置数据增强）
- 使用基于套接字的IPC机制将数据从数据采集器传递到预处理管理器。此时数据采集器会继续采集数据，而无需等待预处理管理器的响应
- 执行数据预处理。这包括执行
preprocessing steps and dependent item processing.
::: noteclassic
如果在执行预处理步骤时任何步骤失败，监控项可能将其状态更改为NOT SUPPORTED。
:::
- 预处理管理器本地数据缓存中的历史数据正被刷新到history cache
- 此时数据流停止，直到下一次history cache同步（当历史同步器进程执行数据同步时）
- 同步进程从数据规范化开始，存储数据
in Zabbix database. Data normalization performs conversions to
desired item type (type defined in item configuration), including
truncation of textual data based on predefined sizes allowed for
those types (HISTORY\_STR\_VALUE\_LEN for string,
HISTORY\_TEXT\_VALUE\_LEN for text and HISTORY\_LOG\_VALUE\_LEN for
log values). Data is being sent to Zabbix database after
normalization is done.
::: noteclassic
如果数据规范化失败（例如当文本值无法转换为数字时），监控项可能将其状态更改为NOT SUPPORTED。
:::
- 正在处理采集的数据——检查触发器，如果监控项变为NOT SUPPORTED则更新监控项配置等
- 从监控项值处理的角度来看，这被认为是数据流的终点
#### Item values
The following information is exported for a collected item value:
|Field|<|Type|Description|
|-|---------|---------|---------------------------|
|*host*|<|object|Host name of the item host.|
| |host|string|Host name.|
|^|name|string|Visible host name.|
|*groups*|<|array|List of host groups of the item host; there should be at least one element in array.|
| |\-|string|Host group name.|
|*itemid*|<|number|Item ID.|
|*name*|<|string|Visible item name.|
|*clock*|<|number|Number of seconds since Epoch to the moment when value was collected (integer part).|
|*ns*|<|number|Number of nanoseconds to be added to `clock` to get a precise value collection time.|
|*timestamp*<br>(*Log* only)|<|number|0 if not available.|
|*source*<br>(*Log* only)|<|string|Empty string if not available.|
|*severity*<br>(*Log* only)|<|number|0 if not available.|
|*eventid*<br>(*Log* only)|<|number|0 if not available.|
|*value*|<|number (for numeric items) or<br>string (for text items)|Collected item value.|
|*type*|<|number|Collected value type:<br>0 - numeric float, 1 - character, 2 - log, 3 - numeric unsigned, 4 - text|
#### 监控项值
以下信息是为收集的监控项值导出的:
| 字段 | < | 类型 | 描述 |
|-|---------|---------|---------------------------|
| *host* | < | object | 监控项主机的主机名。 |
| | 主机 | string | 主机名。 |
| ^ | name | string | 可见主机名。 |
| *groups* | < | array | 监控项主机的主机组列表；array中应至少有一个元素。 |
| | \- | string | 主机组名称。 |
| *itemid* | < | number | 监控项ID。 |
| *name* | < | string | 可见监控项名称。 |
| *clock* | < | number | 从Epoch到值收集时刻的秒数(integer部分)。 |
| *ns* | < | number | 要添加到`clock`以get精确值收集时间的纳秒数。 |
| *timestamp*<br>(*Log* only) | < | number | 不可用时为0。 |
| *source*<br>(*Log* only) | < | string | 不可用时为空string。 |
| *severity*<br>(*Log* only) | < | number | 不可用时为0。 |
| *eventid*<br>(*Log* only) | < | number | 不可用时为0。 |
| *value* | < | number (for numeric items) or<br>string (for text items) | 收集的监控项值。 |
| *type* | < | number | 收集值类型:<br>0 - 数值型float, 1 - 字符型, 2 - 日志型, 3 - 无符号数值型, 4 - 文本型 |
#### Item value suffixes
Suffixes can also be used to display numeric item values in a human-readable format.
To enable this, use one of the following suffixes in the *Units* field when [configuring an item](/manual/config/items/item#configuration):
- **B** - bytes
- **Bps** - bytes per second
- **s** - seconds, displayed using up to three largest non-zero time units
- **uptime** - elapsed time in hh:mm:ss or N days, hh:mm:ss
- **unixtime** - Unix timestamp, formatted as yyyy.mm.dd hh:mm:ss
The following additional rules apply to how these suffixes are interpreted and displayed:
- For B and Bps, Zabbix uses base-2 conversion (1K = 1024B), following the [JEDEC](https://en.wikipedia.org/wiki/JEDEC_memory_standards) standard.
- For other units (such as Hz, W, etc.), Zabbix uses base-10 conversion (1K = 1000).
- For s (seconds):
- The format includes yyy mmm ddd hhh mmm sss ms; only up to three largest non-zero time units are displayed (e.g., 1M 10d 4h).
- If a unit is zero and between two non-zero units, it is omitted (e.g., 10d 56m instead of 10d 0h 56m).
When *Units* are used, the following multiplier suffixes are automatically applied to item values:
- **K**, **M**, **G**, **T** - kilo, mega, giga, tera
- **P**, **E**, **Z**, **Y** - peta, exa, zetta, yotta *(these are applied in frontend only)*
#### 监控项值后缀
后缀也可用于以人类可读格式显示数值监控项值
要启用此功能，在[配置](/manual/config/items/item#配置)时，于*单位*字段中使用以下后缀之一：
- **B** - 字节
- **Bps** - 字节每秒
- **s** - 秒，使用最多三个最大的非零时间单位显示
- **uptime** - 以hh:mm:ss或N天, hh:mm:ss格式显示运行时间
- **unixtime** - Unix时间戳，格式化为yyyy.mm.dd hh:mm:ss
这些后缀的解析和显示遵循以下附加规则：
- 对于B和Bps，Zabbix采用基数为2的转换（1K = 1024B），遵循[JEDEC](https://en.wikipedia.org/wiki/JEDEC_memory_standards)标准
- 对于其他单位（如Hz、W等），Zabbix采用基数为10的转换（1K = 1000）
- 对于s（秒）：
- The format includes yyy mmm ddd hhh mmm sss ms; only up to three largest non-zero time units are displayed (e.g., 1M 10d 4h).
- If a unit is zero and between two non-zero units, it is omitted (e.g., 10d 56m instead of 10d 0h 56m).
当使用*单位*时，以下乘数后缀会自动应用于监控项值：
- **K**, **M**, **G**, **T** - 千, 兆, 吉, 太
- **P**, **E**, **Z**, **Y** - 拍, 艾, 泽, 尧（这些仅在前端应用）
##### Item value
The following parameters are supported if *Data* is set to "Item value".
::: noteclassic
The first number in the *Thresholds* property name (e.g. columnsthresholds.color.0.0) references the column for which thresholds are configured,
while the second number references threshold place in a list, sorted in ascending order.
However, if thresholds are configured in a different order, the values will be sorted in ascending order after updating widget configuration in Zabbix frontend
(e.g. `"threshold.threshold.0":"5"` → `"threshold.threshold.0":"1"`; `"threshold.threshold.1":"1"` → `"threshold.threshold.1": "5"`).
:::
|Parameter|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-|--------|--|--------|-------------------------------|
|*Item*|<|1 |columns.item.0|Valid item name.|
|***Time shift***<br>(required)|<|1|columns.timeshift.0|Valid numeric or time string value (e.g. `3600` or `1h`).<br>You may use [time suffixes](/manual/appendix/suffixes#time-suffixes). Negative values are allowed.|
|*Aggregation function*|<|0|columns.aggregate_function.0|0 - *(default)* none;<br>1 - min;<br>2 - max;<br>3 - avg;<br>4 - count;<br>5 - sum;<br>6 - first;<br>7 - last.|
|*Aggregation interval*|<|1|columns.aggregate_interval.0|Valid time string (e.g. `3600`, `1h`, etc.).<br>You may use [time suffixes](/manual/appendix/suffixes#time-suffixes).<br><br>Parameter *Aggregation interval* not available if *Aggregation function* is set to *none*.<br><br>Default: `1h`.|
|*Display*|<|0|columns.display.0|1 - *(default)* As is;<br>2 - Bar;<br>3 - Indicators.|
|*Min*|<|1|columns.min.0|Any numeric value.<br><br>Parameter *Min* not available if *Display* is set to "As is".|
|*Max*|<|1|columns.max.0|Any numeric value.<br><br>Parameter *Max* not available if *Display* is set to "As is".|
|*History data*|<|0|columns.history.0|1 - *(default)* Auto;<br>2 - History;<br>3 - Trends.|
|*Thresholds*|<|<|<|<|
|<|*Color*|1|columnsthresholds.color.0.0|Hexadecimal color code (e.g. `FF0000`).<br><br>Default: `""` (empty).|
|^|*Threshold*|1|columnsthresholds.threshold.0.0|Any string value.|
##### 监控项值
当*数据*设置为"监控项值"时支持以下参数。
::: noteclassic
*Thresholds*属性名中的第一个数字（例如columnsthresholds.color.0.0）引用配置阈值的列，
而第二个数字引用按升序排序的阈值在列表中的位置。
但是，如果阈值以不同顺序配置，在Zabbix前端更新小部件配置后，值将按升序重新排序
（例如`"threshold.threshold.0":"5"` → `"threshold.threshold.0":"1"`；`"threshold.threshold.1":"1"` → `"threshold.threshold.1": "5"`）。
:::
| 参数 | < | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-|--------|--|--------|-------------------------------|
| *Item* | < | 1 | columns.item.0 | 有效的监控项名称。 |
| ***Time shift***<br>(required) | < | 1 | columns.timeshift.0 | 有效的数值或时间string值（例如`3600`或`1h`）。<br>可使用[时间后缀](/manual/appendix/suffixes#时间后缀)。允许负值。 |
| *Aggregation function* | < | 0 | columns.aggregate_function.0 | 0 - *（默认）* 无；<br>1 - 最小值；<br>2 - 最大值；<br>3 - 平均值；<br>4 - 计数；<br>5 - 求和；<br>6 - 第一个；<br>7 - 最后一个。 |
| *Aggregation interval* | < | 1 | columns.aggregate_interval.0 | 有效的时间string（例如`3600`、`1h`等）。<br>可使用[时间后缀](/manual/appendix/suffixes#时间后缀)。<br><br>当*聚合函数*设置为*无*时，*聚合间隔*参数不可用。<br><br>默认：`1h`。 |
| *Display* | < | 0 | columns.display.0 | 1 - *（默认）* 原样显示；<br>2 - 条形图；<br>3 - 指示器。 |
| *Min* | < | 1 | columns.min.0 | 任意数值。<br><br>当*显示*设置为"原样显示"时，*最小值*参数不可用。 |
| *Max* | < | 1 | columns.max.0 | 任意数值。<br><br>当*显示*设置为"原样显示"时，*最大值*参数不可用。 |
| *History data* | < | 0 | columns.history.0 | 1 - *（默认）* 自动；<br>2 - 历史数据；<br>3 - 趋势数据。 |
| *Thresholds* | < | < | < | < |
| < | *颜色* | 1 | columnsthresholds.color.0.0 | 十六进制颜色代码（例如`FF0000`）。<br><br>默认：`""`（空）。 |
| ^ | *阈值* | 1 | columnsthresholds.threshold.0.0 | 任意string值。 |
### Item value widget
An *Item value* widget has been added to dashboard widgets.
This type of widget is useful for displaying values of
single items prominently. Different visual styles of display
are possible:
For more information, see [Item value widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/item_value).
Macros for internal actions contain the reason why an item, an LLD-rule, or a trigger became unsupported:
- {ITEM.STATE.ERROR} - for item-based internal notifications;
- {LLDRULE.STATE.ERROR} - for LLD-rule based internal notifications;
- {TRIGGER.STATE.ERROR} - for trigger-based internal notifications.
For more details, see [Supported macros](/manual/appendix/macros/supported_by_location).
It is possible to zoom in and out the map by using the plus and minus
buttons in the widget's upper left corner or by using the mouse scroll
wheel or touchpad. To set the current view as default, right-click
anywhere on the map and select *Set this view as default*. This setting
will override *Initial view* widget parameter for the current user. To
undo this action, right-click anywhere on the map again and select
*Reset the initial view*.
When *Initial view* or *Default view* is set, you can return to this
view at any time by pressing on the home icon on the left.
可以通过使用小部件左上角的加减按钮或鼠标滚轮/触摸板来放大和缩小地图。要将当前视图设为默认，请在地图上任意位置右键点击并选择*将此视图设为默认*。此设置将覆盖当前用户的*初始视图*小部件参数。要撤销此操作，请再次在地图上右键点击并选择*重置初始视图*。
当设置了*初始视图*或*默认视图*时，您可以通过点击左侧的主页图标随时返回该视图。
#### Java 11 required for Java gateway
Zabbix Java gateway now requires Java 11 for runtime (building from source is still possible with Java 8), due to updated minimum logback library versions:
|Library|New minimum version|Old minimum version|
|------|--|--|
|[logback-classic](https://mvnrepository.com/artifact/ch.qos.logback/logback-classic)|**1.5.16**|1.2.9|
|[logback-core](https://mvnrepository.com/artifact/ch.qos.logback/logback-core)|**1.5.16**|1.2.9|
|[slf4j-api](https://mvnrepository.com/artifact/org.slf4j/slf4j-api)|**2.0.16**|1.7.32|
#### Java网关需要Java 11
由于日志库最低版本要求更新，Zabbix Java网关现在需要Java 11运行时环境（从源码构建仍可使用Java 8）:
| 库名称 | 新最低version | 旧最低version |
|------|--|--|
| [logback-classic](https://mvnrepository.com/artifact/ch.qos.logback/logback-classic) | **1.5.16** | 1.2.9 |
| [logback-core](https://mvnrepository.com/artifact/ch.qos.logback/logback-core) | **1.5.16** | 1.2.9 |
| [slf4j-api](https://mvnrepository.com/artifact/org.slf4j/slf4j-api) | **2.0.16** | 1.7.32 |
##### Java gateway
If you obtained Zabbix from the source repository or an archive, then
the necessary dependencies are already included in the source tree.
If you obtained Zabbix from your distribution's package, then the
necessary dependencies are already provided by the packaging system.
In both cases above, the software is ready to be used and no additional
downloads are necessary.
If, however, you wish to provide your versions of these dependencies
(for instance, if you are preparing a package for some Linux
distribution), below is the list of library versions that Java gateway
is known to work with. Zabbix may work with other versions of these
libraries, too.
The following table lists JAR files that are currently bundled with Java
gateway in the original code:
|Library|Mandatory status|Comments|
|--|-|-------|
|[android-json](https://mvnrepository.com/artifact/com.vaadin.external.google/android-json)|Yes|Version 4.3r1 or higher.<br>JSON (JavaScript Object Notation) is a lightweight data-interchange format. This is the org.json compatible Android implementation extracted from the Android SDK.|
|[logback-classic](https://mvnrepository.com/artifact/ch.qos.logback/logback-classic)|^|Version 1.5.16 or higher.|
|[logback-core](https://mvnrepository.com/artifact/ch.qos.logback/logback-core)|^|Version 1.5.16 or higher.|
|[slf4j-api](https://mvnrepository.com/artifact/org.slf4j/slf4j-api)|^|Version 2.0.16 or higher.|
Java gateway can be built using either Oracle Java or open source
OpenJDK (version 1.6 or newer). Packages provided by Zabbix are compiled
using OpenJDK. The following table lists OpenJDK
packages used for building Zabbix packages by distribution:
|Distribution|OpenJDK package|
|---|--------|
|Debian 12|`default-jdk-headless` (amd64, arm64: 2:1.17-74)|
|Debian 11|`default-jdk-headless` (amd64: 2:1.11-72)|
|Debian 10|`default-jdk-headless` (amd64, i386: 2:1.11-71)|
|OpenSUSE Leap 15|`java-17-openjdk-devel` (amd64: 17.0.5.0-150400.3.9.3; arm64: 17.0.8.0-150400.3.27.1)|
|Oracle Linux 9|`java-11-openjdk-devel` (amd64: 11.0.19.0.7-4.0.1; arm64: 11.0.20.0.8-2.0.1)|
|Oracle Linux 8|`java-1.8.0-openjdk-devel` (amd64: 1.8.0.372.b07-4.0.1); `java-11-openjdk-devel` (arm64: 11.0.20.0.8-3.0.1)|
|Oracle Linux 7|`java-1.8.0-openjdk-devel` (amd64: 1.8.0.282.b08-1)|
|Raspberry Pi OS 12|`default-jdk-headless` (arm64, armhf: 2:1.17-74)|
|Raspberry Pi OS 11|`default-jdk-headless` (arm64: 2:1.11-72; armhf: 2:1.11-72+b4)|
|Raspberry Pi OS 10|`default-jdk` (armhf: 2:1.11-71+b2)|
|RHEL 9|`java-11-openjdk-devel` (amd64: 11.0.19.0.7-4; arm64: 11.0.20.0.8-3)|
|RHEL 8|`java-1.8.0-openjdk-devel` (amd64: 1.8.0.372.b07-4; arm64: 1.8.0.382.b05-2)|
|RHEL 7|`java-1.8.0-openjdk-devel` (amd64: 1.8.0.282.b08-1)|
|SLES 15|`java-17-openjdk-devel` (amd64: 17.0.5.0-150400.3.9.3; arm64: 17.0.8.0-150400.3.27.1)|
|SLES 12|`java-1_8_0-openjdk-devel` (amd64: 1.8.0.252-27.45.6)|
|Ubuntu 24.04|`default-jdk-headless` (amd64, arm64: 2:1.21-75+exp1)|
|Ubuntu 22.04|`default-jdk-headless` (amd64, arm64: 2:1.11-72build2)|
|Ubuntu 20.04|`default-jdk-headless` (amd64, arm64: 2:1.11-72)|
|Ubuntu 18.04|`default-jdk` (amd64: 2:1.11-68ubuntu1~18.04.1; i386: 2:1.10-63ubuntu1~02)|
##### Java网关
如果您从源代码仓库或归档文件获取Zabbix
则所需依赖项已包含在源代码树中
如果您从发行版的软件包获取Zabbix
则所需依赖项已由打包系统提供
上述两种情况下 软件已准备就绪 无需额外下载
但如果您希望提供这些依赖项的自定义版本
(例如为某个Linux发行版准备软件包)
以下是已知与Java网关兼容的库版本列表
Zabbix也可能支持这些库的其他版本
下表列出了当前Java网关原始代码中捆绑的JAR文件:
| 库文件 | 必需状态 | 说明 |
|--|-|-------|
| [android-json](https://mvnrepository.com/artifact/com.vaadin.external.google/android-json) | Yes | 需要4.3r1或更高版本<br>JSON(JavaScript object表示法)是一种轻量级数据交换格式 这是从Android SDK提取的org.json兼容实现 |
| [logback-classic](https://mvnrepository.com/artifact/ch.qos.logback/logback-classic) | ^ | 需要1.5.16或更高版本 |
| [logback-core](https://mvnrepository.com/artifact/ch.qos.logback/logback-core) | ^ | 需要1.5.16或更高版本 |
| [slf4j-api](https://mvnrepository.com/artifact/org.slf4j/slf4j-api) | ^ | 需要2.0.16或更高版本 |
Java网关可使用Oracle Java或开源OpenJDK(version 1.6或更新版本)构建
Zabbix提供的软件包使用OpenJDK编译
下表列出了各发行版用于构建Zabbix软件包的OpenJDK包:
| 发行版 | OpenJDK软件包 |
|---|--------|
| Debian 12 | `default-jdk-headless` (amd64, arm64: 2:1.17-74) |
| Debian 11 | `default-jdk-headless` (amd64: 2:1.11-72) |
| Debian 10 | `default-jdk-headless` (amd64, i386: 2:1.11-71) |
| OpenSUSE Leap 15 | `java-17-openjdk-devel` (amd64: 17.0.5.0-150400.3.9.3; arm64: 17.0.8.0-150400.3.27.1) |
| Oracle Linux 9 | `java-11-openjdk-devel` (amd64: 11.0.19.0.7-4.0.1; arm64: 11.0.20.0.8-2.0.1) |
| Oracle Linux 8 | `java-1.8.0-openjdk-devel` (amd64: 1.8.0.372.b07-4.0.1); `java-11-openjdk-devel` (arm64: 11.0.20.0.8-3.0.1) |
| Oracle Linux 7 | `java-1.8.0-openjdk-devel` (amd64: 1.8.0.282.b08-1) |
| Raspberry Pi OS 12 | `default-jdk-headless` (arm64, armhf: 2:1.17-74) |
| Raspberry Pi OS 11 | `default-jdk-headless` (arm64: 2:1.11-72; armhf: 2:1.11-72+b4) |
| Raspberry Pi OS 10 | `default-jdk` (armhf: 2:1.11-71+b2) |
| RHEL 9 | `java-11-openjdk-devel` (amd64: 11.0.19.0.7-4; arm64: 11.0.20.0.8-3) |
| RHEL 8 | `java-1.8.0-openjdk-devel` (amd64: 1.8.0.372.b07-4; arm64: 1.8.0.382.b05-2) |
| RHEL 7 | `java-1.8.0-openjdk-devel` (amd64: 1.8.0.282.b08-1) |
| SLES 15 | `java-17-openjdk-devel` (amd64: 17.0.5.0-150400.3.9.3; arm64: 17.0.8.0-150400.3.27.1) |
| SLES 12 | `java-1_8_0-openjdk-devel` (amd64: 1.8.0.252-27.45.6) |
| Ubuntu 24.04 | `default-jdk-headless` (amd64, arm64: 2:1.21-75+exp1) |
| Ubuntu 22.04 | `default-jdk-headless` (amd64, arm64: 2:1.11-72build2) |
| Ubuntu 20.04 | `default-jdk-headless` (amd64, arm64: 2:1.11-72) |
| Ubuntu 18.04 | `default-jdk` (amd64: 2:1.11-68ubuntu1~18.04.1; i386: 2:1.10-63ubuntu1~02) |
### Java gateway installation
It is required to install [Java gateway](/manual/concepts/java) only if
you want to monitor JMX applications. Java gateway is lightweight and
does not require a database.
Once the required repository is added, you can install Zabbix Java
gateway by running:
apt install zabbix-java-gateway
Proceed to [setup](/manual/concepts/java/from_debian_ubuntu) for more
details on configuring and running Java gateway.
### Java网关安装
仅当需要监控JMX应用程序时才需要安装[Java gateway](/manual/concepts/java)。Java网关是轻量级的且不需要数据库。
添加所需仓库后，可通过以下命令安装Zabbix Java网关：
apt install zabbix-java-gateway
前往[setup](/manual/concepts/java/from_debian_ubuntu)获取更多关于配置和运行Java网关的详细信息。
### Java gateway installation
It is required to install [Java gateway](/manual/concepts/java) only if
you want to monitor JMX applications. Java gateway is lightweight and
does not require a database.
Once the required repository is added, you can install Zabbix Java
gateway by running:
# dnf install zabbix-java-gateway
Proceed to [setup](/manual/concepts/java/from_rhel_centos) for more
details on configuring and running Java gateway.
### 安装Java gateway
仅当你想监控 JMX 应用程序时，才需要安装 [Java gateway](/manual/concepts/java)。 Java gateway 是轻量级的不需要数据库。
一旦添加了所需软件源，就可通过执行如下命令安装 Zabbix Java gateway：
# dnf install zabbix-java-gateway
了解更多关于配置和运行Java gateway的详细信息可跳转至[ java 设置](/manual/concepts/java/from_rhel_centos)。
### Java gateway installation
It is required to install [Java gateway](/manual/concepts/java) only if
you want to monitor JMX applications. Java gateway is lightweight and
does not require a database.
Once the required repository is added, you can install Zabbix Java
gateway by running:
dnf install zabbix-java-gateway
Proceed to [setup](/manual/concepts/java/from_rhel) for more
details on configuring and running Java gateway.
### Java网关安装
仅当需要监控JMX应用程序时才需要安装[Java gateway](/manual/concepts/java)。Java网关是轻量级的且不需要数据库。
添加所需仓库后，可通过以下命令安装Zabbix Java网关：
dnf install zabbix-java-gateway
前往[setup](/manual/concepts/java/from_rhel)获取有关配置和运行Java网关的更多详细信息。
#### JavaScript methods
HTTP methods PATCH, HEAD, OPTIONS, TRACE, CONNECT have been added to the JavaScript engine. Also, the engine now allows
sending custom HTTP method requests with the new JS method HttpRequest.customRequest.
See also: [Additional JavaScript objects](/manual/config/items/preprocessing/javascript/javascript_objects).
#### JavaScript 方法
JavaScript引擎已新增支持PATCH、HEAD、OPTIONS、TRACE、CONNECT等HTTP方法。同时，该引擎现在允许通过新的JS方法HttpRequest.customRequest发送自定义HTTP方法请求。
另请参阅：[Additional JavaScript objects](/manual/config/items/preprocessing/javascript/javascript_objects)。
#### JavaScript preprocessing
JavaScript preprocessing is done by invoking JavaScript function with a
single parameter 'value' and user provided function body. The
preprocessing step result is the value returned from this function, for
example, to perform Fahrenheit to Celsius conversion user must enter:
return (value - 32) * 5 / 9
in JavaScript preprocessing parameters, which will be wrapped into a
JavaScript function by server:
``` {.java}
function (value)
{
return (value - 32) * 5 / 9
}
```
The input parameter 'value' is always passed as a string. The return
value is automatically coerced to string via ToString() method (if it
fails then the error is returned as string value), with a few
exceptions:
- returning undefined value will result in an error
- returning null value will cause the input value to be discarded,
much like 'Discard value' preprocessing on 'Custom on fail' action.
Errors can be returned by throwing values/objects (normally either
strings or Error objects).
For example:
``` {.java}
if (value == 0)
throw "Zero input value"
return 1/value
```
Each script has a 10 second execution timeout (depending on the script
it might take longer for the timeout to trigger); exceeding it will
return error. A 512-megabyte heap limit is enforced (64 megabytes before Zabbix 6.0.19).
The JavaScript preprocessing step bytecode is cached and reused when the
step is applied next time. Any changes to the item's preprocessing steps
will cause the cached script to be reset and recompiled later.
Consecutive runtime failures (3 in a row) will cause the engine to be
reinitialized to mitigate the possibility of one script breaking the
execution environment for the next scripts (this action is logged with
DebugLevel 4 and higher).
JavaScript preprocessing is implemented with Duktape
(<https://duktape.org/>) JavaScript engine.
See also: [Additional JavaScript objects and global
functions](/manual/config/items/preprocessing/javascript/javascript_objects)
#### JavaScript 预处理
JavaScript预处理通过调用带有单个参数'value'的JavaScript函数及用户提供的函数体来实现。预处理步骤的结果是该函数的返回值，例如要实现华氏度转摄氏度的转换，用户需输入：
return (value - 32) * 5 / 9
在JavaScript预处理参数中，这些内容将被服务器封装成JavaScript函数：
```{.java}
function (value)
{
return (value - 32) * 5 / 9
}
```
输入参数'value'始终以string形式传递。返回值会通过ToString()方法自动强制转换为string（若转换失败则返回错误作为string值），但存在以下例外情况：
- 返回undefined值将导致错误
- 返回null值将导致输入值被丢弃
much like 'Discard value' preprocessing on 'Custom on fail' action.
可通过抛出值/objects来返回错误（通常为字符串或Error objects）。
例如：
```{.java}
if (value == 0)
throw "Zero input value"
return 1/value
```
每个脚本有10秒执行超时限制（根据脚本不同可能需更长时间才会触发超时）；超时将返回错误。强制执行512MB堆内存限制（Zabbix 6.0.19之前为64MB）。
JavaScript预处理步骤的字节码会被缓存，并在下次应用该步骤时复用。对监控项预处理步骤的任何修改将导致缓存脚本被重置并重新编译。
连续运行时错误（连续3次）将导致引擎重新初始化，以降低某个脚本破坏后续脚本执行环境的可能性（该操作会记录在DebugLevel 4及以上日志中）。
JavaScript预处理功能通过Duktape JavaScript引擎（<https://duktape.org/>）实现。
另请参阅：[Additional JavaScript objects and global
functions](/manual/config/items/preprocessing/javascript/javascript_objects)
### JavaScript preprocessing
The heap limit for scripts has been upped from 64 to 512 megabytes.
### JavaScript预处理
脚本的堆内存限制已从64兆字节提升至512兆字节。
#### Jira webhook (custom)
This script will create a JIRA issue and return some info on the created
issue.
``` {.java}
try {
Zabbix.log(4, '[ Jira webhook ] Started with params: ' + value);
var result = {
'tags': {
'endpoint': 'jira'
}
},
params = JSON.parse(value),
req = new HttpRequest(),
fields = {},
resp;
if (params.HTTPProxy) {
req.setProxy(params.HTTPProxy);
}
req.addHeader('Content-Type: application/json');
req.addHeader('Authorization: Basic ' + params.authentication);
fields.summary = params.summary;
fields.description = params.description;
fields.project = {key: params.project_key};
fields.issuetype = {id: params.issue_id};
resp = req.post('https://jira.example.com/rest/api/2/issue/',
JSON.stringify({"fields": fields})
);
if (req.getStatus() != 201) {
throw 'Response code: ' + req.getStatus();
}
resp = JSON.parse(resp);
result.tags.issue_id = resp.id;
result.tags.issue_key = resp.key;
return JSON.stringify(result);
}
catch (error) {
Zabbix.log(4, '[ Jira webhook ] Issue creation failed json : ' + JSON.stringify({"fields": fields}));
Zabbix.log(3, '[ Jira webhook ] issue creation failed : ' + error);
throw 'Failed with error: ' + error;
}
```
#### Jira webhook(自定义)
该脚本将create一个JIRA问题并返回所创建问题的相关信息.
```{.java}
try {
Zabbix.log(4, '[ Jira webhook ] Started with params: ' + value);
var result = {
'tags': {
'endpoint': 'jira'
}
},
params = JSON.parse(value),
req = new HttpRequest(),
fields = {},
resp;
if (params.HTTPProxy) {
req.setProxy(params.HTTPProxy);
}
req.addHeader('Content-Type: application/json');
req.addHeader('Authorization: Basic ' + params.authentication);
fields.summary = params.summary;
fields.description = params.description;
fields.project = {key: params.project_key};
fields.issuetype = {id: params.issue_id};
resp = req.post('https://jira.example.com/rest/api/2/issue/',
JSON.stringify({"fields": fields})
);
if (req.getStatus() != 201) {
throw 'Response code: ' + req.getStatus();
}
resp = JSON.parse(resp);
result.tags.issue_id = resp.id;
result.tags.issue_key = resp.key;
return JSON.stringify(result);
}
catch (error) {
Zabbix.log(4, '[ Jira webhook ] Issue creation failed json : ' + JSON.stringify({"fields": fields}));
Zabbix.log(3, '[ Jira webhook ] issue creation failed : ' + error);
throw 'Failed with error: ' + error;
}
```
#### JMX item keys in more detail
#### JMX监控项键详解
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX监控
详情请参阅[JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring)页面
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX监控
详情请参阅[JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring)页面
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX监控
详情请参阅[JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring)页面
#### JMX monitoring
See [JMX monitoring](/manual/config/items/itemtypes/jmx_monitoring) page
for more details.
#### JMX 监控
详见 [JMX 监控](/manual/config/items/itemtypes/jmx_monitoring) 页面以获取更多信息。
### JMX monitoring
The template *Generic Java JMX* now contains discovery rules for low-level discovery of memory pools and garbage collectors.
### JMX 监控
模板 *Generic Java JMX* 现在包含用于memory池和垃圾收集器低级发现的发现规则.
#### JSON format
The JSON export format contains the following objects:
- Root object for Zabbix JSON export
- Export version
- Date when export was created in ISO 8601 long format
```json
{
"zabbix_export": {
"version": "6.0",
"date": "2020-04-22T06:20:11Z"
}
}
```
Other objects are dependent on exported objects.
#### JSON格式
JSON export 格式包含以下 objects:
- Zabbix JSON export 的根 object
- 导出 version
- export 创建日期（ISO 8601 长格式）
```json
{
"zabbix_export": {
"version": "6.0",
"date": "2020-04-22T06:20:11Z"
}
}
```
其他 objects 取决于导出的 objects。
### JSONPath parsing errors
JSONPath parsing errors occur in this version in case of leading whitespace and empty array/object. Fixed in Zabbix 6.0.12.
### JSONPath 解析错误
当存在前导空格或空array/object时，该version会出现JSONPath解析错误。该问题已在Zabbix 6.0.12中修复。
#### Keeping history
You can set for how many days history will be kept:
- in the item properties [form](/manual/config/items/item)
- when mass-updating items
- when [setting
up](/manual/web_interface/frontend_sections/administration/general#housekeeper)
housekeeper tasks
Any older data will be removed by the housekeeper.
The general strong advice is to keep history for the smallest possible
number of days and that way not to overload the database with lots of
historical values.
Instead of keeping a long history, you can keep longer data of trends.
For example, you could keep history for 14 days and trends for 5 years.
You can get a good idea of how much space is required by history versus
trends data by referring to the [database sizing
page](/manual/installation/requirements#database_size).
While keeping shorter history, you will still be able to review older
data in graphs, as graphs will use trend values for displaying older
data.
::: noteimportant
If history is set to '0', the item will update
only dependent items and inventory. No trigger functions will be
evaluated because trigger evaluation is based on history data
only.
:::
::: notetip
As an alternative way to preserve
history consider to use [history
export](/manual/config/items/loadablemodules#providing_history_export_callbacks)
functionality of loadable modules.
:::
#### 保留历史数据
您可以设置历史数据保留的天数：
- 在监控项属性中[form](/manual/config/items/item)
- 批量更新监控项时
- 当[setting
up](/manual/web_interface/frontend_sections/administration/general#housekeeper)
housekeeper tasks
Any older data will be removed by the housekeeper.
The general strong advice is to keep history for the smallest possible
number of days and that way not to overload the database with lots of
historical values.
Instead of keeping a long history, you can keep longer data of trends.
For example, you could keep history for 14 days and trends for 5 years.
You can get a good idea of how much space is required by history versus
trends data by referring to the [database sizing
page](/manual/installation/requirements#database_size)时
即使保留较短的历史数据，您仍能在图表中查看较旧的数据，因为图表会使用趋势值来显示历史数据。
::: noteimportant
如果将历史数据设置为'0'，监控项将update
仅依赖监控项和资产清单。不会评估任何触发器函数，因为触发器评估仅基于历史数据。
:::
::: notetip
作为保留历史数据的替代方案，可考虑使用[history
export](/manual/config/items/loadablemodules#providing_history_export_callbacks)
可加载模块的功能。
:::
#### Keeping trends
Trends is a built-in historical data reduction mechanism which stores
minimum, maximum, average and the total number of values per every hour
for numeric data types.
You can set for how many days trends will be kept:
- in the item properties [form](/manual/config/items/item)
- when mass-updating items
- when setting up Housekeeper tasks
Trends usually can be kept for much longer than history. Any older data
will be removed by the housekeeper.
Zabbix server accumulates trend data in runtime in the trend cache, as
the data flows in. Server flushes **previous hour** trends of every item
into the database (where frontend can find them) in these situations:
- server receives the first current hour value of the item
- 5 or less minutes of the current hour left and still no current hour
values of the item
- server stops
To see trends on a graph you need to wait at least to the beginning of
the next hour (if item is updated frequently) and at most to the end of
the next hour (if item is updated rarely), which is 2 hours maximum.
When server flushes trend cache and there are already trends in the
database for this hour (for example, server has been restarted
mid-hour), server needs to use update statements instead of simple
inserts. Therefore on a bigger installation if restart is needed it is
desirable to stop server in the end of one hour and start in the
beginning of the next hour to avoid trend data overlap.
History tables do not participate in trend generation in any way.
::: noteimportant
If trends are set to '0', Zabbix server does not
calculate or store trends at all.
:::
::: noteclassic
The trends are calculated and stored with the same data type
as the original values. As a result the average value calculations of
unsigned data type values are rounded and the less the value interval is
the less precise the result will be. For example if item has values 0
and 1, the average value will be 0, not 0.5.
Also restarting server might result in the precision loss of unsigned
data type average value calculations for the current hour.
:::
#### 保留趋势数据
趋势功能是内置的历史数据精简机制，它会为数值型数据存储每小时的最小值、最大值、平均值以及数值总数。
您可以通过以下方式设置趋势数据的保留天数：
- 在监控项属性中[form](/manual/config/items/item)
- 批量更新监控项时
- 设置Housekeeper任务时
趋势数据通常可以比历史数据保留更长时间。所有过期数据将由housekeeper清理。
Zabbix server在运行时将趋势数据累积到trend cache中。服务器在以下情况下会将每个监控项的**前一小时**趋势数据写入数据库（供前端查询）：
- 服务器收到监控项的当前小时第一个数值时
- 当前小时剩余5分钟或更少时间且仍未收到监控项的当前小时数值时
- 服务器停止运行时
要在图表中查看趋势数据，您至少需要等待到下一小时开始（若监控项更新频繁），最多等待到下一小时结束（若监控项更新不频繁），最长不超过2小时。
当服务器刷新trend cache且数据库中已存在该小时段的趋势数据时（例如服务器在小时中段重启），服务器需要使用update语句而非简单插入。因此在大型部署中如需重启，建议在一小时结束时停止服务器，并在下一小时开始时启动，以避免趋势数据重叠。
历史数据表不参与趋势数据的生成过程。
::: noteimportant
若趋势保留天数设为'0'，Zabbix server将不会计算或存储任何趋势数据。
:::
::: noteclassic
趋势数据使用与原值相同的数据类型进行计算和存储。因此无符号数据类型的平均值计算会进行取整处理，且数值区间越小结果精度越低。例如当监控项的值为0和1时，平均值将为0而非0.5。
此外，重启服务器可能导致当前小时无符号数据类型平均值计算的精度损失。
:::
##### Kernel data
|Item key|<|<|<|
|--|--|------|------|
|Description|Return value|Parameters|Comments|
|**kernel.maxfiles**|<|<|<|
|Maximum number of opened files supported by OS.|Integer| | |
|**kernel.maxproc**|<|<|<|
|Maximum number of processes supported by OS.|Integer| | |
|**kernel.openfiles**|<|<|<|
|Return the number of currently open file descriptors.|Integer| |This item is supported since Zabbix 6.0.|
##### 内核数据
| 监控项 键 | < | < | < |
|--|--|------|------|
| Description | 返回值 | 参数 | 注释 |
| **kernel.maxfiles** | < | < | < |
| Maximum number of opened files supported by OS. | integer | | |
| **kernel.maxproc** | < | < | < |
| Maximum number of processes supported by OS. | integer | | |
| **kernel.openfiles** | < | < | < |
| Return the number of currently open file descriptors. | integer | | 该 监控项 自 Zabbix 6.0 起支持。 |
### Keyboard navigation
Keyboard control has been implemented for info icons in the frontend. Thus it is now
possible to focus on info icons, and open the hints, using the keyboard.
### 键盘导航
前端中的信息图标已实现键盘控制功能。现在可以通过键盘聚焦信息图标并打开提示信息。
|Key|<|<|<|<|
|---|-|-|-|-|
|<|**Description**|**Return value**|**Parameters**|**Comments**|
|agent.hostmetadata|<|<|<|<|
|<|Agent host metadata.|String||Returns the value of HostMetadata or HostMetadataItem parameters, or empty string if none are defined.<br><br>Supported since Zabbix 6.0.|
|agent.hostname|<|<|<|<|
|<|Agent host name.|String| |Returns:<br>As passive check - the name of the first host listed in the Hostname parameter of the agent configuration file;<br>As active check - the name of the current hostname.|
|agent.ping|<|<|<|<|
|<|Agent availability check.|Nothing - unavailable<br><br>1 - available| |Use the **nodata()** trigger function to check for host unavailability.|
|agent.variant|<|<|<|<|
|<|Variant of Zabbix agent (Zabbix agent or Zabbix agent 2).|Integer| |Example of returned value:<br>1 - Zabbix agent<br>2 - Zabbix agent 2|
|agent.version|<|<|<|<|
|<|Version of Zabbix agent.|String| |Example of returned value:<br>6.0.3|
|kernel.maxfiles|<|<|<|<|
|<|Maximum number of opened files supported by OS.|Integer| | |
|kernel.maxproc|<|<|<|<|
|<|Maximum number of processes supported by OS.|Integer| | |
|kernel.openfiles|<|<|<|<|
|<|Return the number of currently open file descriptors.|Integer||This item is supported on Linux only since Zabbix 6.0.|
|log\[file,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|Monitoring of a log file.|Log|**file** - full path and name of log file<br>**regexp** - regular [expression](/manual/regular_expressions#overview) describing the required pattern<br>**encoding** - code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxlines** - maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of 'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd)<br>**mode** (since version 2.0)- possible values:<br>*all* (default), *skip* - skip processing of older data (affects only newly created items).<br>**output** (since version 2.2) - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups).<br>**maxdelay** (since version 3.2) - maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using_maxdelay_parameter) notes before using it!<br>**options** (since version 4.4.7) - additional options:<br>*mtime-noreread* - non-unique records, reread only if the file size changes (ignore modification time change). (This parameter is deprecated since 5.0.2, because now mtime is ignored.)<br>**persistent\_dir** (since versions 5.0.18, 5.4.9, only in zabbix\_agentd on Unix systems; not supported in Agent2) - absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items).|The item must be configured as an [active check](/manual/appendix/items/activepassive#active_checks).<br>If file is missing or permissions do not allow access, item turns unsupported.<br><br>If `output` is left empty - the whole line containing the matched text is returned. Note that all global regular expression types except 'Result is TRUE' always return the whole matched line and the `output` parameter is ignored.<br><br>Content extraction using the `output` parameter takes place on the agent.<br><br>Examples:<br>=> log\[/var/log/syslog\]<br>=> log\[/var/log/syslog,error\]<br>=> log\[/home/zabbix/logs/logfile,,,100\]<br><br>*Using `output` parameter for extracting a number from log record:*<br>=> log\[/app1/app.log,"task run \[0-9.\]+ sec, processed (\[0-9\]+) records, \[0-9\]+ errors",,,,\\1\] → will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send only '6080' to server. Because a numeric value is being sent, the "Type of information" for this item can be set to "Numeric (unsigned)" and the value can be used in graphs, triggers etc.<br><br>*Using `output` parameter for rewriting log record before sending to server:*<br>=> log\[/app1/app.log,"(\[0-9 :-\]+) task run (\[0-9.\]+) sec, processed (\[0-9\]+) records, (\[0-9\]+) errors",,,,"\\1 RECORDS: \\3, ERRORS: \\4, DURATION: \\2"\] → will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send a modified record "2015-11-13 10:08:26 RECORDS: 6080, ERRORS: 0, DURATION: 6.08" to server.<br><br>See also additional information on [log monitoring](log_items).|
|log.count\[file,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|Count of matched lines in a monitored log file.|Integer|**file** - full path and name of log file<br>**regexp** - regular [expression](/manual/regular_expressions#overview) describing the required pattern<br>**encoding** - code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxproclines** - maximum number of new lines per second the agent will analyze (cannot exceed 10000). Default value is 10\*'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd).<br>**mode** - possible values:<br>*all* (default), *skip* - skip processing of older data (affects only newly created items).<br>**maxdelay** - maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using_maxdelay_parameter) notes before using it!<br>**options** (since version 4.4.7) - additional options:<br>*mtime-noreread* - non-unique records, reread only if the file size changes (ignore modification time change). (This parameter is deprecated since 5.0.2, because now mtime is ignored.)<br>**persistent\_dir** (since versions 5.0.18, 5.4.9, only in zabbix\_agentd on Unix systems; not supported in Agent2) - absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items).|The item must be configured as an [active check](/manual/appendix/items/activepassive#active_checks).<br>If file is missing or permissions do not allow access, item turns unsupported.<br><br>See also additional information on [log monitoring](log_items).<br><br>This item is not supported for Windows Event Log.<br><br>Supported since Zabbix 3.2.0.|
|logrt\[file\_regexp,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|Monitoring of a log file that is rotated.|Log|**file\_regexp** - absolute path to file and the file name described by a regular [expression](/manual/regular_expressions#overview). *Note* that only the file name is a regular expression<br>**regexp** - regular [expression](/manual/regular_expressions#overview) describing the required content pattern<br>**encoding** - code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxlines** - maximum number of new lines per second the agent will send to Zabbix server or proxy. This parameter overrides the value of 'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd)<br>**mode** (since version 2.0) - possible values:<br>*all* (default), *skip* - skip processing of older data (affects only newly created items).<br>**output** (since version 2.2) - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups).<br>**maxdelay** (since version 3.2) - maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using_maxdelay_parameter) notes before using it!<br>**options** (since version 4.0; *mtime-reread*, *mtime-noreread* options since 4.4.7) - type of log file rotation and other options. Possible values:<br>*rotate* (default),<br>*copytruncate* - note that *copytruncate* cannot be used together with *maxdelay*. In this case *maxdelay* must be 0 or not specified; see [copytruncate](log_items#notes_on_handling_copytruncate_log_file_rotation) notes,<br>*mtime-reread* - non-unique records, reread if modification time or size changes (default),<br>*mtime-noreread* - non-unique records, reread only if the size changes (ignore modification time change).<br>**persistent\_dir** (since versions 5.0.18, 5.4.9, only in zabbix\_agentd on Unix systems; not supported in Agent2) - absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items).|The item must be configured as an [active check](/manual/appendix/items/activepassive#active_checks).<br>Log rotation is based on the last modification time of files.<br><br>Note that logrt is designed to work with one currently active log file, with several other matching inactive files rotated. If, for example, a directory has many active log files, a separate logrt item should be created for each one. Otherwise if one logrt item picks up too many files it may lead to exhausted memory and a crash of monitoring.<br><br>If `output` is left empty - the whole line containing the matched text is returned. Note that all global regular expression types except 'Result is TRUE' always return the whole matched line and the `output` parameter is ignored.<br><br>Content extraction using the `output` parameter takes place on the agent.<br><br>Examples:<br>=> logrt\["/home/zabbix/logs/\^logfile\[0-9\]{1,3}$",,,100\] → will match a file like "logfile1" (will not match ".logfile1")<br>=> logrt\["/home/user/\^logfile\_.\*\_\[0-9\]{1,3}$","pattern\_to\_match","UTF-8",100\] → will collect data from files such "logfile\_abc\_1" or "logfile\_\_001".<br><br>*Using `output` parameter for extracting a number from log record:*<br>=> logrt\[/app1/\^test.\*log$,"task run \[0-9.\]+ sec, processed (\[0-9\]+) records, \[0-9\]+ errors",,,,\\1\] → will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send only '6080' to server. Because a numeric value is being sent, the "Type of information" for this item can be set to "Numeric (unsigned)" and the value can be used in graphs, triggers etc.<br><br>*Using `output` parameter for rewriting log record before sending to server:*<br>=> logrt\[/app1/\^test.\*log$,"(\[0-9 :-\]+) task run (\[0-9.\]+) sec, processed (\[0-9\]+) records, (\[0-9\]+) errors",,,,"\\1 RECORDS: \\3, ERRORS: \\4, DURATION: \\2"\] → will match a log record "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" and send a modified record "2015-11-13 10:08:26 RECORDS: 6080, ERRORS: 0, DURATION: 6.08" to server.<br><br>See also additional information on [log monitoring](log_items).|
|logrt.count\[file\_regexp,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|Count of matched lines in a monitored log file that is rotated.|Integer|**file\_regexp** - absolute path to file and regular [expression](/manual/regular_expressions#overview) describing the file name pattern<br>**regexp** - regular [expression](/manual/regular_expressions#overview) describing the required content pattern<br>**encoding** - code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxproclines** - maximum number of new lines per second the agent will analyze (cannot exceed 10000). Default value is 10\*'MaxLinesPerSecond' in [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd).<br>**mode** - possible values:<br>*all* (default), *skip* - skip processing of older data (affects only newly created items).<br>**maxdelay** - maximum delay in seconds. Type: float. Values: 0 - (default) never ignore log file lines; > 0.0 - ignore older lines in order to get the most recent lines analyzed within "maxdelay" seconds. Read the [maxdelay](log_items#using_maxdelay_parameter) notes before using it!<br>**options** (since version 4.0; *mtime-reread*, *mtime-noreread* options since 4.4.7) - type of log file rotation and other options. Possible values:<br>*rotate* (default),<br>*copytruncate* - note that *copytruncate* cannot be used together with *maxdelay*. In this case *maxdelay* must be 0 or not specified; see [copytruncate](log_items#notes_on_handling_copytruncate_log_file_rotation) notes,<br>*mtime-reread* - non-unique records, reread if modification time or size changes (default),<br>*mtime-noreread* - non-unique records, reread only if the size changes (ignore modification time change).<br>**persistent\_dir** (since versions 5.0.18, 5.4.9, only in zabbix\_agentd on Unix systems; not supported in Agent2) - absolute pathname of directory where to store persistent files. See also additional notes on [persistent files](log_items#notes-on-persistent-files-for-log-items).|The item must be configured as an [active check](/manual/appendix/items/activepassive#active_checks).<br>Log rotation is based on the last modification time of files.<br><br>See also additional information on [log monitoring](log_items).<br><br>This item is not supported for Windows Event Log.<br><br>Supported since Zabbix 3.2.0.|
|modbus.get\[endpoint,<slave id>,<function>,<address>,<count>,<type>,<endianness>,<offset>\]|<|<|<|<|
|<|Reads Modbus data.|JSON object|**endpoint** - endpoint defined as `protocol://connection_string`<br>**slave id** - slave ID<br>**function** - Modbus function<br>**address** - address of first registry, coil or input<br>**count** - number of records to read<br>**type** - type of data<br>**endianness** - endianness configuration<br>**offset** - number of registers, starting from 'address', the results of which will be discarded.<br><br>See a [detailed description](/manual/appendix/items/modbus) of parameters.|Supported since Zabbix 5.2.0.|
|net.dns\[<ip>,name,<type>,<timeout>,<count>,<protocol>\]|<|<|<|<|
|<|Checks if DNS service is up.|0 - DNS is down (server did not respond or DNS resolution failed)<br><br>1 - DNS is up|**ip** - IP address of DNS server (leave empty for the default DNS server, ignored on Windows)<br>**name** - DNS name to query<br>**type** - record type to be queried (default is *SOA*)<br>**timeout** (ignored on Windows) - timeout for the request in seconds (default is 1 second)<br>**count** (ignored on Windows) - number of tries for the request (default is 2)<br>**protocol** (since version 3.0) - the protocol used to perform DNS queries: *udp* (default) or *tcp*|Example:<br>=> net.dns\[8.8.8.8,example.com,MX,2,1\]<br><br>The possible values for `type` are:<br>*ANY*, *A*, *NS*, *CNAME*, *MB*, *MG*, *MR*, *PTR*, *MD*, *MF*, *MX*, *SOA*, *NULL*, *WKS* (except for Windows), *HINFO*, *MINFO*, *TXT*, *SRV*<br><br>Internationalized domain names are not supported, please use IDNA encoded names instead.<br><br>SRV record type is supported since Zabbix 1.8.6 (Unix) and 2.0.0 (Windows).<br><br>Naming before Zabbix 2.0 (still supported): *net.tcp.dns*|
|net.dns.record\[<ip>,name,<type>,<timeout>,<count>,<protocol>\]|<|<|<|<|
|<|Performs a DNS query.|Character string with the required type of information|**ip** - IP address of DNS server (leave empty for the default DNS server, ignored on Windows)<br>**name** - DNS name to query<br>**type** - record type to be queried (default is *SOA*)<br>**timeout** (ignored on Windows) - timeout for the request in seconds (default is 1 second)<br>**count** (ignored on Windows) - number of tries for the request (default is 2)<br>**protocol**(since version 3.0) - the protocol used to perform DNS queries: *udp* (default) or *tcp*|Example:<br>=> net.dns.record\[8.8.8.8,example.com,MX,2,1\]<br><br>The possible values for `type` are:<br>*ANY*, *A*, *NS*, *CNAME*, *MB*, *MG*, *MR*, *PTR*, *MD*, *MF*, *MX*, *SOA*, *NULL*, *WKS* (except for Windows), *HINFO*, *MINFO*, *TXT*, *SRV*<br><br>Internationalized domain names are not supported, please use IDNA encoded names instead.<br><br>SRV record type is supported since Zabbix 1.8.6 (Unix) and 2.0.0 (Windows).<br><br>Naming before Zabbix 2.0 (still supported): *net.tcp.dns.query*|
|net.if.collisions\[if\]|<|<|<|<|
|<|Number of out-of-window collisions.|Integer|**if** - network interface name| |
|net.if.discovery|<|<|<|<|
|<|List of network interfaces. Used for low-level discovery.|JSON object| |Supported since Zabbix 2.0.<br><br>On FreeBSD, OpenBSD and NetBSD supported since Zabbix 2.2.<br><br>Some Windows versions (for example, Server 2008) might require the latest updates installed to support non-ASCII characters in interface names.|
|net.if.in\[if,<mode>\]|<|<|<|<|
|<|Incoming traffic statistics on network interface.|Integer|**if** - network interface name (Unix); network interface full description or IPv4 address; or, if in braces, network interface GUID (Windows)<br>**mode** - possible values:<br>*bytes* - number of bytes (default)<br>*packets* - number of packets<br>*errors* - number of errors<br>*dropped* - number of dropped packets<br>*overruns (fifo)* - the number of FIFO buffer errors<br>*frame* - the number of packet framing errors<br>*compressed* - the number of compressed packets transmitted or received by the device driver<br>*multicast* - the number of multicast frames received by the device driver|On Windows, the item gets values from 64-bit counters if available. 64-bit interface statistic counters were introduced in Windows Vista and Windows Server 2008. If 64-bit counters are not available, the agent uses 32-bit counters.<br><br>Multi-byte interface names on Windows are supported since Zabbix 1.8.6.<br><br>Examples:<br>=> net.if.in\[eth0,errors\]<br>=> net.if.in\[eth0\]<br><br>You may obtain network interface descriptions on Windows with net.if.discovery or net.if.list items.<br><br>You may use this key with the *Change per second* preprocessing step in order to get bytes per second statistics.|
|net.if.out\[if,<mode>\]|<|<|<|<|
|<|Outgoing traffic statistics on network interface.|Integer|**if** - network interface name (Unix); network interface full description or IPv4 address; or, if in braces, network interface GUID (Windows)<br>**mode** - possible values:<br>*bytes* - number of bytes (default)<br>*packets* - number of packets<br>*errors* - number of errors<br>*dropped* - number of dropped packets<br>*overruns (fifo)* - the number of FIFO buffer errors<br>*collisions (colls)* - the number of collisions detected on the interface<br>*carrier* - the number of carrier losses detected by the device driver<br>*compressed* - the number of compressed packets transmitted by the device driver|On Windows, the item gets values from 64-bit counters if available. 64-bit interface statistic counters were introduced in Windows Vista and Windows Server 2008. If 64-bit counters are not available, the agent uses 32-bit counters.<br><br>Multi-byte interface names on Windows are supported since Zabbix agent 1.8.6 version.<br><br>Examples:<br>=> net.if.out\[eth0,errors\]<br>=> net.if.out\[eth0\]<br><br>You may obtain network interface descriptions on Windows with net.if.discovery or net.if.list items.<br><br>You may use this key with the *Change per second* preprocessing step in order to get bytes per second statistics.|
|net.if.total\[if,<mode>\]|<|<|<|<|
|<|Sum of incoming and outgoing traffic statistics on network interface.|Integer|**if** - network interface name (Unix); network interface full description or IPv4 address; or, if in braces, network interface GUID (Windows)<br>**mode** - possible values:<br>*bytes* - number of bytes (default)<br>*packets* - number of packets<br>*errors* - number of errors<br>*dropped* - number of dropped packets<br>*overruns (fifo)* - the number of FIFO buffer errors<br>*compressed* - the number of compressed packets transmitted or received by the device driver|On Windows, the item gets values from 64-bit counters if available. 64-bit interface statistic counters were introduced in Windows Vista and Windows Server 2008. If 64-bit counters are not available, the agent uses 32-bit counters.<br><br>Examples:<br>=> net.if.total\[eth0,errors\]<br>=> net.if.total\[eth0\]<br><br>You may obtain network interface descriptions on Windows with net.if.discovery or net.if.list items.<br><br>You may use this key with the *Change per second* preprocessing step in order to get bytes per second statistics.<br><br>Note that dropped packets are supported only if both net.if.in and net.if.out work for dropped packets on your platform.|
|net.tcp.listen\[port\]|<|<|<|<|
|<|Checks if this TCP port is in LISTEN state.|0 - it is not in LISTEN state<br><br>1 - it is in LISTEN state|**port** - TCP port number|Example:<br>=> net.tcp.listen\[80\]<br><br>On Linux supported since Zabbix 1.8.4<br><br>Since Zabbix 3.0.0, on Linux kernels 2.6.14 and above, information about listening TCP sockets is obtained from the kernel's NETLINK interface, if possible. Otherwise, the information is retrieved from /proc/net/tcp and /proc/net/tcp6 files.|
|net.tcp.port\[<ip>,port\]|<|<|<|<|
|<|Checks if it is possible to make TCP connection to specified port.|0 - cannot connect<br><br>1 - can connect|**ip** - IP or DNS name (default is 127.0.0.1)<br>**port** - port number|Example:<br>=> net.tcp.port\[,80\] → can be used to test availability of web server running on port 80.<br><br>For simple TCP performance testing use net.tcp.service.perf\[tcp,<ip>,<port>\]<br><br>Note that these checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually).|
|net.tcp.service\[service,<ip>,<port>\]|<|<|<|<|
|<|Checks if service is running and accepting TCP connections.|0 - service is down<br><br>1 - service is running|**service** - either of:<br>*ssh*, *ldap*, *smtp*, *ftp*, *http*, *pop*, *nntp*, *imap*, *tcp*, *https*, *telnet* (see [details](/manual/appendix/items/service_check_details))<br>**ip** - IP address (default is 127.0.0.1)<br>**port** - port number (by default standard service port number is used)|Example:<br>=> net.tcp.service\[ftp,,45\] → can be used to test the availability of FTP server on TCP port 45.<br><br>Note that these checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually).<br><br>Checking of encrypted protocols (like IMAP on port 993 or POP on port 995) is currently not supported. As a workaround, please use net.tcp.port for checks like these.<br><br>Checking of LDAP and HTTPS on Windows is only supported by Zabbix agent 2.<br><br>Note that the telnet check looks for a login prompt (':' at the end).<br><br>See also [known issues](/manual/installation/known_issues#https_checks) of checking HTTPS service.<br><br>*https* and *telnet* services are supported since Zabbix 2.0.|
|net.tcp.service.perf\[service,<ip>,<port>\]|<|<|<|<|
|<|Checks performance of TCP service.|0 - service is down<br><br>seconds - the number of seconds spent while connecting to the service|**service** - either of:<br>*ssh*, *ldap*, *smtp*, *ftp*, *http*, *pop*, *nntp*, *imap*, *tcp*, *https*, *telnet* (see [details](/manual/appendix/items/service_check_details))<br>**ip** - IP address (default is 127.0.0.1)<br>**port** - port number (by default standard service port number is used)|Example:<br>=> net.tcp.service.perf\[ssh\] → can be used to test the speed of initial response from SSH server.<br><br>Checking of encrypted protocols (like IMAP on port 993 or POP on port 995) is currently not supported. As a workaround, please use net.tcp.service.perf\[tcp,<ip>,<port>\] for checks like these.<br><br>Checking of LDAP and HTTPS on Windows is only supported by Zabbix agent 2.<br><br>Note that the telnet check looks for a login prompt (':' at the end).<br><br>See also [known issues](/manual/installation/known_issues#https_checks) of checking HTTPS service.<br><br>*https* and *telnet* services are supported since Zabbix 2.0.|
|net.tcp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]|<|<|<|<|
|<|Return the number of TCP sockets that match parameters.|Integer|**laddr** - local IPv4/6 address or CIDR subnet<br>**lport** - local port number or service name<br>**raddr** - remote IPv4/6 address or CIDR subnet<br>**rport** - remote port number or service name<br>**state** - connection state (*established*, *syn\_sent*, *syn\_recv*, *fin\_wait1*, *fin\_wait2*, *time\_wait*, *close*, *close\_wait*, *last\_ack*, *listen*, *closing*)|This item is supported on Linux only on both Zabbix agent/agent 2. On Zabbix agent 2 it is also supported on 64-bit Windows.<br><br>Example:<br>=> net.tcp.socket.count\[,80,,,established\] → check if local TCP port 80 is in "established" state<br><br>This item is supported since Zabbix 6.0.|
|net.udp.listen\[port\]|<|<|<|<|
|<|Checks if this UDP port is in LISTEN state.|0 - it is not in LISTEN state<br><br>1 - it is in LISTEN state|**port** - UDP port number|Example:<br>=> net.udp.listen\[68\]<br><br>On Linux supported since Zabbix 1.8.4|
|net.udp.service\[service,<ip>,<port>\]|<|<|<|<|
|<|Checks if service is running and responding to UDP requests.|0 - service is down<br><br>1 - service is running|**service** - *ntp* (see [details](/manual/appendix/items/service_check_details))<br>**ip** - IP address (default is 127.0.0.1)<br>**port** - port number (by default standard service port number is used)|Example:<br>=> net.udp.service\[ntp,,45\] → can be used to test the availability of NTP service on UDP port 45.<br><br>This item is supported since Zabbix 3.0.0, but *ntp* service was available for net.tcp.service\[\] item in prior versions.|
|net.udp.service.perf\[service,<ip>,<port>\]|<|<|<|<|
|<|Checks performance of UDP service.|0 - service is down<br><br>seconds - the number of seconds spent waiting for response from the service|**service** - *ntp* (see [details](/manual/appendix/items/service_check_details))<br>**ip** - IP address (default is 127.0.0.1)<br>**port** - port number (by default standard service port number is used)|Example:<br>=> net.udp.service.perf\[ntp\] → can be used to test response time from NTP service.<br><br>This item is supported since Zabbix 3.0.0, but *ntp* service was available for net.tcp.service\[\] item in prior versions.|
|net.udp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]|<|<|<|<|
|<|Return the number of TCP sockets that match parameters.|Integer|**laddr** - local IPv4/6 address or CIDR subnet<br>**lport** - local port number or service name<br>**raddr** - remote IPv4/6 address or CIDR subnet<br>**rport** - remote port number or service name<br>**state** - connection state (*established*, *unconn*)|This item is supported on Linux only on both Zabbix agent/agent 2. On Zabbix agent 2 it is also supported on 64-bit Windows.<br><br>Example:<br>=> net.udp.socket.count\[,,,,listening\] → check if any UDP socket is in "listening" state<br><br>This item is supported since Zabbix 6.0.|
|proc.cpu.util\[<name>,<user>,<type>,<cmdline>,<mode>,<zone>\]|<|<|<|<|
|<|Process CPU utilization percentage.|Float|**name** - process name (default is *all processes*)<br>**user** - user name (default is *all users*)<br>**type** - CPU utilization type:<br>*total* (default), *user*, *system*<br>**cmdline** - filter by command line (it is a regular [expression](/manual/regular_expressions#overview))<br>**mode** - data gathering mode: *avg1* (default), *avg5*, *avg15*<br>**zone** - target zone: *current* (default), *all*. This parameter is supported on Solaris only.|Examples:<br>=> proc.cpu.util\[,root\] → CPU utilization of all processes running under the "root" user<br>=> proc.cpu.util\[zabbix\_server,zabbix\] → CPU utilization of all zabbix\_server processes running under the zabbix user<br><br>The returned value is based on single CPU core utilization percentage. For example CPU utilization of a process fully using two cores is 200%.<br><br>The process CPU utilization data is gathered by a collector which supports the maximum of 1024 unique (by name, user and command line) queries. Queries not accessed during the last 24 hours are removed from the collector.<br><br>*Note* that when setting the `zone` parameter to *current* (or default) in case the agent has been compiled on a Solaris without zone support, but running on a newer Solaris where zones are supported, then the agent will return NOTSUPPORTED (the agent cannot limit results to only the current zone). However, *all* is supported in this case.<br><br>This key is supported since Zabbix 3.0.0 and is available on several platforms (see [Items supported by platform](/manual/appendix/items/supported_by_platform)).|
|proc.mem\[<name>,<user>,<mode>,<cmdline>,<memtype>\]|<|<|<|<|
|<|Memory used by process in bytes.|Integer - with `mode` as *max*, *min*, *sum*<br><br>Float - with `mode` as *avg*|**name** - process name (default is *all processes*)<br>**user** - user name (default is *all users*)<br>**mode** - possible values:<br>*avg*, *max*, *min*, *sum* (default)<br>**cmdline** - filter by command line (it is a regular [expression](/manual/regular_expressions#overview))<br>**memtype** - [type of memory](/manual/appendix/items/proc_mem_notes) used by process|Examples:<br>=> proc.mem\[,root\] → memory used by all processes running under the "root" user<br>=> proc.mem\[zabbix\_server,zabbix\] → memory used by all zabbix\_server processes running under the zabbix user<br>=> proc.mem\[,oracle,max,oracleZABBIX\] → memory used by the most memory-hungry process running under oracle having oracleZABBIX in its command line<br><br>*Note*: When several processes use shared memory, the sum of memory used by processes may result in large, unrealistic values.<br><br>See [notes](/manual/appendix/items/proc_mem_num_notes) on selecting processes with `name` and `cmdline` parameters (Linux-specific).<br><br>When this item is invoked from the command line and contains a command line parameter (e.g. using the agent test mode: `zabbix_agentd -t proc.mem[,,,apache2]`), one extra process will be counted, as the agent will count itself.<br><br>The `memtype` parameter is supported on several [platforms](/manual/appendix/items/supported_by_platform) since Zabbix 3.0.0.|
|proc.num\[<name>,<user>,<state>,<cmdline>,<zone>\]|<|<|<|<|
|<|The number of processes.|Integer|**name** - process name (default is *all processes*)<br>**user** - user name (default is *all users*)<br>**state** (*disk* and *trace* options since version 3.4.0) - possible values:<br>*all* (default),<br>*disk* - uninterruptible sleep,<br>*run* - running,<br>*sleep* - interruptible sleep,<br>*trace* - stopped,<br>*zomb* - zombie<br>**cmdline** - filter by command line (it is a regular [expression](/manual/regular_expressions#overview))<br>**zone** - target zone: *current* (default), *all*. This parameter is supported on Solaris only.|Examples:<br>=> proc.num\[,mysql\] → number of processes running under the mysql user<br>=> proc.num\[apache2,www-data\] → number of apache2 processes running under the www-data user<br>=> proc.num\[,oracle,sleep,oracleZABBIX\] → number of processes in sleep state running under oracle having oracleZABBIX in its command line<br><br>See [notes](/manual/appendix/items/proc_mem_num_notes) on selecting processes with `name` and `cmdline` parameters (Linux-specific).<br><br>On Windows, only the `name` and `user` parameters are supported.<br><br>When this item is invoked from the command line and contains a command line parameter (e.g. using the agent test mode: `zabbix_agentd -t proc.num[,,,apache2]`), one extra process will be counted, as the agent will count itself.<br><br>*Note* that when setting the `zone` parameter to *current* (or default) in case the agent has been compiled on a Solaris without zone support, but running on a newer Solaris where zones are supported, then the agent will return NOTSUPPORTED (the agent cannot limit results to only the current zone). However, *all* is supported in this case.|
|sensor\[device,sensor,<mode>\]|<|<|<|<|
|<|Hardware sensor reading.|Float|**device** - device name<br>**sensor** - sensor name<br>**mode** - possible values:<br>*avg*, *max*, *min* (if this parameter is omitted, device and sensor are treated verbatim).|Reads /proc/sys/dev/sensors on Linux 2.4.<br><br>Example:<br>=> sensor\[w83781d-i2c-0-2d,temp1\]<br><br>Prior to Zabbix 1.8.4, the *sensor\[temp1\]* format was used.|
|^|^|^|^|Reads /sys/class/hwmon on Linux 2.6+.<br><br>See a more detailed description of [sensor](/manual/appendix/items/sensor) item on Linux.|
|^|^|^|^|Reads the *hw.sensors* MIB on OpenBSD.<br><br>Examples:<br>=> sensor\[cpu0,temp0\] → temperature of one CPU<br>=> sensor\["cpu\[0-2\]$",temp,avg\] → average temperature of the first three CPU's<br><br>Supported on OpenBSD since Zabbix 1.8.4.|
|system.boottime|<|<|<|<|
|<|System boot time.|Integer (Unix timestamp)| | |
|system.cpu.discovery|<|<|<|<|
|<|List of detected CPUs/CPU cores. Used for low-level discovery.|JSON object| |Supported on all platforms since 2.4.0.|
|system.cpu.intr|<|<|<|<|
|<|Device interrupts.|Integer| | |
|system.cpu.load\[<cpu>,<mode>\]|<|<|<|<|
|<|[CPU load](http://en.wikipedia.org/wiki/Load_(computing)).|Float|**cpu** - possible values:<br>*all* (default), *percpu* (since version 2.0; total load divided by online CPU count)<br>**mode** - possible values:<br>*avg1* (one-minute average, default), *avg5*, *avg15*|Example:<br>=> system.cpu.load\[,avg5\].|
|system.cpu.num\[<type>\]|<|<|<|<|
|<|Number of CPUs.|Integer|**type** - possible values:<br>*online* (default), *max*|Example:<br>=> system.cpu.num|
|system.cpu.switches|<|<|<|<|
|<|Count of context switches.|Integer| | |
|system.cpu.util\[<cpu>,<type>,<mode>,<logical\_or\_physical>\]|<|<|<|<|
|<|CPU utilization percentage.|Float|**cpu** - *<CPU number>* or *all* (default)<br>**type** - possible values:<br>*user* (default), *idle*, *nice*, *system* (default for Windows), *iowait*, *interrupt*, *softirq*, *steal*, *guest* (on Linux kernels 2.6.24 and above), *guest\_nice* (on Linux kernels 2.6.33 and above).<br>See also [platform-specific](/manual/appendix/items/supported_by_platform) details for this parameter.<br>**mode** - possible values:<br>*avg1* (one-minute average, default), *avg5*, *avg15*<br>**logical\_or\_physical** (since version 5.0.3; on AIX only) - possible values: *logical* (default), *physical*. This parameter is supported on AIX only.|Example:<br>=> system.cpu.util\[0,user,avg5\]<br><br>Old naming: *system.cpu.idleX, system.cpu.niceX, system.cpu.systemX, system.cpu.userX*|
|system.hostname\[<type>, <transform>\]|<|<|<|<|
|<|System host name.|String|**type** (before version 5.4.7 supported on Windows only) - possible values: *netbios* (default on Windows), *host* (default on Linux), *shorthost* (since version 5.4.7; returns part of the hostname before the first dot, a full string for names without dots).<br>**transform** (since version 5.4.7) - possible values:<br>*none* (default), *lower* (convert to lowercase)|The value is acquired by either GetComputerName() (for **netbios**) or gethostname() (for **host**) functions on Windows and by "hostname" command on other systems.<br><br>Examples of returned values:<br>*on Linux*:<br>=> system.hostname → linux-w7x1<br>=> system.hostname → example.com<br>=> system.hostname\[shorthost\] → example<br>*on Windows*:<br>=> system.hostname → WIN-SERV2008-I6<br>=> system.hostname\[host\] → Win-Serv2008-I6LonG<br>=> system.hostname\[host,lower\] → win-serv2008-i6long<br><br>See also a [more detailed description](/manual/appendix/install/windows_agent#configuration).|
|system.hw.chassis\[<info>\]|<|<|<|<|
|<|Chassis information.|String|**info** - one of full (default), model, serial, type or vendor|Example: system.hw.chassis\[full\]<br>Hewlett-Packard HP Pro 3010 Small Form Factor PC CZXXXXXXXX Desktop\]<br><br>This key depends on the availability of the [SMBIOS](http://en.wikipedia.org/wiki/System_Management_BIOS) table.<br>Will try to read the DMI table from sysfs, if sysfs access fails then try reading directly from memory.<br><br>**Root permissions** are required because the value is acquired by reading from sysfs or memory.<br><br>Supported since Zabbix 2.0.|
|system.hw.cpu\[<cpu>,<info>\]|<|<|<|<|
|<|CPU information.|String or integer|**cpu** - *<CPU number>* or *all* (default)<br>**info** - possible values:<br>*full* (default), *curfreq*, *maxfreq*, *model* or *vendor*|Example:<br>=> system.hw.cpu\[0,vendor\] → AuthenticAMD<br><br>Gathers info from /proc/cpuinfo and /sys/devices/system/cpu/\[cpunum\]/cpufreq/cpuinfo\_max\_freq.<br><br>If a CPU number and *curfreq* or *maxfreq* is specified, a numeric value is returned (Hz).<br><br>Supported since Zabbix 2.0.|
|system.hw.devices\[<type>\]|<|<|<|<|
|<|Listing of PCI or USB devices.|Text|**type** (since version 2.0) - *pci* (default) or *usb*|Example:<br>=> system.hw.devices\[pci\] → 00:00.0 Host bridge: Advanced Micro Devices \[AMD\] RS780 Host Bridge<br>\[..\]<br><br>Returns the output of either lspci or lsusb utility (executed without any parameters).|
|system.hw.macaddr\[<interface>,<format>\]|<|<|<|<|
|<|Listing of MAC addresses.|String|**interface** - *all* (default) or a regular [expression](/manual/regular_expressions#overview)<br>**format** - *full* (default) or *short*|Lists MAC addresses of the interfaces whose name matches the given `interface` regular [expression](/manual/regular_expressions#overview) (*all* lists for all interfaces).<br><br>Example:<br>=> system.hw.macaddr\["eth0$",full\] → \[eth0\] 00:11:22:33:44:55<br><br>If `format` is specified as *short*, interface names and identical MAC addresses are not listed.<br><br>Supported since Zabbix 2.0.|
|system.localtime\[<type>\]|<|<|<|<|
|<|System time.|Integer - with `type` as *utc*<br><br>String - with `type` as *local*|**type** (since version 2.0) - possible values:<br>*utc* - (default) the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds.<br>*local* - the time in the 'yyyy-mm-dd,hh:mm:ss.nnn,+hh:mm' format<br>|Must be used as a [passive check](/manual/appendix/items/activepassive#passive_checks) only.<br><br>Example:<br>=> system.localtime\[local\] → create an item using this key and then use it to display host time in the *Clock* [dashboard widget](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#clock).|
|system.run\[command,<mode>\]|<|<|<|<|
|<|Run specified command on the host.|Text result of the command<br><br>1 - with `mode` as *nowait* (regardless of command result)|**command** - command for execution<br>**mode** - possible values:<br>*wait* - wait end of execution (default),<br>*nowait* - do not wait|Up to 512KB of data can be returned, including trailing whitespace that is truncated.<br>To be processed correctly, the output of the command must be text.<br><br>Example:<br>=> system.run\[ls -l /\] → detailed file list of root directory.<br><br>*Note*: system.run items are disabled by default. Learn how to [enable them](/manual/config/items/restrict_checks).<br><br>The return value of the item is standard output together with standard error produced by command. The exit code is not checked.<br><br>Empty result is allowed starting with Zabbix 2.4.0.<br>See also: [Command execution](/manual/appendix/command_execution).|
|system.stat\[resource,<type>\]|<|<|<|<|
|<|System statistics.|Integer or float|**ent** - number of processor units this partition is entitled to receive (float)<br>**kthr,<type>** - information about kernel thread states:<br>*r* - average number of runnable kernel threads (float)<br>*b* - average number of kernel threads placed in the Virtual Memory Manager wait queue (float)<br>**memory,<type>** - information about the usage of virtual and real memory:<br>*avm* - active virtual pages (integer)<br>*fre* - size of the free list (integer)<br>**page,<type>** - information about page faults and paging activity:<br>*fi* - file page-ins per second (float)<br>*fo* - file page-outs per second (float)<br>*pi* - pages paged in from paging space (float)<br>*po* - pages paged out to paging space (float)<br>*fr* - pages freed (page replacement) (float)<br>*sr* - pages scanned by page-replacement algorithm (float)<br>**faults,<type>** - trap and interrupt rate:<br>*in* - device interrupts (float)<br>*sy* - system calls (float)<br>*cs* - kernel thread context switches (float)<br>**cpu,<type>** - breakdown of percentage usage of processor time:<br>*us* - user time (float)<br>*sy* - system time (float)<br>*id* - idle time (float)<br>*wa* - idle time during which the system had outstanding disk/NFS I/O request(s) (float)<br>*pc* - number of physical processors consumed (float)<br>*ec* - the percentage of entitled capacity consumed (float)<br>*lbusy* - indicates the percentage of logical processor(s) utilization that occurred while executing at the user and system level (float)<br>*app* - indicates the available physical processors in the shared pool (float)<br>**disk,<type>** - disk statistics:<br>*bps* - indicates the amount of data transferred (read or written) to the drive in bytes per second (integer)<br>*tps* - indicates the number of transfers per second that were issued to the physical disk/tape (float)|<|
|<|^|^|Comments|<|
|<|^|^|This item is [supported](/manual/appendix/items/supported_by_platform) on AIX only, since Zabbix 1.8.1.<br>Take note of the following limitations in these items:<br>=> system.stat\[cpu,app\] - supported only on AIX LPAR of type "Shared"<br>=> system.stat\[cpu,ec\] - supported on AIX LPAR of type "Shared" and "Dedicated" ("Dedicated" always returns 100 (percent))<br>=> system.stat\[cpu,lbusy\] - supported only on AIX LPAR of type "Shared"<br>=> system.stat\[cpu,pc\] - supported on AIX LPAR of type "Shared" and "Dedicated"<br>=> system.stat\[ent\] - supported on AIX LPAR of type "Shared" and "Dedicated"|<|
|system.sw.arch|<|<|<|<|
|<|Software architecture information.|String| |Example:<br>=> system.sw.arch → i686<br><br>Info is acquired from uname() function.<br><br>Supported since Zabbix 2.0.|
|system.sw.os\[<info>\]|<|<|<|<|
|<|Operating system information.|String|**info** - possible values:<br>*full* (default), *short* or *name*|Example:<br>=> system.sw.os\[short\]→ Ubuntu 2.6.35-28.50-generic 2.6.35.11<br><br>Info is acquired from (note that not all files and options are present in all distributions):<br>/proc/version (*full*)<br>/proc/version\_signature (*short*)<br>PRETTY\_NAME parameter from /etc/os-release on systems supporting it, or /etc/issue.net (*name*)<br><br>Supported since Zabbix 2.0.|
|system.sw.packages\[<package>,<manager>,<format>\]|<|<|<|<|
|<|Listing of installed packages.|Text|**package** - *all* (default) or a regular [expression](/manual/regular_expressions#overview)<br>**manager** - *all* (default) or a package manager<br>**format** - *full* (default) or *short*|Lists (alphabetically) installed packages whose name matches the given `package` regular [expression](/manual/regular_expressions#overview) (*all* lists them all).<br><br>Example:<br>=> system.sw.packages\[mini,dpkg,short\] → python-minimal, python2.6-minimal, ubuntu-minimal<br><br>Supported package managers (executed command):<br>dpkg (dpkg --get-selections)<br>pkgtool (ls /var/log/packages)<br>rpm (rpm -qa)<br>pacman (pacman -Q)<br><br>If `format` is specified as *full*, packages are grouped by package managers (each manager on a separate line beginning with its name in square brackets).<br>If `format` is specified as *short*, packages are not grouped and are listed on a single line.<br><br>Supported since Zabbix 2.0.|
|system.swap.in\[<device>,<type>\]|<|<|<|<|
|<|Swap in (from device into memory) statistics.|Integer|**device** - device used for swapping (default is *all*)<br>**type** - possible values:<br>*count* (number of swapins), *sectors* (sectors swapped in), *pages* (pages swapped in).<br>See also [platform-specific](/manual/appendix/items/supported_by_platform) details for this parameter.|Example:<br>=> system.swap.in\[,pages\]<br><br>The source of this information is:<br>/proc/swaps, /proc/partitions, /proc/stat (Linux 2.4)<br>/proc/swaps, /proc/diskstats, /proc/vmstat (Linux 2.6)|
|system.swap.out\[<device>,<type>\]|<|<|<|<|
|<|Swap out (from memory onto device) statistics.|Integer|**device** - device used for swapping (default is *all*)<br>**type** - possible values:<br>*count* (number of swapouts), *sectors* (sectors swapped out), *pages* (pages swapped out).<br>See also [platform-specific](/manual/appendix/items/supported_by_platform) details for this parameter.|Example:<br>=> system.swap.out\[,pages\]<br><br>The source of this information is:<br>/proc/swaps, /proc/partitions, /proc/stat (Linux 2.4)<br>/proc/swaps, /proc/diskstats, /proc/vmstat (Linux 2.6)|
|system.swap.size\[<device>,<type>\]|<|<|<|<|
|<|Swap space size in bytes or in percentage from total.|Integer - for bytes<br><br>Float - for percentage|**device** - device used for swapping (default is *all*)<br>**type** - possible values:<br>*free* (free swap space, default), *pfree* (free swap space, in percent), *pused* (used swap space, in percent), *total* (total swap space), *used* (used swap space)<br>Note that *pfree*, *pused* are not supported on Windows if swap size is 0.<br>See also [platform-specific](/manual/appendix/items/supported_by_platform) details for this parameter.|Example:<br>=> system.swap.size\[,pfree\] → free swap space percentage<br><br>If *device* is not specified Zabbix agent will only take into account swap devices (files), physical memory will be ignored. For example, on Solaris systems *swap -s* command includes a portion of physical memory and swap devices (unlike *swap -l*).<br><br>Note that this key might report incorrect swap space size/percentage on virtualized (VMware ESXi, VirtualBox) Windows platforms. In this case you may use the `perf_counter[\700(_Total)\702]` key to obtain correct swap space percentage.|
|system.uname|<|<|<|<|
|<|Identification of the system.|String| |Example of returned value (Unix):<br>FreeBSD localhost 4.2-RELEASE FreeBSD 4.2-RELEASE \#0: Mon Nov i386<br><br>Example of returned value (Windows):<br>Windows ZABBIX-WIN 6.0.6001 Microsoft® Windows Server® 2008 Standard Service Pack 1 x86<br><br>On Unix since Zabbix 2.2.0 the value for this item is obtained with uname() system call. Previously it was obtained by invoking "uname -a". The value of this item might differ from the output of "uname -a" and does not include additional information that "uname -a" prints based on other sources.<br><br>On Windows since Zabbix 3.0 the value for this item is obtained from Win32\_OperatingSystem and Win32\_Processor WMI classes. Previously it was obtained from volatile Windows APIs and undocumented registry keys. The OS name (including edition) might be translated to the user's display language. On some versions of Windows it contains trademark symbols and extra spaces.<br><br>Note that on Windows the item returns OS architecture, whereas on Unix it returns CPU architecture.|
|system.uptime|<|<|<|<|
|<|System uptime in seconds.|Integer| |In [item configuration](/manual/config/items/item#configuration), use **s** or **uptime** units to get readable values.|
|system.users.num|<|<|<|<|
|<|Number of users logged in.|Integer| |**who** command is used on the agent side to obtain the value.|
|vfs.dev.discovery|<|<|<|<|
|<|List of block devices and their type. Used for low-level discovery.|JSON object| |This item is supported on Linux platform only.<br><br>Supported since Zabbix 4.4.0.|
|vfs.dev.read\[<device>,<type>,<mode>\]|<|<|<|<|
|<|Disk read statistics.|Integer - with `type` in *sectors*, *operations*, *bytes*<br><br>Float - with `type` in *sps*, *ops*, *bps*<br><br>*Note*: if using an update interval of three hours or more^**[2](#footnotes)**^, will always return '0'|**device** - disk device (default is *all* ^**[3](#footnotes)**^)<br>**type** - possible values: *sectors*, *operations*, *bytes*, *sps*, *ops*, *bps*<br>Note that 'type' parameter support and defaults depend on the platform. See [platform-specific](/manual/appendix/items/supported_by_platform) details.<br>*sps*, *ops*, *bps* stand for: sectors, operations, bytes per second, respectively.<br>**mode** - possible values: *avg1* (one-minute average, default), *avg5*, *avg15*.<br>This parameter is supported only with `type` in: sps, ops, bps.|You may use relative device names (for example, `sda`) as well as an optional /dev/ prefix (for example, `/dev/sda`).<br><br>LVM logical volumes are supported.<br><br>Default values of 'type' parameter for different OSes:<br>AIX - operations<br>FreeBSD - bps<br>Linux - sps<br>OpenBSD - operations<br>Solaris - bytes<br><br>Example:<br>=> vfs.dev.read\[,operations\]<br><br>*sps*, *ops* and *bps* on supported platforms used to be limited to 8 devices (7 individual and one *all*). Since Zabbix 2.0.1 this limit is 1024 devices (1023 individual and one for *all*).|
|vfs.dev.write\[<device>,<type>,<mode>\]|<|<|<|<|
|<|Disk write statistics.|Integer - with `type` in *sectors*, *operations*, *bytes*<br><br>Float - with `type` in *sps*, *ops*, *bps*<br><br>*Note*: if using an update interval of three hours or more^**[2](#footnotes)**^, will always return '0'|**device** - disk device (default is *all* ^**[3](#footnotes)**^)<br>**type** - possible values: *sectors*, *operations*, *bytes*, *sps*, *ops*, *bps*<br>Note that 'type' parameter support and defaults depend on the platform. See [platform-specific](/manual/appendix/items/supported_by_platform) details.<br>*sps*, *ops*, *bps* stand for: sectors, operations, bytes per second, respectively.<br>**mode** - possible values: *avg1* (one-minute average, default), *avg5*, *avg15*.<br>This parameter is supported only with `type` in: sps, ops, bps.|You may use relative device names (for example, `sda`) as well as an optional /dev/ prefix (for example, `/dev/sda`).<br><br>LVM logical volumes are supported.<br><br>Default values of 'type' parameter for different OSes:<br>AIX - operations<br>FreeBSD - bps<br>Linux - sps<br>OpenBSD - operations<br>Solaris - bytes<br><br>Example:<br>=> vfs.dev.write\[,operations\]<br><br>*sps*, *ops* and *bps* on supported platforms used to be limited to 8 devices (7 individual and one *all*). Since Zabbix 2.0.1 this limit is 1024 (1023 individual and one for *all*).|
|vfs.dir.count\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]|<|<|<|<|
|<|Directory entry count.|Integer|**dir** - absolute path to directory<br>**regex\_incl** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to include; include all if empty (default value)<br>**regex\_excl** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to exclude; don't exclude any if empty (default value)<br>**types\_incl** - directory entry types to count, possible values:<br>*file* - regular file, *dir* - subdirectory, *sym* - symbolic link, *sock* - socket, *bdev* - block device, *cdev* - character device, *fifo* - FIFO, *dev* - synonymous with "bdev,cdev", *all* - all types (default), i.e. "file,dir,sym,sock,bdev,cdev,fifo". Multiple types must be separated with comma and quoted.<br>**types\_excl** - directory entry types (see <types\_incl>) to NOT count. If some entry type is in both <types\_incl> and <types\_excl>, directory entries of this type are NOT counted.<br>**max\_depth** - maximum depth of subdirectories to traverse. **-1** (default) - unlimited, **0** - no descending into subdirectories.<br>**min\_size** - minimum size (in bytes) for file to be counted. Smaller files will not be counted. [Memory suffixes](/manual/appendix/suffixes#memory_suffixes) can be used.<br>**max\_size** - maximum size (in bytes) for file to be counted. Larger files will not be counted. [Memory suffixes](/manual/appendix/suffixes#memory_suffixes) can be used.<br>**min\_age** - minimum age (in seconds) of directory entry to be counted. More recent entries will not be counted. [Time suffixes](/manual/appendix/suffixes#time_suffixes) can be used.<br>**max\_age** - maximum age (in seconds) of directory entry to be counted. Entries so old and older will not be counted (modification time). [Time suffixes](/manual/appendix/suffixes#time_suffixes) can be used.<br>**regex\_excl\_dir** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the directory to exclude. All content of the directory will be excluded (in contrast to regex\_excl)|Environment variables, e.g. %APP\_HOME%, $HOME and %TEMP% are not supported.<br><br>Pseudo-directories "." and ".." are never counted.<br><br>Symbolic links are never followed for directory traversal.<br><br>On Windows, directory symlinks are skipped and hard links are counted only once.<br><br>Both `regex_incl` and `regex_excl` are being applied to files and directories when calculating entry size, but are ignored when picking subdirectories to traverse (if regex\_incl is “(?i)\^.+\\.zip$” and max\_depth is not set, then all subdirectories will be traversed, but only files of type zip will be counted).<br><br>Execution time is limited by the default timeout value in agent [configuration](/manual/appendix/config/zabbix_agentd) (3 sec). Since large directory traversal may take longer than that, no data will be returned and the item will turn unsupported. Partial count will not be returned.<br><br>When filtering by size, only regular files have meaningful sizes. Under Linux and BSD, directories also have non-zero sizes (a few Kb typically). Devices have zero sizes, e.g. the size of **/dev/sda1** does not reflect the respective partition size. Therefore, when using `<min_size>` and `<max_size>`, it is advisable to specify `<types_incl>` as "*file*", to avoid surprises.<br><br>Examples:<br>⇒ vfs.dir.count\[/dev\] - monitors number of devices in /dev (Linux)<br>⇒ vfs.dir.count\["C:\\Users\\ADMINI\~1\\AppData\\Local\\Temp"\] - monitors number of files in temporary directory (Windows)<br><br>Supported since Zabbix 4.0.0.|
|vfs.dir.get\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]|<|<|<|<|
|<|Directory entry list.|JSON|**dir** - absolute path to directory<br>**regex\_incl** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to include; include all if empty (default value)<br>**regex\_excl** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to exclude; don't exclude any if empty (default value)<br>**types\_incl** - directory entry types to list, possible values:<br>*file* - regular file, *dir* - subdirectory, *sym* - symbolic link, *sock* - socket, *bdev* - block device, *cdev* - character device, *fifo* - FIFO, *dev* - synonymous with "bdev,cdev", *all* - all types (default), i.e. "file,dir,sym,sock,bdev,cdev,fifo". Multiple types must be separated with comma and quoted.<br>**types\_excl** - directory entry types (see <types\_incl>) to NOT list. If some entry type is in both <types\_incl> and <types\_excl>, directory entries of this type are NOT listed.<br>**max\_depth** - maximum depth of subdirectories to traverse. **-1** (default) - unlimited, **0** - no descending into subdirectories.<br>**min\_size** - minimum size (in bytes) for file to be listed. Smaller files will not be listed. [Memory suffixes](/manual/appendix/suffixes#memory_suffixes) can be used.<br>**max\_size** - maximum size (in bytes) for file to be listed. Larger files will not be counted. [Memory suffixes](/manual/appendix/suffixes#memory_suffixes) can be used.<br>**min\_age** - minimum age (in seconds) of directory entry to be listed. More recent entries will not be listed. [Time suffixes](/manual/appendix/suffixes#time_suffixes) can be used.<br>**max\_age** - maximum age (in seconds) of directory entry to be listed. Entries so old and older will not be listed (modification time). [Time suffixes](/manual/appendix/suffixes#time_suffixes) can be used.<br>**regex\_excl\_dir** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the directory to exclude. All content of the directory will be excluded (in contrast to regex\_excl)|Environment variables, e.g. %APP\_HOME%, $HOME and %TEMP% are not supported.<br><br>Pseudo-directories "." and ".." are never listed.<br><br>Symbolic links are never followed for directory traversal.<br><br>On Windows, directory symlinks are skipped and hard links are listed only once.<br><br>Both `regex_incl` and `regex_excl` are being applied to files and directories when calculating entry size, but are ignored when picking subdirectories to traverse (if regex\_incl is “(?i)\^.+\\.zip$” and max\_depth is not set, then all subdirectories will be traversed, but only files of type zip will be listed).<br><br>Execution time is limited by the default timeout value in agent [configuration](/manual/appendix/config/zabbix_agentd) (3 sec). Since large directory traversal may take longer than that, no data will be returned and the item will turn unsupported. Partial list will not be returned.<br><br>When filtering by size, only regular files have meaningful sizes. Under Linux and BSD, directories also have non-zero sizes (a few Kb typically). Devices have zero sizes, e.g. the size of **/dev/sda1** does not reflect the respective partition size. Therefore, when using `<min_size>` and `<max_size>`, it is advisable to specify `<types_incl>` as "*file*", to avoid surprises.<br><br>Examples:<br>⇒ vfs.dir.get\[/dev\] - retrieves device list in /dev (Linux)<br>⇒ vfs.dir.get\["C:\\Users\\ADMINI\~1\\AppData\\Local\\Temp"\] - retrieves file list in temporary directory (Windows)<br><br>Supported since Zabbix 6.0.0.|
|vfs.dir.size\[dir,<regex\_incl>,<regex\_excl>,<mode>,<max\_depth>,<regex\_excl\_dir>\]|<|<|<|<|
|<|Directory size (in bytes).|Integer|**dir** - absolute path to directory<br>**regex\_incl** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to include; include all if empty (default value)<br>**regex\_excl** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the entity (file, directory, symbolic link) to exclude; don't exclude any if empty (default value)<br>**mode** - possible values:<br>*apparent* (default) - gets apparent file sizes rather than disk usage (acts as `du -sb dir`), *disk* - gets disk usage (acts as `du -s -B1 dir`). Unlike du command, vfs.dir.size item takes hidden files in account when calculating directory size (acts as `du -sb .[^.]* *` within dir).<br>**max\_depth** - maximum depth of subdirectories to traverse. **-1** (default) - unlimited, **0** - no descending into subdirectories.<br>**regex\_excl\_dir** - regular [expression](/manual/regular_expressions#overview) describing the name pattern of the directory to exclude. All content of the directory will be excluded (in contrast to regex\_excl)|Only directories with at least read permission for *zabbix* user are calculated.<br><br>On Windows any symlink is skipped and hard links are taken into account only once.<br><br>With large directories or slow drives this item may time out due to the Timeout setting in [agent](/manual/appendix/config/zabbix_agentd) and [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy) configuration files. Increase the timeout values as necessary.<br><br>Examples:<br>⇒ vfs.dir.size\[/tmp,log\] - calculates size of all files in /tmp which contain 'log'<br>⇒ vfs.dir.size\[/tmp,log,\^.+\\.old$\] - calculates size of all files in /tmp which contain 'log', excluding files containing '.old'<br><br>The file size limit depends on [large file support](/manual/appendix/items/large_file_support).<br><br>Supported since Zabbix 3.4.0.|
|vfs.file.cksum\[file,<mode>\]|<|<|<|<|
|<|File checksum, calculated by the UNIX cksum algorithm.|Integer - with `mode` as *crc32*<br><br>String - with `mode` as *md5*, *sha256*|**file** - full path to file<br>**mode** - *crc32* (default), *md5*, *sha256*|Example:<br>=> vfs.file.cksum\[/etc/passwd\]<br><br>Example of returned values (crc32/md5/sha256 respectively):<br>675436101<br>9845acf68b73991eb7fd7ee0ded23c44<br>ae67546e4aac995e5c921042d0cf0f1f7147703aa42bfbfb65404b30f238f2dc<br><br>The file size limit depends on [large file support](/manual/appendix/items/large_file_support).<br><br>The `mode` parameter is supported since Zabbix 6.0.|
|vfs.file.contents\[file,<encoding>\]|<|<|<|<|
|<|Retrieving contents of a file.|Text|**file** - full path to file<br>**encoding** - code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)|Returns an empty string if the file is empty or contains LF/CR characters only.<br><br>Byte order mark (BOM) is excluded from the output.<br><br>Example:<br>=> vfs.file.contents\[/etc/passwd\]<br><br>This item is limited to files no larger than 64 Kbytes.<br><br>Supported since Zabbix 2.0.|
|vfs.file.exists\[file,<types\_incl>,<types\_excl>\]|<|<|<|<|
|<|Checks if file exists.|0 - not found<br><br>1 - file of the specified type exists|**file** - full path to file<br>**types\_incl** - list of file types to include, possible values: *file* (regular file, default (if types\_excl is not set)), *dir* (directory), *sym* (symbolic link), *sock* (socket), *bdev* (block device), *cdev* (character device), *fifo* (FIFO), *dev* (synonymous with "bdev,cdev"), *all* (all mentioned types, default if types\_excl is set).<br>**types\_excl** - list of file types to exclude, see types\_incl for possible values (by default no types are excluded)|Multiple types must be separated with a comma and the entire set enclosed in quotes "".<br>On Windows the double quotes have to be backslash '\\' escaped and the whole item key enclosed in double quotes when using the command line utility for calling zabbix\_get.exe or agent2.<br><br>If the same type is in both <types\_incl> and <types\_excl>, files of this type are excluded.<br><br>Examples:<br>=> vfs.file.exists\[/tmp/application.pid\]<br>=> vfs.file.exists\[/tmp/application.pid,"file,dir,sym"\]<br>=> vfs.file.exists\[/tmp/application\_dir,dir\]<br><br>The file size limit depends on [large file support](/manual/appendix/items/large_file_support).<br><br>Note that the item may turn unsupported on Windows if a directory is searched within a non-existing directory, e.g. vfs.file.exists\[C:\\no\\dir,dir\] (where 'no' does not exist).|
|vfs.file.get\[file\]|<|<|<|<|
|<|Return information about a file.|JSON object|**file** - full path to file|Supported file types on UNIX-like systems: regular file, directory, symbolic link, socket, block device, character device, FIFO<br><br>Supported file types on Windows: regular file, directory, symbolic link<br><br>Example:<br>=> vfs.file.get\[/etc/passwd\] → return a JSON with information about the /etc/passwd file (type, user, permissions, SID, uid etc)<br><br>Supported since Zabbix 6.0.|
|vfs.file.md5sum\[file\]|<|<|<|<|
|<|MD5 checksum of file.|Character string (MD5 hash of the file)|**file** - full path to file|Example:<br>=> vfs.file.md5sum\[/usr/local/etc/zabbix\_agentd.conf\]<br><br>Example of returned value:<br>b5052decb577e0fffd622d6ddc017e82<br><br>The file size limit (64 MB) for this item was removed in version 1.8.6.<br><br>The file size limit depends on [large file support](/manual/appendix/items/large_file_support).|
|vfs.file.owner\[file,<ownertype>,<resulttype>\]|<|<|<|<|
|<|Retrieve owner of a file.|Character string|**file** - full path to file<br>**ownertype** - *user* (default) or *group* (Unix only)<br>**resulttype** - *name* (default) or *id*; for id - return uid/gid on Unix, SID on Windows|Example:<br>=> vfs.file.owner\[/tmp/zabbix\_server.log\] → return file owner of /tmp/zabbix\_server.log<br>=> vfs.file.owner\[/tmp/zabbix\_server.log,,id\] → return file owner ID of /tmp/zabbix\_server.log<br><br>Supported since Zabbix 6.0.|
|vfs.file.permissions\[file\]|<|<|<|<|
|<|Return a 4-digit string containing the octal number with Unix permissions.|String|**file** - full path to the file|Not supported on Windows.<br><br>Example:<br>=> vfs.file.permissions\[/etc/passwd\] → return permissions of /etc/passwd, for example, '0644'<br><br>Supported since Zabbix 6.0.|
|vfs.file.regexp\[file,regexp,<encoding>,<start line>,<end line>,<output>\]|<|<|<|<|
|<|Find string in a file.|The line containing the matched string, or as specified by the optional `output` parameter|**file** - full path to file<br>**regexp** - regular [expression](/manual/regular_expressions#overview) describing the required pattern<br>**encoding** - code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**start line** - the number of first line to search (first line of file by default).<br>**end line** - the number of last line to search (last line of file by default).<br>**output** - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups).|Only the first matching line is returned.<br>An empty string is returned if no line matched the expression.<br><br>Byte order mark (BOM) is excluded from the output.<br><br>Content extraction using the `output` parameter takes place on the agent.<br><br>The `start line`, `end line` and `output` parameters are supported from version 2.2.<br><br>Examples:<br>=> vfs.file.regexp\[/etc/passwd,zabbix\]<br>=> vfs.file.regexp\[/path/to/some/file,"(\[0-9\]+)$",,3,5,\\1\]<br>=> vfs.file.regexp\[/etc/passwd,"\^zabbix:.:(\[0-9\]+)",,,,\\1\] → getting the ID of user *zabbix*|
|vfs.file.regmatch\[file,regexp,<encoding>,<start line>,<end line>\]|<|<|<|<|
|<|Find string in a file.|0 - match not found<br><br>1 - found|**file** - full path to file<br>**regexp** - regular [expression](/manual/regular_expressions#overview) describing the required pattern<br>**encoding** - code page [identifier](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**start line** - the number of first line to search (first line of file by default).<br>**end line** - the number of last line to search (last line of file by default).|Byte order mark (BOM) is ignored.<br><br>The `start line` and `end line` parameters are supported from version 2.2.<br><br>Example:<br>=> vfs.file.regmatch\[/var/log/app.log,error\]|
|vfs.file.size\[file,<mode>\]|<|<|<|<|
|<|File size (in bytes).|Integer|**file** - full path to file<br>**mode** - possible values:<br>*bytes* (default) or *lines* (empty lines are counted, too)|The file must have read permissions for user *zabbix*.<br><br>Example:<br>=> vfs.file.size\[/var/log/syslog\]<br><br>The file size limit depends on [large file support](/manual/appendix/items/large_file_support).<br><br>The `mode` parameter is supported since Zabbix 6.0.|
|vfs.file.time\[file,<mode>\]|<|<|<|<|
|<|File time information.|Integer (Unix timestamp)|**file** - full path to the file<br>**mode** - possible values:<br>*modify* (default) - last time of modifying file content,<br>*access* - last time of reading file,<br>*change* - last time of changing file properties|Example:<br>=> vfs.file.time\[/etc/passwd,modify\]<br><br>The file size limit depends on [large file support](/manual/appendix/items/large_file_support).|
|vfs.fs.discovery|<|<|<|<|
|<|List of mounted filesystems and their types. Used for low-level discovery.|JSON object| |Supported since Zabbix 2.0.<br><br>The {\#FSDRIVETYPE} macro is supported on Windows since Zabbix 3.0.<br><br>The {\#FSLABEL} macro is supported on Windows since Zabbix 6.0.|
|vfs.fs.get|<|<|<|<|
|<|List of mounted filesystems, their types, disk space and inode statistics. Can be used for low-level discovery.|JSON object| |Supported since Zabbix 4.4.5.<br><br>The {\#FSLABEL} macro is supported on Windows since Zabbix 6.0.|
|vfs.fs.inode\[fs,<mode>\]|<|<|<|<|
|<|Number or percentage of inodes.|Integer - for number<br><br>Float - for percentage|**fs** - filesystem<br>**mode** - possible values:<br>*total* (default), *free*, *used*, //pfree // (free, percentage), *pused* (used, percentage)|Example:<br>=> vfs.fs.inode\[/,pfree\]|
|vfs.fs.size\[fs,<mode>\]|<|<|<|<|
|<|Disk space in bytes or in percentage from total.|Integer - for bytes<br><br>Float - for percentage|**fs** - filesystem<br>**mode** - possible values:<br>*total* (default), *free*, *used*, *pfree* (free, percentage), *pused* (used, percentage)|In case of a mounted volume, disk space for local file system is returned.<br><br>Example:<br>=> vfs.fs.size\[/tmp,free\]<br><br>Reserved space of a file system is taken into account and not included when using the *free* mode.|
|vm.memory.size\[<mode>\]|<|<|<|<|
|<|Memory size in bytes or in percentage from total.|Integer - for bytes<br><br>Float - for percentage|**mode** - possible values:<br>*total* (default), *active*, *anon*, *buffers*, *cached*, *exec*, *file*, *free*, *inactive*, *pinned*, *shared*, *slab*, *wired*, *used*, *pused* (used, percentage), *available*, *pavailable* (available, percentage)<br>See also [platform-specific](/manual/appendix/items/supported_by_platform) support and [additional details](/manual/appendix/items/vm.memory.size_params) for this parameter.|This item accepts three categories of parameters:<br><br>1) *total* - total amount of memory;<br>2) platform-specific memory types: *active*, *anon*, *buffers*, *cached*, *exec*, *file*, *free*, *inactive*, *pinned*, *shared*, *slab*, *wired*;<br>3) user-level estimates on how much memory is used and available: *used*, *pused*, *available*, *pavailable*.|
|web.page.get\[host,<path>,<port>\]|<|<|<|<|
|<|Get content of web page.|Web page source as text (including headers)|**host** - hostname or URL (as `scheme://host:port/path`, where only *host* is mandatory).<br>Allowed URL schemes: *http*, *https*^**[4](#footnotes)**^. Missing scheme will be treated as *http*. If URL is specified `path` and `port` must be empty. Specifying user name/password when connecting to servers that require authentication, for example: `http://user:password@www.example.com` is only possible with cURL support ^**[4](#footnotes)**^.<br>Punycode is supported in hostnames.<br>**path** - path to HTML document (default is /)<br>**port** - port number (default is 80 for HTTP)|This item turns unsupported if the resource specified in `host` does not exist or is unavailable.<br><br>`host` can be hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled.<br><br>Example:<br>=> web.page.get\[www.example.com,index.php,80\]<br>=> web.page.get\[https://www.example.com\]<br>=> web.page.get\[https://blog.example.com/?s=zabbix\]<br>=> web.page.get\[localhost:80\]<br>=> web.page.get\["\[::1\]/server-status"\]|
|web.page.perf\[host,<path>,<port>\]|<|<|<|<|
|<|Loading time of full web page (in seconds).|Float|**host** - hostname or URL (as `scheme://host:port/path`, where only *host* is mandatory).<br>Allowed URL schemes: *http*, *https*^**[4](#footnotes)**^. Missing scheme will be treated as *http*. If URL is specified `path` and `port` must be empty. Specifying user name/password when connecting to servers that require authentication, for example: `http://user:password@www.example.com` is only possible with cURL support ^**[4](#footnotes)**^.<br>Punycode is supported in hostnames.<br>**path** - path to HTML document (default is /)<br>**port** - port number (default is 80 for HTTP)|This item turns unsupported if the resource specified in `host` does not exist or is unavailable.<br><br>`host` can be hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled.<br><br>Example:<br>=> web.page.perf\[www.example.com,index.php,80\]<br>=> web.page.perf\[https://www.example.com\]|
|web.page.regexp\[host,<path>,<port>,regexp,<length>,<output>\]|<|<|<|<|
|<|Find string on a web page.|The matched string, or as specified by the optional `output` parameter|**host** - hostname or URL (as `scheme://host:port/path`, where only *host* is mandatory).<br>Allowed URL schemes: *http*, *https*^**[4](#footnotes)**^. Missing scheme will be treated as *http*. If URL is specified `path` and `port` must be empty. Specifying user name/password when connecting to servers that require authentication, for example: `http://user:password@www.example.com` is only possible with cURL support ^**[4](#footnotes)**^.<br>Punycode is supported in hostnames.<br>**path** - path to HTML document (default is /)<br>**port** - port number (default is 80 for HTTP)<br>**regexp** - regular [expression](/manual/regular_expressions#overview) describing the required pattern<br>**length** - maximum number of characters to return<br>**output** - an optional output formatting template. The **\\0** escape sequence is replaced with the matched part of text (from the first character where match begins until the character where match ends) while an **\\N** (where N=1...9) escape sequence is replaced with Nth matched group (or an empty string if the N exceeds the number of captured groups).|This item turns unsupported if the resource specified in `host` does not exist or is unavailable.<br><br>`host` can be hostname, domain name, IPv4 or IPv6 address. But for IPv6 address Zabbix agent must be compiled with IPv6 support enabled.<br><br>Content extraction using the `output` parameter takes place on the agent.<br><br>The `output` parameter is supported from version 2.2.<br><br>Example:<br>=> web.page.regexp\[www.example.com,index.php,80,OK,2\]<br>=> web.page.regexp\[https://www.example.com,,,OK,2\]|
|zabbix.stats\[<ip>,<port>\]|<|<|<|<|
|<|Return a set of Zabbix server or proxy internal metrics remotely.|JSON object|**ip** - IP/DNS/network mask list of servers/proxies to be remotely queried (default is 127.0.0.1)<br>**port** - port of server/proxy to be remotely queried (default is 10051)|Note that the stats request will only be accepted from the addresses listed in the 'StatsAllowedIP' [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy) parameter on the target instance.<br><br>A selected set of internal metrics is returned by this item. For details, see [Remote monitoring of Zabbix stats](/manual/appendix/items/remote_stats#exposed_metrics).|
|zabbix.stats\[<ip>,<port>,queue,<from>,<to>\]|<|<|<|<|
|<|Return number of monitored items in the queue which are delayed on Zabbix server or proxy remotely.|JSON object|**ip** - IP/DNS/network mask list of servers/proxies to be remotely queried (default is 127.0.0.1)<br>**port** - port of server/proxy to be remotely queried (default is 10051)<br>**queue** - constant (to be used as is)<br>**from** - delayed by at least (default is 6 seconds)<br>**to** - delayed by at most (default is infinity)|Note that the stats request will only be accepted from the addresses listed in the 'StatsAllowedIP' [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy) parameter on the target instance.|
|键|<|<|<|<|
|---|-|-|-|-|
|<|**描述**|**返回值**|**参数**|**注释**|
|agent.hostmetadata|<|<|<|<|
|<|Agent 主机元数据|字符串||返回HostMetadata或HostMetadataItem参数的值，如果没有定义的话返回空字符串<br><br> 自Zabbix 6.0后开始支持|
|agent.hostname|<|<|<|<|
|<|Agent 主机名。|字符串| |返回:<br>被动模式 - Agent 配置文件中Hostname参数中的列出第一个主机名名称;<br>主动模式 - 当前主机名的名称|
|agent.ping|<|<|<|<|
|<|Agent 可用性检查|Nothing - 不可用<br><br>1 - 可用| |使用 **nodata()** 触发器函数检查主机不可用|
|agent.variant|<|<|<|<|
|<|Zabbix agent变量 (Zabbix agent 或 Zabbix agent 2)。|整型| |返回值举例:<br>1 - Zabbix agent<br>2 - Zabbix agent 2|
|agent.version|<|<|<|<|
|<|Zabbix agent版本。|字符串| |返回值举例:<br>6.0.3|
|kernel.maxfiles|<|<|<|<|
|<|系统支持的最大文件打开数量。|整型| | |
|kernel.maxproc|<|<|<|<|
|<|系统支持的最大的进程数量.|整型| | |
|kernel.openfiles|<|<|<|<|
|<|返回当前打开的文件描述符的数量。|整型||自Zabbix6.0以后，Linux才支持此项|
|log\[file,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|监控日志文件。|日志|**file** - 日志文件的全路径<br>**regexp** - 正则[表达式](/manual/regular_expressions#overview) 所需要的匹配的模式<br>**encoding** - 编码 [标识符](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxlines** - agent将发送到Zabbix server或proxy的每秒最大行数。此参数覆盖[zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd)中的'MaxLinesPerSecond'值<br>**mode** (自版本 2.0以后)- 可能的值有:<br>*all* (默认), *skip* - 跳过旧数据的处理 (仅影响新创建的项目)。<br>**output** (自版本2.2以后) - 一个可选的输出格式模板， **\\0** 转义序列被替换为文本的匹配部分 (匹配从开始的第一个字符到结束的字符) 而 **\\N** (其中N=1...9) 转义序列被替换为第 N 个匹配组 (或如果 N 超过捕获的组数，则为空字符串)。<br>**maxdelay** (自版本 3.2后) - 最大延迟，以秒为单位。 类型: 浮点型， 值: 0 - (默认) 从不忽略日志文件行; > 0.0 - 忽略旧行， 以便在“maxdelay”秒内分析最新行。使用前请阅读 [maxdelay](log_items#using_maxdelay_parameter) 说明！<br>**options** (自版本 4.4.7以后) - 附件选项:<br>*mtime-noreread* - 非唯一记录, 仅在文件大小更改时重读 (忽略修改时间更改). (从 5.0.2 开始不推荐使用此参数，因为现在忽略了 mtime。)<br>**persistent\_dir** (从 5.0.18、5.4.9 版本开始，仅在 Unix 系统上的 zabbix_agentd 中；在 Agent2 中不支持) - 存储持久性的目录的绝对路径名文件。另请参阅有关[持久文件](log_items#notes-on-persistent-files-for-log-items)附加说明|该项必须配置为 [主动检查](/manual/appendix/items/activepassive#active_checks)。<br>如果文件丢失或权限不允许访问，监控项变为不受支持。<br><br>如果`output` 留空 - 返回包含匹配文本的整行。 请注意，除 'Result is TRUE' 之外的所有全局正则表达式类型始终返回整个匹配行，并且`output`忽略该参数。<br><br>在agent上使用`output`参数进行内容提取。<br><br>例如:<br>=> log\[/var/log/syslog\]<br>=> log\[/var/log/syslog,error\]<br>=> log\[/home/zabbix/logs/logfile,,,100\]<br><br>*使用`output` 参数中从日志记录中提取一个数字 :*<br>=> log\[/app1/app.log,"task run \[0-9.\]+ sec, processed (\[0-9\]+) records, \[0-9\]+ errors",,,,\\1\] → 将匹配日志记录 "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" 并只发送 '6080' 到server。 因为发送的是一个数值, 所以该项目的 "信息类型"可以设置为 "数字(无符号)" 该值可用于图形，触发器等。<br><br>*使用`output` 参数在发送到server之前重写日志记录:*<br>=> log\[/app1/app.log,"(\[0-9 :-\]+) task run (\[0-9.\]+) sec, processed (\[0-9\]+) records, (\[0-9\]+) errors",,,,"\\1 RECORDS: \\3, ERRORS: \\4, DURATION: \\2"\] → 将匹配日志记录 "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" 并且向服务端发送修改后的记录 "2015-11-13 10:08:26 RECORDS: 6080, ERRORS: 0, DURATION: 6.08" 。<br><br>另请参阅 [日志监控](log_items)其他信息。|
|log.count\[file,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|监控日志文件中匹配的行数量|整型|**file** - 含全路径的日志文件名称<br>**regexp** - 正则 [表达式](/manual/regular_expressions#overview)匹配的内容模式 <br>**encoding** - 编码 [标识符](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxproclines** - agent 每秒分析新增的最大行数 (不能超过10000)。 在[zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd)中设置的默认值是 10\*'MaxLinesPerSecond'<br>**mode** - 可能的值:<br>*all* (默认), *skip* - 跳过旧数据的处理 (仅影响新创建的项目)。<br>**maxdelay** - 最大延迟秒数。 类型: 浮点型。 值: 0 - (默认) 从不忽略日志行数; > 0.0 - 忽略旧行 以便在“maxdelay”秒内分析最新行。使用前请阅读[maxdelay](log_items#using_maxdelay_parameter) 说明!<br>**options** (自4.4.7版后) - 附加选项:<br>*mtime-noreread* - 非唯一记录, 仅在文件大小发生更改时重新读取 (忽略修改时间更改). (从5.0.2开始不推荐使用此参数, 因为现在忽略了mtime。)<br>**persistent\_dir** (从 5.0.18、5.4.9 版本开始，仅在 Unix 系统上的 zabbix_agentd 中；在 Agent2 中不支持) - 存储持久性的目录的绝对路径名文件。另请参阅有关[持久文件](log_items#notes-on-persistent-files-for-log-items)附加说明|该项必须配置为 [主动检查](/manual/appendix/items/activepassive#active_checks).<br>如果文件缺失或权限不允许访问，则监控项不受支持。<br><br>另请参阅有关 [日志监控](log_items)的其他信息<br><br>该项不支持Windows的事件日志。<br><br>自 Zabbix 3.2.0版本后开始支持。|
|logrt\[file\_regexp,\<regexp\>,\<encoding\>,\<maxlines\>,\<mode\>,\<output\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|监控轮换的日志文件。|日志|**file\_regexp** - 文件的绝对路径和正则[表达式](/manual/regular_expressions#overview)匹配的文件名模式 *请注意* 只有文件名是正则表达式<br>**regexp** - 描述正则[表达式](/manual/regular_expressions#overview)匹配的文件内容模式 <br>**encoding** - 编码 [标识符](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxlines** - agent 每秒将发送到 Zabbix server 或proxy的最大新行数。 此参数覆盖[zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd)的 'MaxLinesPerSecond'的值 <br>**mode** (自版本 2.0后) - 可能值:<br>*all* (默认), *skip* - 跳过旧数据的处理 (仅影响新创建的项目)。<br>**output** (自版本2.2后) - 一个可选的输出格式模板。**\\0** 转义序列被替换文本的匹配部分 (匹配从开始的第一个字符到结束的字符) 而 **\\N** (其中 N=1...9) 转义序列被替换为第N个匹配组 (或如果N超过捕获的组数，则为空字符串)。<br>**maxdelay** (自版本 3.2后) -最大的时延，以秒为单位。 类型: 浮点型。 值: 0 - (默认) 从不忽略日志文件行数; > 0.0 - 忽略旧行，以便在“maxdelay”秒内分析最新行。使用前请阅读 [maxdelay](log_items#using_maxdelay_parameter) 说明!<br>**options** (版本4.0和版本4.4.7后; *mtime-reread*, 和*mtime-noreread*选项 ) - 日志文件轮换类型和其他选项。可能的值:<br>*rotate* (默认),<br>*copytruncate* - 注意的是 *copytruncate* 不能和 *maxdelay*一起使用，在这种情况下 *maxdelay* 必须为0或未指定; 参阅 [copytruncate](log_items#notes_on_handling_copytruncate_log_file_rotation) 文档。<br>*mtime-reread* - 非唯一记录，如果修改时间或大小更改则重新读取(默认),<br>*mtime-noreread* -非唯一记录，仅在大小更改时重新读取 (忽略修改时间更改)。<br>**persistent\_dir** (从 5.0.18, 5.4.9版本开始,仅在Unix系统 zabbix\_agentd中; 不支持 Agent2) - 存储持久文件的目录的绝对路径名。另请参阅有关 [持久文件](log_items#notes-on-persistent-files-for-log-items)的附加说明。|该项必须配置为 [主动检查](/manual/appendix/items/activepassive#active_checks).<br>日志轮换基于文件的最后修改时间。<br><br请注意，logrt 旨在处理一个当前活动的日志文件，并轮换几个其他匹配的非活动文件。例如，如果一个目录有许多活动日志文件，则应为每个文件创建一个单独的 logrt 项。否则，如果一个 logrt 项获取太多文件，可能会导致内存耗尽和监控崩溃。<br><br>如果 `output` 留空 - 返回包含匹配文本的整行。请注意，除 'Result is TRUE' 之外的所有全局正则表达式类型始终返回整个匹配行，并且`output` 忽略该参数.<br><br>在agent上使用`output`参数进行内容提取。<br><br>例如:<br>=> logrt\["/home/zabbix/logs/\^logfile\[0-9\]{1,3}\$",,,100\] → 将匹配文件名如"logfile1"(不会匹配".logfile1")<br>=> logrt\["/home/user/\^logfile\_.\*\_\[0-9\]{1,3}\$","pattern\_to\_match","UTF-8",100\] → 将从文件名如 "logfile\_abc\_1" 或 "logfile\_\_001"中采集数据<br><br>*使用 `output` 参数 从日志记录中提取数字:*<br>=> logrt\[/app1/\^test.\*log\$,"task run \[0-9.\]+ sec, processed (\[0-9\]+) records, \[0-9\]+ errors",,,,\\1\] →将匹配一条日志记录 "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" 并发送 '6080' 到服务端。 因为发送的数值， 所以此项 "信息类型" 可以设置为 "数字 (无符号)" 这个值可以用于图形，触发器等。<br><br>*使用 `output` 参数可以在发送到服务端前重写日志记录:*<br>=> logrt\[/app1/\^test.\*log$,"(\[0-9 :-\]+) task run (\[0-9.\]+) sec, processed (\[0-9\]+) records, (\[0-9\]+) errors",,,,"\\1 RECORDS: \\3, ERRORS: \\4, DURATION: \\2"\] → 将匹配一条日志记录 "2015-11-13 10:08:26 task run 6.08 sec, processed 6080 records, 0 errors" 并发送修改记录到服务端 "2015-11-13 10:08:26 RECORDS: 6080, ERRORS: 0, DURATION: 6.08" 。<br><br>另请参阅 [日志监控](log_items)其他信息。|
|logrt.count\[file\_regexp,\<regexp\>,\<encoding\>,\<maxproclines\>,\<mode\>,\<maxdelay\>,\<options\>,\<persistent\_dir\>\]|<|<|<|<|
|<|轮换的监控日志文件中的匹配行数|整型|**file\_regexp** - 文件绝对路径和正则 [表达式](/manual/regular_expressions#overview) 所需匹配的文件名模式<br>**regexp** - 正则 [表达式](/manual/regular_expressions#overview) 所需的内容匹配模式<br>**encoding** - 编码 [标识符](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**maxproclines** - agent 每秒分析新增的最大行数 (不能超过10000)。在 [zabbix\_agentd.conf](/manual/appendix/config/zabbix_agentd)中设置的默认值是10\*'MaxLinesPerSecond'。<br>**mode** - 可能值:<br>*all* (默认), *skip* - 跳过旧数据的处理 (仅影响新创建的监控项).<br>**maxdelay** - 最大时延，以秒为单位。 类型: 浮点型。 值: 0 - (默认) 从不忽略日志文件行; > 0.0 - 以便在“maxdelay”秒内分析最新行。使用前请阅读[maxdelay](log_items#using_maxdelay_parameter)说明!<br>**options** (自版本 4.0和4.4.7后; *mtime-reread*和*mtime-noreread* 选项) - 日志文件轮换类型和其他选项， 可能的值:<br>*rotate* (默认),<br>*copytruncate* - 注意 *copytruncate* 不能与 *maxdelay*一起使用，这种情况下 *maxdelay* 必须为0或未指定; 参阅 [copytruncate](log_items#notes_on_handling_copytruncate_log_file_rotation) 说明,<br>*mtime-reread* - 非唯一记录, 如果修改时间或大小改变重新读 (默认),<br>*mtime-noreread* - 非唯一记录, 仅当大小改变时重新读 (忽略修改时间的改变)。<br>**persistent\_dir** (自版本 5.0.18和 5.4.9后, 仅在Unix系统上的zabbix\_agentd中;不支持 Agent2) - 存储持久文件的目录的绝对路径名。另请参阅有关[持久文件](log_items#notes-on-persistent-files-for-log-items)附加说明。|该监控项必须配置为 [主动检查](/manual/appendix/items/activepassive#active_checks).<br>日志轮换基于文件的最后修改时间。<br><br>另请参阅有关[日志监控](log_items)其他信息<br><br>此监控项不支持Windows事件日志<br><br>自Zabbix 3.2.0后开始支持|
|modbus.get\[endpoint,<slave id>,<function>,<address>,<count>,<type>,<endianness>,<offset>\]|<|<|<|<|
|<|读取Modbus数据|JSON 对象|**endpoint** - 终端定义为 `protocol://connection_string`<br>**slave id** - 从机 ID<br>**function** - Modbus 函数<br>**address** - 第一个注册地址, 线圈 或输入<br>**count** - 读取的记录数量<br>**type** - 数据类型<br>**endianness** - 字节序配置<br>**offset** - 寄存器数, 从 '地址'开始, 其结果将被丢弃。<br><br>参阅参数的[详细描述](/manual/appendix/items/modbus) 。|自 Zabbix 5.2.0后开始支持|
|net.dns\[<ip>,name,<type>,<timeout>,<count>,<protocol>\]|<|<|<|<|
|<|检查DNS服务是否启动|0 - DNS 已关闭 (服务器并没有响应或 DNS解析失败)<br><br>1 - DNS 已启动|**ip** - DNS服务器IP地址 (默认DNS服务器上的IP留空,在Windows上忽略)<br>**name** -要查询的DNS名称<br>**type** - 要查询的记录类型 (默认为 *SOA*)<br>**timeout** (在Windows上忽略) -请求超时秒数 (默认是 1 秒)<br>**count** (在在Windows上忽略) -请求的尝试次数 (默认是 2)<br>**protocol** (自版本3.0后) - 用于执行 DNS 查询的协议: *udp* (默认) 或 *tcp*|例如:<br>=> net.dns\[8.8.8.8,example.com,MX,2,1\]<br><br>可能的值 `type` 是:<br>*ANY*, *A*, *NS*, *CNAME*, *MB*, *MG*, *MR*, *PTR*, *MD*, *MF*, *MX*, *SOA*, *NULL*, *WKS* (Windows除外), *HINFO*, *MINFO*, *TXT*, *SRV*<br><br>不支持国际化域名，请改用 IDNA 编码名称。<br><br>从 Zabbix 1.8.6 (Unix) 和 2.0.0 (Windows) 开始支持 SRV 记录类型.<br><br>Zabbix 2.0 之前的命名（仍然支持）: *net.tcp.dns*|
|net.dns.record\[<ip>,name,<type>,<timeout>,<count>,<protocol>\]|<|<|<|<|
|<|执行 DNS 查询。|具有所需信息类型的字符串|**ip** - DNS 服务器的 IP 地址（默认 DNS 服务器留空，在 Windows 上忽略）<br>**name** - 要查询的 DNS 名称<br>**type** - 要查询的记录类型(默认为 *SOA*)<br>**timeout** (在 Windows 上忽略) - 请求超时秒数 (默认是 1 秒)<br>**count** (在 Windows 上忽略) - 请求的尝试次数(默认是2)<br>**protocol**(自 3.0 版起) - 用于执行 DNS 查询的协议: *udp* (默认) 或 *tcp*|例如:<br>=> net.dns.record\[8.8.8.8,example.com,MX,2,1\]<br><br>可能的值 `type` 是:<br>*ANY*, *A*, *NS*, *CNAME*, *MB*, *MG*, *MR*, *PTR*, *MD*, *MF*, *MX*, *SOA*, *NULL*, *WKS* (Windows除外), *HINFO*, *MINFO*, *TXT*, *SRV*<br><br>不支持国际化域名，请改用 IDNA 编码名称。<br><br>从 Zabbix 1.8.6 (Unix) 和 2.0.0 (Windows) 开始支持 SRV 记录类型。<br><br>Zabbix 2.0 之前的命名（仍然支持）: *net.tcp.dns.query*|
|net.if.collisions\[if\]|<|<|<|<|
|<|Number of out-of-window collisions.|整型|**if** - 网络接口名称| |
|net.if.discovery|<|<|<|<|
|<|网络接口列表.用于低级别的发现。|JSON 对象| |自 Zabbix 2.0后支持<br><br>在 FreeBSD, OpenBSD 和 NetBSD 上从 Zabbix 2.2后开始支持<br><br>某些Windows版本 (如 Server 2008)可能需要安装最新更新以支持接口名称中的非ASCII 字符。|
|net.if.in\[if,<mode>\]|<|<|<|<|
|<|网络接口的传入流量统计|整型|**if** - 网络接口名称 (Unix); 网络接口完整描述或 IPv4 地址；或者，如果在大括号内，网络接口GUID（窗口）<br>**mode** - 可能的值:<br>*bytes* - 字节数 (默认)<br>*packets* - 包数<br>*errors* - 错误数<br>*dropped* - 丢弃的数据包数量<br>*overruns (fifo)* - FIFO 缓冲错误数<br>*frame* - 数据包帧错误数<br>*compressed* - 设备驱动程序发送或接收的压缩数据包数<br>*multicast* - 设备驱动程序接收的多播帧数|在Windows上, 该监控项从64位计数器中获取值（如果可用），Windows Vista 和 Windows Server 2008 中引入了 64 位接口统计计数器。如果 64 位计数器不可用，agent 将使用 32 位计数器。 <br><br>从 Zabbix 1.8.6 开始支持 Windows 上的多字节接口名称<br><br>例如:<br>=> net.if.in\[eth0,errors\]<br>=> net.if.in\[eth0\]<br><br>您可以使用 net.if.discovery 或 net.if.list 项获取 Windows 上的网络接口描述。<br><br>您可以将此键与预处理每秒更改步骤一起使用，以获取每秒字节数统计信息。|
|net.if.out\[if,<mode>\]|<|<|<|<|
|<|网络接口的传出流量统计|整型|**if** - 网络接口名称 (Unix); 网络接口完整描述或 IPv4 地址；或者，如果在大括号内，网络接口GUID（窗口）<br>**mode** - 可能的值:<br>*bytes* - 字节数 (默认)<br>*packets* -包数<br>*errors* - 错误数<br>*dropped* - 丢弃的包的数量<br>*overruns (fifo)* - FIFO 缓冲错误数 <br>*collisions (colls)* - 接口上检测到的冲突数<br>*carrier* - 在设备驱动程序检测到的载体丢失数<br>*compressed* -设备驱动程序传输的压缩数据包数|在 Windows 上，该项目从 64 位计数器中获取值（如果可用）。Windows Vista 和 Windows Server 2008 中引入了 64 位接口统计计数器。如果 64 位计数器不可用，agent 将使用 32 位计数器。<br><br>从 Zabbix 1.8.6 版本开始支持 Windows 上的多字节接口名称。<br><br>例如:<br>=> net.if.out\[eth0,errors\]<br>=> net.if.out\[eth0\]<br><br>您可以使用 net.if.discovery 或 net.if.list 项获取 Windows 上的网络接口描述。<br><br>您可以将此键与预处理每秒更改步骤一起使用，以获取每秒字节数统计信息。|
|net.if.total\[if,<mode>\]|<|<|<|<|
|<|网络接口上传入和传出流量统计的总和。|整型|**if** - 网络接口名称 (Unix); 网络接口完整描述或 IPv4 地址；或者，如果在大括号内，网络接口GUID（窗口）<br>**mode** -可能值:<br>*bytes* - 字节数 (默认)<br>*packets* - 包数<br>*errors* - 错误数<br>*dropped* - 丢弃的数据包数量<br>*overruns (fifo)* - FIFO缓冲错误数<br>*compressed* - 设备驱动程序发送或接收的压缩数据包数|在 Windows 上，该项目从 64 位计数器中获取值（如果可用）。Windows Vista 和 Windows Server 2008 中引入了 64 位接口统计计数器。如果 64 位计数器不可用，agent 将使用 32 位计数器。<br><br>例如:<br>=> net.if.total\[eth0,errors\]<br>=> net.if.total\[eth0\]<br><br>您可以使用 net.if.discovery 或 net.if.list 项获取 Windows 上的网络接口描述。<br><br>可以将此键与预处理每秒更改步骤一起使用，以获取每秒字节数统计信息。<br><br>请注意，仅当 net.if.in 和 net.if.out 都在您平台上的丢弃数据包时，才支持丢弃数据包。|
|net.tcp.listen\[port\]|<|<|<|<|
|<|检查TCP端口是否处于监听状态|0 - 它不处于监听状态<br><br>1 - 它处于监听状态|**port** - TCP端口号|例如:<br>=> net.tcp.listen\[80\]<br><br> 自 Zabbix 1.8.4后在Linux上支持<br><br>自 Zabbix 3.0.0后, 在 Linux 内核 2.6.14及以上,如果可能，从内核的 NETLINK 接口获取有关侦听 TCP 套接字的信息. 否则，将从 /proc/net/tcp 和 /proc/net/tcp6 文件中检索信息。|
|net.tcp.port\[<ip>,port\]|<|<|<|<|
|<| 检查是否可以与指定端口建立 TCP 连接。|0 -不能连接<br><br>1 - 能连接|**ip** - IP 或 DNS 名称 (默认是 127.0.0.1)<br>**port** - 端口号|例如:<br>=> net.tcp.port\[,80\] → 可用于测试在端口80上运行Web 服务的可用性<br><br>对于简单的TCP性能测试，使用 net.tcp.service.perf\[tcp,<ip>,<port>\]<br><br>请注意，这些检查可能会导致增加系统守护程序日志文件中的额外信息（通常会记录SMTP和SSH会话）。|
|net.tcp.service\[service,<ip>,<port>\]|<|<|<|<|
|<|检查服务是否正在运行并接受 TCP 连接。|0 - 服务关闭<br><br>1 - 服务正在运行|**service** - 任意一个:<br>*ssh*, *ldap*, *smtp*, *ftp*, *http*, *pop*, *nntp*, *imap*, *tcp*, *https*, *telnet* (另见 [详情](/manual/appendix/items/service_check_details))<br>**ip** - IP地址 (默认是 127.0.0.1)<br>**port** - 端口号 (默认为标准服务使用端口号)|例如:<br>=> net.tcp.service\[ftp,,45\] → 用于测试在tcp端口45上的FTP服务的可用性.<br><br>请注意，这些检查可能会导致系统守护程序日志文件中出现额外消息（SMTP 和 SSH 会话正在通常记录）。<br><br>目前不支持检查加密协议（如端口 993 上的 IMAP 或端口 995 上的 POP）。作为一种解决方法，请使用 net.tcp.port 进行此类检查。<br><br>仅 Zabbix agent 2 支持在 Windows 上检查 LDAP 和 HTTPS。<br><br>请注意，telnet 检查会查找登录提示（末尾为“：”）。<br><br>请你参阅[已知问题](/manual/installation/known_issues#https_checks)用于检查HTTPS服务。<br><br>从Zabbix2.0后开始支持*https* 和 *telnet* 服务。|
|net.tcp.service.perf\[service,<ip>,<port>\]|<|<|<|<|
|<|检查TCP服务的性能。|0 - 服务已关闭<br><br>seconds - 连接到服务花费的时间（秒）|**service** -以下任意一个:<br>*ssh*, *ldap*, *smtp*, *ftp*, *http*, *pop*, *nntp*, *imap*, *tcp*, *https*, *telnet* (见 [详细](/manual/appendix/items/service_check_details))<br>**ip** - IP地址 (默认是 127.0.0.1)<br>**port** - 端口号 (默认为标准服务使用端口号)|例如:<br>=> net.tcp.service.perf\[ssh\] → 可用于测试来自 SSH 服务器的初始响应速度。<br><br>目前不支持检查加密协议（如端口 993 上的 IMAP 或端口 995 上的 POP）。作为一种解决方法，请使用 net.tcp.service.perf\[tcp,<ip>,<port>\] 进行此类检查。<br><br>仅 Zabbix agent 2 支持在 Windows 上检查 LDAP 和 HTTPS。<br><br>请注意，telnet 检查会查找登录提示（末尾为“：”）。<br><br>请你参阅[已知问题](/manual/installation/known_issues#https_checks)用于检查HTTPS服务。<br><br>从Zabbix2.0后开始支持*https* 和 *telnet* 服务。|
|net.tcp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]|<|<|<|<|
|<|返回与参数匹配的套接字数|整型|**laddr** - 本地 IPv4/6 地址 或 CIDR 子网<br>**lport** - 本地的端口号或服务名称<br>**raddr** - 远程 IPv4/6 地址或CIDR子网<br>**rport** - 远程端口号或服务名称<br>**state** - 连接状态(*established*, *syn\_sent*, *syn\_recv*, *fin\_wait1*, *fin\_wait2*, *time\_wait*, *close*, *close\_wait*, *last\_ack*, *listen*, *closing*)|Zabbix agent和Zabbix agent 2均在Linux上支持此项，64位 Windows在Zabbix agent 2上支持此项<br><br>例如:<br>=> net.tcp.socket.count\[,80,,,established\] →检查本地 TCP 端口 80 是否处于“已建立”状态<br><br>从 Zabbix 6.0后开始支持此项|
|net.udp.listen\[port\]|<|<|<|<|
|<|检查UDP端口是否处于监听状态|0 - 它不处于监听状态<br><br>1 -它处于监听状态|**port** - UDP端口号|例如:<br>=> net.udp.listen\[68\]<br><br>在Linux上自Zabbix 1.8.4后支持|
|net.udp.service\[service,<ip>,<port>\]|<|<|<|<|
|<|检查服务是否正在运行并响应 UDP 请求。|0 - 服务已关闭<br><br>1 - 服务正在运行|**service** - *ntp* (见 [详情](/manual/appendix/items/service_check_details))<br>**ip** -IP地址 (默认是 127.0.0.1)<br>**port** - 端口号(默认为标准服务使用端口号)|例:<br>=> net.udp.service\[ntp,,45\] → 可用于测试 UDP 45 端口 NTP 服务的可用性。<br><br> Zabbix 3.0.0后开始支持此项, 但*ntp* 服务可用于以前版本的 net.tcp.service\[\]监控项中|
|net.udp.service.perf\[service,<ip>,<port>\]|<|<|<|<|
|<|检查UDP服务性能。|0 - 服务已关闭<br><br>seconds - 等待服务响应秒数|**service** - *ntp* (见 [详情](/manual/appendix/items/service_check_details))<br>**ip** - IP地址 (默认是127.0.0.1)<br>**port** - 端口号 (默认为标准服务使用端口号)|例:<br>=> net.udp.service.perf\[ntp\] → 可用于测试来自 NTP 服务的响应时间。<br><br>自 Zabbix 3.0.0后开始支持该项，但 *ntp* 服务可用于以前版本的net.tcp.service\[\]监控项中|
|net.udp.socket.count\[<laddr>,<lport>,<raddr>,<rport>,<state>\]|<|<|<|<|
|<|返回与参数匹配的 TCP 套接字数。|整型|**laddr** -本地IPv4/6地址或CIDR子网地址<br>**lport** -本地端口号或服务名称<br>**raddr** - 远程IPv4/6地址或CIDR子网<br>**rport** - 远程端口号或服务名称<br>**state** - 连接状态 (*established*, *unconn*)|Zabbix agent和Zabbix agent 2均在Linux上支持此项，64位 Windows在Zabbix agent 2上支持此项。<br><br>Example:<br>=> net.udp.socket.count\[,,,,listening\] → 检查是否有任何 UDP 套接字处于“监听”状态<br><br>从 Zabbix 6.0 开始支持此项|
|proc.cpu.util\[<name>,<user>,<type>,<cmdline>,<mode>,<zone>\]|<|<|<|<|
|<|进程CPU使用百分比.|浮点型|**name** -进程名 (默认是 *all processes*)<br>**user** - 用户名称 (默认是*all users*)<br>**type** -CPU使用率类型:<br>*total* (默认), *user*, *system*<br>**cmdline** - 可按命令行过滤(它是一个正则[表达式](/manual/regular_expressions#overview))<br>**mode** - 数据搜集模式: *avg1* (默认), *avg5*, *avg15*<br>**zone** - 目标区域: *current* (默认), *all*. 这个参数仅在Solaris平台上支持|例:<br>=> proc.cpu.util\[,root\] → 在root用户下运行的所有进程的CPU使用率<br>=> proc.cpu.util\[zabbix\_server,zabbix\] →在zabbix用户下运行的所有 zabbix\_server 进程的CPU使用率<br><br>T返回值基于单个 CPU 核心利用率百分比。例如，完全使用两个内核的进程的 CPU 利用率为 200%。<br><br>进程 CPU 利用率数据由支持最多 1024 个唯一（按名称、用户和命令行）查询的收集器收集。在过去 24 小时内未访问的查询将从收集器中删除。<br><br>*请注意* 将zone参数设置为*current* （或默认值）如果 agent 已在不支持区域的 Solaris 上编译，但在支持区域的较新 Solaris 上运行，则 agent 将返回 NOTSUPPORTED（ agent 不能将结果限制为仅当前区域）。但是，在这种情况下，*all*都支持。<br><br>自 Zabbix 3.0.0 起支持此键，并且可在多个平台上使用 (请参阅 [平台支持的监控项](/manual/appendix/items/supported_by_platform))。|
|proc.mem\[<name>,<user>,<mode>,<cmdline>,<memtype>\]|<|<|<|<|
|<|进程使用的内存（以字节为单位）|整型 - 当 `mode` 为 *max*, *min*, *sum*时<br><br>浮点数 - 当 `mode` 为 *avg*时|**name** -进程名 (默认是 *all processes*)<br>**user** - 用户名 (默认是 *all users*)<br>**mode** - 可能的值:<br>*avg*, *max*, *min*, *sum* (默认)<br>**cmdline** - 按命令行过滤(它是一个正则 [表达式](/manual/regular_expressions#overview))<br>**memtype** - 进程使用的[内存类型](/manual/appendix/items/proc_mem_notes) |例如:<br>=> proc.mem\[,root\] → 运行在root用户下的所有进程使用的内存<br>=> proc.mem\[zabbix\_server,zabbix\] → 运行在zabbix用户下的所有zabbix\_server进程使用的内存<br>=> proc.mem\[,oracle,max,oracleZABBIX\] → 在oracle用户下，包含有oracleZABBIX命令行运行的所有内存最多的内存<br><br>*需要注意*:当多个进程使用共享内存时，进程使用的内存总和可能会导致大到不切实际。<br><br>参考 [说明](/manual/appendix/items/proc_mem_num_notes) 关于选择进程 `name` 和 `cmdline` 参数 (指定为Linux).<br><br>当此项从命令行调用并包含命令行参数时 (例如 使用 agent 测试模式: `zabbix_agentd -t proc.mem[,,,apache2]`), 一个额外的进程将被计算在内，因为 agent 将计算自己。<br><br>从Zabbix3.0.0起， `memtype` 参数开始支持多个 [平台](/manual/appendix/items/supported_by_platform) |
|proc.num\[<name>,<user>,<state>,<cmdline>,<zone>\]|<|<|<|<|
|<|进程数量|整型|**name** - 进程名称 (默认为 *all processes*)<br>**user** - 用户名 (默认为 *all users*)<br>**state** (*disk* 和 *trace* 选项从3.4.0起) - 可能值:<br>*all* (默认),<br>*disk* - 不间断睡眠,<br>*run* - 运行,<br>*sleep* - 可中断的睡眠,<br>*trace* - 停止,<br>*zomb* - 僵尸<br>**cmdline** - 按命令行过滤(它是一个正则[表达式](/manual/regular_expressions#overview))<br>**zone** -目标区域: *current* (默认), *all*. 此参数仅在 Solaris 上受支持。|例如:<br>=> proc.num\[,mysql\] → 在mysql用户下运行的进程数<br>=> proc.num\[apache2,www-data\] → www-data 用户下运行的 apache2 进程数<br>=> proc.num\[,oracle,sleep,oracleZABBIX\] → 在oracleZABBIX命令行下的oracle用户运行的睡眠状态进程数<br><br> [说明](/manual/appendix/items/proc_mem_num_notes) 关于选择进程 `name` 和 `cmdline` 参数 (指定于Linux)。<br><br>在Windows上仅支持`name`和`user`参数<br><br>当此项从命令行调用并包含命令行参数时 (例如 使用 agent 测试模式: `zabbix_agentd -t proc.num[,,,apache2]`), 一个额外的进程将被计算在内，因为 agent 将计算自己。<br><br>*请注意* 将zone参数设置为*current* （或默认值）如果 agent 已在不支持区域的 Solaris 上编译，但在支持区域的较新 Solaris 上运行，则 agent 将返回 NOTSUPPORTED（ agent 不能将结果限制为仅当前区域）。但是，在这种情况下，*all*都支持。|
|sensor\[device,sensor,<mode>\]|<|<|<|<|
|<|硬件传感器读数|浮点型|**device** - 设备名称<br>**sensor** - 传感器名称<br>**mode** - 可能的值:<br>*avg*, *max*, *min* (如果省略此参数，设备和传感器将逐字处理).|在linux2.4上读取 /proc/sys/dev/sensors <br><br>例如:<br>=> sensor\[w83781d-i2c-0-2d,temp1\]<br><br>在 Zabbix 1.8.4之前, *sensor\[temp1\]* 格式被使用。|
|^|^|^|^|在Linux2.6+上读取 /sys/class/hwmon <br><br>请参阅Linux [sensor](/manual/appendix/items/sensor)项目中 更详细的说明|
|^|^|^|^|读取OpenBSD上的 *hw.sensors* MIB <br><br>例如:<br>=> sensor\[cpu0,temp0\] → 一个CPU的温度<br>=> sensor\["cpu\[0-2\]$",temp,avg\] → 前三个CPU温度的平均值<br><br>自Zabbix 1.8.4后开始支持OpenBSD|
|system.boottime|<|<|<|<|
|<|系统启动时间。|整型 (Unix时间戳)| | |
|system.cpu.discovery|<|<|<|<|
|<|检测到的CPU/CPUs的内核列表，用于低级别发现。|JSON 对象| |自2.4.0后，支持所有平台|
|system.cpu.intr|<|<|<|<|
|<|设备中断。|整型| | |
system.cpu.load\[<cpu>,<mode>\]|<|<|<|<|
|<|[CPU 负载](http://en.wikipedia.org/wiki/Load_(computing)).|Float|**cpu** - possible values:<br>*all* (default), *percpu* (从版本2.0开始; 总负载除以在线CPU数)<br>**mode** - 可能的值：<br>*avg1* (一分钟的平均值，默认), *avg5*, *avg15*|Example:<br>=> system.cpu.load\[,avg5\].|
|system.cpu.num\[<type>\]|<|<|<|<|
|<|CPU数量。|Integer|**type** - 可能的值：<br>*online* (default), *max*|Example:<br>=> system.cpu.num|
|system.cpu.switches|<|<|<|<|
|<|上下文切换次数。|整型| | |
|system.cpu.util\[<cpu>,<type>,<mode>,<logical\_or\_physical>\]|<|<|<|<|
|<|CPU 利用率百分比。|浮点型|**cpu** - *<CPU number>* or *all* (default)<br>**type** - 可能的值：<br>*user* (default), *idle*, *nice*, *system* （Windows默认）, *iowait*, *interrupt*, *softirq*, *steal*, *guest* (Linux内核版本2.6.24及以上), *guest\_nice* (Linux内核版本2.6.33及以上).<br>可在[平台特性](/manual/appendix/items/supported_by_platform) 查看更多此参数的细节。<br>**mode** - 可能的值：<br>*avg1* (一分钟的平均值，默认), *avg5*, *avg15*<br>**logical\_or\_physical** (从5.0.3版本开始; 仅支持AIX) - 可能的值： *logical* （默认）, *physical*. 此参数仅支持AIX。|Example:<br>=> system.cpu.util\[0,user,avg5\]<br><br>曾用名: *system.cpu.idleX, system.cpu.niceX, system.cpu.systemX, system.cpu.userX*|
|system.hostname\[<type>, <transform>\]|<|<|<|<|
|<|系统主机名|字符串|**type** (在版本5.4.7前仅支持Windows) - 可能的值： *netbios* （Windows默认）, *host* (Linux默认), *shorthost* (从5.4.7版本开始; 返回第一个"."前的主机名或在没有"."时返回完整的主机名).<br>**transform** (从5.4.7版本开始) - 可能的值：<br>*none* （默认）, *lower* (转换到小写)|这个值通过Windows的函数 GetComputerName() (**netbios**)或者gethostname() (**host**) 和其他操作系统的 "hostname" 命令获取。<br><br>返回值示例：<br>*在Linux上*:<br>=> system.hostname → linux-w7x1<br>=> system.hostname → example.com<br>=> system.hostname\[shorthost\] → example<br>*on Windows*:<br>=> system.hostname → WIN-SERV2008-I6<br>=> system.hostname\[host\] → Win-Serv2008-I6LonG<br>=> system.hostname\[host,lower\] → win-serv2008-i6long<br><br>可查看[更详细的描述](/manual/appendix/install/windows_agent#configuration).|
|system.hw.chassis\[<info>\]|<|<|<|<|
|<|板卡信息。|字符串|**info** - one of full （默认）, model, serial, type or vendor|Example: system.hw.chassis\[full\]<br>Hewlett-Packard HP Pro 3010 Small Form Factor PC CZXXXXXXXX Desktop\]<br><br>这个键依赖于[SMBIOS](http://en.wikipedia.org/wiki/System_Management_BIOS) 表的可用性。<br>会尝试从sysfs读取DMI表, 如果访问sysfs 失败，会尝试直接读取内存。<br><br>需要**Root权限**因为这个值是通过读取 sysfs 或 memory 获得的。<br><br>从Zabbix 2.0开始支持。|
|system.hw.cpu\[<cpu>,<info>\]|<|<|<|<|
|<|CPU 信息。|字符串或整型|**cpu** - *<CPU number>* or *all* （默认）<br>**info** - 可能的值：<br>*full* （默认）, *curfreq*, *maxfreq*, *model* or *vendor*|Example:<br>=> system.hw.cpu\[0,vendor\] → AuthenticAMD<br><br>从/proc/cpuinfo 和 /sys/devices/system/cpu/\[cpunum\]/cpufreq/cpuinfo\_max\_freq 获取信息。<br><br>如果设置了CPU数和 *curfreq* 或 *maxfreq*，会返回数字值(Hz)。<br><br>从Zabbix 2.0开始支持。|
|system.hw.devices\[<type>\]|<|<|<|<|
|<|PCI或USB设备列表。|文本|**type** (从版本2.0开始) - *pci* （默认） or *usb*|Example:<br>=> system.hw.devices\[pci\] → 00:00.0 Host bridge: Advanced Micro Devices \[AMD\] RS780 Host Bridge<br>\[..\]<br><br>返回lspci或lsusb程序的结果（不带参数执行）。|
|system.hw.macaddr\[<interface>,<format>\]|<|<|<|<|
|<|MAC地址列表。|字符串|**interface** - *all* （默认）或 [正则表达式](/manual/regular_expressions#overview)<br>**format** - *full* （默认） 或 *short*|列出接口名称匹配`接口`[正则表达式](/manual/regular_expressions#overview)的MAC地址列表(*all* 列出所有接口).<br><br>示例：<br>=> system.hw.macaddr\["eth0$",full\] → \[eth0\] 00:11:22:33:44:55<br><br>If 如果`format`被设为*short*，接口名称和重复的MAC地址将不会列出。<br><br>从Zabbix 2.0开始支持。|
|system.localtime\[<type>\]|<|<|<|<|
|<|系统时间。|整型 - `type`是*utc*时<br><br>字符串 - `type`是*local*时|**type** (从版本2.0开始) - 可能的值：<br>*utc* - （默认）从 (00:00:00 UTC, January 1, 1970) 开始计算的时间, 单位是秒。<br>*local* - 格式为'yyyy-mm-dd,hh:mm:ss.nnn,+hh:mm'的时间<br>|只能用于[被动检查](/manual/appendix/items/activepassive#passive_checks)。<br><br>示例：<br>=> system.localtime\[local\] → 用这个键创建一个监控项用于在*Clock* [仪表盘组件](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets#clock)展示主机时间。|
|system.run\[command,<mode>\]|<|<|<|<|
|<|在主机上运行特定的命令。|命令的文本结果<br><br>1 - `mode`为*nowait*时(无论命令结果如何)|**command** - 待执行的命令<br>**mode** - 可能的值：<br>*wait* - 等待执行结束（默认）,<br>*nowait* - 不等待|包括被截取的空白符，最大可以返回512KB的数据。<br>命令的输出必须是文本才能正常处理。<br><br>示例：<br>=> system.run\[ls -l /\] → 根目录的详细文件列表。<br><br>*Note*: system.run监控项默认被禁用。在[启用监控项](/[[/manual/config/items/restrict_checks)学习如何启用。<br><br>这个监控项的返回值是命令产生的标准输出和标准错误，未检查退出码。<br><br>从 Zabbix 2.4.0 开始允许空结果。<br>也可查看[命令执行](/manual/appendix/command_execution)。|
|system.stat\[resource,<type>\]|<|<|<|<|
|<|系统统计数据。|整型或浮点型|**ent** - 该区域可获取的处理器单元数量（浮点型）<br>**kthr,<type>** - 关于内核线程状态的信息:<br>*r* - 可运行的内核线程的平均数（浮点型）<br>*b* - 虚拟内存管理器等待队列中内核线程的平均数（浮点型）<br>**memory,<type>** - 虚拟和实际内存的使用信息：<br>*avm* - 活跃的虚拟页 (整型)<br>*fre* - 可用列表的大小 (整型)<br>**page,<type>** - 页错误和分页活动的信息：<br>*fi* - 每秒文件入页（浮点型）<br>*fo* - 每秒文件出页 （浮点型）<br>*pi* - 从分页空间入页（浮点型）<br>*po* - 向分页空间出页（浮点型）<br>*fr* - 页释放（页替换）（浮点型）<br>*sr* - 通过页替换算法扫描到的页（浮点型）<br>**faults,<type>** - 陷阱和中断率：<br>*in* - 设备中断（浮点型）<br>*sy* - 系统调用（浮点型）<br>*cs* - 内核线程上下文切换 （浮点型）<br>**cpu,<type>** - 处理器时间的分类百分比：<br>*us* - 用户时间（浮点型）<br>*sy* - 系统时间（浮点型）<br>*id* - 空闲时间（浮点型）<br>*wa* - 系统在磁盘或网络文件系统I/O请求多时的空闲时间（浮点型）<br>*pc* - 物理处理器消耗的时间（浮点型）<br>*ec* - 标称计算能力的消耗的百分比（浮点型）<br>*lbusy* - 在用户级和系统级运行时，逻辑处理器的使用百分比 （浮点型）<br>*app* - 共享池中可用物理处理器数量（浮点型）<br>**disk,<type>** - 磁盘统计信息：<br>*bps* - 磁盘驱动器传输的数据量，单位是字节/秒（整型）<br>*tps* - 发送给物理磁盘/磁带的每秒传输次数（浮点型）|<|
|<|^|^|Comments|<|
|<|^|^|从Zabbix 1.8.1开始，此监控项仅被AIX[支持](/manual/appendix/items/supported_by_platform)。<br>请注意这些监控项的以下限制：<br>=> system.stat\[cpu,app\] - 仅支持"Shared"类型的AIX LPAR<br>=> system.stat\[cpu,ec\] - 仅支持"Shared"和"Dedicated"类型的AIX LPAR（"Dedicated"一直返回100（百分比））<br>=> system.stat\[cpu,lbusy\] - 仅支持"Shared"类型的AIX LPAR<br>=> system.stat\[cpu,pc\] - 仅支持"Shared"和"Dedicated"类型的AIX LPAR<br>=> system.stat\[ent\] - 仅支持"Shared"和"Dedicated"类型的AIX LPAR|<|
|system.sw.arch|<|<|<|<|
|<|软件架构信息。|字符串| |示例：<br>=> system.sw.arch → i686<br><br>通过uname()函数获取信息。<br><br>从Zabbix 2.0开始支持。|
|system.sw.os\[<info>\]|<|<|<|<|
|<|操作系统信息。|字符串|**info** - 可能的值：<br>*full* （默认）, *short* or *name*|示例：<br>=> system.sw.os\[short\]→ Ubuntu 2.6.35-28.50-generic 2.6.35.11<br><br>信息通过以下方式（请注意并非所有发行版本都存在所有文件和选项）获取：<br>/proc/version (*full*)<br>/proc/version\_signature (*short*)<br>PRETTY\_NAME 参数在支持的系统从/etc/os-release获取，或/etc/issue.net (*name*)<br><br>从Zabbix 2.0开始支持。|
|system.sw.packages\[<package>,<manager>,<format>\]|<|<|<|<|
|<|已安装的包列表。|文本|**package** - *all* （默认） 或[正则表达式](/manual/regular_expressions#overview)<br>**manager** - *all* （默认）或包管理器<br>**format** - *full* （默认）或*short*|按首字母顺序，列出匹配`package`[正则表达式](/manual/regular_expressions#overview)的已安装的包名 (*all* 列出全部).<br><br>示例：<br>=> system.sw.packages\[mini,dpkg,short\] → python-minimal, python2.6-minimal, ubuntu-minimal<br><br>支持的包管理器（执行的命令）：<br>dpkg (dpkg --get-selections)<br>pkgtool (ls /var/log/packages)<br>rpm (rpm -qa)<br>pacman (pacman -Q)<br><br>如果`format`设为*full*，包按照包管理器分组（每个包管理器在单独的行，开头是方括号中的包管理器名称）。<br>如果`format`设为*short*，包不会分组，会列在一行中。<br><br>从Zabbix 2.0开始支持。|
|system.swap.in\[<device>,<type>\]|<|<|<|<|
|<|交换入（从设备到内存）统计|整型|**device** - 用于交换的设备（默认是*all*）<br>**type** - 可能的值：<br>*count* （交换入的数量）, *sectors* （交换入的分区）, *pages* （交换入的页）.<br>也可在[平台特性](/manual/appendix/items/supported_by_platform)查看此参数的详情。|示例：<br>=> system.swap.in\[,pages\]<br><br>此信息的来源是：<br>/proc/swaps, /proc/partitions, /proc/stat (Linux 2.4)<br>/proc/swaps, /proc/diskstats, /proc/vmstat (Linux 2.6)|
|system.swap.out\[<device>,<type>\]|<|<|<|<|
|<|交换出（从内存到设备）统计。|整型|**device** - 用于交换的设备（默认是*all*）<br>**type** - 可能的值：<br>*count* （交换出的数量）， *sectors* （交换出的分区）, *pages* （交换出的页）。<br>也可在[平台特性](/manual/appendix/items/supported_by_platform)查看此参数的详情。|示例：<br>=> system.swap.out\[,pages\]<br><br>此信息的来源是：<br>/proc/swaps, /proc/partitions, /proc/stat (Linux 2.4)<br>/proc/swaps, /proc/diskstats, /proc/vmstat (Linux 2.6)|
|system.swap.size\[<device>,<type>\]|<|<|<|<|
|<|交换区空间大小，字节数或总量的百分比。|Integer - 字节数的类型<br><br>Float - 百分比的类型|**device** - 用于交换的设备(默认是*all*)<br>**type** - 可能的值：<br>*free* (空闲交换空间，默认), *pfree* (空闲交换空间的百分比), *pused* (已用交换空间的百分比), *total* (总交换空间), *used* (已用交换空间)<br>请注意 *pfree*, *pused* 在交换空间为0时不支持Windows。<br>也可在[平台特性](/manual/appendix/items/supported_by_platform)查看此参数的详情。|示例：<br>=> system.swap.size\[,pfree\] → 空闲交换空间的百分比<br><br>如果未设置*device*的值，Zabbix agent仅会考虑账户交换设备（文件），忽略物理内存。比如，在 Solaris 系统 *swap -s* 命令包括物理内存的一部分以及交换设备（不同于*swap -l*）。<br><br>请注意此键在虚拟化（VMware ESXi, VirtualBox）Windows平台可能报告错误的交换空间大小/百分比。在这种情况下你可使用`perf_counter[\700(_Total)\702]`键来获取正确的交换空间百分比。|
|system.uname|<|<|<|<|
|<|系统标识|字符串| |返回值实例（Unix）：<br>FreeBSD localhost 4.2-RELEASE FreeBSD 4.2-RELEASE \#0: Mon Nov i386<br><br>返回值实例（Windows）：<br>Windows ZABBIX-WIN 6.0.6001 Microsoft® Windows Server® 2008 Standard Service Pack 1 x86<br><br>在 Unix，从 Zabbix 2.2.0 开始，此值通过uname()系统调用获取，在此之前通过调用"uname -a"获取。此监控项的值可能和"uname -a"的输出不同，并且不包括"uname -a"打印的从其他来源获取的额外信息。<br><br>在 Windows 系统，从 Zabbix 3.0 开始，此值通过 Win32\_OperatingSystem 和 Win32\_Processor WMI 类获取。在此之前通过不稳定的 Windows APIs 和无稳定的注册表键获取。OS名（包括版本）可能被翻译到了用户的显示语言。在 Windows 的某些版本，OS 名包括商标符号和额外的空格。<br><br>请注意在Windows，此监控项返回 OS 架构，而在 Unix 返回 CPU 架构。|
|system.uptime|<|<|<|<|
|<|系统运行时间，单位是秒。|整型| |在[监控项配置](/manual/config/items/item#configuration)中，使用 **s** or **uptime** 单位获取可读的值。|
|system.users.num|<|<|<|<|
|<|用户登录数|整型| |**who** 命令是用于在agent处获取值的。|
|vfs.dev.discovery|<|<|<|<|
|<|块设备和类型的列表，用于低级别自动发现。|JSON 对象| |此监控项仅支持Linux平台。<br><br>从 Zabbix 4.4.0 开始支持。|
|vfs.dev.read\[<device>,<type>,<mode>\]|<|<|<|<|
|<|磁盘读取统计信息。|整型 - 当`type`在 *sectors*, *operations*, *bytes* 中时<br><br>浮点型 - 当`type`在 *sps*, *ops*, *bps* 中时<br><br>*注意*: 如果更新间隔在3小时及以上时^**[2](#footnotes)**^, 会一直返回 '0'|**device** - 磁盘设备（默认是 *all* ^**[3](#footnotes)**^）<br>**type** - 可能的值： *sectors*, *operations*, *bytes*, *sps*, *ops*, *bps*<br>请注意'type'在各平台的支持和默认情况，在[平台特性](/manual/appendix/items/supported_by_platform)查看详情。<br>*sps*, *ops*, *bps* 分别代表： sectors, operations, bytes 每秒的值。<br>**mode** - 可能的值： *avg1* (一分钟的平均值，默认), *avg5*, *avg15*.<br>此参数仅支持`type` 在 sps, ops, bps中的情况。|你也可使用相关设备名称（如`sda`）加 /dev/ 前缀（如`/dev/sda`）。<br><br>支持 LVM 逻辑卷。<br><br>不同操作系统的'type'默认值：<br>AIX - operations<br>FreeBSD - bps<br>Linux - sps<br>OpenBSD - operations<br>Solaris - bytes<br><br>示例：<br>=> vfs.dev.read\[,operations\]<br><br>*sps*, *ops* and *bps* 在支持的平台曾经支持8个设备（7个单独的和一个*all*）。从 Zabbix 2.0.1 开始这个限制是1024个设备（1023个单独的和一个*all*）。|
|vfs.dev.write\[<device>,<type>,<mode>\]|<|<|<|<|
|<|磁盘写入统计信息。|整型 - 当`type`在 *sectors*, *operations*, *bytes* 中时<br><br>浮点型 - 当`type`在 *sps*, *ops*, *bps* 中时<br><br>*注意*: 如果更新间隔在3小时及以上时^**[2](#footnotes)**^, 会一直返回 '0'|**device** - 磁盘设备（默认是 *all* ^**[3](#footnotes)**^）<br>**type** - 可能的值： *sectors*, *operations*, *bytes*, *sps*, *ops*, *bps*<br>请注意'type'在各平台的支持和默认情况，在[平台特性](/manual/appendix/items/supported_by_platform)查看详情。<br>*sps*, *ops*, *bps* 分别代表： sectors, operations, bytes 每秒的值。<br>**mode** - 可能的值： *avg1* (一分钟的平均值，默认), *avg5*, *avg15*.<br>此参数仅支持`type` 在 sps, ops, bps中的情况。|你也可使用相关设备名称（如`sda`）加 /dev/ 前缀（如`/dev/sda`）。<br><br>支持 LVM 逻辑卷。<br><br>不同操作系统的'type'默认值：<br>AIX - operations<br>FreeBSD - bps<br>Linux - sps<br>OpenBSD - operations<br>Solaris - bytes<br><br>示例：<br>=> vfs.dev.read\[,operations\]<br><br>*sps*, *ops* and *bps* 在支持的平台曾经支持8个设备（7个单独的和一个*all*）。从 Zabbix 2.0.1 开始这个限制是1024个设备（1023个单独的和一个*all*）。|
|vfs.dir.count\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]|<|<|<|<|
|<|目录条目计数。|整型|**dir** - 目录的绝对路径<br>**regex\_incl** - 描述包含的 (文件, 目录, 符号连接 )的名称模式的正则 [表达式](/manual/regular_expressions#overview) ;如果为空，则包含所有 (默认值)<br>**regex\_excl** - 描述了排除 (文件, 目录, 符号链接) 的名称模式正则 [表达式](/manual/regular_expressions#overview) ; 如果为空，不排除任何实体 (默认)<br>**types\_incl** - 要计数的目录条目类型, 可能的值：<br>*file* - 常规文件, *dir* - 子目录, *sym* - 符号链接, *sock* - 套接字, *bdev* - 块设备, *cdev* - 字符设备, *fifo* - FIFO, *dev* - "bdev,cdev"同义词, *all* - 所有类型 （默认）, 即 "file,dir,sym,sock,bdev,cdev,fifo".多种类型时需在双引号中用逗号隔开。<br>**types\_excl** - 不需要计数的目录条目类型 (见 <types\_incl>)。 如果某些条目类型同时位于 <types\_incl> 和 <types\_excl>中, 则不计算此类型的目录条目。<br>**max\_depth** - 遍历的子目录最大深度 **-1** （默认） - 无限制, **0** -不涉及子目录。<br>**min\_size** -要计数文件的最小大小（以字节为单位）。 小于此的文件不会被计算在内，[内存后缀](/manual/appendix/suffixes#memory_suffixes) 可以被使用。<br>**max\_size** - 要计数文件的最大大小（以字节为单位），大于此的文件将不会被计算在内。 [内存后缀](/manual/appendix/suffixes#memory_suffixes) 可以被使用<br>**min\_age** - 要计数的目录条目最小创建时间（以秒为单位）。最新的条目不进行计数。 [时间后缀](/manual/appendix/suffixes#time_suffixes) 可以被使用。<br>**max\_age** - 要计数的目录条目最大创建时间（以秒为单位）。 比此旧的条目将不被计算在内 (修改时间)。 [时间后缀](/manual/appendix/suffixes#time_suffixes) can 可以被使用.<br>**regex\_excl\_dir** - 述要排除的目录的名称模式的正则[表达式](/manual/regular_expressions#overview)，目录的所有内容都将被排除 (与 regex\_excl相比)|不支持的环境变量, 如 %APP\_HOME%, $HOME 和 %TEMP% 。<br><br>伪目录 "." 和 ".." 不会被计算在内。<br><br>目录遍历不会跟踪符号链接。<br><br>在Windows上， 目录符号链接被跳过，硬链接只计算一次。<br><br>在计算条目大小时， `regex_incl` 和 `regex_excl` 都被应用于文件和目录， 但在选择要遍历的子目录时被忽略 (如果 regex\_incl 是 “(?i)\^.+\\.zip$” 并且 max\_depth 未设置, 那么所有子目录都将是遍历，但只会计算 zip 类型的文件)。<br><br>执行时间受限于 agent [配置](/manual/appendix/config/zabbix_agentd) (3秒)的默认时间设置，由于大目录遍历可能需要更长的时间，因此不会返回任何数据并且该监控项项将变为不受支持。 部分计数将不予返回<br><br>当按照大小过滤时，只有常规文件的大小具有意义，在Linux和BSD下 ，目录也有非零大小 (通常只有几KB)。设备大小为0 如 **/dev/sda1**的大小不反映相应分区的大小。因此，在使用 `<min_size>` 和 `<max_size>`, 建议指定 `<types_incl>` 为 "*file*",防止出现意外。<br><br>例如:<br>⇒ vfs.dir.count\[/dev\] - 监控 /dev (Linux)中的设备数量<br>⇒ vfs.dir.count\["C:\\Users\\ADMINI\~1\\AppData\\Local\\Temp"\] - 监控临时目录下的文件数量 (Windows)<br><br>自 Zabbix 4.0.0后支持。|
|vfs.dir.get\[dir,<regex\_incl>,<regex\_excl>,<types\_incl>,<types\_excl>,<max\_depth>,<min\_size>,<max\_size>,<min\_age>,<max\_age>,<regex\_excl\_dir>\]|<|<|<|<|
|<|目录条目列表|JSON|**dir** - 目录的绝对路径<br>**regex\_incl** - 描述包含的 (文件, 目录, 符号连接 )的名称模式的正则 [表达式](/manual/regular_expressions#overview) ;如果为空，则包含所有 (默认值)<br>**regex\_excl** - 描述了排除 (文件, 目录, 符号链接) 的名称模式正则 [表达式](/manual/regular_expressions#overview) ; 如果为空，不排除任何实体 (默认)<br>**types\_incl** - 要计数的目录条目类型, 可能的值：<br>*file* - 常规文件, *dir* - 子目录, *sym* - 符号链接, *sock* - 套接字, *bdev* - 块设备, *cdev* - 字符设备, *fifo* - FIFO, *dev* - "bdev,cdev"同义词, *all* - 所有类型 （默认）, 即 "file,dir,sym,sock,bdev,cdev,fifo".多种类型时需在双引号中用逗号隔开。<br>**types\_excl** - 不需要计数的目录条目类型 (见 <types\_incl>)。 如果某些条目类型同时位于 <types\_incl> 和 <types\_excl>中, 则不计算此类型的目录条目。<br>**max\_depth** - 遍历的子目录最大深度 **-1** （默认） - 无限制, **0** -不涉及子目录。<br>**min\_size** -要计数文件的最小大小（以字节为单位）。 小于此的文件不会被计算在内，[内存后缀](/manual/appendix/suffixes#memory_suffixes) 可以被使用。<br>**max\_size** - 要计数文件的最大大小（以字节为单位），大于此的文件将不会被计算在内。 [内存后缀](/manual/appendix/suffixes#memory_suffixes) 可以被使用<br>**min\_age** - 要计数的目录条目最小创建时间（以秒为单位）。最新的条目不进行计数。 [时间后缀](/manual/appendix/suffixes#time_suffixes) 可以被使用。<br>**max\_age** - 要计数的目录条目最大创建时间（以秒为单位）。 比此旧的条目将不被计算在内 (修改时间)。 [时间后缀](/manual/appendix/suffixes#time_suffixes) can 可以被使用.<br>**regex\_excl\_dir** - 述要排除的目录的名称模式的正则[表达式](/manual/regular_expressions#overview)，目录的所有内容都将被排除 (与 regex\_excl相比)|不支持的环境变量, 如 %APP\_HOME%, $HOME 和 %TEMP% 。<br><br>伪目录 "." 和 ".." 不会被计算在内。<br><br>目录遍历不会跟踪符号链接。<br><br>在Windows上， 目录符号链接被跳过，硬链接只计算一次。<br><br>在计算条目大小时， `regex_incl` 和 `regex_excl` 都被应用于文件和目录， 但在选择要遍历的子目录时被忽略 (如果 regex\_incl 是 “(?i)\^.+\\.zip$” 并且 max\_depth 未设置, 那么所有子目录都将是遍历，但只会计算 zip 类型的文件)。<br><br>执行时间受限于 agent [配置](/manual/appendix/config/zabbix_agentd) (3秒)的默认时间设置，由于大目录遍历可能需要更长的时间，因此不会返回任何数据并且该监控项项将变为不受支持。 部分计数将不予返回<br><br>当按照大小过滤时，只有常规文件的大小具有意义，在Linux和BSD下 ，目录也有非零大小 (通常只有几KB)。设备大小为0 如 **/dev/sda1**的大小不反映相应分区的大小。因此，在使用 `<min_size>` 和 `<max_size>`, 建议指定 `<types_incl>` 为 "*file*",防止出现意外。<br><br>例如:<br>⇒ vfs.dir.count\[/dev\] - 监控 /dev (Linux)中的设备数量<br>⇒ vfs.dir.count\["C:\\Users\\ADMINI\~1\\AppData\\Local\\Temp"\] - 监控临时目录下的文件数量 (Windows)<br><br>自 Zabbix 6.0.0后支持。|
|vfs.dir.size\[dir,<regex\_incl>,<regex\_excl>,<mode>,<max\_depth>,<regex\_excl\_dir>\]|<|<|<|<|
|<|目录大小(以字节为单位).|整型|**dir** - 目录的绝对路径<br>**regex\_incl** - 描述包含的 (文件, 目录, 符号连接 )的名称模式的正则 [表达式](/manual/regular_expressions#overview) ;如果为空，则包含所有 (默认值)<br>**regex\_excl** - 描述了排除 (文件, 目录, 符号链接) 的名称模式正则 [表达式](/manual/regular_expressions#overview) ; 如果为空，不排除任何实体 (默认)<br>**mode** - 可能的值：<br>*apparent* （默认） - 获取明确文件大小而不是磁盘使用情况( `du -sb dir`), *disk* - 获取磁盘使用情况 ( `du -s -B1 dir`)。与du 命令不同, vfs.dir.size 监控项在计算目录大小会考虑隐藏文件 (`du -sb .[^.]* *` 在目录中起作用).<br>**max\_depth** -目录遍历的最大深度。 **-1** （默认） - 无限制, **0** -不下钻到子目录<br>**regex\_excl\_dir** - 述要排除的目录的名称模式的正则[表达式](/manual/regular_expressions#overview)，目录的所有内容都将被排除 (与 regex\_excl相比)|只计算 *zabbix* 用户至少可读权限的目录<br><br>在Windows上任何软链接被跳过，硬链接只计算一次<br><br>对于大型目录或慢速驱动器，此监控项可能会根据 [agent](/manual/appendix/config/zabbix_agentd) 和 [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy) 配置文件中的超时设置而超时，可以根据需要设置超时值。<br><br>示例:<br>⇒ vfs.dir.size\[/tmp,log\] - 计算 /tmp目录中包含 'log'的所有文件大小；<br>⇒ vfs.dir.size\[/tmp,log,\^.+\\.old$\] -计算 /tmp目录中包含'log'的所有文件大小，排除文件中包含'.old'的文件。<br><br>文件大小限制取决于 [大文件支持](/manual/appendix/items/large_file_support)。<br><br>自Zabbix 3.4.0后开始支持|
|vfs.file.cksum\[file,<mode>\]|<|<|<|<|
|<|文件校验和，由 UNIX cksum 算法计算得出。|整型 -`mode` 作为 *crc32*<br><br>字符串 - `mode` 作为 *md5*, *sha256*|**file** - 文件模式的全路径<br>**mode** - *crc32* （默认）, *md5*, *sha256*|示例：<br>=> vfs.file.cksum\[/etc/passwd\]<br><br>返回值示例 (分别为crc32/md5/sha256):<br>675436101<br>9845acf68b73991eb7fd7ee0ded23c44<br>ae67546e4aac995e5c921042d0cf0f1f7147703aa42bfbfb65404b30f238f2dc<br><br>文件大小限制取决于[大文件支持](/manual/appendix/items/large_file_support)。<br><br>自 Zabbix 6.0后开始支持`mode` 参数|
|vfs.file.contents\[file,<encoding>\]|<|<|<|<|
|<|检索文件的内容。|文本|**file** - 文件的全路径<br>**encoding** - 编码 [标识符](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)|如果文件为空或仅包含 LF/CR 字符，则返回空字符串。<br><br>字节顺序标记 (BOM) 从输出中排除。<br><br>示例：<br>=> vfs.file.contents\[/etc/passwd\]<br><br>此监控项仅限于不大于 64 KB 的文件。<br><br>从Zabbix 2.0开始支持。|
|vfs.file.exists\[file,<types\_incl>,<types\_excl>\]|<|<|<|<|
|<|检查文件是否存在。|0 -没有找到<br><br>1 - 指定文件类型存在|**file** - 文件的完整路径。<br>**types\_incl** - 包含的文件类型列表, 可能的值： *file* (常规文件，默认 (如果 types\_excl未设置)), *dir* (目录), *sym* (符号链接), *sock* (套接字), *bdev* (块设备), *cdev* (字符设备), *fifo* (FIFO), *dev* (与 "bdev,cdev"同义), *all* (所有提到的类型，默认为如果 types\_excl设置的值)。<br>**types\_excl** - 排除的文件类型列表, 参阅 types\_incl 获取可能的值 (默认情况下不排除任何类型)|多个类型必须用逗号分隔，整个集合用 引号""括起来.<br>在Windows上，当使用命令行调用zabbix\_get.exe或agent2时，双引号必须用反斜杠 '\\' 转义，并且整个项目键用双引号括起来。<br><br>如果 <types\_incl> 和 <types\_excl>中的类型相同,则排除此类型的文件<br><br>例如:<br>=> vfs.file.exists\[/tmp/application.pid\]<br>=> vfs.file.exists\[/tmp/application.pid,"file,dir,sym"\]<br>=> vfs.file.exists\[/tmp/application\_dir,dir\]<br><br>文件大小取决于[大文件支持](/manual/appendix/items/large_file_support)。<br><br>请注意，如果在不存在的目录中搜索目录，例如vfs.file.exists\[C:\\no\\dir,dir\] (其中不存在 'no')则该监控项可能会在Windows上变为不受支持|
|vfs.file.get\[file\]|<|<|<|<|
|<|返回有关文件的信息。|JSON 对象|**file** - 文件的全路径|类 UNIX 系统上支持的文件类型: 常规文件,、目录、 符号链接、套接字、块设备、字符设备、FIFO<br><br>Windows 上支持的文件类型：常规文件、目录、符号链接<br><br>示例：<br>=> vfs.file.get\[/etc/passwd\] → 返回一个 JSON，其中包含有关 /etc/passwd 文件的信息(类型、用户、权限、SID、uid 等)<br><br>自Zabbix 6.0后开始支持|
|vfs.file.md5sum\[file\]|<|<|<|<|
|<|文件的MD5校验和。|字符串 (MD5的哈希文件)|**file** - 文件的全路径|示例：<br>=> vfs.file.md5sum\[/usr/local/etc/zabbix\_agentd.conf\]<br><br>示例的返回值:<br>b5052decb577e0fffd622d6ddc017e82<br><br>版本 1.8.6 中删除了此项目的文件大小限制 (64 MB)。<br><br>文件大小限制取决于 [大文件支持](/manual/appendix/items/large_file_support)。|
|vfs.file.owner\[file,<ownertype>,<resulttype>\]|<|<|<|<|
|<|检索文件的所有者|字符串|**file** - 文件的全路径<br>**ownertype** - *user* （默认） 或 *group* (仅Unix)<br>**resulttype** - *name* （默认） 或 *id*; 对于id - 在Unix上返回 uid/gid，Windows上返回SID|示例：<br>=> vfs.file.owner\[/tmp/zabbix\_server.log\] → 返回/tmp/zabbix\_server.log文件所有者<br>=> vfs.file.owner\[/tmp/zabbix\_server.log,,id\] → 返回 /tmp/zabbix\_server.log文件所有者id<br><br>自Zabbix 6.0后开始支持。|
|vfs.file.permissions\[file\]|<|<|<|<|
|<|返回一个 4 位字符串，其中包含具有 Unix 权限的八进制数。|字符串|**file** - 文件的全路径|在Windows上不支持<br><br>示例：<br>=> vfs.file.permissions\[/etc/passwd\] →返回/etc/passwd的文件权限, 例如, '0644'<br><br>自Zabbix 6.0后开始支持|
|vfs.file.regexp\[file,regexp,<encoding>,<start line>,<end line>,<output>\]|<|<|<|<|
|<|在文件中查找字符串。|包含匹配字符串的行，或由可选 `output` 参数指定的行|**file** - 文件的全路径<br>**regexp** - 描述所需模式编码的正则[表达式](/manual/regular_expressions#overview)<br>**encoding** - 编码[标识符](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**start line** - 要搜索的第一行(默认为文件的第一行).<br>**end line** - 要搜索的最后一行的编号(默认为文件的最后一行)。<br>**output** - 可选的输出格式模板 **\\0** 转义序列被替换为匹配的文本部分(从匹配开始的第一个字符到匹配结束的字符) 而 **\\N** (其中 N=1...9) 转义序列被替换为第N个匹配组 (如果N超过捕获组的数量，则为空字符串)。|仅返回第一个匹配行。<br>如果没有行匹配表达式，则返回一个空字符串。<br><br>字节顺序标记 (BOM) 从输出中排除。<br><br>使用该参数的内容提取`output`发生在 agent 上。<br><br>从2.2版本开始支持 `start line`, `end line` and `output` 参数。<br><br>例如:<br>=> vfs.file.regexp\[/etc/passwd,zabbix\]<br>=> vfs.file.regexp\[/path/to/some/file,"(\[0-9\]+)$",,3,5,\\1\]<br>=> vfs.file.regexp\[/etc/passwd,"\^zabbix:.:(\[0-9\]+)",,,,\\1\] → 获取 *zabbix*用户ID|
|vfs.file.regmatch\[file,regexp,<encoding>,<start line>,<end line>\]|<|<|<|<|
|<|在文件中查找字符串。|0 - 未找到匹配<br><br>1 - 找到|**file** - 文件全路径<br>**regexp** - 描述所需模式编码的正则[表达式](/manual/regular_expressions#overview)<br>**encoding** - 编码[标识符](/manual/config/items/itemtypes/zabbix_agent#encoding_settings)<br>**start line** - 要搜索的第一行(默认为文件的第一行).<br>**end line** - 要搜索的最后一行的编号(默认为文件的最后一行)。|字节顺序标记 (BOM) 被忽略。<br><br>从2.2开始支持 `start line` 和 `end line`参数。<br><br>示例：<br>=> vfs.file.regmatch\[/var/log/app.log,error\]|
|vfs.file.size\[file,<mode>\]|<|<|<|<|
|<|文件大小 (以字节为单位).|整型|**file** - 文件全路径<br>**mode** - 可能的值：<br>*bytes* （默认） 或 *lines* (也计算空行)|该文件必须对用户*zabbix*具有读取权限。<br><br>示例：<br>=> vfs.file.size\[/var/log/syslog\]<br><br>文件大小限制取决于[大文件支持](/manual/appendix/items/large_file_support)。<br><br>自Zabbix6.0起支持 `mode`参数。|
|vfs.file.time\[file,<mode>\]|<|<|<|<|
|<|文件时间信息。|整型 (Unix 时间戳)|**file** - 文件全路径<br>**mode** - 可能的值：<br>*modify* （默认） - 最后修改文件内容的时间<br>*access* - 最后读文件的时间。<br>*change* - 最后更改文件属性的时间。|示例：<br>=> vfs.file.time\[/etc/passwd,modify\]<br><br>文件大小限制取决于 [大文件支持](/manual/appendix/items/large_file_support).|
|vfs.fs.discovery|<|<|<|<|
|<|已安装文件系统及其类型的列表。用于低级别自动发现.|JSON 对象| |从Zabbix 2.0开始支持。<br><br>自Zabbix3.0起，Windows支持{\#FSDRIVETYPE}宏。<br><br>自Zabbix6.0起，Windows支持 {\#FSLABEL}宏。|
|vfs.fs.get|<|<|<|<|
|<|挂载的文件系统列表、它们的类型、磁盘空间和 inode 统计信息。可用于低级别自动发现.|JSON 对象| |自Zabbix 4.4.5后开始支持。<br><br>自Zabbix 6.0 起，Windows上支持 {\#FSLABEL}宏|
|vfs.fs.inode\[fs,<mode>\]|<|<|<|<|
|<|inode数量或百分比|整型 - 表示数量<br><br>浮点数 - 用于百分比|**fs** - 文件系统<br>**mode** - 可能的值：<br>*total* （默认）, *free*, *used*, //pfree // (空闲, 百分比), *pused* (使用, 百分比)|示例：<br>=> vfs.fs.inode\[/,pfree\]|
|vfs.fs.size\[fs,<mode>\]|<|<|<|<|
|<|磁盘空间（以字节为单位）或占总数的百分比。|整型 - 字节<br><br>浮点数 - 百分比|**fs** - 文件系统<br>**mode** - 可能的值：<br>*total* (默认), *free*, *used*, *pfree* (空闲, 百分比), *pused* (使用, 百分比)|如果是已挂载的卷，则返回本地文件系统的磁盘空间。<br><br>示例：<br>=> vfs.fs.size\[/tmp,free\]<br><br>当使用 *free* 模式时，文件系统的保留空间不考虑在内.|
|vm.memory.size\[<mode>\]|<|<|<|<|
|<|内存大小（以字节为单位）或占总数的百分比。|整型 - 字节<br><br>浮点数 -百分比|**mode** - 可能的值：<br>*total* (默认), *active*, *anon*, *buffers*, *cached*, *exec*, *file*, *free*, *inactive*, *pinned*, *shared*, *slab*, *wired*, *used*, *pused* (used, percentage), *available*, *pavailable* (available, percentage)<br>参阅[平台特性](/manual/appendix/items/supported_by_platform) 支持和此参数的 [其他详细信息](/manual/appendix/items/vm.memory.size_params)。|此监控项接受三类参数：
:<br><br>1) *total* - 内存总量;<br>2) 特定于平台的内存类型: *active*, *anon*, *buffers*, *cached*, *exec*, *file*, *free*, *inactive*, *pinned*, *shared*, *slab*, *wired*;<br>3) 用户级估计有多少内存已使用和可用: *used*, *pused*, *available*, *pavailable*。|
|web.page.get\[host,<path>,<port>\]|<|<|<|<|
|<|获取网页内容。|作为文本的网页源（包括标题）|**host** - 主机名或URL (如 `scheme://host:port/path`, 只有 *host*是强制的).<br>允许的URL方案: *http*, *https*^**[4](#footnotes)**^. 缺少的方案将被使用 *http*。如果URL 指定了 `path` 和 `port`必须为空。 连接服务需要验证时需指定用户名和密码，示例： `http://user:password@www.example.com` 只有curl^**[4](#footnotes)**^才有可能。<br>主机名支持Punycode。<br>**path** - HTML文档路径(默认为 /)<br>**port** - 端口号(默认是 http 80)|如果指定的资源在 `host`中不存在或不可用，则此监控项将不受支持。<br><br>`host` 可以是主机名、域名、IPv4 或 IPv6 地址。但是对于 IPv6 地址，Zabbix agent必须在启用 IPv6 支持的情况下编译。<br><br>示例：<br>=> web.page.get\[www.example.com,index.php,80\]<br>=> web.page.get\[https://www.example.com\]<br>=> web.page.get\[https://blog.example.com/?s=zabbix\]<br>=> web.page.get\[localhost:80\]<br>=> web.page.get\["\[::1\]/server-status"\]|
|web.page.perf\[host,<path>,<port>\]|<|<|<|<|
|<|整个网页的加载时间（以秒为单位）。|浮点型|**host** - 主机名或URL (如 `scheme://host:port/path`, 只有 *host*是强制的).<br>允许的URL方案: *http*, *https*^**[4](#footnotes)**^. 缺少的方案将被使用 *http*。如果URL 指定了 `path` 和 `port`必须为空。 连接服务需要验证时需指定用户名和密码，示例： `http://user:password@www.example.com` 只有curl^**[4](#footnotes)**^才有可能。<br>主机名支持Punycode。<br>**path** - HTML文档路径(默认为 /)<br>**port** - 端口号(默认是 http 80)|如果指定的资源在 `host`中不存在或不可用，则此监控项将不受支持。<br><br>`host` 可以是主机名、域名、IPv4 或 IPv6 地址。但是对于 IPv6 地址，Zabbix agent 必须在启用 IPv6 支持的情况下编译。<br><br>示例：<br>=> web.page.perf\[www.example.com,index.php,80\]<br>=> web.page.perf\[https://www.example.com\]|
|web.page.regexp\[host,<path>,<port>,regexp,<length>,<output>\]|<|<|<|<|
|<|在网页上查找字符串。|匹配的字符串, 或由可选`output`参数指定。|**host** - 主机名或URL (如 `scheme://host:port/path`, 只有 *host*是强制的).<br>允许的URL方案: *http*, *https*^**[4](#footnotes)**^. 缺少的方案将被使用 *http*。如果URL 指定了 `path` 和 `port`必须为空。 连接服务需要验证时需指定用户名和密码，示例： `http://user:password@www.example.com` 只有curl^**[4](#footnotes)**^才有可能。<br>主机名支持Punycode。<br>**path** - HTML文档路径(默认为 /)<br>**port** - 端口号(默认是 http 80)<br>**regexp** - 描述了所需模式的正则 [表达式](/manual/regular_expressions#overview)<br>**length** -返回最大的字符数<br>**output** - 可选的输出格式模板， **\\0** 转义序列被替换为文本的匹配部分 (从从匹配开始的第一个字符到匹配结束的字符) ，而 **\\N** (其中 N=1...9) 转义序列被替换为第 N 个匹配组 (如果 N 超过捕获的组数，则为空字符串)。|如果指定的资源在 `host`中不存在或不可用，则此监控项将不受支持。<br><br>`host` 可以是主机名、域名、IPv4 或 IPv6 地址。但是对于 IPv6 地址，Zabbix agent 必须在启用 IPv6 支持的情况下编译。<br><br>使用该参数的内容提取 `output` 发生在 agent 上。<br><br>从2.2版本开始支持 `output`参数。<br><br>示例：<br>=> web.page.regexp\[www.example.com,index.php,80,OK,2\]<br>=> web.page.regexp\[https://www.example.com,,,OK,2\]|
|zabbix.stats\[<ip>,<port>\]|<|<|<|<|
|<|远程返回一组 Zabbix Server或Proxy内部指标|JSON 对象|**ip** - 要远程查询的server/proxy的IP/DNS/网络掩码列表 (默认为127.0.0.1)<br>**port** - 要远程查询的server/proxy的端口 (默认为10051)|请注意，仅接受来自目标实例 [server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)参数'StatsAllowedIP'中列出的地址统计请求<br><br>此项目返回一组选定的内部指标。有关详细信息，请参阅[Zabbix stats的远程监控](/manual/appendix/items/remote_stats#exposed_metrics).|
|zabbix.stats\[<ip>,<port>,queue,<from>,<to>\]|<|<|<|<|
|<|返回队列中被远程Zabbix Server或 proxy 延迟的监控项数。|JSON 对象|**ip** - 要远程查询的server/proxy的IP/DNS/网络掩码列表 (默认为127.0.0.1)<br>**port** - 要远程查询的server/proxy的端口 (默认为10051)<br>**queue** - 常量 (按原样使用)<br>**from** - 至少时延 (默认是6秒)<br>**to** - 最多延迟 (默认是无穷大)|请注意，仅接受来自目标实例[server](/manual/appendix/config/zabbix_server)/[proxy](/manual/appendix/config/zabbix_proxy)参数'StatsAllowedIP'中列出的地址统计请求。|
##### Key file authentication
To use key based authentication for SSH items, certain changes to the
server configuration are required.
Open the Zabbix server configuration file
([*zabbix\_server.conf*](/manual/appendix/config/zabbix_server)) as `root`
and look for the following line:
```ini
# SSHKeyLocation=
```
Uncomment it and set the full path to the folder where the public and private keys
will be located:
```ini
SSHKeyLocation=/home/zabbix/.ssh
```
Save the file and restart Zabbix server afterwards.
The path */home/zabbix* here is the home directory for the *zabbix* user account,
and *.ssh* is a directory where by default public and private keys will
be generated by an [ssh-keygen](http://en.wikipedia.org/wiki/Ssh-keygen)
command inside the home directory.
Usually installation packages of Zabbix server from different OS
distributions create the *zabbix* user account with a home directory elsewhere,
for example, */var/lib/zabbix* (as for system accounts).
Before generating the keys, you could reallocate the home
directory to */home/zabbix*, so that it
corresponds with the `SSHKeyLocation` Zabbix server
configuration parameter mentioned above.
::: noteclassic
The following steps can be skipped if *zabbix* account has been added manually
according to the [installation
section](/manual/installation/install#create_user_account).
In such a case the home directory for the *zabbix* account is most likely already
*/home/zabbix*.
:::
To change the home directory of the *zabbix* user account, all working
processes which are using it have to be stopped:
```bash
systemctl stop zabbix-agent
systemctl stop zabbix-server
```
To change the home directory location with an attempt to move it (if it
exists) the following command should be executed:
```bash
usermod -m -d /home/zabbix zabbix
```
It is also possible that a home directory did not exist in the old
location, so it should be created at the new location. A safe attempt to do that is:
```bash
test -d /home/zabbix || mkdir /home/zabbix
```
To be sure that all is secure, additional commands could be executed to
set permissions to the home directory:
```bash
chown zabbix:zabbix /home/zabbix
chmod 700 /home/zabbix
```
Previously stopped processes can now be started again:
```bash
systemctl start zabbix-agent
systemctl start zabbix-server
```
Now, the steps to generate the public and private keys can be performed
with the following commands (for better readability, command prompts are commented out):
```bash
sudo -u zabbix ssh-keygen -t rsa
# Generating public/private rsa key pair.
# Enter file in which to save the key (/home/zabbix/.ssh/id_rsa):
/home/zabbix/.ssh/id_rsa
# Enter passphrase (empty for no passphrase):
<Leave empty>
# Enter same passphrase again:
<Leave empty>
# Your identification has been saved in /home/zabbix/.ssh/id_rsa.
# Your public key has been saved in /home/zabbix/.ssh/id_rsa.pub.
# The key fingerprint is:
# 90:af:e4:c7:e3:f0:2e:5a:8d:ab:48:a2:0c:92:30:b9 zabbix@it0
# The key's randomart image is:
# +--[ RSA 2048]----+
# | |
# | . |
# | o |
# | . o |
# |+ . S |
# |.+ o = |
# |E . * = |
# |=o . ..* . |
# |... oo.o+ |
# +-----------------+
```
::: noteclassic
The public and private keys (*id\_rsa.pub* and *id\_rsa*)
have been generated by default in the */home/zabbix/.ssh* directory,
which corresponds to the Zabbix server `SSHKeyLocation` configuration
parameter.
:::
::: noteimportant
Key types other than "rsa" may be supported by the
ssh-keygen tool and SSH servers but they may not be supported by
libssh2 used by Zabbix.
:::
##### 密钥文件认证
要为SSH 监控项启用基于密钥的认证，需要对服务器配置进行特定修改。
打开Zabbix server的file配置文件
([*zabbix\_server.conf*](/manual/appendix/config/zabbix_server))，即`root`
找到以下行：
```ini
# SSHKeyLocation=
```
取消注释并设置公钥/私钥存储目录的完整路径：
```ini
SSHKeyLocation=/home/zabbix/.ssh
```
保存file后重启Zabbix server服务。
示例中的*/home/zabbix*是*zabbix*用户的主目录，
*.ssh*是默认通过[ssh-keygen](http://en.wikipedia.org/wiki/Ssh-keygen)命令
在主目录下生成公私钥的目录。
不同操作系统发行版的Zabbix server安装包
create通常将*zabbix*用户的主目录设为其他路径，
例如系统账户常用的*/var/lib/zabbix*。
生成密钥前，建议将主目录调整为*/home/zabbix*以匹配
上文提到的`SSHKeyLocation` Zabbix server
配置参数。
::: noteclassic
若已按[installation
section](/manual/installation/install#create_user_account)手动添加*zabbix*账户，
可跳过后续步骤。此类情况下用户主目录通常已是*/home/zabbix*。
:::
修改*zabbix*用户主目录前需停止相关进程：
```bash
systemctl stop zabbix-agent
systemctl stop zabbix-server
```
执行以下命令迁移现有主目录（若存在）：
```bash
usermod -m -d /home/zabbix zabbix
```
若原位置无主目录，则在新位置创建：
```bash
test -d /home/zabbix || mkdir /home/zabbix
```
为确保安全，可执行以下权限设置命令：
```bash
chown zabbix:zabbix /home/zabbix
chmod 700 /home/zabbix
```
重启之前停止的进程：
```bash
systemctl start zabbix-agent
systemctl start zabbix-server
```
现在可通过以下命令generate公私钥（为便于阅读，已注释命令提示符）：
```bash
sudo -u zabbix ssh-keygen -t rsa
# Generating public/private rsa key pair.
# Enter file in which to save the key (/home/zabbix/.ssh/id_rsa):
/home/zabbix/.ssh/id_rsa
# Enter passphrase (empty for no passphrase):
<Leave empty>
# Enter same passphrase again:
<Leave empty>
# Your identification has been saved in /home/zabbix/.ssh/id_rsa.
# Your public key has been saved in /home/zabbix/.ssh/id_rsa.pub.
# The key fingerprint is:
# 90:af:e4:c7:e3:f0:2e:5a:8d:ab:48:a2:0c:92:30:b9 zabbix@it0
# The key's randomart image is:
# +--[ RSA 2048]----+
# | |
# | . |
# | o |
# | . o |
# |+ . S |
# |.+ o = |
# |E . * = |
# |=o . ..* . |
# |... oo.o+ |
# +-----------------+
```
::: noteclassic
默认生成的公钥(*id\_rsa.pub*)和私钥(*id\_rsa*)
存储在*/home/zabbix/.ssh*目录，
与Zabbix server的`SSHKeyLocation`配置参数相符。
:::
::: noteimportant
虽然ssh-keygen工具和SSH服务器可能支持"rsa"以外的密钥类型，
但Zabbix使用的libssh2库可能不支持其他类型。
:::
#### Key name
The key name itself has a limited range of allowed characters, which
just follow each other. Allowed characters are:
0-9a-zA-Z_-.
Which means:
- all numbers;
- all lowercase letters;
- all uppercase letters;
- underscore;
- dash;
- dot.
#### 键名
键名本身允许的字符范围有限
这些字符必须连续排列。允许的字符包括:
0-9a-zA-Z_-.
这意味着:
- 所有数字
- 所有小写字母
- 所有大写字母
- 下划线
- 连字符
- 点号
#### Key parameters
An item key can have multiple parameters that are comma separated.
Each key parameter can be either a quoted string, an unquoted string or
an array.
The parameter can also be left empty, thus using the default value. In
that case, the appropriate number of commas must be added if any further
parameters are specified. For example, item key
**icmpping\[,,200,,500\]** would specify that the interval between
individual pings is 200 milliseconds, timeout - 500 milliseconds, and
all other parameters are left at their defaults.
It is possible to include macros in the parameters. Those can be [user macros](/manual/appendix/macros/supported_by_location_user#items-item-prototypes) or some of the built-in macros.
To see what particular built-in macros are supported in item key parameters,
search the page [Supported macros](/manual/appendix/macros/supported_by_location) for "item key parameters".
#### 键参数
一个监控项键可以包含多个以逗号分隔的参数。
每个键参数可以是带引号的string、不带引号的string或array。
参数也可以留空以使用默认值。在这种情况下，如果指定了后续参数，则必须添加适当数量的逗号。例如，监控项键**icmpping\[,,200,,500\]**表示单个ping之间的间隔为200毫秒，超时为500毫秒，其余参数均保留默认值。
参数中可以包含宏。这些宏可以是[监控项监控项原型](/manual/appendix/macros/supported_by_location_user#监控项监控项原型)或某些内置宏。要查看监控项键参数支持哪些特定的内置宏，请在页面[Supported macros](/manual/appendix/macros/supported_by_location)中搜索"监控项键参数"。
#### Kiosk mode
The kiosk mode in supported frontend pages can be activated using URL
parameters. For example, in dashboards:
- `/zabbix.php?action=dashboard.view&kiosk=1` - activate kiosk mode
- `/zabbix.php?action=dashboard.view&kiosk=0` - activate normal mode
#### Kiosk 模式
支持的前端页面中的信息亭模式可以通过URL参数激活。例如，在仪表板中：
- `/zabbix.php?action=dashboard.view&kiosk=1` - 激活信息亭模式
- `/zabbix.php?action=dashboard.view&kiosk=0` - 激活普通模式
#### Known issues
1. Zabbix agent does not have the possibility to determine proper node
name. It always has dynamic hostname.
#### 已知 问题
1. Zabbix agent 无法确定正确的节点名称。它始终具有动态主机名。
#### Known issues
See [known issues](/manual/installation/known_issues#graphs) for graphs.
#### 已知 问题
有关图表请参阅[图形](/manual/installation/known_issues#图形)。
#### Known issues
To improve performance, you can convert the field types from *nclob* to *nvarchar2*, see [known issues](/manual/installation/known_issues#slow-configuration-sync-with-oracle).
#### 已知 问题
为提高性能，您可以将字段类型从*nclob*转换为*nvarchar2*，参见[oracle-配置同步缓慢](/manual/installation/known_issues#oracle-配置同步缓慢)。
#### Kubernetes
- *Kubernetes nodes by HTTP*
- *Kubernetes cluster state by HTTP*
- *Kubernetes API server by HTTP*
- *Kubernetes Controller manager by HTTP*
- *Kubernetes Scheduler by HTTP*
- *Kubernetes kubelet by HTTP*
To enable Kubernetes monitoring, you need to use the new tool
[Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0),
which installs Zabbix proxy and Zabbix agents in the Kubernetes cluster.
To learn more about configuring templates, see [HTTP template operation](/manual/config/templates_out_of_the_box/http).
#### Kubernetes
- *通过HTTP监控Kubernetes节点*
- *通过HTTP监控Kubernetes集群状态*
- *通过HTTP监控Kubernetes API服务器*
- *通过HTTP监控Kubernetes控制器管理器*
- *通过HTTP监控Kubernetes调度器*
- *通过HTTP监控Kubernetes kubelet*
要启用Kubernetes监控，您需要使用新工具
[Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0),
该工具会在Kubernetes集群中安装Zabbix proxy和Zabbix agents。
要了解有关配置模板的更多信息，请参阅[HTTP template operation](/manual/config/templates_out_of_the_box/http)。
##### Large file support
Zabbix has large file support for SNMP trapper files. The maximum file
size that Zabbix can read is 2\^63 (8 EiB). Note that the filesystem may
impose a lower limit on the file size.
##### 大文件支持
Zabbix对SNMP trapper文件具有较大的file支持。Zabbix可读取的最大file大小为2^63（8 EiB）。需注意文件系统可能对file大小施加更低的限制。
### Latest data link for hosts shows numbers
The latest data link for hosts in [*Monitoring* -> *Hosts*](/manual/web_interface/frontend_sections/monitoring/hosts) now shows the number of items with latest data.
### 主机的最新数据链接显示数值
[*Monitoring* -> *Hosts*](/manual/web_interface/frontend_sections/monitoring/hosts)中主机的最新数据链接现在显示具有最新数据的监控项数量
#### Legend
The following parameters are supported for configuring *Legend*.
|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|*Show legend*|0|legend|0 - Disabled;<br>1 - *(default)* Enabled.|
|*Number of rows*|0|legend_lines|Valid values range from 1-5.<br><br>Default: 1.|
#### 图例
以下参数可用于配置*图例*.
| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| *Show legend* | 0 | legend | 0 - 禁用;<br>1 - *(默认)* 启用. |
| *Number of rows* | 0 | legend_lines | 有效值范围为1-5.<br><br>默认: 1. |
#### Library in a non-standard location
Zabbix allows you to specify a library located in a non-standard location. In the example below, Zabbix will run `curl-config` from the specified non-standard location and use its output to determine the correct libcurl to use.
$ ./configure --enable-server --with-mysql --with-libcurl=/usr/local/bin/curl-config
This will work if it is the only libcurl installed in the system, but might not if there is another libcurl installed in a standard location (by the package manager, for example). Such is the case when you need a newer version of the library for Zabbix and the older one for other applications.
Therefore, specifying a component in a non-standard location will not always work when the same component also exists in a standard location.
For example, if you use a newer libcurl installed in `/usr/local` with the libcurl package still installed, Zabbix might pick up the wrong one and compilation will fail:
usr/bin/ld: ../../src/libs/zbxhttp/libzbxhttp.a(http.o): in function 'zbx_http_convert_to_utf8':
/tmp/zabbix-master/src/libs/zbxhttp/http.c:957: undefined reference to 'curl_easy_header'
collect2: error: ld returned 1 exit status
Here, the function `curl_easy_header()` is not available in the older `/usr/lib/x86_64-linux-gnu/libcurl.so`, but is available in the newer `/usr/local/lib/libcurl.so`.
The problem lies with the order of linker flags, and one solution is to specify the full path to the library in an LDFLAGS variable:
$ LDFLAGS="-Wl,--no-as-needed /usr/local/lib/libcurl.so" ./configure --enable-server --with-mysql --with-libcurl=/usr/local/bin/curl-config
Note the `-Wl,--no-as-needed` option which might be needed on some systems (see also: default linking options on [Debian-based](https://wiki.debian.org/ToolChain/DSOLinking) systems).
#### 非标准路径下的库
Zabbix允许您指定位于非标准位置的库。在以下示例中，Zabbix将从指定的非标准位置run`curl-config`，并使用其输出来确定要使用的正确libcurl版本。
$ ./configure --enable-server --with-mysql --with-libcurl=/usr/local/bin/curl-config
当系统中仅安装了一个libcurl时此方法有效，但如果标准位置（例如通过包管理器安装）还存在另一个libcurl时可能失效。这种情况常见于您需要为Zabbix使用较新的version库版本，而其他应用程序仍需使用旧版本。
因此，当标准位置已存在相同组件时，指定非标准位置的组件并不总能生效。
例如，若您使用安装在`/usr/local`的新版libcurl，而系统中仍存在libcurl软件包，Zabbix可能会错误选择版本导致编译失败：
usr/bin/ld: ../../src/libs/zbxhttp/libzbxhttp.a(http.o): in function 'zbx_http_convert_to_utf8':
/tmp/zabbix-master/src/libs/zbxhttp/http.c:957: undefined reference to 'curl_easy_header'
collect2: error: ld returned 1 exit status
此处函数`curl_easy_header()`在旧版`/usr/lib/x86_64-linux-gnu/libcurl.so`中不可用，但在新版`/usr/local/lib/libcurl.so`中可用。
问题源于链接器标志的顺序，解决方案之一是在LDFLAGS变量中指定库的完整路径：
$ LDFLAGS="-Wl,--no-as-needed /usr/local/lib/libcurl.so" ./configure --enable-server --with-mysql --with-libcurl=/usr/local/bin/curl-config
注意`-Wl,--no-as-needed`选项在某些系统上可能需要（另请参阅：[Debian-based](https://wiki.debian.org/ToolChain/DSOLinking)系统的默认链接选项）。
##### Limitations
- Only same host (template) dependencies are allowed
- An item prototype can depend on another item prototype or regular
item from the same host
- Maximum count of dependent items for one master item is limited to
29999 (regardless of the number of dependency levels)
- Maximum 3 dependency levels allowed
- Dependent item on a host with master item from template will not be
exported to XML
##### 限制
- 仅允许相同主机（模板）的依赖关系
- 一个监控项原型可以依赖于同一主机中的另一个监控项原型或常规监控项
- 单个主监控项的依赖监控项最大数量限制为29999（不考虑依赖层级数量）
- 最多允许3级依赖关系
- 来自模板的主监控项在一个主机上的依赖监控项不会被导出到XML
#### Limitations on using X.509 v3 certificate extensions
When implementing X.509 v3 certificates within Zabbix, certain extensions may not be fully supported or could result in inconsistent behavior.
**Subject Alternative Name extension**
Zabbix does not support the *Subject Alternative Name* extension, which is used to specify alternative DNS names such as IP addresses or email addresses.
Zabbix can only validate the value in the *Subject* field of the certificate (see [Restricting Allowed Certificate Issuer and Subject](#restricting-allowed-certificate-issuer-and-subject)).
If certificates include the `subjectAltName` field, the outcome of certificate validation may vary depending on the specific crypto toolkits used to compile Zabbix components.
As a result, Zabbix may either accept or reject certificates based on these combinations.
**Extended Key Usage extension**
Zabbix supports the *Extended Key Usage* extension.
However, if used, it is generally required that both *clientAuth* (for TLS WWW client authentication) and *serverAuth* (for TLS WWW server authentication) attributes are specified.
For example:
- In passive checks, where Zabbix agent operates as a TLS server, the *serverAuth* attribute must be included in the agent's certificate.
- For active checks, where the agent operates as a TLS client, the *clientAuth* attribute must be included in the agent's certificate.
While GnuTLS may issue a warning for key usage violations, it typically allows communication to proceed despite these warnings.
**Name Constraints extension**
Support for the *Name Constraints* extension varies among crypto toolkits.
Ensure that your chosen toolkit supports this extension.
This extension may restrict Zabbix from loading CA certificates if this section is marked as critical, depending on the specific toolkit in use.
#### 使用X.509 v3证书扩展的限制
在Zabbix中实现X.509 v3证书时，某些扩展可能无法完全支持或导致不一致的行为。
**主题备用名称扩展**
Zabbix不支持*主题备用名称*扩展，该扩展用于指定替代DNS名称（如IP地址或电子邮件地址）。
Zabbix仅能验证证书*Subject*字段中的值（参见[限制允许的证书颁发者和主题](#restricting-allowed-certificate-issuer-and-subject)）。
若证书包含`subjectAltName`字段，证书验证结果可能因编译Zabbix组件所使用的加密工具包而异。
因此，Zabbix可能根据这些组合接受或拒绝证书。
**扩展密钥用法扩展**
Zabbix支持*扩展密钥用法*扩展。
但使用时通常需要同时指定*clientAuth*（用于TLS WWW客户端认证）和*serverAuth*（用于TLS WWW服务器认证）属性。
例如：
- 在被动检查中，当Zabbix agent作为TLS服务器运行时，agent的证书必须包含*serverAuth*属性。
- 对于主动检查，当agent作为TLS客户端运行时，agent的证书必须包含*clientAuth*属性。
尽管GnuTLS可能问题密钥用法违规警告，但通常仍会允许通信继续进行。
**名称约束扩展**
对*名称约束*扩展的支持因加密工具包而异。
请确保所选工具包支持此扩展。
若该部分被标记为关键，根据使用的具体工具包，此扩展可能限制Zabbix加载CA证书。
#### Limitations
- Private keys are stored in plain text in files readable by Zabbix
components during startup
- Pre-shared keys are entered in Zabbix frontend and stored in Zabbix
database in plain text
- Built-in encryption does not protect communications:
- Between the web server running Zabbix frontend and user web
browser
- Between Zabbix frontend and Zabbix server
- Currently each encrypted connection opens with a full TLS handshake,
no session caching and tickets are implemented
- Adding encryption increases the time for item checks and actions,
depending on network latency:
- For example, if packet delay is 100ms then opening a TCP
connection and sending unencrypted request takes around 200ms.
With encryption about 1000 ms are added for establishing the TLS
connection;
- Timeouts may need to be increased, otherwise some items and
actions running remote scripts on agents may work with
unencrypted connections, but fail with timeout with encrypted.
- Encryption is not supported by [network
discovery](/manual/discovery/network_discovery). Zabbix agent checks
performed by network discovery will be unencrypted and if Zabbix
agent is configured to reject unencrypted connections such checks
will not succeed.
#### 限制条件
- 私钥以明文形式存储在Zabbix组件启动时可读取的文件中
- 预共享密钥通过Zabbix前端输入并以明文形式存储在Zabbix数据库中
- 内置加密不保护以下通信：
- 运行Zabbix前端的Web服务器与用户Web浏览器之间的通信
- Zabbix前端与Zabbix server之间的通信
- 当前每个加密连接都会进行完整的TLS握手，未实现会话缓存和票据机制
- 加密会增加监控项检查和操作的耗时，具体取决于网络延迟：
- 例如，若数据包延迟为100ms，则建立TCP连接并发送未加密请求约需200ms。启用加密后，建立TLS连接会增加约1000ms耗时；
- 可能需要增加超时设置，否则某些监控项和在agents上执行远程脚本的操作可能在使用未加密连接时正常工作，但加密连接会因超时而失败。
- [network
discovery](/manual/discovery/network_discovery)不支持加密。网络发现执行的Zabbix agent检查将保持未加密状态，若Zabbix agent配置为拒绝未加密连接，此类检查将无法成功。
##### Limitations
There are some limitations associated with the algorithm of creating LLD
macro names from MBean property names:
- attribute names are changed to uppercase
- attribute names are ignored (no LLD macros are generated) if they
consist of unsupported characters for LLD macro names. Supported
characters can be described by the following regular expression:
`A-Z0-9_\.`
- if an attribute is called "obj" or "domain" they will be ignored
because of the overlap with the values of the reserved Zabbix
properties {\#JMXOBJ} and {\#JMXDOMAIN} (supported since Zabbix
3.4.3.)
Please consider this jmx.discovery (with "beans" mode) example. MBean
has the following properties defined (some of which will be ignored; see below):
name=test
тип=Type
attributes []=1,2,3
Name=NameOfTheTest
domAin=some
As a result of JMX discovery, the following LLD macros will be
generated:
- {\#JMXDOMAIN} - Zabbix internal, describing the domain of MBean
- {\#JMXOBJ} - Zabbix internal, describing MBean object
- {\#JMXNAME} - created from "name" property
Ignored properties are:
- тип : its name contains unsupported characters (non-ASCII)
- attributes\[\] : its name contains unsupported characters (square
brackets are not supported)
- Name : it's already defined (name=test)
- domAin : it's a Zabbix reserved name
##### 限制
从MBean属性名称生成LLD宏名称的算法存在以下限制:
- 属性名称会被转换为大写
- 如果属性名称包含LLD宏名不支持的字符，则会被忽略(不生成LLD宏)。支持的字符可以用以下正则表达式描述:
`A-Z0-9_\.`
- 如果属性名为"obj"或"domain"，它们将被忽略
because of the overlap with the values of the reserved Zabbix
properties {\#JMXOBJ} and {\#JMXDOMAIN} (supported since Zabbix
3.4.3.)
请看这个jmx.discovery(使用"beans"模式)的示例。MBean定义了以下属性(其中部分属性会被忽略，见下文):
name=test
тип=Type
attributes []=1,2,3
Name=NameOfTheTest
domAin=some
JMX发现过程将生成以下LLD宏:
- {\#JMXDOMAIN} - Zabbix内部使用，描述MBean的域
- {\#JMXOBJ} - Zabbix内部使用，描述MBean object
- {\#JMXNAME} - 从"name"属性创建
被忽略的属性包括:
- тип : 名称包含不支持的字符(非ASCII字符)
- attributes[] : 名称包含不支持的字符(不支持方括号)
- Name : 已定义(name=test)
- domAin : 是Zabbix保留名称
#### Limitations
Zabbix agent for Windows does not support
non-standard Windows configurations where CPUs are distributed
non-uniformly across NUMA nodes. If logical CPUs are distributed
non-uniformly, then CPU performance metrics may not be available for
some CPUs. For example, if there are 72 logical CPUs with 2 NUMA nodes,
both nodes must have 36 CPUs each.
#### 限制条件
Zabbix agent for Windows不支持
在非标准Windows配置下CPU非均匀分布
跨NUMA节点的场景。若逻辑CPU呈现
非均匀分布，则部分CPU的性能指标
可能无法获取。例如，当系统存在72个逻辑CPU
且划分为2个NUMA节点时，每个节点
必须均包含36个CPU。
#### Limiting access to API
Update role with ID "5", deny to call any "create", "update" or "delete"
methods.
Request:
```json
{
"jsonrpc": "2.0",
"method": "role.update",
"params": [
{
"roleid": "5",
"rules": {
"api.access": "1",
"api.mode": "0",
"api": ["*.create", "*.update", "*.delete"]
}
}
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}
```
#### 限制对 API 的访问
更新ID为"5"的角色，禁止调用任何"create"、"update"或"delete"
方法。
请求:
```json
{
"jsonrpc": "2.0",
"method": "role.update",
"params": [
{
"roleid": "5",
"rules": {
"api.access": "1",
"api.mode": "0",
"api": ["*.create", "*.update", "*.delete"]
}
}
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}
```
### Limits for JavaScript objects in preprocessing
The following limits for [JavaScript objects](/manual/config/items/preprocessing/javascript/javascript_objects#additional-javascript-objects) in preprocessing have been introduced:
- The total size of all messages that can be logged with the `log()` method has been limited to 8 MB per script execution.
- The initialization of multiple `HttpRequest` objects has been limited to 10 per script execution.
- The total length of header fields that can be added to a single `HttpRequest` object with the `addHeader()` method has been limited to 128 Kbytes (special characters and header names included).
### 预处理中 JavaScript objects 的限制
预处理中针对[1-附加-javascript-objects](/manual/config/items/preprocessing/javascript/javascript_objects#1-附加-javascript-objects)的以下限制已被引入:
- 通过`log()`方法可记录的所有消息总大小被限制为每次脚本执行8 MB
- 多个`HttpRequest` objects的初始化被限制为每次脚本执行10个
- 通过`addHeader()`方法添加到单个`HttpRequest` object的标头字段总长度被限制为128 KB(包含特殊字符和标头名称)
### Limits for JavaScript objects in preprocessing
The following limits for [JavaScript objects](/manual/config/items/preprocessing/javascript/javascript_objects#additional-javascript-objects) in preprocessing have been introduced:
- The total size of all messages that can be logged with the `log()` method has been limited to 8 MB per script execution.
- The initialization of multiple `HttpRequest` objects has been limited to 10 per script execution.
- The total length of header fields that can be added to a single `HttpRequest` object with the `addHeader()` method has been limited to 128 Kbytes (special characters and header names included).
### 预处理中 JavaScript objects 的限制
预处理中针对[1-附加-javascript-objects](/manual/config/items/preprocessing/javascript/javascript_objects#1-附加-javascript-objects)设置了以下限制:
- 通过`log()`方法记录的所有消息总大小限制为每次脚本执行8MB
- 每次脚本执行最多可初始化10个`HttpRequest` objects
- 通过`addHeader()`方法添加到单个`HttpRequest` object的标头字段总长度限制为128KB(包含特殊字符和标头名称)
#### Limits of filtering with utf8mb4 collations
Filters (e.g., in *Configuration* → [*Maintenance*](/manual/web_interface/frontend_sections/configuration/maintenance#using-filter)) may not function correctly when applied to entities containing certain Unicode characters (e.g., ȼ, ɇ).
This issue arises due to how the default utf8mb4\_bin collation for MySQL or MariaDB databases handles sorting and comparison of Unicode characters.
To address this limitation, users can change the collation of database columns to alternatives such as utf8mb4\_0900\_bin, utf8mb4\_0900\_ai\_ci, or utf8mb4\_unicode\_520\_ci.
Note, however, that changing the collation may cause unexpected behavior in the handling of empty spaces, as well as sorting and filtering for other characters.
For more information on changing collations, see [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/alter-table.html#alter-table-character-set) or [MariaDB documentation](https://mariadb.com/kb/en/alter-database/).
For details on collation differences, see [Unicode Character Sets](https://dev.mysql.com/doc/refman/8.4/en/charset-unicode-sets.html) in MySQL documentation.
#### 使用utf8mb4排序规则过滤的限制
过滤器（例如在*配置* → [使用过滤器](/manual/web_interface/frontend_sections/configuration/maintenance#使用过滤器)中）在应用于包含特定Unicode字符（如ȼ、ɇ）的实体时可能无法正常工作。
该问题是由于MySQL默认的utf8mb4\_bin排序规则或mariadb数据库处理Unicode字符排序和比较的方式所导致。
为解决此限制，用户可将数据库列的排序规则更改为其他选项，如utf8mb4\_0900\_bin、utf8mb4\_0900\_ai\_ci或utf8mb4\_unicode\_520\_ci。
但需注意，更改排序规则可能导致处理空格时出现意外行为，以及其他字符的排序和过滤异常。
有关更改排序规则的更多信息，请参阅[MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/alter-table.html#alter-table-character-set)或[MariaDB documentation](https://mariadb.com/kb/en/alter-database/)。
有关排序规则差异的详细信息，请参见MySQL文档中的[Unicode Character Sets](https://dev.mysql.com/doc/refman/8.4/en/charset-unicode-sets.html)。
#### Link a group to templates
Add host group "2" to two templates.
Request:
```json
{
"jsonrpc": "2.0",
"method": "template.massadd",
"params": {
"templates": [
{
"templateid": "10085"
},
{
"templateid": "10086"
}
],
"groups": [
{
"groupid": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10085",
"10086"
]
},
"id": 1
}
```
#### 将组关联至模板
将主机组 "2"添加到两个模板中。
请求:
```json
{
"jsonrpc": "2.0",
"method": "template.massadd",
"params": {
"templates": [
{
"templateid": "10085"
},
{
"templateid": "10086"
}
],
"groups": [
{
"groupid": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10085",
"10086"
]
},
"id": 1
}
```
#### Linking a template
To link a template to the host, do the following:
- Go to *Configuration → Hosts*
- Click on the required host
- Start typing the template name in the *Templates* field. A list of
matching templates will appear; scroll down to select.
- Alternatively, you may click on *Select* next to the field and
select one or several templates from the list in a popup window
- Click on *Add/Update* in the host attributes form
The host will now have all the entities (items, triggers, graphs, etc)
of the template.
::: noteimportant
Linking multiple templates to the same host will
fail if in those templates there are items with the same item key. And,
as triggers and graphs use items, they cannot be linked to a single host
from multiple templates either, if using identical item
keys.
:::
When entities (items, triggers, graphs etc.) are added from the
template:
- previously existing identical entities on the host are updated as
entities of the template, and **any existing host-level customizations to the entity are lost**
- entities from the template are added
- any directly linked entities that, prior to template linkage,
existed only on the host remain untouched
In the lists, all entities from the template now are prefixed by the
template name, indicating that these belong to the particular template.
The template name itself (in gray text) is a link allowing to access the
list of those entities on the template level.
If some entity (item, trigger, graph etc.) is not prefixed by the
template name, it means that it existed on the host before and was not
added by the template.
#### 关联模板
要将模板链接至主机，请执行以下操作：
- 前往*配置 → 主机*
- 点击目标主机
- 在*模板*字段输入模板名称，将显示匹配模板列表，滚动选择
- 或点击字段旁的*选择*按钮，在弹出窗口中从列表选择一个或多个模板
- 在主机属性表单中点击*添加/更新*
主机将继承模板中的所有实体（监控项、触发器、图形等）
::: noteimportant
若多个模板中存在监控项键相同的监控项，则无法将这些模板链接至同一主机。由于触发器和图形依赖监控项，若使用相同监控项键，它们也无法通过多个模板链接至单个主机。
:::
当从模板添加实体（监控项、触发器、图形等）时：
- 主机上已存在的相同实体将更新为模板实体，**该实体所有现有主机级别自定义配置将被清除**
- 模板中的实体将被添加
- 模板链接前直接关联的实体若...
existed only on the host remain untouched
在列表中，所有来自模板的实体现在都带有模板名前缀，表明它们属于特定模板。灰色文本的模板名称本身是可点击链接，可访问模板级别的实体列表。
若某实体（监控项、触发器、图形等）未带模板名前缀，说明该实体在模板链接前已存在于主机。
#### Linking elements
Once you have put some elements on the map, it is time to start linking
them. To link two elements you must first select them. With the elements
selected, click on *Add* next to Link.
With a link created, the single element form now contains an additional
*Links* section. Click on *Edit* to edit link attributes.
{width="600"}
Link attributes:
|Parameter|Description|
|--|--------|
|*Label*|Label that will be rendered on top of the link.<br>Expression [macros](/manual/appendix/macros/supported_by_location) are supported in this field, but only with `avg`, `last`, `min` and `max` functions, with time as parameter (for example, `{?avg(/host/key,1h)}`).|
|*Connect to*|The element that the link connects to.|
|*Type (OK)*|Default link style:<br>**Line** - single line<br>**Bold line** - bold line<br>**Dot** - dots<br>**Dashed line** - dashed line|
|*Color (OK)*|Default link color.|
|*[Link indicators](links)*|List of triggers linked to the link. In case a trigger has status PROBLEM, its style is applied to the link.|
#### 关联元素
在地图上放置了一些元素后，就可以开始连接它们了。要连接两个元素，首先需要选中它们。选中元素后，点击链接旁边的*添加*按钮。
创建链接后，单个元素表单现在包含一个额外的*链接*部分。点击*编辑*来修改链接属性。
{width="600"}
链接属性：
| 参数 | 描述 |
|--|--------|
| *Label* | 将在链接Top上显示的标签。<br>此字段支持表达式[macros](/manual/appendix/macros/supported_by_location)，但仅限使用`avg`、`last`、`min`和`max`函数，并以时间作为参数（例如`{?avg(/host/key,1h)}`）。 |
| *Connect to* | 链接所连接到的元素。 |
| *Type (OK)* | 默认链接样式：<br>**线条** - 单线<br>**粗线** - 粗线<br>**点线** - 点线<br>**虚线** - 虚线 |
| *Color (OK)* | 默认链接颜色。 |
| *[Link indicators](links)* | 与链接关联的触发器列表。如果触发器状态为PROBLEM，其样式将应用于链接。 |
##### Linking pre-defined templates to hosts
As you may have noticed, Zabbix comes with a set of predefined templates
for various OS, devices and applications. To get started with monitoring
very quickly, you may link the appropriate one of them to a host, but
beware that these templates need to be fine-tuned for your environment.
Some checks may not be needed, and polling intervals may be way too
frequent.
More information about [templates](/manual/config/templates) is
available.
##### 将预定义模板关联至主机
正如您可能已经注意到的，Zabbix附带了一组针对各种操作系统、设备和应用程序的预定义模板。为了get快速开始监控，您可以将其中合适的模板链接到一个主机，但请注意这些模板需要根据您的环境进行微调。某些检查可能并不需要，轮询间隔也可能过于频繁。
有关[templates](/manual/config/templates)的更多信息可用。
#### Linking template to host
With a template ready, it only remains to add it to a host. For that, go
to *Configuration → Hosts*, click on 'New host' to open its property
form and find the **Templates** field.
Start typing *New template* in the *Templates* field. The name of
template we have created should appear in the dropdown list. Scroll down
to select. See that it appears in the *Templates* field.
Click *Update* in the form to save the changes. The template is now
added to the host, with all entities that it holds.
As you may have guessed, this way it can be applied to any other host as
well. Any changes to the items, triggers and other entities at the
template level will propagate to the hosts the template is linked to.
#### 将模板链接到主机
准备好模板后，只需将其添加到一个主机。为此，请转到*配置 → 主机*，点击'新建主机'打开其属性表单，并找到**模板**字段。
开始在*模板*字段中输入*新模板*。我们创建的模板名称应出现在下拉列表中。向下滚动选择。确认它出现在*模板*字段中。
点击表单中的*更新*保存更改。该模板现已添加到主机，包含其持有的所有实体。
您可能已经猜到，这种方式也可以将其应用于任何其他主机。对监控项、触发器及其他模板级别实体的任何更改，都将传播到该模板所链接的主机。
#### Links available
For each entry the following links are available:
- Hosts
- Monitoring
- Latest data
- Problems
- Graphs
- Host dashboards
- Web scenarios
- Configuration
- Items
- Triggers
- Graphs
- Discovery rules
- Web scenarios
```{=html}
<!-- -->
```
- Host groups
- Monitoring
- Latest data
- Problems
- Web scenarios
- Configuration
- Hosts
- Templates
```{=html}
<!-- -->
```
- Templates
- Configuration
- Items
- Triggers
- Graphs
- Template dashboards
- Discovery rules
- Web scenarios
#### 可用链接
每个条目提供以下链接:
- 主机
- Monitoring
- Latest data
- Problems
- Graphs
- Host dashboards
- Web scenarios
- Configuration
- Items
- Triggers
- Graphs
- Discovery rules
- Web scenarios
```{=html}
<!-- -->
```
- 主机 组
- Monitoring
- Latest data
- Problems
- Web scenarios
- Configuration
- Hosts
- Templates
```{=html}
<!-- -->
```
- 模板
- 配置
- 监控项
- 触发器
- 图形
- 模板仪表板
- 发现规则
- Web场景
##### Links
Clicking on a map element opens a menu with some available links.
##### 链接
点击地图元素会打开一个包含可用链接的菜单。
#### Link two templates to a template
Link templates "10106" and "10104" to template.
Request:
```json
{
"jsonrpc": "2.0",
"method": "template.massadd",
"params": {
"templates": [
{
"templateid": "10073"
}
],
"templates_link": [
{
"templateid": "10106"
},
{
"templateid": "10104"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10073"
]
},
"id": 1
}
```
#### 将两个模板链接至一个模板
将模板"10106"和"10104"链接至模板。
请求:
```json
{
"jsonrpc": "2.0",
"method": "template.massadd",
"params": {
"templates": [
{
"templateid": "10073"
}
],
"templates_link": [
{
"templateid": "10106"
},
{
"templateid": "10104"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"templateids": [
"10073"
]
},
"id": 1
}
```
#### Linux kernel threads
#### Linux 内核线程
##### Linux
On Linux systems `ps` command can be used together with `watch` command
for observing how Zabbix is doing. For example, to run `ps` command 5
times per second to see process activities:
watch -n 0.2 ps -fu zabbix
To show only Zabbix proxy and agent processes:
watch -tn 0.2 'ps -f -C zabbix_proxy -C zabbix_agentd'
To show only history syncer processes:
watch -tn 0.2 'ps -fC zabbix_server | grep history'
The `ps` command produces a wide output (approximately 190 columns) as
some activity messages are long. If your terminal has less than 190
columns of text you can try
watch -tn 0.2 'ps -o cmd -C zabbix_server -C zabbix_proxy -C zabbix_agentd'
to display only commandlines without UID, PID, start time etc.
`top` command also can be used for observing Zabbix performance.
Pressing 'c' key in `top` shows processes with their commandlines. In
our tests on Linux `top` and `atop` correctly displayed changing
activities of Zabbix processes, but `htop` was not displaying changing
activities.
##### Linux
在 Linux 系统上 `ps` 命令可以与 `watch` 命令一起使用，以观察 Zabbix 的运行情况。例如，`ps` c每秒运行 5 次命令以查看进程活动：
watch -n 0.2 ps -fu zabbix
仅显示Zabbix proxy 和 agent 进程：
watch -tn 0.2 'ps -f -C zabbix_proxy -C zabbix_agentd'
仅显示历史同步器进程：
watch -tn 0.2 'ps -fC zabbix_server | grep history'
由于某些活动消息很长，因此该 `ps` 命令会产生很宽的输出（大约 190 列）。如果您的终端的文本少于 190 列，您可以尝试
watch -tn 0.2 'ps -o cmd -C zabbix_server -C zabbix_proxy -C zabbix_agentd'
仅显示没有 UID、PID、开始时间等的命令行。
`top`命令也可用于观察 Zabbix 性能。按 'c' 键 `top` 显示带有命令行的进程。在我们在 Linux 上的测试中 `top` and `atop` c正确显示了 Zabbix 进程的变化活动，但 `htop` 没有显示变化的活动。
#### Linux
See values supported for 'memtype' parameter on Linux in the table.
|Supported value|Description|Source in /proc/<pid>/status file|
|--|------|--|
|vsize ^[1](proc_mem_notes#footnotes)^|Virtual memory size|VmSize|
|pmem|Percentage of real memory|(VmRSS/total\_memory) \* 100|
|rss|Resident set size|VmRSS|
|data|Size of data segment|VmData|
|exe|Size of code segment|VmExe|
|hwm|Peak resident set size|VmHWM|
|lck|Size of locked memory|VmLck|
|lib|Size of shared libraries|VmLib|
|peak|Peak virtual memory size|VmPeak|
|pin|Size of pinned pages|VmPin|
|pte|Size of page table entries|VmPTE|
|size|Size of process code + data + stack segments|VmExe + VmData + VmStk|
|stk|Size of stack segment|VmStk|
|swap|Size of swap space used|VmSwap|
Notes for Linux:
1. Not all 'memtype' values are supported by older Linux kernels. For
example, Linux 2.4 kernels do not support `hwm`, `pin`, `peak`,
`pte` and `swap` values.
2. We have noticed that self-monitoring of the Zabbix agent active
check process with `proc.mem[...,...,...,...,data]` shows a value
that is 4 kB larger than reported by `VmData` line in the agent's
/proc/<pid>/status file. At the time of self-measurement the
agent's data segment increases by 4 kB and then returns to the
previous size.
#### Linux
请参阅表格中Linux系统下'memtype'参数支持的值。
| 支持的值 | 描述 | 在 /proc/<pid>/status 中的来源 file |
|--|------|--|
| vsize ^[1](proc_mem_notes#脚注)^ | 虚拟 memory 大小 | VmSize |
| pmem | 实际内存使用百分比 memory | (VmRSS/总内存) \* 100 |
| rss | 驻留集大小 | VmRSS |
| data | 数据段大小 | VmData |
| exe | 代码段大小 | VmExe |
| hwm | 峰值常驻内存集大小 | VmHWM |
| lck | 锁定的memory大小 | VmLck |
| lib | 共享库大小 | VmLib |
| peak | 峰值虚拟 memory 大小 | VmPeak |
| pin | 固定页面大小 | VmPin |
| pte | 页表条目大小 | VmPTE |
| 大小 | 进程代码+数据+堆栈段的总大小 | VmExe + VmData + VmStk |
| stk | 栈段大小 | VmStk |
| swap | 已使用的交换空间大小 | VmSwap |
Linux注意事项:
1. 并非所有'memtype'值都被旧版Linux内核支持。
例如，Linux 2.4内核不支持`hwm`、`pin`、`peak`，
`pte` 和 `swap` 值。
2. 我们注意到Zabbix agent活跃项的自我监控
使用`proc.mem[...,...,...,...,data]`检查进程显示一个值
比`VmData`行在agent中报告的大4 kB
/proc/<pid>/status file. 在自测量时
agent的数据段增加4 kB后恢复原状
previous size.
之前的尺寸.
##### List of sorting fields available for each type of diagnostic information request
Following statistic fields can be used to sort and limit requested
information.
|Diagnostic type|Available fields|[Type](/manual/api/reference_commentary#data_types)|
|---------------|----------------|---------------------------------------------------|
|historycache|values|integer|
|valuecache|values|integer|
|^|request.values|integer|
|preprocessing|values|integer|
|alerting|media.alerts|integer|
|^|source.alerts|integer|
|lld|values|integer|
##### 每种诊断信息请求类型可用的排序字段列表
以下统计字段可用于排序和限制请求的信息。
| 诊断类型 | 可用字段 | [数据类型](/manual/api/reference_commentary#数据类型) |
|---------------|----------------|---------------------------------------------------|
| historycache | values | integer |
| valuecache | values | integer |
| ^ | request.values | integer |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| ^ | source.alerts | integer |
| lld | values | integer |
##### List of statistic fields available for each type of diagnostic information request
Following statistic fields can be requested for each type of diagnostic
information request property.
|Diagnostic type|Available fields|Description|
|---------------|----------------|-----------|
|historycache|items|Number of cached items.|
|^|values|Number of cached values.|
|^|memory|Shared memory statistics (free space, number of used chunks, number of free chunks, max size of free chunk).|
|^|memory.data|History data cache shared memory statistics.|
|^|memory.index|History index cache shared memory statistics.|
|valuecache|items|Number of cached items.|
|^|values|Number of cached values.|
|^|memory|Shared memory statistics (free space, number of used chunks, number of free chunks, max size of free chunk).|
|^|mode|Value cache mode.|
|preprocessing|values|Number of queued values.|
|^|preproc.values|Number of queued values with preprocessing steps.|
|alerting|alerts|Number of queued alerts.|
|lld|rules|Number of queued rules.|
|^|values|Number of queued values.|
##### 每种诊断信息请求类型可用的统计字段列表
每种诊断信息请求属性可获取以下统计字段
| 诊断类型 | 可用字段 | 描述 |
|---------------|----------------|-----------|
| historycache | 监控项 | 缓存的监控项数量 |
| ^ | values | 缓存值数量 |
| ^ | memory | 共享memory统计（空闲空间、已用块数、空闲块数、最大空闲块大小） |
| ^ | memory.data | 历史数据缓存共享memory统计 |
| ^ | memory.index | 历史index cache共享memory统计 |
| valuecache | 监控项 | 缓存的监控项数量 |
| ^ | values | 缓存值数量 |
| ^ | memory | 共享memory统计（空闲空间、已用块数、空闲块数、最大空闲块大小） |
| ^ | mode | value cache模式 |
| preprocessing | values | 排队值数量 |
| ^ | preproc.values | 带预处理步骤的排队值数量 |
| alerting | alerts | 排队告警数量 |
| lld | rules | 排队规则数量 |
| ^ | values | 排队值数量 |
##### List of waiting items
In this screen, each waiting item is listed.
{width="600"}
Displayed data:
|Column|Description|
|--|--------|
|*Scheduled check*|The time when the check was due is displayed.|
|*Delayed by*|The length of the delay is displayed.|
|*Host*|Host of the item is displayed.|
|*Name*|Name of the waiting item is displayed.|
|*Proxy*|The proxy name is displayed, if the host is monitored by proxy.|
##### 等待中的 监控项 列表
在此界面中，每个等待中的监控项都会被列出。
{width="600"}
显示的数据：
| 列 | 描述 |
|--|--------|
| *Scheduled check* | 显示检查应执行的时间。 |
| *Delayed by* | 显示延迟的时长。 |
| *Host* | 显示监控项的主机。 |
| *Name* | 显示等待中的监控项名称。 |
| *Proxy* | 如果主机由proxy监控，则显示proxy名称。 |
### LLD macro path
The LLD macro path has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**lld\_macro**<br>(required)|string|LLD macro.|
|**path**<br>(required)|string|Selector for value which will be assigned to corresponding macro.|
### LLD 宏路径
LLD宏路径具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **lld\_macro**<br>(required) | string | LLD宏. |
| **path**<br>(required) | string | 用于选择将分配给相应宏的值的选择器. |
#### LLD rule filter condition
The LLD rule filter condition object defines a separate check to perform
on the value of an LLD macro. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**macro**<br>(required)|string|LLD macro to perform the check on.|
|**value**<br>(required)|string|Value to compare with.|
|formulaid|string|Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|operator|integer|Condition operator.<br><br>Possible values:<br>8 - *(default)* matches regular expression;<br>9 - does not match regular expression;<br>12 - exists;<br>13 - does not exist.|
::: notetip
To better understand how to use filters with various
types of expressions, see examples on the
[discoveryrule.get](get#retrieving_filter_conditions) and
[discoveryrule.create](create#using_a_custom_expression_filter) method
pages.
:::
#### LLD 规则过滤条件
LLD规则过滤条件object定义了在LLD宏值上执行的独立检查。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **macro**<br>(required) | string | 待检查的LLD宏。 |
| **value**<br>(required) | string | 用于比较的值。 |
| formulaid | string | 用于在自定义表达式中引用该条件的任意唯一ID。只能包含大写字母。修改过滤条件时必须由用户定义该ID，但在后续请求时会重新生成。 |
| operator | integer | 条件运算符。<br><br>可选值：<br>8 - *(默认)* 匹配正则表达式；<br>9 - 不匹配正则表达式；<br>12 - 存在；<br>13 - 不存在。 |
::: notetip
要更好地理解如何将过滤器与各类表达式结合使用，请参阅
[discoveryrule.get](get#retrieving_filter_conditions)和
[discoveryrule.create](create#using_a_custom_expression_filter)方法页面的示例。
:::
### LLD rule filter
The LLD rule filter object defines a set of conditions that can be used
to filter discovered objects. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**conditions**<br>(required)|array|Set of filter conditions to use for filtering results.|
|**evaltype**<br>(required)|integer|Filter condition evaluation method.<br><br>Possible values:<br>0 - and/or;<br>1 - and;<br>2 - or;<br>3 - custom expression.|
|eval\_formula|string|*(readonly)* Generated expression that will be used for evaluating filter conditions. The expression contains IDs that reference specific filter conditions by its `formulaid`. The value of `eval_formula` is equal to the value of `formula` for filters with a custom expression.|
|formula|string|User-defined expression to be used for evaluating conditions of filters with a custom expression. The expression must contain IDs that reference specific filter conditions by its `formulaid`. The IDs used in the expression must exactly match the ones defined in the filter conditions: no condition can remain unused or omitted.<br><br>Required for custom expression filters.|
### LLD 规则过滤器
LLD规则过滤器object定义了一组可用于筛选发现objects的条件。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **conditions**<br>(required) | array | 用于筛选结果的过滤条件集合。 |
| **evaltype**<br>(required) | integer | 过滤条件评估方法。<br><br>可能值：<br>0 - 与/或；<br>1 - 与；<br>2 - 或；<br>3 - 自定义表达式。 |
| eval\_formula | string | *(只读)* 用于评估过滤条件的生成表达式。该表达式包含通过`formulaid`引用特定过滤条件的ID。对于具有自定义表达式的过滤器，`eval_formula`的值等于`formula`的值。 |
| formula | string | 用户定义的表达式，用于评估具有自定义表达式的过滤器的条件。该表达式必须包含通过`formulaid`引用特定过滤条件的ID。表达式中使用的ID必须与过滤条件中定义的ID完全匹配：不能有任何条件未被使用或遗漏。<br><br>自定义表达式过滤器必需。 |
#### LLD rule override filter condition
The LLD rule override filter condition object defines a separate check
to perform on the value of an LLD macro. It has the following
properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**macro**<br>(required)|string|LLD macro to perform the check on.|
|**value**<br>(required)|string|Value to compare with.|
|formulaid|string|Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.|
|operator|integer|Condition operator.<br><br>Possible values:<br>8 - *(default)* matches regular expression;<br>9 - does not match regular expression;<br>12 - exists;<br>13 - does not exist.|
#### LLD 规则覆盖过滤条件
LLD规则覆盖过滤器条件object定义了要对LLD宏值执行的独立检查。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **macro**<br>(required) | string | 要执行检查的LLD宏。 |
| **value**<br>(required) | string | 用于比较的值。 |
| formulaid | string | 用于从自定义表达式引用该条件的任意唯一ID。只能包含大写字母。修改过滤条件时必须由用户定义该ID，但在后续请求时会重新生成。 |
| operator | integer | 条件运算符。<br><br>可能的值：<br>8 - *(默认)* 匹配正则表达式；<br>9 - 不匹配正则表达式；<br>12 - 存在；<br>13 - 不存在。 |
#### LLD rule override filter
The LLD rule override filter object defines a set of conditions that if
they match the discovered object the override is applied. It has the
following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**evaltype**<br>(required)|integer|Override filter condition evaluation method.<br><br>Possible values:<br>0 - and/or;<br>1 - and;<br>2 - or;<br>3 - custom expression.|
|**conditions**<br>(required)|array|Set of override filter conditions to use for matching the discovered objects.|
|eval\_formula|string|*(readonly)* Generated expression that will be used for evaluating override filter conditions. The expression contains IDs that reference specific override filter conditions by its `formulaid`. The value of `eval_formula` is equal to the value of `formula` for filters with a custom expression.|
|formula|string|User-defined expression to be used for evaluating conditions of override filters with a custom expression. The expression must contain IDs that reference specific override filter conditions by its `formulaid`. The IDs used in the expression must exactly match the ones defined in the override filter conditions: no condition can remain unused or omitted.<br><br>Required for custom expression override filters.|
#### LLD 规则覆盖过滤器
LLD规则覆盖过滤器object定义了一组条件，当这些条件与发现的object匹配时，将应用覆盖。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **evaltype**<br>(required) | integer | 覆盖过滤器条件评估方法。<br><br>可能的值：<br>0 - 与/或；<br>1 - 与；<br>2 - 或；<br>3 - 自定义表达式。 |
| **conditions**<br>(required) | array | 用于匹配发现的objects的覆盖过滤器条件集。 |
| eval\_formula | string | *(只读)* 生成的表达式，用于评估覆盖过滤器条件。该表达式包含通过其`formulaid`引用特定覆盖过滤器条件的ID。对于具有自定义表达式的过滤器，`eval_formula`的值等于`formula`的值。 |
| formula | string | 用户定义的表达式，用于评估具有自定义表达式的覆盖过滤器条件。该表达式必须包含通过其`formulaid`引用特定覆盖过滤器条件的ID。表达式中使用的ID必须与覆盖过滤器条件中定义的ID完全匹配：不能有任何条件未被使用或省略。<br><br>自定义表达式覆盖过滤器必需。 |
##### LLD rule override operation discover
LLD rule override operation discover status that is set to discovered
object. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**discover**<br>(required)|integer|Override the discover status for selected object.<br><br>Possible values:<br>0 - Yes, continue discovering the objects;<br>1 - No, new objects will not be discovered and existing ones will be marked as lost.|
##### LLD 规则覆盖操作发现
LLD规则覆盖操作发现状态设置为已发现
object. 它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **discover**<br>(required) | integer | 覆盖所选object的发现状态.<br><br>可能的值:<br>0 - 是, 继续发现objects;<br>1 - 否, 新的objects将不会被发现且现有的将被标记为丢失. |
##### LLD rule override operation history
LLD rule override operation history value that is set to discovered
item. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**history**<br>(required)|string|Override the history of item prototype which is a time unit of how long the history data should be stored. Also accepts user macro and LLD macro.|
##### LLD 规则覆盖操作历史
LLD规则覆盖操作历史值设置为已发现的
监控项. 它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **history**<br>(required) | string | 覆盖监控项原型的历史记录，这是一个关于历史数据应存储多长时间的时间单位。同时接受用户宏和LLD宏。 |
##### LLD rule override operation inventory
LLD rule override operation inventory mode value that is set to
discovered host. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**inventory\_mode**<br>(required)|integer|Override the host prototype inventory mode.<br><br>Possible values are:<br>-1 - disabled;<br>0 - *(default)* manual;<br>1 - automatic.|
##### LLD 规则覆盖操作清单
LLD规则覆盖操作中设置的资产清单模式值
已发现的主机。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **inventory\_mode**<br>(required) | integer | 覆盖 主机 原型资产清单模式.<br><br>可选值为:<br>-1 - 禁用;<br>0 - *(默认)* 手动;<br>1 - 自动. |
##### LLD rule override operation period
LLD rule override operation period is an update interval value (supports
custom intervals) that is set to discovered item. It has the following
properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**delay**<br>(required)|string|Override the update interval of the item prototype. Accepts seconds or a time unit with suffix (30s,1m,2h,1d) as well as flexible and scheduling intervals and user macros or LLD macros. Multiple intervals are separated by a semicolon.|
##### LLD 规则覆盖操作周期
LLD规则覆盖操作周期是一个update间隔值（支持自定义间隔），用于设置被发现的监控项。它具有以下特性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **delay**<br>(required) | string | 覆盖监控项原型的update间隔。接受秒数或带后缀的时间单位（30s,1m,2h,1d），以及灵活调度间隔和用户宏或LLD宏。多个间隔用分号分隔。 |
##### LLD rule override operation severity
LLD rule override operation severity value that is set to discovered
trigger. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**severity**<br>(required)|integer|Override the severity of trigger prototype.<br><br>Possible values are: 0 - *(default)* not classified;<br>1 - information;<br>2 - warning;<br>3 - average;<br>4 - high;<br>5 - disaster.|
##### LLD 规则覆盖操作严重性
LLD规则覆盖操作中设置的触发器严重级别值。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **severity**<br>(required) | integer | 覆盖触发器原型的严重级别。<br><br>可选值为：0 - *(默认)* 未分类；<br>1 - 信息；<br>2 - 警告；<br>3 - 一般严重；<br>4 - 严重；<br>5 - 灾难。 |
##### LLD rule override operation status
LLD rule override operation status that is set to discovered object. It
has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**status**<br>(required)|integer|Override the status for selected object.<br><br>Possible values:<br>0 - Create enabled;<br>1 - Create disabled.|
##### LLD 规则覆盖操作状态
LLD规则覆盖操作状态设置为已发现object. 它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **status**<br>(required) | integer | 为选定的object覆盖状态.<br><br>可能的值:<br>0 - 创建启用;<br>1 - 创建禁用. |
##### LLD rule override operation tag
LLD rule override operation tag object contains tag name and value that
are set to discovered object. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**tag**<br>(required)|string|New tag name.|
|value|string|New tag value.|
##### LLD 规则覆盖操作标签
LLD规则覆盖操作标签object包含为发现项object设置的标签名称和值。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **tag**<br>(required) | string | 新标签名称。 |
| value | string | 新标签值。 |
##### LLD rule override operation template
LLD rule override operation template object that is linked to discovered
host. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**templateid**<br>(required)|string|Override the template of host prototype linked templates.|
##### LLD 规则覆盖操作模板
与已发现主机关联的LLD规则覆盖操作模板object. 它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **templateid**<br>(required) | string | 覆盖主机原型关联模板的模板. |
#### LLD rule override operation
The LLD rule override operation is combination of conditions and actions
to perform on the prototype object. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**operationobject**<br>(required)|integer|Type of discovered object to perform the action.<br><br>Possible values:<br>0 - Item prototype;<br>1 - Trigger prototype;<br>2 - Graph prototype;<br>3 - Host prototype.|
|operator|integer|Override condition operator.<br><br>Possible values:<br>0 - *(default)* equals;<br>1 - does not equal;<br>2 - contains;<br>3 - does not contain;<br>8 - matches;<br>9 - does not match.|
|value|string|Pattern to match item, trigger, graph or host prototype name depending on selected object.|
|opstatus|object|Override operation status object for item, trigger and host prototype objects.|
|opdiscover|object|Override operation discover status object (all object types).|
|opperiod|object|Override operation period (update interval) object for item prototype object.|
|ophistory|object|Override operation history object for item prototype object.|
|optrends|object|Override operation trends object for item prototype object.|
|opseverity|object|Override operation severity object for trigger prototype object.|
|optag|array|Override operation tag object for trigger and host prototype objects.|
|optemplate|array|Override operation template object for host prototype object.|
|opinventory|object|Override operation inventory object for host prototype object.|
#### LLD 规则覆盖操作
LLD规则覆盖操作是条件与动作的组合，用于对原型object执行操作。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **operationobject**<br>(required) | integer | 要执行操作的发现object类型。<br><br>可能值：<br>0 - 监控项原型；<br>1 - 触发器原型；<br>2 - 图形原型；<br>3 - 主机原型。 |
| operator | integer | 覆盖条件运算符。<br><br>可能值：<br>0 - *(默认)* 等于；<br>1 - 不等于；<br>2 - 包含；<br>3 - 不包含；<br>8 - 匹配；<br>9 - 不匹配。 |
| value | string | 根据所选object匹配监控项、触发器、图形或主机原型名称的模式。 |
| opstatus | object | 针对监控项、触发器和主机原型objects的覆盖操作状态object。 |
| opdiscover | object | 覆盖操作发现状态object（所有object类型）。 |
| opperiod | object | 针对监控项原型object的覆盖操作周期（update间隔）object。 |
| ophistory | object | 针对监控项原型object的覆盖操作历史object。 |
| optrends | object | 针对监控项原型object的覆盖操作趋势object。 |
| opseverity | object | 针对触发器原型object的覆盖操作严重性object。 |
| optag | array | 针对触发器和主机原型objects的覆盖操作标签object。 |
| optemplate | array | 针对主机原型object的覆盖操作模板object。 |
| opinventory | object | 针对主机原型object的覆盖操作资产清单object。 |
##### LLD rule override operation trends
LLD rule override operation trends value that is set to discovered item.
It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**trends**<br>(required)|string|Override the trends of item prototype which is a time unit of how long the trends data should be stored. Also accepts user macro and LLD macro.|
##### LLD 规则覆盖操作趋势
LLD规则覆盖操作将趋势值设置为已发现的监控项.
它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **trends**<br>(required) | string | 覆盖监控项原型的趋势值，该值表示趋势数据应存储的时间单位。同时支持用户宏和LLD宏。 |
### LLD rule overrides
The LLD rule overrides object defines a set of rules (filters,
conditions and operations) that are used to override properties of
different prototype objects. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**name**<br>(required)|string|Unique override name.|
|**step**<br>(required)|integer|Unique order number of the override.|
|stop|integer|Stop processing next overrides if matches.<br><br>Possible values:<br>0 - *(default)* don't stop processing overrides;<br>1 - stop processing overrides if filter matches.|
|filter|object|Override filter.|
|operations|array|Override operations.|
### LLD 规则覆盖
LLD规则覆盖object定义了一组规则(过滤器、
条件和操作)，用于覆盖不同原型objects的属性。它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **name**<br>(required) | string | 唯一的覆盖名称。 |
| **step**<br>(required) | integer | 覆盖的唯一序号。 |
| stop | integer | 如果匹配则停止处理后续覆盖。<br><br>可能的值:<br>0 - *(默认)* 不停止处理覆盖;<br>1 - 如果过滤器匹配则停止处理覆盖。 |
| filter | object | 覆盖过滤器。 |
| operations | array | 覆盖操作。 |
### LLD rule
The low-level discovery rule object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|itemid|string|*(readonly)* ID of the LLD rule.|
|**delay**<br>(required)|string|Update interval of the LLD rule. Accepts seconds or time unit with suffix and with or without one or more [custom intervals](/manual/config/items/item/custom_intervals) that consist of either flexible intervals and scheduling intervals as serialized strings. Also accepts user macros. Flexible intervals could be written as two macros separated by a forward slash. Intervals are separated by a semicolon.<br><br>Optional for Zabbix trapper, dependent items and for Zabbix agent (active) with `mqtt.get` key.|
|**hostid**<br>(required)|string|ID of the host that the LLD rule belongs to.|
|**interfaceid**<br>(required)|string|ID of the LLD rule's host interface. Used only for host LLD rules.<br><br>Not required for Zabbix agent (active), Zabbix internal, Zabbix trapper, dependent, database monitor and script LLD rules. Optional for HTTP agent LLD rules.|
|**key\_**<br>(required)|string|LLD rule key.|
|**name**<br>(required)|string|Name of the LLD rule.|
|**type**<br>(required)|integer|Type of the LLD rule.<br><br>Possible values:<br>0 - Zabbix agent;<br>2 - Zabbix trapper;<br>3 - simple check;<br>5 - Zabbix internal;<br>7 - Zabbix agent (active);<br>10 - external check;<br>11 - database monitor;<br>12 - IPMI agent;<br>13 - SSH agent;<br>14 - TELNET agent;<br>16 - JMX agent;<br>18 - Dependent item;<br>19 - HTTP agent;<br>20 - SNMP agent;<br>21 - Script.|
|**url**<br>(required)|string|URL string, required for HTTP agent LLD rule. Supports user macros, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.|
|allow\_traps|integer|HTTP agent LLD rule field. Allow to populate value as in trapper item type also.<br><br>0 - *(default)* Do not allow to accept incoming data.<br>1 - Allow to accept incoming data.|
|authtype|integer|Used only by SSH agent or HTTP agent LLD rules.<br><br>SSH agent authentication method possible values:<br>0 - *(default)* password;<br>1 - public key.<br><br>HTTP agent authentication method possible values:<br>0 - *(default)* none<br>1 - basic<br>2 - NTLM|
|description|string|Description of the LLD rule.|
|error|string|*(readonly)* Error text if there are problems updating the LLD rule value.|
|follow\_redirects|integer|HTTP agent LLD rule field. Follow response redirects while polling data.<br><br>0 - Do not follow redirects.<br>1 - *(default)* Follow redirects.|
|headers|object|HTTP agent LLD rule field. Object with HTTP(S) request headers, where header name is used as key and header value as value.<br><br>Example:<br>{ "User-Agent": "Zabbix" }|
|http\_proxy|string|HTTP agent LLD rule field. HTTP(S) proxy connection string.|
|ipmi\_sensor|string|IPMI sensor. Used only by IPMI LLD rules.|
|jmx\_endpoint|string|JMX agent custom connection string.<br><br>Default value:<br>service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi|
|lifetime|string|Time period after which items that are no longer discovered will be deleted. Accepts seconds, time unit with suffix and user macro.<br><br>Default: `30d`.|
|master\_itemid|integer|Master item ID.<br>Recursion up to 3 dependent items and maximum count of dependent items equal to 999 are allowed.<br>Discovery rule cannot be master item for another discovery rule.<br><br>Required for Dependent item.|
|output\_format|integer|HTTP agent LLD rule field. Should response be converted to JSON.<br><br>0 - *(default)* Store raw.<br>1 - Convert to JSON.|
|params|string|Additional parameters depending on the type of the LLD rule:<br>- executed script for SSH and Telnet LLD rules;<br>- SQL query for database monitor LLD rules;<br>- formula for calculated LLD rules.|
|parameters|array|Additional parameters for script type LLD rule. Array of objects with 'name' and 'value' properties, where name must be unique.|
|password|string|Password for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent LLD rules.|
|post\_type|integer|HTTP agent LLD rule field. Type of post data body stored in posts property.<br><br>0 - *(default)* Raw data.<br>2 - JSON data.<br>3 - XML data.|
|posts|string|HTTP agent LLD rule field. HTTP(S) request body data. Used with post\_type.|
|privatekey|string|Name of the private key file.|
|publickey|string|Name of the public key file.|
|query\_fields|array|HTTP agent LLD rule field. Query parameters. Array of objects with 'key':'value' pairs, where value can be empty string.|
|request\_method|integer|HTTP agent LLD rule field. Type of request method.<br><br>0 - *(default)* GET<br>1 - POST<br>2 - PUT<br>3 - HEAD|
|retrieve\_mode|integer|HTTP agent LLD rule field. What part of response should be stored.<br><br>0 - *(default)* Body.<br>1 - Headers.<br>2 - Both body and headers will be stored.<br><br>For request\_method HEAD only 1 is allowed value.|
|snmp\_oid|string|SNMP OID.|
|ssl\_cert\_file|string|HTTP agent LLD rule field. Public SSL Key file path.|
|ssl\_key\_file|string|HTTP agent LLD rule field. Private SSL Key file path.|
|ssl\_key\_password|string|HTTP agent LLD rule field. Password for SSL Key file.|
|state|integer|*(readonly)* State of the LLD rule.<br><br>Possible values:<br>0 - *(default)* normal;<br>1 - not supported.|
|status|integer|Status of the LLD rule.<br><br>Possible values:<br>0 - *(default)* enabled LLD rule;<br>1 - disabled LLD rule.|
|status\_codes|string|HTTP agent LLD rule field. Ranges of required HTTP status codes separated by commas. Also supports user macros as part of comma separated list.<br><br>Example: 200,200-{$M},{$M},200-400|
|templateid|string|(readonly) ID of the parent template LLD rule.|
|timeout|string|Item data polling request timeout. Used for HTTP agent and script LLD rules. Supports user macros.<br><br>default: 3s<br>maximum value: 60s|
|trapper\_hosts|string|Allowed hosts. Used by trapper LLD rules or HTTP agent LLD rules.|
|username|string|Username for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent LLD rules.<br><br>Required by SSH and Telnet LLD rules.|
|uuid|string|Universal unique identifier, used for linking imported LLD rules to already existing ones. Used only for LLD rules on templates. Auto-generated, if not given.|
|verify\_host|integer|HTTP agent LLD rule field. Whether to validate that the host name for the connection matches the one in the host's certificate.<br><br>0 - *(default)* Do not validate.<br>1 - Validate.|
|verify\_peer|integer|HTTP agent LLD rule field. Whether to validate that the host's certificate is authentic.<br><br>0 - *(default)* Do not validate.<br>1 - Validate.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### LLD规则
低级发现规则object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| itemid | string | *(只读)* LLD规则的ID。 |
| **delay**<br>(required) | string | LLD规则的更新间隔。接受秒数或带后缀的时间单位，可包含一个或多个[custom intervals](/manual/config/items/item/custom_intervals)，这些间隔可以是灵活间隔或调度间隔的序列化字符串。也接受用户宏。灵活间隔可以写成由正斜杠分隔的两个宏。间隔之间用分号分隔。<br><br>对于Zabbix trapper、依赖监控项和使用`mqtt.get`键的Zabbix agent(主动)类型为可选。 |
| **hostid**<br>(required) | string | LLD规则所属的主机的ID。 |
| **interfaceid**<br>(required) | string | LLD规则的主机接口ID。仅用于主机 LLD规则。<br><br>对于Zabbix agent(主动)、Zabbix内部、Zabbix trapper、依赖、数据库监控和脚本LLD规则不需要。HTTPagent LLD规则为可选。 |
| **key\_**<br>(required) | string | LLD规则键值。 |
| **name**<br>(required) | string | LLD规则的名称。 |
| **type**<br>(required) | integer | LLD规则的类型。<br><br>可能的值:<br>0 - Zabbix agent;<br>2 - Zabbix trapper;<br>3 - 简单检查;<br>5 - Zabbix内部;<br>7 - Zabbix agent(主动);<br>10 - 外部检查;<br>11 - 数据库监控;<br>12 - IPMIagent;<br>13 - SSHagent;<br>14 - TELNETagent;<br>16 - JMXagent;<br>18 - 依赖监控项;<br>19 - HTTPagent;<br>20 - SNMPagent;<br>21 - 脚本。 |
| **url**<br>(required) | string | HTTPagent LLD规则所需的URLstring。支持用户宏、{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}。 |
| allow\_traps | integer | HTTPagent LLD规则字段。允许像trapper监控项类型一样填充值。<br><br>0 - *(默认)* 不允许接收传入数据。<br>1 - 允许接收传入数据。 |
| authtype | integer | 仅用于SSHagent或HTTPagent LLD规则。<br><br>SSHagent认证方法可能的值:<br>0 - *(默认)* 密码;<br>1 - 公钥。<br><br>HTTPagent认证方法可能的值:<br>0 - *(默认)* 无<br>1 - 基本<br>2 - NTLM |
| description | string | LLD规则的描述。 |
| error | string | *(只读)* 更新LLD规则值时出现问题的错误文本。 |
| follow\_redirects | integer | HTTPagent LLD规则字段。轮询数据时跟随响应重定向。<br><br>0 - 不跟随重定向。<br>1 - *(默认)* 跟随重定向。 |
| headers | object | HTTPagent LLD规则字段。object包含HTTP(S)请求头，其中头名称用作键，头值用作值。<br><br>示例:<br>{ "User-Agent": "Zabbix" } |
| http\_proxy | string | HTTPagent LLD规则字段。HTTP(S)proxy连接string。 |
| ipmi\_sensor | string | IPMI传感器。仅用于IPMI LLD规则。 |
| jmx\_endpoint | string | JMXagent自定义连接string。<br><br>默认值:<br>service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| lifetime | string | 不再发现的监控项将被删除的时间周期。接受秒数、带后缀的时间单位和用户宏。<br><br>默认: `30d`。 |
| master\_itemid | integer | 主监控项 ID。<br>允许递归最多3层依赖监控项，且依赖监控项的最大数量为999。<br>发现规则不能作为另一个发现规则的主监控项。<br><br>依赖监控项必需。 |
| output\_format | integer | HTTPagent LLD规则字段。是否将响应转换为JSON。<br><br>0 - *(默认)* 存储原始数据。<br>1 - 转换为JSON。 |
| params | string | 根据LLD规则类型的附加参数:<br>- SSH和Telnet LLD规则的执行脚本;<br>- 数据库监控LLD规则的SQLquery;<br>- 计算LLD规则的公式。 |
| parameters | array | 脚本类型LLD规则的附加参数。array包含objects，具有'名称'和'value'属性，其中名称必须唯一。 |
| password | string | 认证密码。用于简单检查、SSH、Telnet、数据库监控、JMX和HTTPagent LLD规则。 |
| post\_type | integer | HTTPagent LLD规则字段。存储在posts属性中的post数据体类型。<br><br>0 - *(默认)* 原始数据。<br>2 - JSON数据。<br>3 - XML数据。 |
| posts | string | HTTPagent LLD规则字段。HTTP(S)请求体数据。与post_type一起使用。 |
| privatekey | string | 私钥file的名称。 |
| publickey | string | 公钥file的名称。 |
| query\_fields | array | HTTPagent LLD规则字段。query参数。array包含'key':'value'对的objects，其中值可以是空string。 |
| request\_method | integer | HTTPagent LLD规则字段。请求方法类型。<br><br>0 - *(默认)* GET<br>1 - POST<br>2 - PUT<br>3 - HEAD |
| retrieve\_mode | integer | HTTPagent LLD规则字段。应存储响应的哪部分。<br><br>0 - *(默认)* 正文。<br>1 - 头。<br>2 - 正文和头都将存储。<br><br>对于request_method HEAD，只允许值为1。 |
| snmp\_oid | string | SNMP OID。 |
| ssl\_cert\_file | string | HTTPagent LLD规则字段。公共SSL密钥file路径。 |
| ssl\_key\_file | string | HTTPagent LLD规则字段。私有SSL密钥file路径。 |
| ssl\_key\_password | string | HTTPagent LLD规则字段。SSL密钥file的密码。 |
| state | integer | *(只读)* LLD规则的状态。<br><br>可能的值:<br>0 - *(默认)* 正常;<br>1 - 不支持。 |
| status | integer | LLD规则的状态。<br><br>可能的值:<br>0 - *(默认)* 启用LLD规则;<br>1 - 禁用LLD规则。 |
| status\_codes | string | HTTPagent LLD规则字段。所需HTTP状态码的范围，用逗号分隔。也支持用户宏作为逗号分隔列表的一部分。<br><br>示例: 200,200-{$M},{$M},200-400 |
| templateid | string | (只读)父模板LLD规则的ID。 |
| timeout | string | 监控项数据轮询请求超时。用于HTTPagent和脚本LLD规则。支持用户宏。<br><br>默认: 3s<br>最大值: 60s |
| trapper\_hosts | string | 允许的主机。用于trapper LLD规则或HTTPagent LLD规则。 |
| username | string | 认证用户名。用于简单检查、SSH、Telnet、数据库监控、JMX和HTTPagent LLD规则。<br><br>SSH和Telnet LLD规则必需。 |
| uuid | string | 通用唯一标识符，用于将导入的LLD规则链接到已存在的规则。仅用于模板上的LLD规则。如果未提供则自动生成。 |
| verify\_host | integer | HTTPagent LLD规则字段。是否验证主机名称与主机证书中的名称匹配。<br><br>0 - *(默认)* 不验证。<br>1 - 验证。 |
| verify\_peer | integer | HTTPagent LLD规则字段。是否验证主机证书的真实性。<br><br>0 - *(默认)* 不验证。<br>1 - 验证。 |
注意，对于某些方法(update, delete)，必需/可选参数的组合是不同的。
### Loadable MongoDB plugin
MongoDB [plugin](https://git.zabbix.com/projects/AP/repos/mongodb/browse/README.md) is no longer part of Zabbix agent 2 and is now available as a loadable plugin instead. List of supported MongoDB versions has been extended to *2.6-5.3*.
Plugin functionality and set of supported [items](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#mongodb) haven't change.
### 可加载的 MongoDB 插件
MongoDB [plugin](https://git.zabbix.com/projects/AP/repos/mongodb/browse/README.md) 已不再是 Zabbix agent 2 的组成部分，现改为以可加载插件形式提供。支持的 MongoDB 版本范围已扩展至 *2.6-5.3*。
插件功能及支持的 [mongodb](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#mongodb) 集合未发生变化。
### Loadable MongoDB plugin
MongoDB [plugin](https://git.zabbix.com/projects/AP/repos/mongodb/browse/README.md) is no longer part of Zabbix agent 2 and is now available as
a loadable plugin instead. List of supported MongoDB versions has been extended to *2.6-5.3*.
Plugin functionality and set of supported [items](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#mongodb) haven't change.
The MongoDB plugin, along with other loadable plugins which may potentially be added in the future, is stored in the new repository
[zabbix-agent2-plugins](http://repo.zabbix.com/zabbix-agent2-plugins/). The package *zabbix-release* now adds this repository to the user's system.
To continue monitoring MongoDB on the installations from official Zabbix packages, update *zabbix-release* package and install *zabbix-agent2-plugin-mongodb* package.
Sources are available on [CDN](https://cdn.zabbix.com/zabbix-agent2-plugins/sources/mongodb/).
### 可加载的 MongoDB 插件
MongoDB [plugin](https://git.zabbix.com/projects/AP/repos/mongodb/browse/README.md) 已不再是 Zabbix agent 2 的组成部分，现作为可加载插件提供。支持的 MongoDB 版本范围已扩展至 *2.6-5.3*。
插件功能及支持的 [mongodb](/manual/config/items/itemtypes/zabbix_agent/zabbix_agent2#mongodb) 集合未发生变化。
MongoDB 插件与未来可能添加的其他可加载插件一同存储于新仓库 [zabbix-agent2-plugins](http://repo.zabbix.com/zabbix-agent2-plugins/)。*zabbix-release* 软件包现在会将此仓库添加至用户系统。
若需在官方 Zabbix 软件包安装环境中继续监控 MongoDB，请 update *zabbix-release* 软件包并安装 *zabbix-agent2-plugin-mongodb* 软件包。
源代码可通过 [CDN](https://cdn.zabbix.com/zabbix-agent2-plugins/sources/mongodb/) 获取。
### Loadable plugins
##### Encrypted MongoDB plugin connection
MongoDB plugin now supports TLS encryption when connecting to MongoDB using named sessions.
Updated plugin (MongoDB plugin 1.2.1) is included into Zabbix official packages starting from Zabbix 6.0.14. Note that MongoDB is a loadable plugin and can be installed separately either from packages or from sources. The plugin will work with any minor version of Zabbix 6.0. For more details see [MongoDB plugin](/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin).
### 可加载插件
##### 加密的 MongoDB 插件连接
MongoDB插件现在支持通过命名会话连接MongoDB时使用TLS加密.
更新后的插件(MongoDB插件1.2.1)从Zabbix 6.0.14开始被包含在Zabbix官方软件包中. 请注意MongoDB是一个可加载插件, 可以单独从软件包或源代码安装. 该插件可与Zabbix 6.0的任何小版本version一起使用. 更多详情请参阅[MongoDB plugin](/manual/appendix/config/zabbix_agent2_plugins/mongodb_plugin).
##### Load on I/O
Item's persistent file is updated after successful sending of every batch of
data \(containing item's data\) to server. For example, default 'BufferSize'
is 100. If a log item has found 70 matching records then the first 50 records
will be sent in one batch, persistent file will be updated, then remaining 20
records will be sent \(maybe with some delay when more data is accumulated\) in
the 2nd batch, and the persistent file will be updated again.
##### I/O 负载
监控项的持久化file会在每批数据（包含监控项的数据）成功发送至服务器后更新。例如，默认的'BufferSize'为100。如果某个日志监控项匹配到70条记录，前50条记录会作为第一批发送，持久化file随即更新；剩余的20条记录将在第二批发送（可能会延迟以积累更多数据），之后持久化file会再次更新。
#### Locale
Note that the agent requires a UTF-8 locale so that some textual agent
items can return the expected content. Most modern Unix-like systems
have a UTF-8 locale as default, however, there are some systems where
that may need to be set specifically.
#### 区域设置
注意agent需要UTF-8区域设置才能让某些文本agent
监控项返回预期内容。大多数现代类Unix系统默认使用UTF-8区域设置，但在某些系统中可能需要专门进行设置。
#### Locale
Note that the proxy requires a UTF-8 locale so that some textual items
can be interpreted correctly. Most modern Unix-like systems have a UTF-8
locale as default, however, there are some systems where that may need
to be set specifically.
#### 区域设置
请注意proxy需要UTF-8区域设置才能正确解析某些文本监控项。大多数现代类Unix系统默认使用UTF-8区域设置，但在某些系统中可能需要专门进行配置。
#### Locale
Note that the server requires a UTF-8 locale so that some textual items
can be interpreted correctly. Most modern Unix-like systems have a UTF-8
locale as default, however, there are some systems where that may need
to be set specifically.
#### 区域设置
请注意服务器需要UTF-8区域设置以确保某些文本监控项能够被正确解析。大多数现代类Unix系统默认使用UTF-8区域设置，但在某些系统中可能需要特别进行配置。
### Log entry
The log entry object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|level|integer|Log level.|
|ms|string|The time elapsed in milliseconds since the script was run before log entry was added.|
|message|string|Log message.|
### 日志条目
日志条目object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| level | integer | 日志级别。 |
| ms | string | 自脚本run后到添加日志条目为止经过的毫秒数。 |
| message | string | 日志消息。 |
#### Log file monitoring
For `log[]`, `logrt[]`, `log.count[]`, `logrt.count[]` items, regular expression runtime errors are now logged in the Zabbix agent log file.
See [more details](/manual/config/items/itemtypes/log_items#handling-of-regular-expression-compilation-and-runtime-errors).
#### 日志文件监控
对于`log[]`、`logrt[]`、`log.count[]`、`logrt.count[]` 监控项，正则表达式运行时错误现在会被记录到Zabbix agent日志file中。
参见[正则表达式编译与运行时错误的处理](/manual/config/items/itemtypes/log_items#正则表达式编译与运行时错误的处理)。
#### Log file monitoring
`log[]` and `logrt[]` items repeatedly reread log file from the
beginning if file system is 100% full and the log file is being appended
(see [ZBX-10884](https://support.zabbix.com/browse/ZBX-10884) for more
information).
#### 日志文件监控
`log[]` 和 `logrt[]` 监控项 会反复从头重新读取日志 file，如果 file 系统已 100% 满且日志 file 正在被追加写入
（更多信息请参阅 [ZBX-10884](https://support.zabbix.com/browse/ZBX-10884)）。
##### Logging
Add the "Log test" entry to the Zabbix server log and receive the item
value "1" in return:
- Create an item with type "Script".
- In the *Script* field, enter:
```javascript
Zabbix.log(3, 'Log test');
return 1;
```
##### 日志记录
将"Log test"条目添加到Zabbix server日志中并接收返回的监控项值"1":
- 创建一个类型为"Script"的监控项
- 在*Script*字段中输入:
```javascript
Zabbix.log(3, 'Log test');
return 1;
```
#### Logging out
Log out from the API.
Request:
```json
{
"jsonrpc": "2.0",
"method": "user.logout",
"params": [],
"id": 1,
"auth": "16a46baf181ef9602e1687f3110abf8a"
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
#### 登出
从API注销登录。
请求:
```json
{
"jsonrpc": "2.0",
"method": "user.logout",
"params": [],
"id": 1,
"auth": "16a46baf181ef9602e1687f3110abf8a"
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
```
### Log history
The log history object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|id|string|ID of the history entry.|
|clock|timestamp|Time when that value was received.|
|itemid|string|ID of the related item.|
|logeventid|integer|Windows event log entry ID.|
|ns|integer|Nanoseconds when the value was received.|
|severity|integer|Windows event log entry level.|
|source|string|Windows event log entry source.|
|timestamp|timestamp|Windows event log entry time.|
|value|text|Received value.|
### 日志历史
日志历史记录object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| id | string | 历史条目的ID。 |
| clock | timestamp | 接收该值的时间。 |
| itemid | string | 相关监控项的ID。 |
| logeventid | integer | Windows事件日志条目ID。 |
| ns | integer | 接收该值的纳秒时间。 |
| severity | integer | Windows事件日志条目级别。 |
| source | string | Windows事件日志条目来源。 |
| timestamp | timestamp | Windows事件日志条目时间。 |
| value | text | 接收到的值。 |
#### Login and systemd
We recommend
[creating](/manual/installation/install#create_user_account) a *zabbix*
user as system user, that is, without ability to log in. Some users
ignore this recommendation and use the same account to log in (e. g.
using SSH) to host running Zabbix. This might crash Zabbix daemon on log
out. In this case you will get something like the following in Zabbix
server log:
zabbix_server [27730]: [file:'selfmon.c',line:375] lock failed: [22] Invalid argument
zabbix_server [27716]: [file:'dbconfig.c',line:5266] lock failed: [22] Invalid argument
zabbix_server [27706]: [file:'log.c',line:238] lock failed: [22] Invalid argument
and in Zabbix agent log:
zabbix_agentd [27796]: [file:'log.c',line:238] lock failed: [22] Invalid argument
This happens because of default systemd setting `RemoveIPC=yes`
configured in `/etc/systemd/logind.conf`. When you log out of the system
the semaphores created by Zabbix previously are removed which causes the
crash.
A quote from systemd documentation:
RemoveIPC=
Controls whether System V and POSIX IPC objects belonging to the user shall be removed when the
user fully logs out. Takes a boolean argument. If enabled, the user may not consume IPC resources
after the last of the user's sessions terminated. This covers System V semaphores, shared memory
and message queues, as well as POSIX shared memory and message queues. Note that IPC objects of the
root user and other system users are excluded from the effect of this setting. Defaults to "yes".
There are 2 solutions to this problem:
1. (recommended) Stop using *zabbix* account for anything else than
Zabbix processes, create a dedicated account for other things.
2. (not recommended) Set `RemoveIPC=no` in `/etc/systemd/logind.conf`
and reboot the system. Note that `RemoveIPC` is a system-wide
parameter, changing it will affect the whole system.
#### 登录与 systemd
我们建议
[2-创建用户账户](/manual/installation/install#2-创建用户账户) 将*zabbix*
用户设置为系统用户，即不具备登录能力。部分用户
忽略此建议并使用相同账户登录（例如
通过SSH）到运行Zabbix的主机。这可能导致注销时
Zabbix守护进程崩溃。此时您将在Zabbix
服务器日志中get类似以下内容：
zabbix_server [27730]: [file:'selfmon.c',line:375] lock failed: [22] Invalid argument
zabbix_server [27716]: [file:'dbconfig.c',line:5266] lock failed: [22] Invalid argument
zabbix_server [27706]: [file:'log.c',line:238] lock failed: [22] Invalid argument
并在Zabbix agent日志中：
zabbix_agentd [27796]: [file:'log.c',line:238] lock failed: [22] Invalid argument
该问题的根源是systemd默认设置`RemoveIPC=yes`
配置于`/etc/systemd/logind.conf`。当您注销系统时，
Zabbix先前创建的信号量会被移除，从而导致
崩溃。
引自systemd文档：
RemoveIPC=
控制当用户退出时是否移除属于该用户的System V和POSIX IPCobjects
user fully logs out. Takes a boolean argument. If enabled, the user may not consume IPC resources
after the last of the user's sessions terminated. This covers System V semaphores, shared memory
and message queues, as well as POSIX shared memory and message queues. Note that IPC objects of the
root user and other system users are excluded from the effect of this setting. Defaults to "yes".
此问题有两种解决方案：
1. （推荐）停止将*zabbix*账户用于Zabbix进程之外的用途，
为其他操作create专用账户。
2. （不推荐）在`/etc/systemd/logind.conf`中设置`RemoveIPC=no`
并重启系统。请注意`RemoveIPC`是系统级
参数，修改它将影响整个系统。
#### Login
{width="350"}
This is the Zabbix welcome screen. Enter the user name **Admin** with
password **zabbix** to log in as a [Zabbix
superuser](/manual/config/users_and_usergroups/permissions). Access to
*Configuration* and *Administration* menus will be granted.
For security reasons, it is strongly recommended to change the default password for the Admin account immediately after the first login.
#### 登录
{width="350"}
这是Zabbix欢迎界面。使用用户名**Admin**和密码**zabbix**登录[Zabbix
superuser](/manual/config/users_and_usergroups/permissions)。登录后将获得访问*配置*和*管理*菜单的权限。
出于安全考虑，强烈建议在首次login后立即更改Admin账户的默认密码。
#### Log in
Zabbix frontend is ready! The default user name is **Admin**, password
**zabbix**.
{width="350"}
Proceed to [getting started with Zabbix](/manual/quickstart/login).
#### 登录
Zabbix前端已准备就绪！默认用户名为**Admin**，密码为
**zabbix**。
{width="350"}
前往[getting started with Zabbix](/manual/quickstart/login)。
###
Log level control targets
*process-type*
All processes of specified type (active checks, collector, listener)
*process-type,N*
Process type and number (e.g., listener,3)
*pid*
Process identifier, up to 65535. For larger values specify target as
"process-type,N"
```{=html}
<!-- -->
```
**-p**, **--print**
Print known items and exit. For each item either generic defaults are
used, or specific defaults for testing are supplied. These defaults are
listed in square brackets as item key parameters. Returned values are
enclosed in square brackets and prefixed with the type of the returned
value, separated by a pipe character. For user parameters type is always
**t**, as the agent can not determine all possible return values. Items,
displayed as working, are not guaranteed to work from the Zabbix server
or zabbix\_get when querying a running agent daemon as permissions or
environment may be different. Returned value types are:
d
Number with a decimal part.
m
Not supported. This could be caused by querying an item that only works
in the active mode like a log monitoring item or an item that requires
multiple collected values. Permission issues or incorrect user
parameters could also result in the not supported state.
s
Text. Maximum length not limited.
t
Text. Same as **s**.
u
Unsigned integer.
**-t**, **--test** *item-key*
Test single item and exit. See **--print** for output description.
**-h**, **--help**
Display this help and exit.
**-V**, **--version**
Output version information and exit.
[ ]{#lbAH}
###
日志级别控制目标
*process-type*
指定类型的所有进程（主动检查、采集器、监听器）
*process-type,N*
进程类型及编号（例如listener,3）
*pid*
进程标识符，最大65535。对于更大值需指定为"process-type,N"格式
```{=html}
<!-- -->
```
**-p**, **--print**
打印已知监控项并退出。每个监控项要么使用通用默认值，要么提供测试专用默认值。这些默认值以方括号列出作为监控项键参数。返回值用方括号包裹并前缀返回类型，以竖线分隔。用户参数类型始终为**t**，因为agent无法确定所有可能的返回值。显示为可用的监控项不保证在Zabbix server或zabbix_get查询运行中的agent守护进程时有效，因为权限或环境可能不同。返回值类型包括：
d
带小数部分的数字
m
不支持。可能由于查询仅支持主动模式的监控项（如日志监控监控项）或需要多个采集值的监控项导致。权限问题或错误的用户参数也可能造成不支持状态
s
文本。最大长度无限制
t
文本。与**s**相同
u
无符号integer
**-t**, **--test** *item-key*
测试单个监控项并退出。输出描述参见**--print**
**-h**, **--help**
显示帮助信息并退出
**-V**, **--version**
输出version信息并退出
[ ]{#lbAH}
###
Log level control targets
*process-type*
All processes of specified type (alerter, alert manager, configuration syncer, discoverer, escalator, ha manager, history syncer, housekeeper, http poller, icmp pinger, ipmi manager, ipmi poller, java poller, lld manager, lld worker, poller, preprocessing manager, preprocessing worker, proxy poller, self-monitoring, snmp trapper, task manager, timer, trapper, unreachable poller, vmware collector, history poller, availability manager, service manager, odbc poller)
*process-type,N*
Process type and number (e.g., poller,3)
*pid*
Process identifier, up to 65535. For larger values specify target as
"process-type,N"
Profiling control targets
*process-type*
All processes of specified type (alerter, alert manager, configuration syncer, discoverer, escalator, history syncer, housekeeper, http poller, icmp pinger, ipmi manager, ipmi poller, java poller, lld manager, lld worker, poller, preprocessing manager, preprocessing worker, proxy poller, self-monitoring, snmp trapper, task manager, timer, trapper, unreachable poller, vmware collector, history poller, availability manager, service manager, odbc poller)
*process-type,N*
Process type and number (e.g., history syncer,1)
*pid*
Process identifier, up to 65535. For larger values specify target as
"process-type,N"
*scope*
Profiling scope (rwlock, mutex, processing) can be used with process type (e.g., history syncer,1,processing)
[ ]{#lbAH}
###
日志级别控制目标
*进程类型*
指定类型的所有进程（告警器、告警管理器、配置同步器、发现器、升级器、高可用管理器、历史数据同步器、管家进程、HTTP轮询器、ICMP ping器、IPMI管理器、IPMI轮询器、Java轮询器、LLD管理器、LLD工作器、轮询器、预处理管理器、预处理工作器、proxy轮询器、自监控、SNMP捕捉器、任务管理器、定时器、捕捉器、不可达轮询器、VMware采集器、历史轮询器、可用性管理器、服务管理器、odbc轮询器）
*进程类型,N*
进程类型及编号（例如：轮询器,3）
*进程ID*
进程标识符，最大65535。对于更大值需指定为"进程类型,N"格式
性能分析控制目标
*进程类型*
指定类型的所有进程（告警器、告警管理器、配置同步器、发现器、升级器、历史数据同步器、管家进程、HTTP轮询器、ICMP ping器、IPMI管理器、IPMI轮询器、Java轮询器、LLD管理器、LLD工作器、轮询器、预处理管理器、预处理工作器、proxy轮询器、自监控、SNMP捕捉器、任务管理器、定时器、捕捉器、不可达轮询器、VMware采集器、历史轮询器、可用性管理器、服务管理器、odbc轮询器）
*进程类型,N*
进程类型及编号（例如：历史数据同步器,1）
*进程ID*
进程标识符，最大65535。对于更大值需指定为"进程类型,N"格式
*分析范围*
性能分析范围（读写锁、互斥锁、处理中）可与进程类型组合使用（例如：历史数据同步器,1,处理中）
[ ]{#lbAH}
###
Log level control targets
*process-type*
All processes of specified type (configuration syncer, data sender, discoverer, heartbeat sender, history syncer, housekeeper, http poller, icmp pinger, ipmi manager, ipmi poller, java poller, poller, preprocessing manager, preprocessing worker, self-monitoring, snmp trapper, task manager, trapper, unreachable poller, vmware collector, history poller, availability manager, odbc poller)
*process-type,N*
Process type and number (e.g., poller,3)
*pid*
Process identifier, up to 65535. For larger values specify target as
"process-type,N"
Profiling control targets
*process-type*
All processes of specified type (configuration syncer, data sender, discoverer, heartbeat sender, history syncer, housekeeper, http poller, icmp pinger, ipmi manager, ipmi poller, java poller, poller, preprocessing manager, preprocessing worker, self-monitoring, snmp trapper, task manager, trapper, unreachable poller, vmware collector, history poller, availability manager, odbc poller)
*process-type,N*
Process type and number (e.g., history syncer,1)
*pid*
Process identifier, up to 65535. For larger values specify target as
"process-type,N"
*scope*
Profiling scope (rwlock, mutex, processing) can be used with process type (e.g., history syncer,1,processing)
**-h**, **--help**
Display this help and exit.
**-V**, **--version**
Output version information and exit.
[ ]{#lbAH}
###
日志级别控制目标
*进程类型*
指定类型的所有进程（配置同步器、数据发送器、发现器、心跳发送器、历史同步器、管家进程、HTTP轮询器、ICMP ping器、IPMI管理器、IPMI轮询器、Java轮询器、轮询器、预处理管理器、预处理工作器、自监控、SNMP陷阱接收器、任务管理器、陷阱接收器、不可达轮询器、VMware收集器、历史轮询器、可用性管理器、odbc轮询器）
*进程类型,N*
进程类型及编号（例如：poller,3）
*进程ID*
进程标识符，最大65535。对于更大值需指定为"process-type,N"格式
性能分析控制目标
*进程类型*
指定类型的所有进程（配置同步器、数据发送器、发现器、心跳发送器、历史同步器、管家进程、HTTP轮询器、ICMP ping器、IPMI管理器、IPMI轮询器、Java轮询器、轮询器、预处理管理器、预处理工作器、自监控、SNMP陷阱接收器、任务管理器、陷阱接收器、不可达轮询器、VMware收集器、历史轮询器、可用性管理器、odbc轮询器）
*进程类型,N*
进程类型及编号（例如：history syncer,1）
*进程ID*
进程标识符，最大65535。对于更大值需指定为"process-type,N"格式
*分析范围*
性能分析范围（读写锁、互斥锁、处理中）可与进程类型组合使用（例如：history syncer,1,processing）
**-h**, **--help**
显示帮助信息并退出
**-V**, **--version**
输出version信息并退出
[ ]{#lbAH}
###### Log request
A request sent by a plugin to write a log message into the agent log file.
| | |
|---|---|
|direction|plugin → agent|
|response|no|
Parameters specific to log requests:
|Name|Type|Comments|
|---------|--------|----------|
|severity|uint32|The message severity (log level).|
|message|string|The message to log.|
*Example:*
{"id":0,"type":1,"severity":3,"message":"message"}
###### 日志请求
插件发送的请求，用于将日志消息写入agent日志file。
| | |
|---|---|
| direction | plugin → agent |
| response | no |
日志请求的特定参数：
| Name | Type | Comments |
|---------|--------|----------|
| severity | uint32 | 消息严重性（日志级别）。 |
| message | string | 要记录的日志消息。 |
*示例：*
{"id":0,"type":1,"severity":3,"message":"message"}
#### Logrotate for Zabbix server and proxy
The logrotate utility is only included into packages for zabbix-agent, zabbix-agent2 and zabbix-web-service, but needs to be installed separately for Zabbix server and proxy. The logrotate dependency has been added to the server and proxy packages for RHEL and SUSE starting from Zabbix 6.4.4rc1.
#### Zabbix server 和 proxy 的日志轮转
logrotate工具仅包含在zabbix-agent、zabbix-agent2和zabbix-web-service的软件包中，但对于Zabbix server和proxy需要单独安装。从Zabbix 6.4.4rc1开始，RHEL和SUSE的服务器及proxy软件包已添加logrotate依赖项。
#### Low-level discovery
Configure low-level discovery rules as well as item, trigger and graph
prototypes to monitor dynamic entities.
[LLD rule API](/manual/api/reference/discoveryrule) | [Item prototype
API](/manual/api/reference/itemprototype) | [Trigger prototype
API](/manual/api/reference/triggerprototype) | [Graph prototype
API](/manual/api/reference/graphprototype) | [Host prototype
API](/manual/api/reference/hostprototype)
#### 低级发现
配置低级发现规则以及监控项、触发器原型和图形原型，以监控动态实体。
[LLD rule API](/manual/api/reference/discoveryrule) | [Item prototype
API](/manual/api/reference/itemprototype) | [Trigger prototype
API](/manual/api/reference/triggerprototype) | [Graph prototype
API](/manual/api/reference/graphprototype) | [Host prototype
API](/manual/api/reference/hostprototype)
#### Low-level discovery
In a [low-level discovery
rule](/manual/discovery/low_level_discovery#configuring_low-level_discovery),
user macros can be used in the following fields:
|Location|<|Multiple macros/mix with text^[1](supported_by_location_user#footnotes)^|
|-|------------------------------|----------|
|Key parameters|<|yes|
|Update interval|<|no|
|Custom interval|<|no|
|Keep lost resources period|<|no|
|Description|<|yes|
|*SNMP agent*|<|<|
| |SNMP OID|yes|
|*SSH agent*|<|<|
| |Username|yes|
|^|Public key file|yes|
|^|Private key file|yes|
|^|Password|yes|
|^|Script|yes|
|*TELNET agent*|<|<|
| |Username|yes|
|^|Password|yes|
|^|Script|yes|
|*Zabbix trapper*|<|<|
| |Allowed hosts|yes|
|*Database monitor*|<|<|
| |Username|yes|
|^|Password|yes|
|^|SQL query|yes|
|*JMX agent*|<|<|
| |JMX endpoint|yes|
|*HTTP agent*|<|<|
| |URL^[3](supported_by_location_user#footnotes)^|yes|
|^|Query fields|yes|
|^|Timeout|no|
|^|Request body|yes|
|^|Headers (names and values)|yes|
|^|Required status codes|yes|
|^|HTTP authentication username|yes|
|^|HTTP authentication password|yes|
|*Filters*|<|<|
| |Regular expression|yes|
|*Overrides*|<|<|
| |Filters: regular expression|yes|
|^|Operations: update interval (for item prototypes)|no|
|^|Operations: history storage period (for item prototypes)|no|
|^|Operations: trend storage period (for item prototypes)|no|
#### 低级发现
在[配置低级发现](/manual/discovery/low_level_discovery#配置低级发现)中，
用户宏可用于以下字段：
| 位置 | < | 多宏/与文本混合^[1](supported_by_location_user#脚注)^ |
|-|------------------------------|----------|
| 键参数 | < | 是 |
| 更新间隔 | < | 否 |
| 自定义间隔 | < | 否 |
| 保留丢失资源周期 | < | 否 |
| 描述 | < | 是 |
| *SNMP agent* | < | < |
| | SNMP OID | 是 |
| *SSH agent* | < | < |
| | 用户名 | 是 |
| ^ | 公钥 file | 是 |
| ^ | 私钥 file | 是 |
| ^ | 密码 | 是 |
| ^ | 脚本 | 是 |
| *TELNET agent* | < | < |
| | 用户名 | 是 |
| ^ | 密码 | 是 |
| ^ | 脚本 | 是 |
| *Zabbix trapper* | < | < |
| | 允许的 主机 | 是 |
| *数据库监控* | < | < |
| | 用户名 | 是 |
| ^ | 密码 | 是 |
| ^ | SQL query | 是 |
| *JMX agent* | < | < |
| | JMX端点 | 是 |
| *HTTP agent* | < | < |
| | URL^[3](supported_by_location_user#脚注)^ | 是 |
| ^ | query 字段 | 是 |
| ^ | 超时 | 否 |
| ^ | 请求体 | 是 |
| ^ | 头部（名称和值） | 是 |
| ^ | 必需状态码 | 是 |
| ^ | HTTP认证用户名 | 是 |
| ^ | HTTP认证密码 | 是 |
| *过滤器* | < | < |
| | 正则表达式 | 是 |
| *覆盖* | < | < |
| | 过滤器：正则表达式 | 是 |
| ^ | 操作：update 间隔（用于 监控项原型） | 否 |
| ^ | 操作：历史存储周期（用于 监控项原型） | 否 |
| ^ | 操作：趋势存储周期（用于 监控项原型） | 否 |
#### Low-level discovery macros
Even though no low-level discovery macros are created in the returned
JSON, these macros can be defined by the user as an additional step,
using the [custom LLD
macro](/manual/discovery/low_level_discovery#custom_macros)
functionality with JSONPath pointing to the discovered values in the
returned JSON.
The macros then can be used to create item, trigger, etc prototypes.
#### 低级发现宏
尽管返回的JSON中未创建低级发现宏，但用户可以通过额外步骤，
使用[自定义宏](/manual/discovery/low_level_discovery#自定义宏)功能并配置指向返回JSON中发现值的JSONPath，
来自行定义这些宏。
这些宏随后可用于create 监控项、触发器原型等场景。
#### Macro functions
The range of the `fmtnum` [macro function](/manual/config/macros/macro_functions#supported-macro-functions) is now limited to 0-20.
#### 宏函数
`fmtnum` [支持的宏函数](/manual/config/macros/macro_functions#支持的宏函数) 的取值范围现在限制为0-20.
## Macros
## 宏
#### Macros
#### 宏
## Macros
## 宏
Macros for internal actions contain the reason why an item, an LLD-rule, or a trigger became unsupported:
- {ITEM.STATE.ERROR} - for item-based internal notifications;
- {LLDRULE.STATE.ERROR} - for LLD-rule based internal notifications;
- {TRIGGER.STATE.ERROR} - for trigger-based internal notifications.
For more details, see [Supported macros](/manual/appendix/macros/supported_by_location).
用于内部操作的宏包含以下原因：为何某个监控项、LLD规则或触发器变为不受支持状态：
- {ITEM.STATE.ERROR} - 用于基于监控项的内部通知；
- {LLDRULE.STATE.ERROR} - 用于基于LLD规则的内部通知；
- {TRIGGER.STATE.ERROR} - 用于基于触发器的内部通知。
更多详细信息，请参阅[Supported macros](/manual/appendix/macros/supported_by_location)。
#### Macro support
Built-in and user macros in tags are resolved at the time of the event. Until the event has occurred these macros will be shown in Zabbix frontend unresolved. Low-level discovery macros are resolved during discovery process.
The following macros may be used in trigger tags:
- {ITEM.VALUE}, {ITEM.LASTVALUE}, {HOST.HOST}, {HOST.NAME}, {HOST.CONN}, {HOST.DNS}, {HOST.IP}, {HOST.PORT} and {HOST.ID}
macros can be used to populate the tag name or tag value.
- {INVENTORY.\*} [macros](/manual/appendix/macros/supported_by_location) can be used
to reference host inventory values from one or several hosts in a trigger expression.
- [User macros](/manual/config/macros/user_macros) and user macros with context are supported for the tag name/value;
context may include low-level discovery macros.
- Low-level discovery macros can be used for the tag name/value in
trigger prototypes.
The following macros may be used in trigger-based notifications:
- {EVENT.TAGS} and {EVENT.RECOVERY.TAGS} macros will resolve to a
comma separated list of event tags or recovery event tags
- {EVENT.TAGSJSON} and {EVENT.RECOVERY.TAGSJSON} macros will resolve
to a JSON array containing event tag
[objects](/manual/api/reference/event/object#event_tag) or recovery
event tag objects
The following macros may be used in template, host, item and web
scenario tags:
- {HOST.HOST}, {HOST.NAME}, {HOST.CONN}, {HOST.DNS}, {HOST.IP},
{HOST.PORT} and {HOST.ID} macros
- {INVENTORY.\*}
[macros](/manual/appendix/macros/supported_by_location)
- [User macros](/manual/config/macros/user_macros)
- Low-level discovery macros can be used in item prototype tags
The following macros may be used in host prototype tags:
- {HOST.HOST}, {HOST.NAME}, {HOST.CONN}, {HOST.DNS}, {HOST.IP},
{HOST.PORT} and {HOST.ID} macros
- {INVENTORY.\*}
[macros](/manual/appendix/macros/supported_by_location)
- [User macros](/manual/config/macros/user_macros)
- [Low-level discovery macros](/manual/config/macros/lld_macros) will
be resolved during discovery process and then added to the
discovered host
#### 宏支持
标签中的内置宏和用户宏在事件发生时解析。在事件发生之前，这些宏将在Zabbix前端显示为未解析状态。低级发现宏在发现过程中解析。
以下宏可用于触发器标签中:
- {ITEM.VALUE}, {ITEM.LASTVALUE}, {HOST.HOST}, {HOST.NAME}, {HOST.CONN}, {HOST.DNS}, {HOST.IP}, {HOST.PORT} 和 {HOST.ID}
宏可用于填充标签名称或标签值。
- {INVENTORY.\*} [macros](/manual/appendix/macros/supported_by_location) 可用于
在触发器表达式中引用一个或多个主机的主机资产记录值
- [User macros](/manual/config/macros/user_macros) 以及带上下文的用户宏支持用于标签名称/值；
上下文可能包含低级发现宏。
- 低级发现宏可用于标签名称/值
trigger prototypes.
以下宏可用于基于触发器的通知:
- {EVENT.TAGS}和{EVENT.RECOVERY.TAGS}宏将解析为
逗号分隔的事件标签或恢复事件标签列表
- {EVENT.TAGSJSON} 和 {EVENT.RECOVERY.TAGSJSON} 宏将被解析
to a JSON array containing event tag
[objects](/manual/api/reference/event/object#event_tag) or recovery
event tag objects
以下宏可用于模板、主机、监控项和网页
场景标签:
- {HOST.HOST}, {HOST.NAME}, {HOST.CONN}, {HOST.DNS}, {HOST.IP},
{HOST.PORT}和{HOST.ID}宏
- {INVENTORY.\*}
[macros](/manual/appendix/macros/supported_by_location)
- [User macros](/manual/config/macros/user_macros)
- 低级发现宏可用于监控项原型标签
以下宏可在主机原型标签中使用:
- {HOST.HOST}, {HOST.NAME}, {HOST.CONN}, {HOST.DNS}, {HOST.IP},
{HOST.PORT} 和 {HOST.ID} 宏
- {INVENTORY.\*}
[macros](/manual/appendix/macros/supported_by_location)
- [User macros](/manual/config/macros/user_macros)
- [Low-level discovery macros](/manual/config/macros/lld_macros) 将
在发现过程中解析并随后添加到
已发现 主机
#### Macro support for email media types
When configuring an [email media type](/manual/config/notifications/media/email), it is now possible to use macros in the [username and password fields](/manual/appendix/macros/supported_by_location_user#other-locations).
#### 邮件媒体类型的宏支持
在配置[email media type](/manual/config/notifications/media/email)时，现在可以在[其他位置](/manual/appendix/macros/supported_by_location_user#其他位置)中使用宏。
# maintenance.create
# maintenance.create
# maintenance.delete
# maintenance.delete
# maintenance.get
# maintenance.get
##### Maintenance periods
The maintenance period window is for scheduling time for a recurring or
a one-time maintenance. The form is dynamic with available fields
changing based on the *Period type* selected.
|Period type|Description|
|--|--------|
|*One time only*|Define the date and time, and the length of the maintenance period.|
|*Daily*|*Every day(s)* - maintenance frequency: 1 (default) - every day, 2 - every two days, etc.<br>*At (hour:minute)* - time of the day when maintenance starts.<br>*Maintenance period length* - for how long the maintenance will be active.|
|*Weekly*|*Every week(s)* - maintenance frequency: 1 (default) - every week, 2 - every two weeks, etc.<br>*Day of week* - on which day the maintenance should take place.<br>*At (hour:minute)* - time of the day when maintenance starts.<br>*Maintenance period length* - for how long the maintenance will be active.|
|*Monthly*|*Month* - select all months during which the regular maintenance is carried out.<br>*Date*: **Day of month** - Select this option if the maintenance takes place on the same date each month (for example, every 1st day of the month). Then, select the required day in the new field that appears.<br>*Date*: **Day of week** - Select this option if the maintenance takes place only on certain days (for example, every first Monday of the month). Then, in the drop-down select the required week of the month (first, second, third, fourth, or last) and mark the checkboxes for maintenance day(s).<br>*At (hour:minute)* - time of the day when maintenance starts.<br>*Maintenance period length* - for how long the maintenance will be active.|
When done, press *Add* to add the maintenance period to the *Periods*
block.
Notes:
- When *Every day/Every week* parameter is greater than 1, the
starting day or week is the day/week that the *Active since* time
falls on. For example:
- with *Active since* set to January 1 at 12:00 and a one-hour
maintenance set for every two days at 23:00 will result in the
first maintenance period starting on January 1 at 23:00, while
the second maintenance period will start on January 3 at 23:00;
- with the same *Active since* time and a one-hour maintenance set
for every two days at 01:00, the first maintenance period will
start on January 3 at 01:00, while the second maintenance period
will start on January 5 at 01:00.
- Daylight Saving Time (**DST**) changes do not affect how long the
maintenance will be.
- Let's say we have a two-hour maintenance that
usually starts at 01:00 and finishes at 03:00:
- If after one hour of maintenance (at 02:00) a DST change happens
and current time changes from 02:00 to 03:00, the maintenance will
continue for one more hour till 04:00;
- If after two hours of maintenance (at 03:00) a DST change happens
and current time changes from 03:00 to 02:00, the maintenance will
stop because two hours have passed.
- If a maintenance period is set to 1 day it usually starts at 00:00
and finishes at 00:00 the next day:
- Since Zabbix calculates days in hours, the actual period of the
maintenance is 24 hours.
- If current time changes forward one hour, the maintenance will
stop at 01:00 the next day.
- If current time changes back one hour, the maintenance will stop
at 23:00 that day.
- If a maintenance period starts during the hour, skipped by DST change:
- The maintenance will not start.
##### 维护周期
维护周期窗口用于安排定期或
一次性维护。该表单是动态的，包含可用字段
根据所选的*Period type*进行变更。
| 周期类型 | 描述 |
|--|--------|
| *One time only* | 定义日期和时间，以及维护周期的时长。 |
| *Daily* | *每天* - 维护频率: 1 (默认) - 每天, 2 - 每两天, 以此类推.<br>*在(时:分)* - 维护开始的每日时间.<br>*维护周期时长* - 维护将持续激活的时间长度. |
| *Weekly* | *每周* - 维护频率: 1 (默认) - 每周一次, 2 - 每两周一次, 以此类推.<br>*星期几* - 指定维护发生的具体星期.<br>*时间(时:分)* - 每日维护开始的具体时间.<br>*维护周期时长* - 维护将持续激活的时间长度. |
| *Monthly* | *月份* - 选择执行定期维护的所有月份。<br>*日期*: **每月第几天** - 若维护在每月固定日期进行（例如每月1日），请选择此选项。随后在出现的新字段中选择所需日期。<br>*日期*: **星期几** - 若维护仅在特定周几进行（例如每月第一个周一），请选择此选项。然后在下拉菜单中选择月份中的具体周次（第一周/第二周/第三周/第四周/最后一周），并勾选维护日复选框。<br>*时间（时:分）* - 每日维护开始的具体时间。<br>*维护周期时长* - 维护将持续激活的时间长度。 |
完成后，点击*Add*将维护周期添加到*Periods*中
块。
注释:
- 当*每天/每周*参数大于1时
起始日或周是指*Active since*时间所对应的日/周
落在。例如：
- 将*Active since*设置为1月1日12:00并持续一小时
每两天在23:00设置的维护计划将导致
第一个维护期从1月1日23:00开始，同时
第二次维护期将于1月3日23:00开始;
- 具有相同的*Active since*时间并设置了一小时的维护时段
每两天在01:00，第一个维护周期将
1月3日01:00开始，而第二个维护时段
将于1月5日01:00开始。
- 夏令时（**DST**）变更不会影响持续时间
维护将会进行。
- 假设我们有一个两小时的维护窗口
通常从01:00开始，到03:00结束：
- 如果维护一小时后（02:00）发生夏令时变更
并且当前时间从02:00变为03:00时，维护将
继续运行一小时直至04:00
- 如果在维护两小时后（03:00）发生夏令时变更
并且当前时间从03:00变为02:00时，维护将
停止，因为已过去两小时。
- 如果维护周期设置为1天，通常从00:00开始
并在次日00:00结束:
- 由于Zabbix以小时为单位计算天数，实际周期为
维护时间为24小时。
- 如果当前时间向前调整一小时，维护将
在次日01:00停止。
- 如果当前时间回拨一小时，维护将停止
在当天23:00。
- 如果维护时段在小时期间开始，因夏令时变更而被跳过：
- 维护将不会启动。
### Maintenance
The maintenance object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|maintenanceid|string|*(readonly)* ID of the maintenance.|
|**name**<br>(required)|string|Name of the maintenance.|
|**active\_since**<br>(required)|timestamp|Time when the maintenance becomes active.|
|**active\_till**<br>(required)|timestamp|Time when the maintenance stops being active.|
|description|string|Description of the maintenance.|
|maintenance\_type|integer|Type of maintenance.<br><br>Possible values:<br>0 - *(default)* with data collection;<br>1 - without data collection.|
|tags\_evaltype|integer|Problem tag evaluation method.<br><br>Possible values:<br>0 - *(default)* And/Or;<br>2 - Or.|
### Maintenance 维护模式
The maintenance object has the following properties.
维护模式对象有如下属性。
|Property|Type|Description|
|--------|----|-----------|
|maintenanceid|string|*(readonly)* ID of the maintenance. 维护模式的ID。|
|**name**<br>(required)|string|Name of the maintenance. 维护模式的名称。|
|**active\_since**<br>(required)|timestamp|Time when the maintenance becomes active. 维护模式生效的时刻。|
|**active\_till**<br>(required)|timestamp|Time when the maintenance stops being active. 维护模式失效的时刻。|
|description|string|Description of the maintenance. 维护模式说明。|
|maintenance\_type|integer|Type of maintenance. 维护模式类型。<br><br>Possible values: 可能的值：<br>0 - *(default)* with data collection;<br>1 - without data collection.|
### Maintenance
The maintenance object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|maintenanceid|string|*(readonly)* ID of the maintenance.|
|**name**<br>(required)|string|Name of the maintenance.|
|**active\_since**<br>(required)|timestamp|Time when the maintenance becomes active.<br><br>The given value will be rounded down to minutes.|
|**active\_till**<br>(required)|timestamp|Time when the maintenance stops being active.<br><br>The given value will be rounded down to minutes.|
|description|string|Description of the maintenance.|
|maintenance\_type|integer|Type of maintenance.<br><br>Possible values:<br>0 - *(default)* with data collection;<br>1 - without data collection.|
|tags\_evaltype|integer|Problem tag evaluation method.<br><br>Possible values:<br>0 - *(default)* And/Or;<br>2 - Or.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 维护
维护object具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| maintenanceid | string | *(只读)* 维护的ID。 |
| **name**<br>(required) | string | 维护的名称。 |
| **active\_since**<br>(required) | timestamp | 维护生效的时间。<br><br>给定值将向下舍入到分钟。 |
| **active\_till**<br>(required) | timestamp | 维护停止生效的时间。<br><br>给定值将向下舍入到分钟。 |
| description | string | 维护的描述。 |
| maintenance\_type | integer | 维护类型。<br><br>可能的值:<br>0 - *(默认)* 带数据收集;<br>1 - 不带数据收集。 |
| tags\_evaltype | integer | 问题标签评估方法。<br><br>可能的值:<br>0 - *(默认)* 与/或;<br>2 - 或。 |
注意，对于某些方法(update, delete)，所需/可选参数组合有所不同。
# maintenance.update
# maintenance.update
### Makefile targets
Loadable plugins provided by Zabbix have simple makefiles with the following targets:
|Target|Description|
|--|--------|
|make|Build plugin.|
|make clean|Delete all files that are normally created by building the plugin.|
|make check|Perform self-tests. A real PostgreSQL database is required.|
|make style|Check Go code style with 'golangci-lint'.|
|make format|Format Go code with 'go fmt'.|
|make dist|Create an archive containing the plugin sources and sources of all packages needed to build the plugin and its self-tests.|
### Makefile目标
Zabbix提供的可加载插件包含简单的Makefile文件，支持以下构建目标：
| 构建目标 | 描述 |
|--|--------|
| make | 编译插件 |
| make clean | 删除构建插件时生成的所有常规文件 |
| make check | 执行自测试（需真实PostgreSQL数据库） |
| make style | 使用'golangci-lint'检查Go代码风格 |
| make format | 使用'go fmt'格式化Go代码 |
| make dist | 创建包含插件源码及所有依赖包源码的归档文件（用于构建插件及其自测试） |
### Managing HA cluster
The current status of the HA cluster can be managed using the dedicated
[runtime control](/manual/concepts/server#runtime_control) options:
- `ha_status` - log HA cluster status in the Zabbix server log (and to stdout)
- `ha_remove_node=target` - remove an HA node identified by its
\<target\> - name or ID of the node (name/ID can be
obtained from the output of running ha\_status), e.g.:
```
zabbix_server -R ha_remove_node=zabbix-node-02
```
Note that active/standby nodes cannot be removed.
- `ha_set_failover_delay=delay` - set HA failover delay (between 10 seconds and 15 minutes; time
suffixes are supported, e.g. 10s, 1m)
Node status can be monitored:
- in *Reports* → *[System information](/manual/web_interface/frontend_sections/reports/status_of_zabbix#high-availability-nodes)*
- in the *System information* dashboard widget
- using the `ha_status` runtime control option of the server (see
above).
The `zabbix[cluster,discovery,nodes]` internal item can be used for node
discovery, as it returns a JSON with the high-availability node information.
### 管理高可用集群
HA集群的当前状态可通过专用[运行时控制](/manual/concepts/server#运行时控制)选项进行管理：
- `ha_status` - 在Zabbix server日志（及标准输出）中记录HA集群状态
- `ha_remove_node=target` - 移除由其
\<target\> - name or ID of the node (name/ID can be
obtained from the output of running ha\_status), e.g.:
标识的HA节点
```
zabbix_server -R ha_remove_node=zabbix-node-02
```
注意：active/standby节点不可移除。
- `ha_set_failover_delay=delay` - 设置HA故障转移延迟（10秒至15分钟之间；时间
suffixes are supported, e.g. 10s, 1m)
节点状态可通过以下方式监控：
- 在*Reports* → *[高可用性节点](/manual/web_interface/frontend_sections/reports/status_of_zabbix#高可用性节点)*中
- 在*System information*仪表板组件中
- 使用服务器的`ha_status`运行时控制选项（参见
above).
内部监控项`zabbix[cluster,discovery,nodes]`可用于节点发现，因其返回包含高可用性节点信息的JSON。
**Mandatory and optional parameters**
Parameters without angle brackets are mandatory. Parameters marked with
angle brackets **<** **>** are optional.
**Usage with command-line utilities**
Note that when testing or using item keys with zabbix_agentd or zabbix_get
from the command line you should consider shell syntax too.
For example, if a certain parameter of the key has to be enclosed in double quotes
you have to explicitly escape double quotes, otherwise they will be trimmed by the shell
as special characters and will not be passed to the Zabbix utility.
Examples:
zabbix_agentd -t 'vfs.dir.count[/var/log,,,"file,dir",,0]'
zabbix_agentd -t vfs.dir.count[/var/log,,,\"file,dir\",,0]
**必选与可选参数**
不带尖括号的参数是必选的。用尖括号 **<** **>** 标记的参数是可选的。
**命令行工具的使用**
请注意，当在命令行中使用 zabbix_agentd 或 zabbix_get 测试或使用 监控项 键时，还需考虑 shell 语法。
例如，如果某个键参数需要用双引号括起来，则必须显式转义双引号，否则它们会被 shell 作为特殊字符截断，而不会被传递给 Zabbix 工具。
示例：
zabbix_agentd -t 'vfs.dir.count[/var/log,,,"file,dir",,0]'
zabbix_agentd -t vfs.dir.count[/var/log,,,\"file,dir\",,0]
##### Manifest preparation
Each module is expected to have a manifest.json file with the following
fields in JSON format:
|Parameter|Required|Type|Default|Description|
|---------|---|----|--|-------------------|
|manifest\_version|Yes|Double|\-|Manifest version of the module. Currently supported version is **1**.|
|id|Yes|String|\-|Module ID. Only one module with given ID can be enabled at the same time.|
|name|Yes|String|\-|Module name as displayed in the Administration section.|
|version|Yes|String|\-|Module version as displayed in the Administration section.|
|namespace|Yes|String|\-|PHP namespace for Module.php and action classes.|
|author|No|String|""|Module author as displayed in the Administration section.|
|url|No|String|""|Module URL as displayed in the Administration section.|
|description|No|String|""|Module description as displayed in the Administration section.|
|actions|No|Object|{}|Actions to register with this module. See Actions.|
|config|No|Object|{}|Module configuration.|
For reference, please see an example of manifest.json in the
[Reference](#reference) section.
##### 清单准备
每个模块都应包含一个manifest.json file文件，其中需以JSON格式声明以下字段：
| 参数 | 必填 | 类型 | 默认值 | 描述 |
|---------|---|----|--|-------------------|
| manifest\_version | 是 | Double | \- | 模块清单version。当前支持的version为**1**。 |
| id | 是 | String | \- | 模块ID。同一时间只能启用一个具有相同ID的模块。 |
| name | 是 | String | \- | 在管理界面显示的模块名称。 |
| version | 是 | String | \- | 在管理界面显示的模块version。 |
| namespace | 是 | String | \- | Module.php及动作类使用的PHP命名空间。 |
| author | 否 | String | "" | 在管理界面显示的模块作者。 |
| url | 否 | String | "" | 在管理界面显示的模块URL。 |
| description | 否 | String | "" | 在管理界面显示的模块描述。 |
| actions | 否 | Object | {} | 需通过该模块注册的动作。参见Actions章节。 |
| config | 否 | Object | {} | 模块配置项。 |
具体示例可参阅[参考](#reference)章节中的manifest.json范例。
##### Manual mode
When [configuring a host](/manual/config/hosts/host), in the *Inventory* tab you can
enter such details as the type of device, serial number, location,
responsible person, etc., - the data that will populate inventory information.
If a URL is included in the host inventory information and it starts with
'http' or 'https', it will result in a clickable link in the *Inventory*
section.
##### 手动模式
当[configuring a host](/manual/config/hosts/host)时，在*Inventory*标签页中可输入设备类型、序列号、位置、责任人等详细信息——这些数据将用于填充资产清单信息。
若主机资产清单信息中包含URL且以'http超文本传输协议'或'https'开头，该URL将在*Inventory*部分显示为可点击链接。
# map.create
# map.create
# map.delete
# map.delete
#### Map element Host group
The map element Host group object defines one host group element.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|groupid|string|Host group ID|
#### 地图元素 主机组
地图元素 主机组 object 定义一个 主机组 元素.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| groupid | string | 主机组 ID |
#### Map element Host
The map element Host object defines one host element.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|hostid|string|Host ID|
#### 地图元素 主机
地图元素 主机 object 定义一个 主机 元素.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| hostid | string | 主机 ID |
#### Map element Map
The map element Map object defines one map element.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|sysmapid|string|Map ID|
#### 地图元素 地图
地图元素 Map object 定义一个地图元素.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| sysmapid | string | 地图 ID |
#### Map element tag
The map element tag object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|**tag**<br>(required)|string|Map element tag name.|
|operator|integer|Map element tag condition operator.<br><br>Possible values:<br>0 - *(default)* Contains;<br>1 - Equals;<br>2 - Does not contain;<br>3 - Does not equal;<br>4 - Exists;<br>5 - Does not exist.|
|value|string|Map element tag value.|
#### 地图元素标签
地图元素标签 object 具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| **tag**<br>(required) | string | 地图元素标签名称. |
| operator | integer | 地图元素标签条件运算符.<br><br>可能的值:<br>0 - *(默认)* 包含;<br>1 - 等于;<br>2 - 不包含;<br>3 - 不等于;<br>4 - 存在;<br>5 - 不存在. |
| value | string | 地图元素标签值. |
### Map element
The map element object defines an object displayed on a map. It has the
following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|selementid|string|*(readonly)* ID of the map element.|
|**elements**<br>(required)|array|Element data object. Required for host, host group, trigger and map type elements.|
|**elementtype**<br>(required)|integer|Type of map element.<br><br>Possible values:<br>0 - host;<br>1 - map;<br>2 - trigger;<br>3 - host group;<br>4 - image.|
|**iconid\_off**<br>(required)|string|ID of the image used to display the element in default state.|
|areatype|integer|How separate host group hosts should be displayed.<br><br>Possible values:<br>0 - *(default)* the host group element will take up the whole map;<br>1 - the host group element will have a fixed size.|
|elementsubtype|integer|How a host group element should be displayed on a map.<br><br>Possible values:<br>0 - *(default)* display the host group as a single element;<br>1 - display each host in the group separately.|
|evaltype|integer|Map element tag filtering condition evaluation method.<br><br>Possible values:<br>0 - *(default)* AND / OR;<br>2 - OR.|
|height|integer|Height of the fixed size host group element in pixels.<br><br>Default: 200.|
|iconid\_disabled|string|ID of the image used to display disabled map elements. Unused for image elements.|
|iconid\_maintenance|string|ID of the image used to display map elements in maintenance. Unused for image elements.|
|iconid\_on|string|ID of the image used to display map elements with problems. Unused for image elements.|
|label|string|Label of the element.|
|label\_location|integer|Location of the map element label.<br><br>Possible values:<br>-1 - *(default)* default location;<br>0 - bottom;<br>1 - left;<br>2 - right;<br>3 - top.|
|permission|integer|Type of permission level.<br><br>Possible values:<br>-1 - none;<br>2 - read only;<br>3 - read-write.|
|sysmapid|string|*(readonly)* ID of the map that the element belongs to.|
|urls|array|Map element URLs.<br><br>The map element URL object is [described in detail below](object#map_element_url).|
|use\_iconmap|integer|Whether icon mapping must be used for host elements.<br><br>Possible values:<br>0 - do not use icon mapping;<br>1 - *(default)* use icon mapping.|
|viewtype|integer|Host group element placing algorithm.<br><br>Possible values:<br>0 - *(default)* grid.|
|width|integer|Width of the fixed size host group element in pixels.<br><br>Default: 200.|
|x|integer|X-coordinates of the element in pixels.<br><br>Default: 0.|
|y|integer|Y-coordinates of the element in pixels.<br><br>Default: 0.|
### 地图元素
地图元素object定义了在地图上显示的object. 它具有以下属性.
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| selementid | string | *(只读)* 地图元素的ID. |
| **elements**<br>(required) | array | 元素数据object. 对于主机, 主机组, 触发器和地图类型元素是必需的. |
| **elementtype**<br>(required) | integer | 地图元素类型.<br><br>可能的值:<br>0 - 主机;<br>1 - 地图;<br>2 - 触发器;<br>3 - 主机组;<br>4 - 图像. |
| **iconid\_off**<br>(required) | string | 用于在默认状态下显示元素的图像ID. |
| areatype | integer | 单独的主机组 主机应如何显示.<br><br>可能的值:<br>0 - *(默认)* 主机组元素将占据整个地图;<br>1 - 主机组元素将具有固定大小. |
| elementsubtype | integer | 一个主机组元素应如何在地图上显示.<br><br>可能的值:<br>0 - *(默认)* 将主机组显示为单个元素;<br>1 - 分别显示组中的每个主机. |
| evaltype | integer | 地图元素标签过滤条件评估方法.<br><br>可能的值:<br>0 - *(默认)* AND / OR;<br>2 - OR. |
| height | integer | 固定大小主机组元素的高度(像素).<br><br>默认值: 200. |
| iconid\_disabled | string | 用于显示禁用地图元素的图像ID. 不适用于图像元素. |
| iconid\_maintenance | string | 用于显示处于维护状态的地图元素的图像ID. 不适用于图像元素. |
| iconid\_on | string | 用于显示存在问题地图元素的图像ID. 不适用于图像元素. |
| label | string | 元素的标签. |
| label\_location | integer | 地图元素标签的位置.<br><br>可能的值:<br>-1 - *(默认)* 默认位置;<br>0 - 底部;<br>1 - 左侧;<br>2 - 右侧;<br>3 - Top. |
| permission | integer | 权限级别类型.<br><br>可能的值:<br>-1 - 无;<br>2 - 只读;<br>3 - 读写. |
| sysmapid | string | *(只读)* 元素所属地图的ID. |
| urls | array | 地图元素URL.<br><br>地图元素URL object是[地图元素-url](object#地图元素-url). |
| use\_iconmap | integer | 是否必须对主机元素使用图标映射.<br><br>可能的值:<br>0 - 不使用图标映射;<br>1 - *(默认)* 使用图标映射. |
| viewtype | integer | 主机组元素放置算法.<br><br>可能的值:<br>0 - *(默认)* 网格. |
| width | integer | 固定大小主机组元素的宽度(像素).<br><br>默认值: 200. |
| x | integer | 元素的X坐标(像素).<br><br>默认值: 0. |
| y | integer | 元素的Y坐标(像素).<br><br>默认值: 0. |
#### Map element Trigger
The map element Trigger object defines one or more trigger elements.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|triggerid|string|Trigger ID|
#### Map 元素触发器
地图元素触发器object定义一个或多个触发器元素。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| triggerid | string | 触发器ID |
#### Map element URL
The map element URL object defines a clickable link that will be
available for a specific map element. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|sysmapelementurlid|string|*(readonly)* ID of the map element URL.|
|**name**<br>(required)|string|Link caption.|
|**url**<br>(required)|string|Link URL.|
|selementid|string|ID of the map element that the URL belongs to.|
#### 地图元素 URL
地图元素URL object 定义了特定地图元素可点击的链接. 它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| sysmapelementurlid | string | *(只读)* 地图元素URL的ID. |
| **name**<br>(required) | string | 链接标题. |
| **url**<br>(required) | string | 链接URL. |
| selementid | string | URL所属地图元素的ID. |
# map.get
# map.get
#### Map lines
Create a map line.
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map API lines",
"width": 500,
"height": 500,
"lines": [
{
"x1": 30,
"y1": 10,
"x2": 100,
"y2": 50,
"line_type": 1,
"line_width": 10,
"line_color": "009900"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"11"
]
},
"id": 1
}
```
#### 地图连线
创建地图连线。
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map API lines",
"width": 500,
"height": 500,
"lines": [
{
"x1": 30,
"y1": 10,
"x2": 100,
"y2": 50,
"line_type": 1,
"line_width": 10,
"line_color": "009900"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"11"
]
},
"id": 1
}
```
### Map lines
The map line object defines a line displayed on a map. It has the
following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|sysmap\_shapeid|string|*(readonly)* ID of the map shape element.|
|x1|integer|X-coordinates of the line point 1 in pixels.<br><br>Default: 0.|
|y1|integer|Y-coordinates of the line point 1 in pixels.<br><br>Default: 0.|
|x2|integer|X-coordinates of the line point 2 in pixels.<br><br>Default: 200.|
|y2|integer|Y-coordinates of the line point 2 in pixels.<br><br>Default: 200.|
|line\_type|integer|Type of the lines.<br><br>Possible values:<br>0 - none;<br>1 - `—————`;<br>2 - `·····`;<br>3 - `- - -`.<br><br>Default: 0.|
|line\_width|integer|Width of the lines in pixels.<br><br>Default: 0.|
|line\_color|string|Line color.<br><br>Default: '000000'.|
|zindex|integer|Value used to order all shapes and lines (z-index).<br><br>Default: 0.|
### 地图连线
地图线条object定义了在地图上显示的线条。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| sysmap\_shapeid | string | *(只读)* 地图形状元素的ID。 |
| x1 | integer | 线条点1的X坐标（像素单位）。<br><br>默认值: 0。 |
| y1 | integer | 线条点1的Y坐标（像素单位）。<br><br>默认值: 0。 |
| x2 | integer | 线条点2的X坐标（像素单位）。<br><br>默认值: 200。 |
| y2 | integer | 线条点2的Y坐标（像素单位）。<br><br>默认值: 200。 |
| line\_type | integer | 线条类型。<br><br>可选值:<br>0 - 无;<br>1 - `—————`;<br>2 - `·····`;<br>3 - `- - -`。<br><br>默认值: 0。 |
| line\_width | integer | 线条宽度（像素单位）。<br><br>默认值: 0。 |
| line\_color | string | 线条颜色。<br><br>默认值: '000000'。 |
| zindex | integer | 用于排序所有形状和线条的值（z-index）。<br><br>默认值: 0。 |
### Map link
The map link object defines a link between two map elements. It has the
following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|linkid|string|*(readonly)* ID of the map link.|
|**selementid1**<br>(required)|string|ID of the first map element linked on one end.|
|**selementid2**<br>(required)|string|ID of the first map element linked on the other end.|
|color|string|Line color as a hexadecimal color code.<br><br>Default: `000000`.|
|drawtype|integer|Link line draw style.<br><br>Possible values:<br>0 - *(default)* line;<br>2 - bold line;<br>3 - dotted line;<br>4 - dashed line.|
|label|string|Link label.|
|linktriggers|array|Map link triggers to use as link status indicators.<br><br>The map link trigger object is [described in detail below](object#map_link_trigger).|
|permission|integer|Type of permission level.<br><br>Possible values:<br>-1 - none;<br>2 - read only;<br>3 - read-write.|
|sysmapid|string|ID of the map the link belongs to.|
### 地图链接
地图链接object用于定义两个地图元素之间的连接关系，具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| linkid | string | *(只读)* 地图链接的唯一标识符。 |
| **selementid1**<br>(required) | string | 连接端点1所关联的地图元素ID。 |
| **selementid2**<br>(required) | string | 连接端点2所关联的地图元素ID。 |
| color | string | 线条颜色（十六进制颜色代码）。<br><br>默认值：`000000`。 |
| drawtype | integer | 链接线条绘制样式。<br><br>可选值：<br>0 - *(默认)* 实线；<br>2 - 粗线；<br>3 - 点线；<br>4 - 虚线。 |
| label | string | 链接标签文本。 |
| linktriggers | array | 用作链接状态指示器的地图链接触发器。<br><br>地图链接触发器object的说明见[地图链接触发器](object#地图链接触发器)。 |
| permission | integer | 权限级别类型。<br><br>可选值：<br>-1 - 无权限；<br>2 - 只读；<br>3 - 读写。 |
| sysmapid | string | 该链接所属的地图ID。 |
#### Map link trigger
The map link trigger object defines a map link status indicator based on
the state of a trigger. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|linktriggerid|string|*(readonly)* ID of the map link trigger.|
|**triggerid**<br>(required)|string|ID of the trigger used as a link indicator.|
|color|string|Indicator color as a hexadecimal color code.<br><br>Default: `DD0000`.|
|drawtype|integer|Indicator draw style.<br><br>Possible values:<br>0 - *(default)* line;<br>2 - bold line;<br>3 - dotted line;<br>4 - dashed line.|
|linkid|string|ID of the map link that the link trigger belongs to.|
#### 地图链接触发器
地图链接触发器object基于触发器状态定义地图链接状态指示器. 它具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| linktriggerid | string | *(只读)* 地图链接触发器的ID. |
| **triggerid**<br>(required) | string | 用作链接指示器的触发器ID. |
| color | string | 指示器颜色(十六进制颜色代码).<br><br>默认: `DD0000`. |
| drawtype | integer | 指示器绘制样式.<br><br>可选值:<br>0 - *(默认)* 细线;<br>2 - 粗线;<br>3 - 点线;<br>4 - 虚线. |
| linkid | string | 链接触发器所属的地图链接ID. |
#### Map listing
{width="600"}
Displayed data:
|Column|Description|
|--|--------|
|*Name*|Name of the map. Click on the name to [view](/manual/web_interface/frontend_sections/monitoring/maps#viewing_maps) the map.|
|*Width*|Map width is displayed.|
|*Height*|Map height is displayed.|
|*Actions*|Two actions are available:<br>**Properties** - edit general map [properties](/manual/config/visualization/maps/map#creating_a_map)<br>**Constructor** - access the grid for adding [map elements](/manual/config/visualization/maps/map#adding_elements)|
To [configure](/manual/config/visualization/maps/map#creating_a_map) a
new map, click on the *Create map* button in the top right-hand corner.
To import a map from a YAML, XML, or JSON file, click on the *Import*
button in the top right-hand corner. The user who imports the map will
be set as its owner.
Two buttons below the list offer some mass-editing options:
- *Export* - export the maps to a YAML, XML, or JSON file
- *Delete* - delete the maps
To use these options, mark the checkboxes before the respective maps,
then click on the required button.
#### 地图列表
{width="600"}
显示数据：
| 列 | 描述 |
|--|--------|
| *Name* | 地图名称。点击名称可[查看网络拓扑图](/manual/web_interface/frontend_sections/monitoring/maps#查看网络拓扑图)该地图。 |
| *Width* | 显示地图宽度。 |
| *Height* | 显示地图高度。 |
| *Actions* | 提供两个操作：<br>**属性** - 编辑地图[创建地图](/manual/config/visualization/maps/map#创建地图)<br>**构建器** - 进入网格界面添加[添加元素](/manual/config/visualization/maps/map#添加元素) |
要[创建地图](/manual/config/visualization/maps/map#创建地图)新地图，点击Top右上角的*创建地图*按钮。
要从YAML、XML或JSONfileimport地图，点击Top右上角的*导入*按钮。导入地图的用户将被设为其所有者。
列表下方两个按钮提供批量编辑选项：
- *导出* - 将地图export为YAML、XML或JSONfile
- *删除* - delete所选地图
使用这些功能时，请先勾选对应地图前的复选框，然后点击所需按钮。
##### Mapping LLD macros
Next you have to go to the LLD macros tab and make the following
mappings:
{#VOLUME}=$.labels['volume']
{#METRIC}=$['name']
{#HELP}=$['help']
##### LLD 宏映射
接下来您需要前往LLD宏选项卡并进行以下映射:
{#VOLUME}=$.labels['卷']
{#METRIC}=$['名称']
{#HELP}=$['help']
#### Maps
Configure maps to create detailed dynamic representations of your IT
infrastructure.
[Map API](/manual/api/reference/map)
#### 拓扑图
配置地图以create您的IT基础设施的详细动态表示。
[Map API](/manual/api/reference/map)
#### Map shapes
Create a map with map name title.
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Host map",
"width": 600,
"height": 600,
"shapes": [
{
"type": 0,
"x": 0,
"y": 0,
"width": 600,
"height": 11,
"text": "{MAP.NAME}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"10"
]
},
"id": 1
}
```
#### 地图形状
创建带有地图名称标题的地图。
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Host map",
"width": 600,
"height": 600,
"shapes": [
{
"type": 0,
"x": 0,
"y": 0,
"width": 600,
"height": 11,
"text": "{MAP.NAME}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"10"
]
},
"id": 1
}
```
#### Map sharing
Create a map with two types of sharing (user and user group).
Request:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map sharing",
"width": 600,
"height": 600,
"users": [
{
"userid": "4",
"permission": "3"
}
],
"userGroups": [
{
"usrgrpid": "7",
"permission": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 1
}
```
#### 地图共享
创建包含两种共享类型（用户和用户组）的地图。
请求:
```json
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map sharing",
"width": 600,
"height": 600,
"users": [
{
"userid": "4",
"permission": "3"
}
],
"userGroups": [
{
"usrgrpid": "7",
"permission": "2"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 1
}
```
### Map
The map object has the following properties.
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|sysmapid|string|*(readonly)* ID of the map.|
|**height**<br>(required)|integer|Height of the map in pixels.|
|**name**<br>(required)|string|Name of the map.|
|**width**<br>(required)|integer|Width of the map in pixels.|
|backgroundid|string|ID of the image used as the background for the map.|
|expand\_macros|integer|Whether to expand macros in labels when configuring the map.<br><br>Possible values:<br>0 - *(default)* do not expand macros;<br>1 - expand macros.|
|expandproblem|integer|Whether the problem trigger will be displayed for elements with a single problem.<br><br>Possible values:<br>0 - always display the number of problems;<br>1 - *(default)* display the problem trigger if there's only one problem.|
|grid\_align|integer|Whether to enable grid aligning.<br><br>Possible values:<br>0 - disable grid aligning;<br>1 - *(default)* enable grid aligning.|
|grid\_show|integer|Whether to show the grid on the map.<br><br>Possible values:<br>0 - do not show the grid;<br>1 - *(default)* show the grid.|
|grid\_size|integer|Size of the map grid in pixels.<br><br>Supported values: 20, 40, 50, 75 and 100.<br><br>Default: 50.|
|highlight|integer|Whether icon highlighting is enabled.<br><br>Possible values:<br>0 - highlighting disabled;<br>1 - *(default)* highlighting enabled.|
|iconmapid|string|ID of the icon map used on the map.|
|label\_format|integer|Whether to enable advanced labels.<br><br>Possible values:<br>0 - *(default)* disable advanced labels;<br>1 - enable advanced labels.|
|label\_location|integer|Location of the map element label.<br><br>Possible values:<br>0 - *(default)* bottom;<br>1 - left;<br>2 - right;<br>3 - top.|
|label\_string\_host|string|Custom label for host elements.<br><br>Required for maps with custom host label type.|
|label\_string\_hostgroup|string|Custom label for host group elements.<br><br>Required for maps with custom host group label type.|
|label\_string\_image|string|Custom label for image elements.<br><br>Required for maps with custom image label type.|
|label\_string\_map|string|Custom label for map elements.<br><br>Required for maps with custom map label type.|
|label\_string\_trigger|string|Custom label for trigger elements.<br><br>Required for maps with custom trigger label type.|
|label\_type|integer|Map element label type.<br><br>Possible values:<br>0 - label;<br>1 - IP address;<br>2 - *(default)* element name;<br>3 - status only;<br>4 - nothing.|
|label\_type\_host|integer|Label type for host elements.<br><br>Possible values:<br>0 - label;<br>1 - IP address;<br>2 - *(default)* element name;<br>3 - status only;<br>4 - nothing;<br>5 - custom.|
|label\_type\_hostgroup|integer|Label type for host group elements.<br><br>Possible values:<br>0 - label;<br>2 - *(default)* element name;<br>3 - status only;<br>4 - nothing;<br>5 - custom.|
|label\_type\_image|integer|Label type for host group elements.<br><br>Possible values:<br>0 - label;<br>2 - *(default)* element name;<br>4 - nothing;<br>5 - custom.|
|label\_type\_map|integer|Label type for map elements.<br><br>Possible values:<br>0 - label;<br>2 - *(default)* element name;<br>3 - status only;<br>4 - nothing;<br>5 - custom.|
|label\_type\_trigger|integer|Label type for trigger elements.<br><br>Possible values:<br>0 - label;<br>2 - *(default)* element name;<br>3 - status only;<br>4 - nothing;<br>5 - custom.|
|markelements|integer|Whether to highlight map elements that have recently changed their status.<br><br>Possible values:<br>0 - *(default)* do not highlight elements;<br>1 - highlight elements.|
|severity\_min|integer|Minimum severity of the triggers that will be displayed on the map.<br><br>Refer to the [trigger "severity" property](/manual/api/reference/trigger/object#trigger) for a list of supported trigger severities.|
|show\_unack|integer|How problems should be displayed.<br><br>Possible values:<br>0 - *(default)* display the count of all problems;<br>1 - display only the count of unacknowledged problems;<br>2 - display the count of acknowledged and unacknowledged problems separately.|
|userid|string|Map owner user ID.|
|private|integer|Type of map sharing.<br><br>Possible values:<br>0 - public map;<br>1 - *(default)* private map.|
|show\_suppressed|integer|Whether suppressed problems are shown.<br><br>Possible values:<br>0 - *(default)* hide suppressed problems;<br>1 - show suppressed problems.|
Note that for some methods (update, delete) the required/optional parameter combination is different.
### 拓扑图
地图 object 具有以下属性。
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| sysmapid | string | *(只读)* 地图的ID。 |
| **height**<br>(required) | integer | 地图的高度（以像素为单位）。 |
| **name**<br>(required) | string | 地图的名称。 |
| **width**<br>(required) | integer | 地图的宽度（以像素为单位）。 |
| backgroundid | string | 用作地图背景的图片ID。 |
| expand\_macros | integer | 配置地图时是否在标签中展开宏。<br><br>可能的值：<br>0 - *(默认)* 不展开宏；<br>1 - 展开宏。 |
| expandproblem | integer | 是否对只有一个问题的元素显示问题触发器。<br><br>可能的值：<br>0 - 始终显示问题数量；<br>1 - *(默认)* 如果只有一个问题则显示问题触发器。 |
| grid\_align | integer | 是否启用网格对齐。<br><br>可能的值：<br>0 - 禁用网格对齐；<br>1 - *(默认)* 启用网格对齐。 |
| grid\_show | integer | 是否在地图上显示网格。<br><br>可能的值：<br>0 - 不显示网格；<br>1 - *(默认)* 显示网格。 |
| grid\_size | integer | 地图网格的大小（以像素为单位）。<br><br>支持的值：20、40、50、75和100。<br><br>默认值：50。 |
| highlight | integer | 是否启用图标高亮。<br><br>可能的值：<br>0 - 禁用高亮；<br>1 - *(默认)* 启用高亮。 |
| iconmapid | string | 地图上使用的图标映射ID。 |
| label\_format | integer | 是否启用高级标签。<br><br>可能的值：<br>0 - *(默认)* 禁用高级标签；<br>1 - 启用高级标签。 |
| label\_location | integer | 地图元素标签的位置。<br><br>可能的值：<br>0 - *(默认)* 底部；<br>1 - 左侧；<br>2 - 右侧；<br>3 - Top。 |
| label\_string\_host | string | 主机 元素的自定义标签。<br><br>对于具有自定义 主机 标签类型的地图是必需的。 |
| label\_string\_hostgroup | string | 主机组 元素的自定义标签。<br><br>对于具有自定义 主机组 标签类型的地图是必需的。 |
| label\_string\_image | string | 图片元素的自定义标签。<br><br>对于具有自定义图片标签类型的地图是必需的。 |
| label\_string\_map | string | 地图元素的自定义标签。<br><br>对于具有自定义地图标签类型的地图是必需的。 |
| label\_string\_trigger | string | 触发器元素的自定义标签。<br><br>对于具有自定义触发器标签类型的地图是必需的。 |
| label\_type | integer | 地图元素标签类型。<br><br>可能的值：<br>0 - 标签；<br>1 - IP地址；<br>2 - *(默认)* 元素名称；<br>3 - 仅状态；<br>4 - 无。 |
| label\_type\_host | integer | 主机 元素的标签类型。<br><br>可能的值：<br>0 - 标签；<br>1 - IP地址；<br>2 - *(默认)* 元素名称；<br>3 - 仅状态；<br>4 - 无；<br>5 - 自定义。 |
| label\_type\_hostgroup | integer | 主机组 元素的标签类型。<br><br>可能的值：<br>0 - 标签；<br>2 - *(默认)* 元素名称；<br>3 - 仅状态；<br>4 - 无；<br>5 - 自定义。 |
| label\_type\_image | integer | 主机组 元素的标签类型。<br><br>可能的值：<br>0 - 标签；<br>2 - *(默认)* 元素名称；<br>4 - 无；<br>5 - 自定义。 |
| label\_type\_map | integer | 地图元素的标签类型。<br><br>可能的值：<br>0 - 标签；<br>2 - *(默认)* 元素名称；<br>3 - 仅状态；<br>4 - 无；<br>5 - 自定义。 |
| label\_type\_trigger | integer | 触发器元素的标签类型。<br><br>可能的值：<br>0 - 标签；<br>2 - *(默认)* 元素名称；<br>3 - 仅状态；<br>4 - 无；<br>5 - 自定义。 |
| markelements | integer | 是否高亮最近更改状态的地图元素。<br><br>可能的值：<br>0 - *(默认)* 不高亮元素；<br>1 - 高亮元素。 |
| severity\_min | integer | 将在地图上显示的触发器的最小严重性。<br><br>请参阅 [触发器](/manual/api/reference/trigger/object#触发器) 获取支持的触发器严重性列表。 |
| show\_unack | integer | 问题的显示方式。<br><br>可能的值：<br>0 - *(默认)* 显示所有问题的计数；<br>1 - 仅显示未确认问题的计数；<br>2 - 分别显示已确认和未确认问题的计数。 |
| userid | string | 地图所有者用户ID。 |
| private | integer | 地图共享类型。<br><br>可能的值：<br>0 - 公共地图；<br>1 - *(默认)* 私有地图。 |
| show\_suppressed | integer | 是否显示被抑制的问题。<br><br>可能的值：<br>0 - *(默认)* 隐藏被抑制的问题；<br>1 - 显示被抑制的问题。 |
请注意，对于某些方法（update、delete），必需/可选参数的组合是不同的。
# map.update
# map.update
### Map URL
The map URL object defines a clickable link that will be available for
all elements of a specific type on the map. It has the following
properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|sysmapurlid|string|*(readonly)* ID of the map URL.|
|**name**<br>(required)|string|Link caption.|
|**url**<br>(required)|string|Link URL.|
|elementtype|integer|Type of map element for which the URL will be available.<br><br>Refer to the [map element "type" property](object#map_element) for a list of supported types.<br><br>Default: 0.|
|sysmapid|string|ID of the map that the URL belongs to.|
### 地图 URL
地图URL object 定义了可点击链接，该链接将在地图上特定类型的所有元素上可用。它具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| sysmapurlid | string | *(只读)* 地图URL的ID。 |
| **name**<br>(required) | string | 链接标题。 |
| **url**<br>(required) | string | 链接URL。 |
| elementtype | integer | URL可用的地图元素类型。<br><br>参考[地图元素](object#地图元素)获取支持的类型列表。<br><br>默认值: 0。 |
| sysmapid | string | URL所属地图的ID。 |
### Map user group
List of map permissions based on user groups. It has the following
properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|sysmapusrgrpid|string|*(readonly)* ID of the map user group.|
|**usrgrpid**<br>(required)|string|User group ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write;|
### 映射用户组
基于用户组的地图权限列表。具有以下属性：
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| sysmapusrgrpid | string | *(只读)* 地图用户组的ID。 |
| **usrgrpid**<br>(required) | string | 用户组ID。 |
| **permission**<br>(required) | integer | 权限级别类型。<br><br>可能的值：<br>2 - 只读；<br>3 - 读写； |
### Map user
List of map permissions based on users. It has the following properties:
|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|sysmapuserid|string|*(readonly)* ID of the map user.|
|**userid**<br>(required)|string|User ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write;|
### 地图用户
基于用户的网络地图权限列表. 具有以下属性:
| 属性 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| sysmapuserid | string | *(只读)* 地图用户的ID. |
| **userid**<br>(required) | string | 用户ID. |
| **permission**<br>(required) | integer | 权限级别类型.<br><br>可能的值:<br>2 - 只读;<br>3 - 读写权限; |
### MariaDB 10.10 support
The maximum supported version for MariaDB is now 10.10.X.
### mariadb 10.10 支持
当前version对mariadb的最大支持版本为10.10.X.
### MariaDB 10.11 support
The maximum [supported version](/manual/installation/requirements#third-party-external-surrounding-software) for MariaDB is now 10.11.X.
### mariadb 10.11 支持
[supported version](/manual/installation/requirements#third-party-external-surrounding-software)的最大mariadb版本现已支持至10.11.X。
### MariaDB 10.7 support
The maximum supported version for MariaDB is now 10.7.X.
### mariadb 10.7 支持
当前version对mariadb的最大支持版本为10.7.X.
### MariaDB 10.8 support
The maximum supported version for MariaDB is now 10.8.X.
### mariadb 10.8 支持
当前支持的version对于mariadb最高版本为10.8.X.
#### MariaDB 11.0 support
The maximum [supported version](/manual/installation/requirements#third-party-external-surrounding-software) for MariaDB is now 11.0.X.
#### mariadb 11.0 支持
[supported version](/manual/installation/requirements#third-party-external-surrounding-software)的最大mariadb版本现已支持11.0.X.
#### MariaDB 11.2 support
The maximum [supported version](/manual/installation/requirements#third-party-external-surrounding-software) for MariaDB is now 11.2.X.
#### mariadb 11.2 支持
[supported version](/manual/installation/requirements#third-party-external-surrounding-software)的最大mariadb版本现在为11.2.X.
#### MariaDB 11.3 support
The maximum [supported version](/manual/installation/requirements#third-party-external-surrounding-software) for MariaDB is now 11.3.X.
#### mariadb 11.3 支持
[supported version](/manual/installation/requirements#third-party-external-surrounding-software)的最大mariadb版本现在为11.3.X.
#### MariaDB 11.4 support
The maximum [supported version](/manual/installation/requirements#third-party-external-surrounding-software) for MariaDB is now 11.4.X.
#### mariadb 11.4 支持
[supported version](/manual/installation/requirements#third-party-external-surrounding-software)的最大mariadb版本现在为11.4.X.
#### MariaDB 11.5 support
The maximum [supported version](/manual/installation/requirements#third-party-external-surrounding-software) for MariaDB is now 11.5.X.
#### mariadb 11.5 支持
[supported version](/manual/installation/requirements#third-party-external-surrounding-software)的最大mariadb版本现在为11.5.X.
#### MariaDB 12.0 support
The maximum [supported version](/manual/installation/requirements#third-party-external-surrounding-software) for MariaDB is now 12.0.X.
#### MariaDB 12.0 support
[supported version](/manual/installation/requirements#third-party-external-surrounding-software)的最大mariadb版本现在为12.0.X。
##### Mass editing options
A button below the list offers one mass-editing option:
- *Delete* - delete the maintenance periods
To use this option, mark the checkboxes before the respective
maintenance periods and click on *Delete*.
##### 批量编辑选项
列表下方按钮提供批量编辑选项:
- *Delete* - delete 维护周期
使用此选项时，请勾选对应维护周期前的复选框并点击*Delete*。
##### Mass editing options
A button below the list offers one mass-editing option:
- *Delete* - delete the scripts
To use this option, mark the checkboxes before the respective scripts
and click on *Delete*.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项：
- *Delete* - delete 脚本
使用此选项时，请勾选相应脚本前的复选框
并点击 *Delete*。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Copy* - copy the graphs to other hosts or templates
- *Delete* - delete the graphs
To use these options, mark the checkboxes before the respective graphs,
then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项：
- *复制* - copy 图表到其他 主机 或模板
- *删除* - delete 图表
使用这些选项时，请先勾选相应图表前的复选框，
然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Copy* - copy the graphs to other hosts or templates
- *Delete* - delete the graphs
To use these options, mark the checkboxes before the respective graphs,
then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项：
- *复制* - copy 图表到其他 主机 或模板
- *删除* - delete 图表
要使用这些选项，请先勾选相应图表前的复选框，
然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Create enabled* - create these hosts as *Enabled*
- *Create disabled* - create these hosts as *Disabled*
- *Delete* - delete these host prototypes
To use these options, mark the checkboxes before the respective
host prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项：
- *创建启用* - create这些主机为*启用*状态
- *创建禁用* - create这些主机为*禁用*状态
- *删除* - delete这些主机原型
使用这些选项时，请先勾选对应主机原型前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Create enabled* - create these hosts as *Enabled*
- *Create disabled* - create these hosts as *Disabled*
- *Delete* - delete these host prototypes
To use these options, mark the checkboxes before the respective
host prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项:
- *创建启用* - create这些主机为*启用*状态
- *创建禁用* - create这些主机为*禁用*状态
- *删除* - delete这些主机原型
要使用这些选项，请先勾选对应主机原型前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Create enabled* - create these items as *Enabled*
- *Create disabled* - create these items as *Disabled*
- *Mass update* - mass update these item prototypes
- *Delete* - delete these item prototypes
To use these options, mark the checkboxes before the respective
item prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项：
- *创建启用* - create这些监控项为*启用*状态
- *创建禁用* - create这些监控项为*禁用*状态
- *批量update* - 批量update这些监控项原型
- *删除* - delete这些监控项原型
使用这些选项时，请先勾选对应监控项原型前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Create enabled* - create these items as *Enabled*
- *Create disabled* - create these items as *Disabled*
- *Mass update* - mass update these item prototypes
- *Delete* - delete these item prototypes
To use these options, mark the checkboxes before the respective
item prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项：
- *创建启用* - create这些监控项为*启用*状态
- *创建禁用* - create这些监控项为*禁用*状态
- *批量update* - 批量update这些监控项原型
- *删除* - delete这些监控项原型
使用这些选项时，请先勾选对应监控项原型前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Create enabled* - create these triggers as *Enabled*
- *Create disabled* - create these triggers as *Disabled*
- *Mass update* - mass update these trigger prototypes
- *Delete* - delete these trigger prototypes
To use these options, mark the checkboxes before the respective
trigger prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供了一些批量编辑选项:
- *创建启用* - create 这些触发器为*启用*状态
- *创建禁用* - create 这些触发器为*禁用*状态
- *批量update* - 批量update这些触发器原型
- *删除* - delete 这些触发器原型
要使用这些选项，请先勾选相应触发器原型前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Create enabled* - create these triggers as *Enabled*
- *Create disabled* - create these triggers as *Disabled*
- *Mass update* - mass update these trigger prototypes
- *Delete* - delete these trigger prototypes
To use these options, mark the checkboxes before the respective
trigger prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供了一些批量编辑选项:
- *创建启用* - create这些触发器为*启用*状态
- *创建禁用* - create这些触发器为*禁用*状态
- *批量update* - 批量update这些触发器原型
- *删除* - delete这些触发器原型
要使用这些选项，请先勾选相应触发器原型前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Delete* - delete these graph prototypes
To use these options, mark the checkboxes before the respective
graph prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供了一些批量编辑选项：
- *Delete* - delete 这些图形原型
要使用这些选项，请先在相应图形原型前勾选复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Delete* - delete these graph prototypes
To use these options, mark the checkboxes before the respective
graph prototypes, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供了一些批量编辑选项：
- *删除* - delete 这些图形原型
要使用这些选项，请先在相应图形原型前勾选复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Enable* - change host status to *Monitored*
- *Disable* - change host status to *Not monitored*
- *Export* - export the hosts to a YAML, XML or JSON file
- *Mass update* - [update several
properties](/manual/config/hosts/hostupdate) for a number of hosts
at once
- *Delete* - delete the hosts
To use these options, mark the checkboxes before the respective hosts,
then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项:
- *启用* - 将主机状态更改为*已监控*
- *禁用* - 将主机状态更改为*未监控*
- *导出* - 将主机export为YAML、XML或JSONfile
- *批量update* - 为多个主机[update several
properties](/manual/config/hosts/hostupdate)
- *删除* - delete所选主机
使用这些选项时，请先勾选对应主机前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Enable* - change item status to *Enabled*.
- *Disable* - change item status to *Disabled*.
- *Copy* - copy the items to other hosts or templates.
- *Mass update* - [update several
properties](/manual/config/items/itemupdate) for a number of items
at once.
- *Delete* - delete the items.
To use these options, mark the checkboxes before the respective items,
then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项:
- *启用* - 将监控项状态更改为*已启用*.
- *禁用* - 将监控项状态更改为*已禁用*.
- *复制* - 将监控项copy到其他主机或模板.
- *批量update* - 为多个监控项[update several
properties](/manual/config/items/itemupdate).
- *删除* - delete所选监控项.
要使用这些选项，请先勾选对应监控项前的复选框，然后点击所需按钮.
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Enable* - change item status to *Enabled*
- *Disable* - change item status to *Disabled*
- *Execute now* - execute a check for new item values immediately.
Supported for **passive** checks only (see [more
details](/manual/config/items/check_now)). Note that when checking
for values immediately, configuration cache is not updated, thus the
values will not reflect very recent changes to item configuration.
- *Clear history and trends* - delete history and trend data for items.
- *Copy* - copy the items to other hosts or templates.
- *Mass update* - [update several
properties](/manual/config/items/itemupdate) for a number of items
at once.
- *Delete* - delete the items.
To use these options, mark the checkboxes before the respective items,
then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项：
- *启用* - 将监控项状态更改为*已启用*
- *禁用* - 将监控项状态更改为*已禁用*
- *立即执行* - 立即execute新监控项值的检查。
仅支持**被动**检查（参见[more
details](/manual/config/items/check_now)）。请注意，立即检查值时，configuration cache不会更新，因此这些值不会反映监控项配置的最新更改。
- *清除历史和趋势数据* - 为监控项delete历史和趋势数据。
- *复制* - 将监控项copy到其他主机或模板。
- *批量update* - 为多个监控项[update several
properties](/manual/config/items/itemupdate)。
- *删除* - delete该监控项。
要使用这些选项，请在相应监控项前标记复选框，然后单击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Enable* - change the action status to *Enabled*
- *Disable* - change the action status to *Disabled*
- *Delete* - delete the actions
To use these options, mark the checkboxes before the respective actions,
then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项:
- *启用* - 将动作状态更改为*已启用*
- *禁用* - 将动作状态更改为*已禁用*
- *删除* - delete 所选动作
使用这些选项时，请先勾选对应动作前的复选框，
然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Enable* - change the correlation rule status to *Enabled*
- *Disable* - change the correlation rule status to *Disabled*
- *Delete* - delete the correlation rules
To use these options, mark the checkboxes before the respective
correlation rules, then click on the required button.
##### 批量编辑选项
列表下方的按钮提供批量编辑选项:
- *启用* - 将关联规则状态更改为*已启用*
- *禁用* - 将关联规则状态更改为*已禁用*
- *删除* - delete 关联规则
使用这些选项时，请先勾选相应关联规则前的复选框，然后点击所需按钮。
##### Mass editing options
Buttons below the list offer some mass-editing options:
- *Enable* - change the discovery rule status to *Enabled*
- *Disable* - change the discovery rule status to *Disabled*
- *Delete* - delete the discovery rules
To use these options, mark the checkboxes before the respective
discovery rules, then click on the required button.
##### 批量编辑选项
列表下方的