en-us	##### 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.|
zh-cn	##### 主机图形标签  |元素|元素属性|是否必须|类型|范围^**[1](#footnotes)**^|描述| |-------|----------------|--------|----|--------------------------|-----------| |graphs|<|\-|<|<|图形的根元素。| |<|name|x|`string`|<|图形名称。| |<|width|\-|`integer`|20-65535 (默认: 900)|图形宽度, 以像素为单位。用于预览和饼图/分解图。| |<|height|\-|`integer`|20-65535 (默认: 200)|图形高度，以像素为单位。用于预览和饼图/分解图。| |<|yaxismin|\-|`double`|默认: 0|Y轴最小值。 <br><br>当'ymin\_type\_1'为固定值时使用。| |<|yaxismax|\-|`double`|默认: 0|Y轴最大值。 <br><br>当'ymax\_type\_1'为固定值时使用。| |<|show\_work\_period|\-|`string`|0 - NO<br>1 - YES (默认)|突出非工作时间。 <br><br>用于普通图和堆叠图。| |<|show\_triggers|\-|`string`|0 - NO<br>1 - YES (默认)|将简单的触发器值显示为一行。 <br><br>用于普通图和堆叠图。| |<|type|\-|`string`|0 - NORMAL (默认)<br>1 - STACKED<br>2 - PIE<br>3 - EXPLODED|图形类型。| |<|show\_legend|\-|`string`|0 - NO<br>1 - YES (默认)|显示图例。| |<|show\_3d|\-|`string`|0 - NO (默认)<br>1 - YES|开启3De风格。<br><br>用于饼图和分解饼图。| |<|percent\_left|\-|`double`|默认:0|显示左轴的百分位线。<br><br>仅用于普通图形。| |<|percent\_right|\-|`double`|默认:0|显示右轴的百分位线。 <br><br>仅用于普通图形。| |<|ymin\_type\_1|\-|`string`|0 - CALCULATED (默认)<br>1 - FIXED<br>2 - ITEM|Y轴的最小值。 <br><br>用于普通图和堆叠图。| |<|ymax\_type\_1|\-|`string`|0 - CALCULATED (默认)<br>1 - FIXED<br>2 - ITEM|Y轴最大值。 <br><br>用于普通图和堆叠图。| |ymin\_item\_1|<|\-|<|<|个别监控项的细节。 <br><br>当'ymin\_type\_1'为ITEM时需要。| |<|host|x|`string`|<|监控项主机。| |<|key|x|`string`|<|监控项键值。| |ymax\_item\_1|<|\-|<|<|个别监控项的细节。<br><br>当'ymax\_type\_1'为ITEM时需要。| |<|host|x|`string`|<|监控项主机。| |<|key|x|`string`|<|监控项键值。| |graph\_items|<|x|<|<|图形监控项的根元素。| |<|sortorder|\-|`integer`|<|画秩序。 先画出较小的值。 可用于在另一个线或区域后面(或前面)画线或区域。| |<|drawtype|\-|`string`|0 - SINGLE\_LINE (默认)<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 (默认)<br>1 - RIGHT|将绘制图形监控项Y比例的图形的一边。 <br><br>用于普通图和堆叠图。| |<|calc\_fnc|\-|`string`|1 - MIN<br>2 - AVG (默认)<br>4 - MAX<br>7 - ALL(最小、平均和最大; <br>9 - LAST(仅用于饼图和分解饼图)|如果某监控项存在多个值，则绘制的数据。| |<|type|\-|`string`|0 - SIMPLE (默认)<br>2 - GRAPH\_SUM (监控项的值代表整个饼图; 仅用于饼图和分解饼图)|监控项图形类型。| |item|<|x|<|<|单一监控项。| |<|host|x|`string`|<|监控项主机。| |<|key|x|`string`|<|监控项键值。|

en-us	#### host group  Changes:\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massupdate`: `hosts` and `templates` fields are now required.\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massadd`, `hostgroup.massupdate`, `hostgroup.massremove`: added strict validation of the method parameters.\
zh-cn	 #### 主机组  变更：\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massupdate`：`hosts`和`templates`字段现在是必填项。\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massadd`，`hostgroup.massupdate`, `hostgroup.massremove`：添加了对方法参数的严格校验。\

en-us	#### host group  Changes:\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massupdate`: `hosts` and `templates` fields are now required.\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massadd`, `hostgroup.massupdate`, `hostgroup.massremove`: added strict validation of the method parameters.\
zh-cn	 #### 主机组  变更：\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massupdate`：`hosts`和`templates`字段现在是必填项。\ [ZBXNEXT-6868](https://support.zabbix.com/browse/ZBXNEXT-6868) `hostgroup.massadd`，`hostgroup.massupdate`, `hostgroup.massremove`：添加了对方法参数的严格校验。\

en-us	# hostgroup.create
zh-cn	# 创建

en-us	# hostgroup.delete
zh-cn	# 删除

en-us	# hostgroup.get
zh-cn	# 获取

en-us	# hostgroup.massadd
zh-cn	# 批量添加

en-us	# hostgroup.massremove
zh-cn	# 批量删除

en-us	# hostgroup.massupdate
zh-cn	# 批量更新

en-us	# > Host group object  The following objects are directly related to the `hostgroup` API.
zh-cn	 # > 主机组对象  以下对象是和`主机组`直接相关的API。

en-us	### 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.<br><br>For update operations this field is *readonly*.|  Note that for some methods (update, delete) the required/optional parameter combination is different.
zh-cn	### 主机组  主机组对象有以下属性。  |属性|[类](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |groupid|字符串|*(只读)* 主机组ID。| |**name**<br>(必填)|字符串|主机组的名称。| |flags|整型|*(只读)* 主机组的来源。<br><br>取值范围:<br>0—普通主机组;<br>4—自动发现的主机组。| |internal|整型|*(只读)* 组是否被系统内部使用。内部组不能被删除。<br><br>取值范围:<br>0 - *(默认值)* 非内部;<br>1 - 内部。| |uuid|字符串|统一唯一标识符，用于将导入的主机组与已经存在的主机组连接。如果没有给出将自动生成。<br><br>对于更新操作，此字段为 *只读*。| 注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。

en-us	# Host group  This class is designed to work with host groups.  Object references:\  -   [Host group](/manual/api/reference/hostgroup/object#host_group)  Available methods:\  -   [hostgroup.create](/manual/api/reference/hostgroup/create) -     creating new host groups -   [hostgroup.delete](/manual/api/reference/hostgroup/delete) -     deleting host groups -   [hostgroup.get](/manual/api/reference/hostgroup/get) - retrieving     host groups -   [hostgroup.massadd](/manual/api/reference/hostgroup/massadd) -     adding related objects to host groups -   [hostgroup.massremove](/manual/api/reference/hostgroup/massremove) -     removing related objects from host groups -   [hostgroup.massupdate](/manual/api/reference/hostgroup/massupdate) -     replacing or removing related objects from host groups -   [hostgroup.update](/manual/api/reference/hostgroup/update) -     updating host groups
zh-cn	 # 主机组  该类用于管理主机组。  对象引用:\  -   [主机组](/manual/api/reference/hostgroup/object#host_group)  可用的方法:\  -   [hostgroup.create](/manual/api/reference/hostgroup/create) -     新建主机组 -   [hostgroup.delete](/manual/api/reference/hostgroup/delete) -     删除主机组 -   [hostgroup.get](/manual/api/reference/hostgroup/get) -      获取主机组 -   [hostgroup.massadd](/manual/api/reference/hostgroup/massadd) -     添加相关对象到主机组 -   [hostgroup.massremove](/manual/api/reference/hostgroup/massremove) -     从主机组删除相关对象 -   [hostgroup.massupdate](/manual/api/reference/hostgroup/massupdate) -     从主机组替换或删除相关对象 -   [hostgroup.update](/manual/api/reference/hostgroup/update) -      更新主机组

en-us	# hostgroup.update
zh-cn	# 更新

en-us	# hostinterface.create
zh-cn	# 创建

en-us	# hostinterface.delete
zh-cn	# 删除

en-us	# hostinterface.get
zh-cn	# 获取

en-us	# hostinterface.massadd
zh-cn	# 批量添加

en-us	# hostinterface.massremove
zh-cn	# 批量删除

en-us	# > Host interface object  The following objects are directly related to the `hostinterface` API.
zh-cn	# > 主机接口对象  以下对象与 `主机接口` API 直接相关。

en-us	# hostinterface.replacehostinterfaces
zh-cn	# 替换

en-us	### 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|array|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.
zh-cn	### 主机接口  主机接口对象具有以下属性。  ::: 重要 注意，IP和DNS都是必需的。如果您不想使用DNS，请将其设置为空字符串. :::  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |available|整型|*(只读)* 主机接口的可用性。<br><br>可能的值有:<br>0 - *(默认)* 未知;<br>1 - 可用;<br>2 - 不可用。| |details|数组|接口的附加对象。  如果接口 'type'是SNMP，则**必选**| |disable\_until|时间戳|*(只读)* 不可用主机接口的下一次轮询时间。| |**dns**<br>(必选)|字符串|接口使用的DNS名称<br><br>如果通过IP直接连接，则可以为空。| |error|字符串|*(只读)* 主机接口不可用的错误文本。| |errors\_from|时间戳|*(只读)* 主机接口不可用开始时间。| |**hostid**<br>(必选)|字符串|接口所属的主机ID。| |interfaceid|字符串|*(只读)* 接口的ID。| |**ip**<br>(必选)|字符串|接口使用的IP地址。<br><br>如果使用DNS域名连接，可以设置为空。| |**main**<br>(必选)|整型|该接口是否在主机上用作默认的接口，在主机上只能将某种类型的一个接口设置为默认值。<br><br>可能的值有:<br>0 - 不是默认;<br>1 - 默认。| |**port**<br>(必选)|字符串|接口使用的端口号，可以包含用户宏。| |**type**<br>(必选)|整型|接口类型。<br><br>可能的值有:<br>1 - agent;<br>2 - SNMP;<br>3 - IPMI;<br>4 - JMX。<br>| |**useip**<br>(必选)|整型|是否通过IP进行连接。<br><br>可能的值有:<br>0 - 使用主机DNS进行连接;<br>1 - 使用主机接口的主机IP进行连接。| 注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。

en-us	# Host interface  This class is designed to work with host interfaces.  Object references:\  -   [Host     interface](/manual/api/reference/hostinterface/object#host_interface)  Available methods:\  -   [hostinterface.create](/manual/api/reference/hostinterface/create) -     creating new host interfaces -   [hostinterface.delete](/manual/api/reference/hostinterface/delete) -     deleting host interfaces -   [hostinterface.get](/manual/api/reference/hostinterface/get) -     retrieving host interfaces -   [hostinterface.massadd](/manual/api/reference/hostinterface/massadd) -     adding host interfaces to hosts -   [hostinterface.massremove](/manual/api/reference/hostinterface/massremove) -     removing host interfaces from hosts -   [hostinterface.replacehostinterfaces](/manual/api/reference/hostinterface/replacehostinterfaces) -     replacing host interfaces on a host -   [hostinterface.update](/manual/api/reference/hostinterface/update) -     updating host interfaces  
zh-cn	# 主机接口  这个类是设计用于处理主机接口.  对象引用:\  -   [Host     interface](/manual/api/reference/hostinterface/object#host_interface)  可用方法:\  -   [hostinterface.create](/manual/api/reference/hostinterface/create) -     创建新的主机接口 -   [hostinterface.delete](/manual/api/reference/hostinterface/delete) -     删除主机接口 -   [hostinterface.get](/manual/api/reference/hostinterface/get) -     获取主机接口 -   [hostinterface.massadd](/manual/api/reference/hostinterface/massadd) -     批量添加主机接口 -   [hostinterface.massremove](/manual/api/reference/hostinterface/massremove) -     批量删除主机接口 -   [hostinterface.replacehostinterfaces](/manual/api/reference/hostinterface/replacehostinterfaces) -     替换主机接口 -   [hostinterface.update](/manual/api/reference/hostinterface/update) -     更新主机接口

en-us	# hostinterface.update
zh-cn	# 更新

en-us	### 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|
zh-cn	### 主机资产  主机资产对象具有以下属性。  ::: notetip 每个属性都有自己的唯一ID号，该ID号用于将主机资产字段与监控项关联起来。 :::  |ID|属性|[类型](/manual/api/reference_commentary#data_types)|描述|最大长度| |----|--------|--------|-------|-----------| |4|alias|string|别名。|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|OOB IP 地址。|39 个字符| |42|oob\_netmask|string|OOB 主机子网掩码。|39 个字符| |43|oob\_router|string|OOB 路由器。|39 个字符| |5|os|string|操作系统名称。|128 个字符| |6|os\_full|string|详细的操作系统名称。|255 个字符| |7|os\_short|string|操作系统简称。|128 个字符| |61|poc\_1\_cell|string|主要 POC 手机号码。|64 个字符| |58|poc\_1\_email|string|主要电子邮件。|128 个字符| |57|poc\_1\_name|string|主要 POC 名称。|128 个字符| |63|poc\_1\_notes|string|主要 POC 注释。|取决于所使用的数据库：<br>- SQL 数据库为 65535 个字符<br>- Oracle 数据库为 2048 个字符| |59|poc\_1\_phone\_a|string|主要 POC 电话 A.|64 个字符| |60|poc\_1\_phone\_b|string|主要 POC 电话 B.|64 个字符| |62|poc\_1\_screen|string|主要 POC 屏幕名称。|64 个字符| |68|poc\_2\_cell|string|辅助 POC 手机号码。|64 个字符| |65|poc\_2\_email|string|辅助 POC 电子邮件。|128 个字符| |64|poc\_2\_name|string|二级 POC 名称。|128 个字符| |70|poc\_2\_notes|string|次要 POC 注释。|取决于所使用的数据库：<br>- SQL 数据库为 65535 个字符<br>- Oracle 数据库为 2048 个字符| |66|poc\_2\_phone\_a|string|辅助 POC 电话 A.|64 个字符| |67|poc\_2\_phone\_b|string|辅助 POC 电话 B.|64 个字符| |69|poc\_2\_screen|string|次要 POC 屏幕名称。|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|Tag.|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 个字符|

en-us	##### 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.|
zh-cn	##### 主机底层自动发现规则标签  |元素|元素属性|是否必须|类型|适用范围^**[1](#footnotes)**^|描述| |-------|----------------|--------|----|--------------------------|-----------| |discovery\_rules|<|\-|<|<|低级别自动发现根元素。| |<|*有关大多数图元标标签，请参见常规监控项的图元标签值。下面只描述特定于底层自动发现规则的标签。*|<|<|<|<| |<|type|\-|`string`|0 - ZABBIX\_PASSIVE (默认)<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`|默认: 30d|在该时间段之后，不再发现的监控项将被删除。支持秒，带后缀的时间单位或用户宏。| |filter|<|<|<|<|单个过滤器。| |<|evaltype|\-|`string`|0 - AND\_OR (默认)<br>1 - AND<br>2 - OR<br>3 - FORMULA|用于检查底层自动发现规则筛选器条件的逻辑。| |<|formula|\-|`string`|<|过滤条件的自定义计算公式。| |conditions|<|\-|<|<|过滤条件的根元素。| |<|macro|x|`string`|<|底层自动发现宏名称| |<|value|\-|`string`|<|筛选值：正则表达式或全局正则表达式。| |<|operator|\-|`string`|8 - MATCHES\_REGEX (默认)<br>9 - NOT\_MATCHES\_REGEX|条件操作者。| |<|formulaid|x|`character`|<|用于从自定义表达式引用条件的任意唯一ID。只能包含大写字母。用户在修改过滤条件时必须定义ID，但在之后请求时将重新生成ID。| |lld\_macro\_paths|<|\-|<|<|底层自动发现宏路径根元素。| |<|lld\_macro|x|`string`|<|底层自动发现宏名称| |<|path|x|`string`|<|将分配给相应宏的值的选择器。| |preprocessing|<|\-|<|<|底层自动发现值预处理。| |step|<|\-|<|<|单个底层自动发现规则值预处理步骤。| |<|*有关大多数图元标签值，请参见主体监控值预处理的图元标签值。下面只描述特定于底层自动发现值预处理的标签。*|<|<|<|<| |<|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|<|\-|<|<|触发器原型的根元素。| |<|*有关触发器原型元素标签值，请参见常规 [主机触发器](/manual/xml_export_import/hosts#host_trigger_tags) 标签。*|<|<|<|<| |graph\_prototypes|<|\-|<|<|图形原型的根元素。| |<|*有关图形原型元素标签值，请参见常规 [主机图形](/manual/xml_export_import/hosts#host_graph_tags) 标签。*|<|<|<|<| |host\_prototypes|<|\-|<|<|主机原型的根元素。| |<|*有关主体原型图元标记值，请参见常规[主机](/manual/xml_export_import/hosts#host_tags) 标签。 *|<|<|<|<| |item\_prototypes|<|\-|<|<|监控项原型的根元素。| |<|*有关监控项原型元素标记值，请参见常规 [主机监控项](/manual/xml_export_import/hosts#host_item_tags) 标签。*|<|<|<|<| |master\_item|<|\-|<|<|单个监控项原型主监控项/监控项原型数据。| |<|key|x|`string`|<|依赖监控项原型 主监控项/监控项原型 键值的值.<br><br>依赖项所需。|

en-us	### 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.
zh-cn	### 主机宏  主机宏对象定义一个主机或模板上可用的宏. 它具有以下属性.  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |hostmacroid|string|*(只读)* 主机宏ID.| |**hostid**<br>(必需)|string|宏所属主机的主机ID.| |**macro**<br>(必需)|string|宏名.| |**value**<br>(必需)|string|宏值.| |type|integer|宏的类型.<br><br>可接受的值:<br>0 - *(default)* 文本宏;<br>1 - 密文宏;<br>2 - 密钥宏.| |description|string|宏的描述信息.|  注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。

en-us	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.  ![](../../../../../../../assets/en/manual/web_interface/frontend_sections/monitoring/geomap_widget_filter.png)
zh-cn	地图上的主机标记会显示最严重问题的颜色，如果主机没有问题则为绿色。点击一个主机标记可以查看该主机的可见名称以及按严重程度汇总未解决的问题数量。点击可见名称将打开[主机菜单](/manual/web_interface/frontend_sections/monitoring/dashboard#host_menu)。  地图上显示的主机可以按问题的严重程度进行过滤。按组件右上角的过滤器图标，标记所需的严重程度。  ![](../../../../../../../assets/en/manual/web_interface/frontend_sections/monitoring/geomap_widget_filter.png)

en-us	# host.massadd
zh-cn	# 批量添加

en-us	# host.massremove
zh-cn	# 配置批量删除

en-us	# host.massupdate
zh-cn	# 批量更新

en-us	#### 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.  ![](../../../../../assets/en/manual/web_interface/host_menu.png)  [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)
zh-cn	#### 主机菜单  在*问题*组件中点击主机会显示主机菜单。它包括到主机资产记录、最新数据、问题、图表、 仪表盘、web 场景和配置的链接。请注意主机配置只对管理员和超级管理员用户可用。  ![](../../../../../assets/en/manual/web_interface/host_menu.png)  [全局脚本](/manual/web_interface/frontend_sections/administration/scripts) 也可在主机菜单中运行。这些脚本的作用域需要被定义为'手动主机动作'才能在主机菜单中可用。  主机菜单可在以下前端部件中点击主机来访问：  -   监测 → [问题](problems) -   监测 → [问题](problems) → Event details -   监测 → [主机](hosts) -   监测 → 主机 → [Web 监测](/manual/web_interface/frontend_sections/monitoring/hosts/web) -   监测 → [最新数据](latest_data) -   监测 → [地理图](maps) -   报表 → [触发器 top 100](/manual/web_interface/frontend_sections/reports/triggers_top)

en-us	##### 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.  
zh-cn	#### agent配置  

en-us	##### 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.
zh-cn	##### 命名主机  当添加主机时，主机名是反向DNS解析的结果，如果解析失败，则主机名设置为IP地址。如果Zabbix server执行网络发现，则解析就在Zabbix server上执行，如果Zabbix proxy执行网络发现，则解析在Zabbix proxy上执行。 如果在proxy上解析失败，不会再到Zabbix server上做解析。如果同名主机已经存在，新发现的主机会在名字后面添加 **\_2**后缀，后续新发现的同名主机的后缀数字依次增加。  可以使用监控项的主机名覆盖DNS/IP解析的主机名，比如：  -   可以使用安装在服务器上的Zabbix agent，通过agent的监控项来发现多台主机并自动给这些主机分配合适的主机名，主机名取决于监控项返回的字符串值 -   可以使用SNMP agent监控项发现多台网络设备并自动分配合适的主机名，主机名取决于监控项返回的字符串值  如果已经使用了监控项的返回值作为主机名，则接下来的网络发现不会更新主机名。如果不使用监控项的返回值作为主机名，则使用默认值(DNS名称)。  如果新发现的主机IP地址已经存在，那么不会创建该主机。然而如果发现动作中包含添加模板、添加到主机组等操作，则会在现有的主机上执行相应操作。

en-us	# > Host object  The following objects are directly related to the host API.
zh-cn	 # > 主机对象  以下对象直接与主机API相关。

en-us	# hostprototype.create
zh-cn	# 创建

en-us	# hostprototype.delete
zh-cn	# 删除

en-us	# hostprototype.get  
zh-cn	# 查询

en-us	# > Host prototype object  The following objects are directly related to the `hostprototype` API.
zh-cn	# > 主机原型对象  以下对象与`主机原型` API直接相关。

en-us	#### Host prototypes  Host prototypes can be created with the low-level discovery rule. When virtual machines are discovered, these prototypes become real hosts. Prototypes, before becoming discovered, cannot have their own items and triggers, other than those from the linked templates. Discovered hosts will belong to an existing host.  ![](../../assets/en/manual/vm_monitoring/vm_host_prototypes.png)  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 ![add\_link.png](../../assets/en/manual/config/add_link.png) 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  :::  ![](../../assets/en/manual/vm_monitoring/vm_host_prototypes_if2.png)  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. Discovered hosts cannot have host prototypes of their own.
zh-cn	#### 主机原型  可以使用低级别发现规则创建主机原型。当发现虚拟机时，这些原型就变成了真正的主机。原型在被发现之前不能有自己的监控项和触发器，除了来自所链接的模板的那些。发现的主机将属于 existing 主机。  ![](../../assets/en/manual/vm_monitoring/vm_host_prototypes.png)  为了使从主机原型创建的主机具有唯一的主机名， *主机名（Host name）* 字段必须包含至少一个 [低级别发现宏](/manual/config/macros/lld_macros)。  从 Zabbix 5.2 开始，发现的主机可以配置自定义接口或继承发现规则所属主机的 IP（默认）。要添加一个或多个自定义接口，请将 *接口（Interface）* 选择器从 *继承（Inherit）* 模式切换到 *自定义（Custom）* 模式，然后按下![add\_link.png](../../assets/en/manual/config/add_link.png) 并从出现的下拉菜单中选择所需的接口类型。可以为主机原型定义所有支持的接口类型：Zabbix agent、SNMP、JMX、IPMI。接口字段支持低级别发现宏和 [用户宏](/manual/config/macros/user_macros)。如果指定了多个自定义接口 - 使用 *默认（Default）* 列指定主接口。  注意：  -   如果选择 *自定义* 但未指定接口，则将创建没有接口的主机。 -   如果为属于模板的主机原型选择了 *继承* ，则发现的主机将继承模板链接到的主机的接口。  ::: notewarning  如果主机接口包含不正确的数据，则不会创建主机。 :::  ![](../../assets/en/manual/vm_monitoring/vm_host_prototypes_if2.png)  LLD 宏还可用于可见名称、主机组原型字段、标签值或主机原型用户宏的值。  可以为主机原型指定的其他选项包括：  -   与现有主机组的链接 -   模板链接 -   加密  如果选中 *Create enabled* ，则添加的主机将处于启用状态。如果未选中，仍会添加主机，但处于禁用状态。  如果选中 *Discover* （默认），则将创建主机。如果未选中，则不会创建主机，除非在 [发现规则](/manual/discovery/low_level_discovery#override) 中覆盖此设置。此功能在创建发现规则时提供了额外的灵活性。  发现的主机在主机列表中以创建它们的发现规则的名称为前缀。发现的主机可以手动删除，也可以根据 *发现规则的保留丢失资源的天数（Keep lost resources period (in days)）* 被自动删除。大多数配置选项都是只读的，除了启用/禁用主机和主机清单。发现的主机不能拥有自己的主机原型。

en-us	### 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.|
zh-cn	### 主机原型标签  主机原型标签对象有以下属性：  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |**tag**<br>(必选)|字符串|主机原型标签名称。| |value|字符串|主机原型标签值。|

en-us	### 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.|
zh-cn	### 主机原型标签  主机原型标签对象有以下属性：  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |**tag**<br>(必选)|字符串|主机原型标签名称。| |value|字符串|主机原型标签值。|

en-us	### 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.<br><br>For update operations this field is *readonly*.|  Note that for some methods (update, delete) the required/optional parameter combination is different.
zh-cn	### 主机原型  主机原型对象有以下属性:  |属性|[对象](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |hostid|字符串|*(只读)*主机原型ID。| |**host**<br>(必选)|字符串|主机原型技术名称| |name|字符串|主机原型可见名称。<br><br>默认: `host` 属性值。| |status|整型|主机原型状态。<br><br>可能值有:<br>0 - *(默认)* 被监控的主机;<br>1 - 没被监控的主机。| |inventory\_mode|整型|主机资产填写模式。<br><br>可能值是:<br>-1 - *(默认)* 关闭;<br>0 - 手动;<br>1 - 自动。| |templateid|字符串|*(只读)* 主机原型父模板ID。| |discover|整型|主机原型发现状态。<br><br>可能的值:<br>0 - *(默认)* 新主机将被发现;<br>1 - 新主机不会被发现并且存在的主机将被标记为丢失。| |custom\_interfaces|整型|通过主机原型创建的主机接口<br><br>可能的值:<br>0 - *(默认)* 从父主机继承接口;<br>1 -使用主机原型定制接口。| |uuid|字符串|通用的唯一标识符，用于向现有主机导入主机原型，仅用于模板上的主机原型，如果没有指定将自动生成。<br><br>对于更新操作，此字段是*只读*。| 注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。

en-us	# Host prototype  This class is designed to work with host prototypes.  Object references:\  -   [Host     prototype](/manual/api/reference/hostprototype/object#host_prototype) -   [Host prototype     inventory](/manual/api/reference/hostprototype/object#host_prototype_inventory) -   [Group link](/manual/api/reference/hostprototype/object#group_link) -   [Group     prototype](/manual/api/reference/hostprototype/object#group_prototype)  Available methods:\  -   [hostprototype.create](/manual/api/reference/hostprototype/create) -     creating new host prototypes -   [hostprototype.delete](/manual/api/reference/hostprototype/delete) -     deleting host prototypes -   [hostprototype.get](/manual/api/reference/hostprototype/get) -     retrieving host prototypes -   [hostprototype.update](/manual/api/reference/hostprototype/update) -     updating host prototypes
zh-cn	# 主机原型  该类被设计用来处理主机原型。  对象引用:\  -   [Host     prototype](/manual/api/reference/hostprototype/object#host_prototype) -   [Host prototype     inventory](/manual/api/reference/hostprototype/object#host_prototype_inventory) -   [Group link](/manual/api/reference/hostprototype/object#group_link) -   [Group     prototype](/manual/api/reference/hostprototype/object#group_prototype)  可用方法:\  -   [hostprototype.create](/manual/api/reference/hostprototype/create) -     创建新的主机原型 -   [hostprototype.delete](/manual/api/reference/hostprototype/delete) -     删除主机原型 -   [hostprototype.get](/manual/api/reference/hostprototype/get) -     获取主机原型 -   [hostprototype.update](/manual/api/reference/hostprototype/update) -     更新主机原型

en-us	# hostprototype.update
zh-cn	# 更新

en-us	##### 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.
zh-cn	##### 删除主机   如果发现的主机不再属于发现规则定义的IP地址范围内，则该主机自动从 *监控* → *网络发现*  中删除。主机会立刻被删除。

en-us	#### 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)
zh-cn	#### 主机和主机组  管理主机组，主机及其相关的一切，包括主机接口，主机宏和维护期。  [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)

en-us	#### 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|
zh-cn	#### 主机/主机原型  在 [主机](/manual/config/hosts/host) 和 [主机原型](/manual/vm_monitoring#host_prototypes) 配置中，用户宏可用于以下地方:  |位置|<|多个宏/混合文本^[1](supported_by_location_user#footnotes)^| |--------|-|------------------------------------------------------------------------| |接口IP/DNS|<|仅支持DNS| |接口端口|<|不支持| |*SNMP v1, v2*|<|<| | |SNMP团体名|支持| |*SNMP v3*|<|<| | |上下文名称|支持| |^|安全名称|支持| |^|身份验证密码|支持| |^|隐私密码|支持| |*IPMI*|<|<| | |用户名|支持| |^|密码|支持| |*标签*^[2](supported_by_location_user#footnotes)^|<|<| | |标签名称|支持| |^|标签值|支持|

en-us	#### 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|  
zh-cn	#### 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).  

en-us	##### 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.|
zh-cn	##### 主机标签  |元素|元素属性|是否必须|类型|适用范围^**[1](#footnotes)**^|描述| |-------|----------------|--------|----|--------------------------|-----------| |groups|<|x|<|<|主机群组根元素。| |<|name|x|`string`|<|主机群组名称。| |hosts|<|\-|<|<|主机的根元素。| |<|host|x|`string`|<|唯一的主机名。| |<|name|\-|`string`|<|可见的主机名| |<|description|\-|`text`|<|主机描述。| |<|status|\-|`string`|0 - 启用(默认)<br>1 - 禁用|主机状态。| |<|ipmi\_authtype|\-|`string`|-1 - 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 (默认)<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 (默认)|这是否是主主机接口<br>主机上只能有一种类型的主接口。| |<|type|\-|`string`|1 - ZABBIX (默认)<br>2 - SNMP<br>3 - IPMI<br>4 - JMX|接口类型| |<|useip|\-|`string`|0 - NO<br>1 - YES (默认)|是否使用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 (默认)<br>3 - SNMP\_V3|使用此SNMP版本。| |<|community|\-|`string`|<|SNMP 团体子.<br><br>SNMPv1和SNMPv2监控项需要。| |<|contextname|\-|`string`|<|SNMPv3 上下文名称.<br><br>仅由SNMPv3监控项使用。| |<|securityname|\-|`string`|<|SNMPv3 安全名称.<br><br>仅由SNMPv3监控项使用。| |<|securitylevel|\-|`string`|0 - NOAUTHNOPRIV (默认)<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 (默认)|对SNMP使用批量请求。| |items|<|\-|<|<|监控项根元素| |<|*对监控项元素标签值, 查看 [监控项](/manual/xml_export_import/hosts#host_item_tags) 标签.*|<|<|<|<| |tags|<|\-|<|<|主机标签的根元素。| |<|tag|x|`string`|<|标签名称。| |<|value|\-|`string`|<|标签值。| |macros|<|\-|<|<|宏的根元素。| |<|macro|x|<|<|用户宏名称。| |<|type|\-|`string`|0 - TEXT (默认)<br>1 - SECRET\_TEXT<br>2 - VAULT|宏类型。| |<|value|\-|`string`|<|用户宏值。| |<|description|\-|`string`|<|用户宏描述。| |inventory|<|\-|<|<|主机资产的根元素。| |<|<inventory\_property>|\-|<|<|单独的资产属性。<br><br>所有可用的资产的属性都列在各自的标签下, e.g. <type>, <name>, <os> (看到上面的例子)。| |inventory\_mode|<|\-|`string`|-1 - DISABLED<br>0 - MANUAL (默认)<br>1 - AUTOMATIC|资产模式。| |valuemaps|<|\-|<|<|值映射的根元素。| |<|name|x|`string`|<|值映射的名称| |<|mapping|\-|<|<|映射的根元素。| |<|value|x|`string`|<|映射的值。| |<|newvalue|x|`string`|<|映射的新值。|

en-us	### 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.|
zh-cn	### Host 标记  主机标记对象具有以下属性。  |属性|[类](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |**tag**<br>(required)|string|主机标记名称。| |value|string|主机标记的值。|

en-us	### 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.|
zh-cn	### Host 标记  主机标记对象具有以下属性。  |属性|[类](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |**tag**<br>(required)|string|主机标记名称。| |value|string|主机标记的值。|

en-us	### 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.| |tls\_issuer|string|Certificate issuer.| |tls\_subject|string|Certificate subject.| |tls\_psk\_identity|string|*(write-only)* PSK identity. Required if either `tls_connect` or `tls_accept` has PSK enabled.<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.| |tls\_psk|string|*(write-only)* The preshared key, 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.
zh-cn	### 主机  主机对象具有以下属性。  |Property|[Type](/manual/api/reference_commentary#data_types)|Description| |--------|---------------------------------------------------|-----------| |hostid|字符|*(只读)* 主机的ID。| |**host**<br>(必须)|字符|主机的正式名称。| |description|文本|主机的描述信息。| |flags|整数|*(只读)* 主机的来源。<br><br>取值范围:<br>0—普通主机;<br>4—自动发现的主机。| |inventory\_mode|整数|主机资产模式。<br><br>取值范围为:<br>-1 - *(默认)* 禁用的;<br>0 - 手动的;<br>1 - 自动的。| |ipmi\_authtype|整数|IPMI 验证算法。<br><br>可能的值:<br>-1 - *(默认)* default;<br>0 - none;<br>1 - MD2;<br>2 - MD5<br>4 - straight;<br>5 - OEM;<br>6 - RMCP+.| |ipmi\_password|字符|IPMI 密码。| |ipmi\_privilege|整数|IPMI 权限等级。<br><br>可能的值:<br>1 - callback;<br>2 - *(默认)* user;<br>3 - operator;<br>4 - admin;<br>5 - OEM.| |ipmi\_username|字符|IPMI 用户名。| |maintenance\_from|时间戳|*(只读)* 有效维护启动时间。| |maintenance\_status|整数|*(只读)* 有效的维护状态。<br><br>取值包括:<br>0 - *(默认)*不维护;<br>1 -有效维护。| |maintenance\_type|整数|*(只读)* 有效的维护类型。<br><br>可能的值是:<br>0 - *(默认)* 数据收集维护;<br>1 - 数据不收集维护。| |maintenanceid|字符|*(只读)* 主机上当前生效的维护ID。| |name|字符|可见的主机名。<br><br>默认: `host` 属性值。| |proxy\_hostid|字符|用于监控主机的Proxy ID。| |status|整数|主机的状态和功能。<br><br>可能的值是:<br>0 - *(默认)* 开启监控的主机;<br>1 - 没有开启监控的主机。| |tls\_connect|整数|链接到主机。<br><br>可能的值是:<br>1 - *(默认)* 没有加密;<br>2 - PSK;<br>4 - 已加密。| |tls\_accept|整数|连接主机。<br><br>可能的位图值如下::<br>1 - *(默认)* 未加密;<br>2 - PSK;<br>4 - 已认证.| |tls\_issuer|字符|证书问题。| |tls\_subject|字符|证书发行者。| |tls\_psk\_identity|字符|*(只写)* PSK 认证。 如果启用了 `tls_connect` 或 `tls_accept` ，则需要。<br>不要将敏感信息放入PSK标识中，该信息通过网络明文传输，以告知接收端使用哪个PSK。| |tls\_psk|字符|*(只写)* 预共享密钥，至少32位十六进制数字。如果启用了 `tls_connect` 或 `tls_accept` ，则需要。| 注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。

en-us	# Host  This class is designed to work with hosts.  Object references:\  -   [Host](/manual/api/reference/host/object#host) -   [Host inventory](/manual/api/reference/host/object#host_inventory)  Available methods:\  -   [host.create](/manual/api/reference/host/create) - creating new     hosts -   [host.delete](/manual/api/reference/host/delete) - deleting hosts -   [host.get](/manual/api/reference/host/get) - retrieving hosts -   [host.massadd](/manual/api/reference/host/massadd) - adding related     objects to hosts -   [host.massremove](/manual/api/reference/host/massremove) - removing     related objects from hosts -   [host.massupdate](/manual/api/reference/host/massupdate) - replacing     or removing related objects from hosts -   [host.update](/manual/api/reference/host/update) - updating hosts
zh-cn	# 主机  这个类是设计用于处理主机。  对象引用:  -   [Host](/manual/api/reference/host/object#host) -   [Host inventory](/manual/api/reference/host/object#host_inventory)  相关方法:  -   [host.create](/manual/api/reference/host/create) - 创建新的主机 -   [host.delete](/manual/api/reference/host/delete) - 删除主机 -   [host.get](/manual/api/reference/host/get) - 获取主机信息 -   [host.massadd](/manual/api/reference/host/massadd) - 主机配置批量添加 -   [host.massremove](/manual/api/reference/host/massremove) - 主机配置批量删除 -   [host.massupdate](/manual/api/reference/host/massupdate) - 主机配置批量更新 -   [host.update](/manual/api/reference/host/update) - 更新主机

en-us	# host.update
zh-cn	# 更新

en-us	#### - Housekeeper  The housekeeper is a periodical process, executed by Zabbix server. The process removes outdated information and information deleted by user.  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/general_housekeeper1.png)  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.  
zh-cn	##### -图片  图像部分显示Zabbix中可用的所有图像。 图像存储在数据库中。  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/general_images.png){width="600"}  *类型* 下拉菜单允许您在图标和背景图像之间切换：  -   标用于显示[网络图](/manual/config/visualization/maps/map) 元素 -   背景用作网络图的背景图像  **添加图像**  您可以通过点击右上角*创建图标*或者*创建背景*按钮添加自己的图像。  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/general_img_upload.png)  图像属性：  |参数     描|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) 参数。 :::  

en-us	#### - Housekeeper  The housekeeper is a periodical process, executed by Zabbix server. The process removes outdated information and information deleted by user.  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/general_housekeeper1.png)  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.
zh-cn	#### - 管家服务  管家是一个​​周期性的进程，由 Zabbix 服务器执行。该过程删除过时的信息和用户删除的信息。  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/general_housekeeper1.png)  在本节中，可以针对每个任务分别启用或禁用内务管理任务：事件和警报/IT 服务/用户会话/历史记录/趋势。审核内务管理设置在单独的 [菜单部分](/manual/web_interface/frontend_sections/administration/general#audit_log) 中可用。  如果启用了管家，则可以设置数据记录在被管家删除之前将保留多少天。  删除项目/触发器也会删除该项目/触发器产生的问题。  此外，只有在与问题没有任何关联的情况下，管家才会删除事件。这意味着如果一个事件是问题或恢复事件，在相关问题记录被删除之前不会被删除。管家会先删除问题，后删除事件，以避免过时的事件或潜在的问题 问题记录。  对于历史和趋势，有一个附加选项可用：*覆盖项目历史周期*和*覆盖项目趋势周期*。此选项允许全局设置项目历史/趋势将保留多少天（1 小时至 25 年；或“0”），在这种情况下覆盖为*历史存储期/趋势存储期*中的单个项目设置的值[项目配置](/manual/config/items/item)中的字段。请注意，对于具有配置选项*不保留历史记录*和/或*不保留趋势*启用的项目，存储期不会被覆盖。  即使禁用内部管理，也可以覆盖历史/趋势存储期。因此，当使用外部管家时，可以使用历史*数据存储周期*字段设置历史存储周期。  ::: noteimportant 如果使用 TimescaleDB，为了充分利用 TimescaleDB 对历史和趋势表的自动分区，*覆盖项目历史周期*和*覆盖项目趋势周期*选项必须启用以及*启用内部管理*选项历史和趋势。否则，保存在这些表中的数据仍将存储在分区中，但是，管家将通过删除单个记录而不是删除过时的分区来清理历史记录和趋势。当启用删除过期分区时，Zabbix 服务器和前端将不再跟踪已删除的项目，并且在删除过期分区时将清除已删除项目的历史记录。 :::  句号字段支持[时间后缀](/manual/appendix/suffixes)，例如1d（一天），1w（一周）。最短为 1 天（历史为 1 小时），最长为 25 年。 *重置默认值*按钮允许恢复所做的任何更改。

en-us	#### housekeeping  Changes:\ [ZBXNEXT-6755](https://support.zabbix.com/browse/ZBXNEXT-6755) added support of property `hk_events_service`.\
zh-cn	 #### 管家  变更：\ [ZBXNEXT-6755](https://support.zabbix.com/browse/ZBXNEXT-6755) 添加对属性`hk_events_service`的支持。\

en-us	#### housekeeping  Changes:\ [ZBXNEXT-6755](https://support.zabbix.com/browse/ZBXNEXT-6755) added support of property `hk_events_service`.\
zh-cn	 #### 管家  变更：\ [ZBXNEXT-6755](https://support.zabbix.com/browse/ZBXNEXT-6755) 添加对属性`hk_events_service`的支持。\

en-us	# housekeeping.get  
zh-cn	# 查询

en-us	# > Housekeeping object  The following objects are directly related to the `housekeeping` API.
zh-cn	# > 管家对象  以下对象与 `housekeeping` API直接相关。

en-us	### 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.|
zh-cn	### 管家  设置对象具有以下属性：  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |hk\_events\_mode|整型|为事件和警报开启内部管家<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_events\_trigger|字符串|触发器数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 365d.| |hk\_events\_service|字符串|服务数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 1d.| |hk\_events\_internal|字符串|内部数据存储期限， 接受带后缀的秒和时间单位。<br><br>默认: 1d.| |hk\_events\_discovery|字符串|网络发现数据存储期限，接受带后缀的秒和时间单位。<br><br>默认1d.| |hk\_events\_autoreg|字符串|自动注册数据存储期限， 接受带后缀的秒和时间单位。<br><br>默认: 1d.| |hk\_services\_mode|整型|为服务启用内部管理<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_services|字符串|服务数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 365d.| |hk\_audit\_mode|整型|开启内部管理用于审计<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_audit|字符串|审计数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 365d.| |hk\_sessions\_mode|整型|为会话启用内部管理。<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_sessions|字符串|会话数据存储期限。接受带后缀的秒和时间单位。<br><br>默认: 365d。| |hk\_history\_mode|整型|为历史数据启用内部管理<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_history\_global|整型|覆盖监控项的历史数据期限<br><br>可能的值:<br>0 - 不要覆盖;<br>1 - *(默认)* 覆盖。| |hk\_history|字符串|历史数据存储期限。接受带后缀的秒和时间单位。<br><br>默认: 90d.| |hk\_trends\_mode|整型|为趋势数据开启内部管理。<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_trends\_global|整型|覆盖监控项的趋势数据期限<br><br>可能的值:<br>0 - 不要覆盖;<br>1 - *(默认)* 覆盖。| |hk\_trends|字符串|趋势数据存储期限。接受带后缀的秒和时间单位。<br><br>默认: 365d.| |db\_extension|字符串|*(只读)* 配置DB扩展标志，如果此标志设置为"timescaledb"，则服务器会更改器行为以进行内务处理和项目删除。| |compression\_status|整型|为历史和趋势数据开启TimescaleDB压缩。<br><br>可能的值:<br>0 - *(默认)* 关;<br>1 - 开。| |compress\_older|字符串|压缩早于指定时间段的历史和趋势记录，接受带后缀的秒和时间单位。<br><br>默认: 7d.| |compression\_availability|整型|*(只读)* 压缩可用性。<br><br>可能的值:<br>0 - 不可用;<br>1 - 可用。|

en-us	### 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.|  
zh-cn	### 管家  设置对象具有以下属性：  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |--------|---------------------------------------------------|-----------| |hk\_events\_mode|整型|为事件和警报开启内部管家<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_events\_trigger|字符串|触发器数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 365d.| |hk\_events\_service|字符串|服务数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 1d.| |hk\_events\_internal|字符串|内部数据存储期限， 接受带后缀的秒和时间单位。<br><br>默认: 1d.| |hk\_events\_discovery|字符串|网络发现数据存储期限，接受带后缀的秒和时间单位。<br><br>默认1d.| |hk\_events\_autoreg|字符串|自动注册数据存储期限， 接受带后缀的秒和时间单位。<br><br>默认: 1d.| |hk\_services\_mode|整型|为服务启用内部管理<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_services|字符串|服务数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 365d.| |hk\_audit\_mode|整型|开启内部管理用于审计<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_audit|字符串|审计数据存储期限，接受带后缀的秒和时间单位。<br><br>默认: 365d.| |hk\_sessions\_mode|整型|为会话启用内部管理。<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_sessions|字符串|会话数据存储期限。接受带后缀的秒和时间单位。<br><br>默认: 365d。| |hk\_history\_mode|整型|为历史数据启用内部管理<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_history\_global|整型|覆盖监控项的历史数据期限<br><br>可能的值:<br>0 - 不要覆盖;<br>1 - *(默认)* 覆盖。| |hk\_history|字符串|历史数据存储期限。接受带后缀的秒和时间单位。<br><br>默认: 90d.| |hk\_trends\_mode|整型|为趋势数据开启内部管理。<br><br>可能的值:<br>0 - 禁用;<br>1 - *(默认)* 开启。| |hk\_trends\_global|整型|覆盖监控项的趋势数据期限<br><br>可能的值:<br>0 - 不要覆盖;<br>1 - *(默认)* 覆盖。| |hk\_trends|字符串|趋势数据存储期限。接受带后缀的秒和时间单位。<br><br>默认: 365d.| |db\_extension|字符串|*(只读)* 配置DB扩展标志，如果此标志设置为"timescaledb"，则服务器会更改器行为以进行内务处理和项目删除。| |compression\_status|整型|为历史和趋势数据开启TimescaleDB压缩。<br><br>可能的值:<br>0 - *(默认)* 关;<br>1 - 开。| |compress\_older|字符串|压缩早于指定时间段的历史和趋势记录，接受带后缀的秒和时间单位。<br><br>默认: 7d.| |compression\_availability|整型|*(只读)* 压缩可用性。<br><br>可能的值:<br>0 - 不可用;<br>1 - 可用。|

en-us	# Housekeeping  This class is designed to work with housekeeping.  Object references:\  -   [Housekeeping](/manual/api/reference/housekeeping/object#housekeeping)  Available methods:\  -   [housekeeping.get](/manual/api/reference/housekeeping/get) -     retrieve housekeeping -   [housekeeping.update](/manual/api/reference/housekeeping/update) -     update housekeeping
zh-cn	# 管家  该类被设计用于和管家一起工作。  对象参考:\  -   [Housekeeping](/manual/api/reference/housekeeping/object#housekeeping)  可用的方法:\  -   [housekeeping.get](/manual/api/reference/housekeeping/get) -     获取管家 -   [housekeeping.update](/manual/api/reference/housekeeping/update) -     更新管家

en-us	# housekeeping.update
zh-cn	# 更新

en-us	#### 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.
zh-cn	#### 工作原理  在日志监控中，可能会遇到下面类似地输出：      Line1: 应用1停止      Line2: 应用2停止      Line3: 应用1重启      Line4: 应用2重启  事件关联地想法是将从“Line1”的问题事件到“Line3”的恢复事件，从“Line2”的问题事件到“Line4”的恢复事件相匹配，并能逐个关闭这些问题：      Line1: 应用1停止      Line3: 应用1重启  #问题来自于Line1关闭      Line2: 应用2停止      Line4: 应用2重启  #问题来自于Line2关闭  为此，需要通过标签将这些事件相关联，例如，可以标识为“应用1”和“应用2”。这个过程也可以将正则表达式应用于日志中来提取标签的值。然后，当事件创建时，他们分别给标识为“应用1”和“应用2”，并且问题可以与解决方法相匹配。

en-us	#### How to  To begin with, you need to create a PHP file and save it as `local/conf/brand.conf.php`. The contents of the file should be the following:  ``` {.php} <?php  return []; ```  This will hide the links to Zabbix Support and Zabbix Integrations.
zh-cn	#### 方法  首先，您需要创建一个 PHP 文件并将其保存为 `local/conf/brand.conf.php`。 该文件的内容应如下所示：  ``` {.php} <?php  return []; ```  这将隐藏 Zabbix Support 和 Zabbix Integrations 的链接。

en-us	#### HP OpenView  Zabbix can be configured to send messages to OpenView server. The following steps must be performed:
zh-cn	#### 惠普 OpenView  Zabbix 可以配置向 OpenView 服务器发送消息。必须执行以下步骤：

en-us	### 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. :::  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/auth_http.png)  Configuration parameters:  |Parameter|Description| |---------|-----------| |*Enable HTTP authentication*|Mark the checkbox to enable HTTP authentication.| |*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 (enabled by default) for usernames.<br>E.g. disable case-sensitive login and log in with, for example, 'ADMIN' user even if the Zabbix user is 'Admin'.<br>*Note* that with case-sensitive login disabled the login will be denied if multiple users exist in Zabbix database with similar usernames (e.g. Admin, admin).|  ::: noteclassic In 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! :::  ::: 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. :::
zh-cn	### HTTP 认证  基于 HTTP 或 Web 服务器的身份验证（例如：Basic Authentication、NTLM/Kerberos）可用于检查用户名和密码。 请注意，用户也必须存在于 Zabbix 中，但是它的不会使用 Zabbix 密码。  ::: noteimportant 当心！ 确保网络服务器身份验证在切换之前已配置且正常工作。 :::  配置参数：  |参数|说明| |---------|------------| |*启用 HTTP 身份验证*|选中复选框以启用 HTTP 身份验证。| |*默认登录表单*|指定是否将未经身份验证的用户定向到：<br>**Zabbix 登录表单** - 标准 Zabbix 登录页面。<br>**HTTP 登录表单** - HTTP 登录页面。<br >建议仅对 `index_http.php` 页面启用基于 Web 服务器的身份验证。如果 *Default login form* 设置为“HTTP login page”，如果 Web 服务器身份验证模块将在 `$_SERVER` 变量中设置有效的用户登录名，则用户将自动登录。<br>支持的 `$_SERVER` 键是 ` PHP_AUTH_USER`，`REMOTE_USER`，`AUTH_USER`。| |*删除域名*|应从用户名中删除的以逗号分隔的域名列表。<br>例如`comp,any` - 如果用户名是 'Admin\@any', 'comp\\Admin'，用户将作为 'Admin' 登录；如果用户名是'notacompany\\Admin'，登录将被拒绝。| |*区分大小写的登录*|取消选中该复选框以禁用用户名的区分大小写登录（默认启用）。<br>例如禁用区分大小写的登录并使用例如“ADMIN”用户登录，即使 Zabbix 用户是“Admin”。<br>*注意*禁用区分大小写登录的情况下，如果在 Zabbix 数据库存在多个用户，登录将被拒绝（例如 Admin、admin）。|  ::: noteclassic 在 Web 服务器身份验证的情况下，所有用户（即使 [前端访问](/manual/config/users_and_usergroups/usergroup#configuration) 设置 到 LDAP/内部）将由 Web 服务器进行身份验证，而不是由Zabbix！ :::  ::: notetip 对于无法使用 HTTP 登录的内部用户导致 401 的凭据（默认设置为 HTTP 登录表单）错误，您可能需要添加一个 `ErrorDocument 401 /index.php?form=default`行到基本身份验证指令，将重定向到常规的 Zabbix 登录表单。 :::

en-us	### 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.|
zh-cn	 ### HTTP字段  HTTP字段定义了名称和值，用于指定查询字段数据中的变量，HTTP请求头，POST表单字段数据。具有如下属性。  |属性|[类型](/manual/api/reference_commentary#数据类型)|描述| |--------|---------------------------------------------------|-----------| |**name**<br>(必填)|string|请求头/变量/POST或GET字段的名称。| |**value**<br>(必填)|string|请求头/变量/POST或GET字段的值。|

en-us	### 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.|
zh-cn	 ### HTTP字段  HTTP字段定义了名称和值，用于指定查询字段数据中的变量，HTTP请求头，POST表单字段数据。具有如下属性。  |属性|[类型](/manual/api/reference_commentary#数据类型)|描述| |--------|---------------------------------------------------|-----------| |**name**<br>(必填)|string|请求头/变量/POST或GET字段的名称。| |**value**<br>(必填)|string|请求头/变量/POST或GET字段的值。|

en-us	#### HttpRequest  This object encapsulates cURL handle allowing to make simple HTTP requests. Errors are thrown as exceptions.  ::: noteimportant HttpRequest is a new name for this object since Zabbix 5.4. Previously it used to be 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. :::  |Method|Description| |--|--------| |`addHeader(name, value)`|Adds HTTP header field. This field is used for all following requests until cleared with the clearHeader() method.| |`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:  ``` {.java} 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://tsupport.zabbix.lan/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); ```
zh-cn	#### HttpRequest   该对象封装了 cURL 句柄，允许发送简单的 HTTP请求。 错误将作为异常抛出。  ::: noteimportant HttpRequest是自 Zabbix 5.4 以来此对象的新名称。 以前它曾经被命名为 CurlHttpRequest。 Zabbix 5.4 中的方法名称也已更改。 旧的对象/方法名称现在已弃用，并且在 Zabbix 6.0 之后将停止对它们的支持。 :::  |方法|描述| |------|-----------| |`addHeader(name, value)`|添加 HTTP 标头字段。此字段用于所有后续请求，直到使用 clearHeader() 方法清除。| |`clearHeader()`|清除 HTTP 标头。如果没有设置头字段，HttpRequest 会将 Content-Type 设置为 application/json 如果发布的数据是 JSON 格式的；否则文本/纯文本。| |`connect(url)`|向 URL 发送 HTTP CONNECT 请求并返回响应。| |`customRequest(method, url, data)`|允许在第一个参数中指定任何 HTTP 方法。 | 将方法请求发送到带有可选 *data* 负载的 URL 并返回响应。| |`delete(url, data)`|使用可选的 *data* 负载向 URL 发送 HTTP DELETE 请求并返回响应。| |`getHeaders(<asArray>)`|返回接收到的 HTTP 标头字段的对象。<br>`asArray` 参数可以设置为“true”（例如 `getHeaders(true)`）、“false”或未定义。 如果设置为“true”，接收到的 HTTP 标头字段值将作为数组返回； 这应该用于检索多个同名标头的字段值。<br>如果未设置或设置为“false”，则接收到的 HTTP 标头字段值将作为字符串返回。| |`get(url, data)`|发送 HTTP GET 请求到带有可选 *data* 负载的 URL 并返回响应。| |`head(url)`|向 URL 发送 HTTP HEAD 请求并返回响应。| |`options(url)`|向 URL 发送 HTTP OPTIONS 请求并返回响应。| |`patch(url, data)`|将 HTTP PATCH 请求发送到带有可选 *data* 负载的 URL 并返回响应。| |`put(url, data)`|将 HTTP PUT 请求发送到带有可选 *data* 负载的 URL 并返回响应。| |`post(url, data)`|发送 HTTP POST 请求到带有可选 *data* 负载的 URL 并返回响应。| |`getStatus()`|返回最后一个 HTTP 请求的状态码。| |`setProxy(proxy)`|将 HTTP 代理设置为“代理”值。如果此参数为空，则不使用代理。| |`setHttpAuth(bitmask, username, password)`|在'bitmask'参数中设置启用的 HTTP 身份验证方法 (HTTPAUTH\_BASIC, HTTPAUTH\_DIGEST, HTTPAUTH\_NEGOTIATE, HTTPAUTH\_NTLM, HTTPAUTH\_NONE) <br>HTTPAUTH \_NONE 标志允许禁用 HTTP 身份验证。<br>示例：<br>`request.setHttpAuth(HTTPAUTH_NTLM \| HTTPAUTH_BASIC, username, password)`<br>`request.setHttpAuth(HTTPAUTH_NONE)`| |`trace(url, data)`|发送 HTTP TRACE 请求到带有可选 *data* 负载的 URL 并返回响应。|  示例:  ``` {.java} 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://tsupport.zabbix.lan/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); ```

en-us	#### 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.
zh-cn	#### 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)  了解更多信息和解决方案。

en-us	# 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.|  
zh-cn	# 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.|  

en-us	# 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/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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*.| |[CockroachDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/cockroachdb_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$COCKROACHDB.API.PORT}** - the port of CockroachDB API and Prometheus endpoint. (default: 8080).<br>**{$COCKROACHDB.API.SCHEME}** - the request scheme. Supported: http (default), https.|Internal node metrics are collected from Prometheus `/_status/vars` endpoint. <br> Node health metrics are collected from `/health` and `/health?ready=1` endpoints. <br><br>The template doesn't require usage of session token. <br><br> Depending on your CockroachDB version and configuration, some metrics may not be collected.| |[DELL PowerEdge R720 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r720_http/README.md?at=refs%2Fheads%2Frelease%2F6.0),<br>[DELL PowerEdge R740 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r740_http/README.md?at=refs%2Fheads%2Frelease%2F6.0),<br>[DELL PowerEdge R820 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r820_http/README.md?at=refs%2Fheads%2Frelease%2F6.0),<br>[DELL PowerEdge R840 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r840_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.| | |[Envoy Proxy by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/envoy_proxy_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$ENVOY.METRICS.PATH}** - the path from where to retrieve metrics in the Prometheus format (default: `/stats/prometheus`).<br>**{$ENVOY.URL}** - Envoy Proxy instance URL (default: http://localhost:9901)|  Depending on your Envoy Proxy instance version and configuration, some metrics may not be collected. | |[Etcd by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/etcd_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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 Consul Cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/consul_http/consul_cluster_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$CONSUL.API.PORT}** - Consul API port, used in node LLD (default: 8500).<br>**{$CONSUL.API.SCHEME}** - Consul API scheme, used in node LLD (default: http).<br>**{$CONSUL.CLUSTER.URL}** - Consul cluster URL (default: http://localhost:8500).<br>**{$CONSUL.TOKEN}** - Consul authorization token (default: <PUT YOUR AUTH TOKEN>).| | |[HashiCorp Consul Node by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/consul_http/consul_node_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$CONSUL.NODE.API.URL}** - Consul instance URL (default: http://localhost:8500).<br>**{$CONSUL.TOKEN}** - Consul authorization token (default: <PUT YOUR AUTH TOKEN>).|Internal service metrics are collected from `/v1/agent/metrics` endpoint.<br><br> Prometheus format must be enabled for export metrics. See Consul [documentation](https://www.consul.io/docs/agent/options#telemetry-prometheus_retention_time) for details.| |[HashiCorp Vault by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vault_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.| |[HPE MSA 2040 Storage by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/hpe_msa2040_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)/[HPE MSA 2060 Storage by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/hpe_msa2060_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$HPE.MSA.API.PORT}** - connection port for API (default: 443) <br> **{$HPE.MSA.API.SCHEME}** - connection scheme for API. Supported: http, https (default)<br> **{$HPE.MSA.API.USERNAME}**, **{$HPE.MSA.API.PASSWORD}** - API credentials (default username: zabbix, password:\`\`). |Create a separate Storage user (for example, *zabbix*) with monitor role and specify username and password in template macros. | |[HPE Primera by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/hpe_primera_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$HPE.PRIMERA.API.PORT}** - connection port for API (default: 443) <br> **{$HPE.PRIMERA.API.SCHEME}** - connection scheme for WSAPI. Supported: http, https (default)<br> **{$HPE.PRIMERA.API.USERNAME}**, **{$HPE.PIMERA.API.PASSWORD}** - WSAPI credentials (default username: zabbix, password:\`\`). |Create a separate Storage user (for example, *zabbix*)  with browse role and enable it for all domains. <br><br> To start WSAPI server, log in to the CLI as a user whose role has the `wsapi_set` right, then run:<br> `startwsapi` <br><br> To check WSAPI state, run:<br> `showwsapi`| |[InfluxDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/influxdb_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.| |[Kubernetes API server by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_api_server_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.API.SERVER.URL}** - instance URL (default: http://localhost:8086/metrics).<br>**{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes Controller manager by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_controller_manager_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.CONTROLLER.SERVER.URL}** - instance URL (default: http://localhost:10252/metrics).<br>**{$KUBE.CONTROLLER.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes kubelet by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_kubelet_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.KUBELET.URL}** - instance URL (default: https://localhost:10250).<br>**{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes nodes by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_nodes_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.API.ENDPOINT}** - Kubernetes API endpoint in the format <scheme>://<host>:<port>/api (default: not set).<br>**{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> To generate a service account token, run: <br> `kubectl get secret zabbix-service-account -n zabbix -o jsonpath={.data.token} | base64 -d` <br><br> See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details.<br><br> The template contains additional macros, which can be used to filter out certain metrics of discovered worker nodes. | |[Kubernetes Scheduler by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_scheduler_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.SCHEDULER.SERVER.URL}** - instance URL (default: http://localhost:10251/metrics).<br>**{$KUBE.SCHEDULER.TOKEN}** - Scheduler API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes cluster state by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_state_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.API.HOST}** - Kubernetes API host (default: not set).<br>**{$KUBE.API.PORT}**- Kubernetes API port (default:6443). <br> **{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal service metrics are collected from the kube-state-metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details.<br><br> The template contains additional macros, which can be used to filter out certain metrics of discovered worker nodes. | |[Microsoft SharePoint by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0) 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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.| |[OpenWeatherMap by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/openweathermap_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$OPENWEATHERMAP.API.ENDPOINT}** - OpenWeatherMap API endpoint (default: api.openweathermap.org/data/2.5/weather?).<br>**{$OPENWEATHERMAP.API.TOKEN}** - OpenWeatherMap API key (default:' ')<br>**{$LOCATION}** - locations for which to retrieve the metrics (default: Riga) |For instructions on getting the API key, see OpenWeatherMap [documentation](https://home.openweathermap.org/api_key). <br><br> **{$LOCATION}** macro supports the following formats: <br> *geo coordinates* - for example, `56.95,24.0833`<br> *location name* - for example, `Chicago`<br> *OpenWeatherMap location ID* - [download the ID list](http://bulk.openweathermap.org/sample/city.list.json.gz)<br>*zip/postal code with a country code* - for example, `94040,us`<br> To specify multiple locations, use the \| delimiter. <br> Example:<br>`43.81821,7.76115|Riga|2643743|94040,us` | |[PHP-FPM by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/php-fpm_agent/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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`| |[Proxmox VE by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$PVE.TOKEN.ID}** - API token that allows stateless access to most parts of the REST API (default: not set). <br> **{$PVE.TOKEN.SECRET}** - secret key (default: not set). <br> **{$PVE.URL.PORT}** - the port the server listens to (default: 8006). |Create a separate user for monitoring, then generate an API token for this user. <br> Grant the following access levels to the token and user: <br>``Check: ["perm","/",["Sys.Audit"]]``<br>``Check: ["perm","/nodes/{node}",["Sys.Audit"]]``<br>``Check: ["perm","/vms/{vmid}",["VM.Audit"]]``  | |[RabbitMQ cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/rabbitmq_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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_ci_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.|
zh-cn	     # HTTP 模板操作  使用[HTTP agent](/manual/config/items/itemtypes/http)方式收集模板指标数据的正确操作步骤:  1\. 在Zabbix 中创建一个主机，指定监控目标的IP地址或DNS名称为主接口。这需要宏{HOST.CONN}在模板项中正确的解析。\ 2. 将模板 [链接](/manual/config/templates/linking#linking_a_template) 到步骤1中创建的主机(如果模板在Zabbix安装中不可用，您可能需要首先导入模板的`.xml`文件 - 参见 [开箱即用的模板](/manual/config/templates_out_of_the_box) 说明).\ 3. 根据需要调整必配宏的值。\ 4. 配置被监视的主机实例，以允许与Zabbix共享数据 - 请参阅 *附加步骤/注释* 列3中的说明。  ::: notetip 此页仅包含正确模板操作所需的最小宏的集和设置步骤。在模板的`Readme.md`文件中（可通过单击模板名称进行访问），可查看模板的详细描述，包括宏、监控项和触发器的完整列表。 :::  |模板|必配宏|附加步骤/注释| |--------|----------------|-------------------------| |[Apache by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/apache_http)|**{\$APACHE.STATUS.HOST}** - - Apache 状态页的主机名或IP地址 (默认: 127.0.0.1).<br>**{\$APACHE.STATUS.PATH}** -URL 路径 (默认: server-status?auto).<br>**{\$APACHE.STATUS.PORT}** - Apache 状态页的端口号 (默认: 80).<br>**{\$APACHE.STATUS.SCHEME}** -请求协议. 支持: http (默认), https.|Apache模块 mod\_status 需要设置 (详情参见Apache [文档](https://httpd.apache.org/docs/current/mod/mod_status.html)).<br>可用性检查, 执行:<br>`httpd -M 2>/dev/null \| grep status_module`<br><br>Apache 配置样例:<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 端口号(默认： 8088).<br>**{\$AMI.SECRET}** - Asterisk Manager的secret(默认: zabbix).<br>**{\$AMI.URL}** - Asterisk Manager 的 API URL 格式<br>`<scheme>://<host>:<port>/<prefix>/rawman`<br>(默认: http://asterisk:8088/asterisk/rawman).<br>**{\$AMI.USERNAME}** - the Asterisk Manager用户名.|1\. 启用 [mini-HTTP Server](https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server).<br><br>2. 添加选项 `webenabled=yes` 到配置文件 *manager.conf*.<br><br>3. 在Asterisk实例中创建 *Asterisk Manager* 用户.| |[ClickHouse by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/clickhouse_http/README.md)|**{\$CLICKHOUSE.PORT}** - ClickHouse HTTP 端点的端口号 (默认： 8123).<br>**{\$CLICKHOUSE.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$CLICKHOUSE.USER}**, **{\$CLICKHOUSE.PASSWORD}** - ClickHouse 登陆凭据 (默认用户名: zabbix, 密码: zabbix\_pass).<br>如果不需要身份验证，请从监控项的HTTP agent类型配置项的请求头中删除.|通过'web'配置文件创建ClickHouse用户，并赋予数据库查询权限(详情参见ClickHouse [文档](https://clickhouse.tech/docs/en/operations/settings/settings-users/)).<br><br>请参阅模板的Readme.md文件，了解zabbix.xml的文件配置.| |[Cloudflare by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/cloudflare_http/README.md)|**{\$CLOUDFLARE.API.TOKEN}** - Cloudflare API token (默认: \`\<change\>\`).<br>**{\$CLOUDFLARE.ZONE\_ID}** - Cloudflare站点Zone ID (默认: \`<change>\`).|在Cloudflare账户下*我的个人资料→ API Tokens*中获取Cloudflare API Tokens.<br>在Cloudflare账户下*账户主页→ 站点*中获取Zone ID.| |[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格式 `<scheme>://<host>:<port>` (默认: \<输入您的URL地址\>)<br>**{\$API.USER}**, **{\$API.PASSWORD}** - Dell iDRAC 登陆凭证 (默认: 不设置).|Dell服务器上的iDRAC接口:<br>1. 启用Redfish API .<br>2. 创建一个用户监控用户，赋予只读权限.| |[Elasticsearch Cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/elasticsearch_http/README.md)|**{\$ELASTICSEARCH.PORT}** - Elasticsearch 主机的端口号 (默认: 9200).<br>**{\$ELASTICSEARCH.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$ELASTICSEARCH.USERNAME}**, **{\$ELASTICSEARCH.PASSWORD}** - 登陆凭证, 仅当用于Elasticsearch身份验证时才需要.|<| |[Etcd by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/etcd_http/README.md)|**{\$ETCD.PORT}**- Etcd API 端点的端口号 (默认: 2379).<br>**{\$ETCD.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$ETCD.USER}**, **{\$ETCD.PASSWORD}** - 登陆凭证, 仅当用于Etcd身份验证时才需要.|端点的接口路径/metrics采集指标; 指定API端点的接口路径，请使用 `--listen-metrics-urls` 参数(详情参见Etcd [文档](https://github.com/etcd-io/website/blob/master/content/docs/v3.4.0/op-guide/configuration.md#--listen-metrics-urls)).<br><br>本地验证Etcd指标采集，执行:<br>`curl -L http://localhost:2379/metrics`<br><br>检查 Etcd 指标可以从 Zabbix proxy 或 Zabbix server 采集，执行:<br>`curl -L http:%%//<etcd_node_adress>:2379/metrics%%`<br><br>每个 Etcd 的节点都需要链接这个模板.| |[GitLab by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/gitlab_http)|**{\$GITLAB.PORT}** - GitLab Web端点的端口号 (默认: 80)<br>**{\$GITLAB.URL}** - GitLab 实例URL (默认: localhost)|该模板只适用与本地 GitLab 实例; 指标采集路径为 `/metrics` .<br><br>需要设置客户IP白名单，才能访问指标(详情参见 [GitLab 文档](https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html)).<br><br>请注意，某些指标可能不适用于特定的GitLab实例版本和配置.| |[Hadoop by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/hadoop_http/README.md)|**{\$HADOOP.NAMENODE.HOST}** - Hadoop NameNode 节点的主机IP 或 FQDN (默认: NameNode).<br>**{\$HADOOP.NAMENODE.PORT}** - Hadoop NameNode 节点的 web-UI 端口号 (默认: 9870).<br>**{\$HADOOP.RESOURCEMANAGER.HOST}** - Hadoop ResourceManager 节点的 IP 地址或 FQDN (默认: ResourceManager).<br>**{\$HADOOP.RESOURCEMANAGER.PORT}** - Hadoop ResourceManager 的 web-UI 端口号 (默认: 8088).|采用HTTP agent和JSONPath预处理方式远程轮询 Hadoop API 来收集指标数据。Zabbix服务器（或代理）完成对ResourceManager、NodeManager、NameNode、DataNodes API的直接请求处理.| |[HAProxy by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/haproxy_http/README.md)|**{\$HAPROXY.STATS.PATH}** - HAProxy 状态页的路径 (默认: stats).<br>**{\$HAPROXY.STATS.PORT}** - HAProxy 状态页主机或容器的端口号 (默认: 8404).<br>**{\$HAPROXY.STATS.SCHEME}** - 请求协议. 支持: http (默认), https.|需设置HAProxy 状态页 (详情参见HAProxy [博客文档](https://www.haproxy.com/blog/exploring-the-haproxy-stats-page/) 或 模板的 Readme.md 配置样例).| |[HashiCorp Vault by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vault_http/README.md)|**{\$VAULT.API.PORT}** - Vault API请求的监听端口(默认: 8200).<br>**{\$VAULT.API.SCHEME}** - Vault API请求的协议. 支持: http (默认), https.<br>**{\$VAULT.HOST}** - Vault主机名 (默认: \<填写您的Vaultu主机名\>).<br>**{\$VAULT.TOKEN}** - Vault 认证令牌 (默认: \<填写您的TOKEN\>).|1\. 配置 Vault API (详情参见 [官方文档](https://www.vaultproject.io/docs/configuration)).<br>2. 创建 Vault 服务的token, 并将其赋值于宏{\$VAULT.TOKEN}.| |[Hikvision camera by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cctv/hikvision/README.md)|**{\$HIKVISION\_ISAPI\_PORT}** - 设备上的 ISAPI 端口 (默认: 80).<br>**{\$USER}**, **{\$PASSWORD}** - camera 登陆凭证 (默认 用户: admin, 密码: 1234).|<| |[InfluxDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/influxdb_http/README.md)|**{\$INFLUXDB.API.TOKEN}** - InfluxDB API 授权token (默认: \`\`).<br>**{\$INFLUXDB.URL}** - InfluxDB 实例 URL 格式`<scheme>://<host>:<port>` (默认: http://localhost:8086).|此模板从本地InfluxDB实例/metrics路径中采集InfluxDB服务指标.<br><br>详情参见 InfluxDB [文档](https://docs.influxdata.com/influxdb/v2.0/security/tokens/).| |[Jenkins by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/jenkins/README.md)|**{\$JENKINS.API.KEY}** - 访问Metrics Servlet的API 秘钥; 采集通用指标时必须配置 (默认: \`\`).<br>**{\$JENKINS.API.TOKEN}** - 用于HTTP BASIC 授权的API token; 监控执行节点和构建过程所需 (默认: \`\`).<br>**{\$JENKINS.URL}** - Jenkins URL 格式 `<scheme>://<host>:<port>`; 监控执行节点和构建过程所需 (默认: \`\`).<br>**{\$JENKINS.USER}** - HTTP BASIC 授权用户; 监控执行节点和构建过程所需 (默认: zabbix).|通过请求 Metrics API 采集指标.<br><br>通用指标: 安装配置 Metrics 插件， 配置参数参考 [官方文档](https://plugins.jenkins.io/metrics/). 发行一个API秘钥用于接入Metrics Servlet，并将其赋值于宏{\$JENKINS.API.KEY}.<br><br>监控执行节点和构建过程所需: 创建一个API token用于Jenkins监控用户，并将其赋值于宏 {\$JENKINS.API.TOKEN}. 详情参见Jenkins [文档](https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/).| |[Kubernetes API server by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_api_server_http/README.md) |**{\$KUBE.API.SERVER.URL}** - 实例URL (默认: http://localhost:8086/metrics).<br>**{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见 Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes Controller manager by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_controller_manager_http/README.md) |**{\$KUBE.CONTROLLER.SERVER.URL}** - 实例 URL (默认: http://localhost:10252/metrics).<br>**{\$KUBE.CONTROLLER.TOKEN}** - API authorization token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) . <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见 Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes kubelet by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_kubelet_http/README.md) |**{\$KUBE.KUBELET.URL}** - instance URL (默认: https://localhost:10250).<br>**{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes nodes by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_nodes_http/README.md) |**{\$KUBE.API.ENDPOINT}** - Kubernetes API 访问地址格式 <scheme>://<host>:<port>/api (默认: 不设置).<br>**{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 生成服务账户token, 执行: <br> `kubectl get secret zabbix-service-account -n zabbix -o jsonpath={.data.token} | base64 -d` <br><br> 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/).<br><br> 模板中包含有一些额外的宏，可用于过滤被发现的工作节点的某些指标. | |[Kubernetes Scheduler by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_scheduler_http/README.md) |**{\$KUBE.SCHEDULER.SERVER.URL}** - 实例 URL (默认: http://localhost:10251/metrics).<br>**{\$KUBE.SCHEDULER.TOKEN}** - Scheduler API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes cluster state by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_state_http/README.md) |**{\$KUBE.API.HOST}** - Kubernetes API 服务器(默认: 不设置).<br>**{\$KUBE.API.PORT}**- Kubernetes API 端口(默认:6443). <br> **{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部服务指标将从kube-state-metrics端点中采集. <br><br> 使用Bearer API token授权方式. 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/).<br><br> 模板中包含有一些额外的宏，可用于过滤被发现的工作节点的某些指标. | |[Microsoft SharePoint by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md)|**{\$SHAREPOINT.URL}** - 门户页面URL, 例如 *http://sharepoint.companyname.local/* (默认: \`\`).<br>**{\$SHAREPOINT.ROOT}** - 根目录; 只监控根目录及其所有子文件夹(默认: /Shared Documents)<br>**{\$SHAREPOINT.USER}**, **{\$SHAREPOINT.PASSWORD}** - SharePoint 登陆凭证 (默认: 不设置).|模板中包含有一些额外的宏，可用于在LLD中过滤掉某些字典和类型(可用于过滤的宏的说明请参见模板的 [Readme.md](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md)).| |[NetApp AFF A700 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/netapp_aff_a700_http/README.md)|**{\$URL}** - AFF700 集群 URL 地址(默认: ' ' )<br>**{\$USERNAME}**, **{PASSWORD}** - AFF700 登陆凭证 (默认: 不设置).|创建 AFF A700主机，Zabbix客户端接口配置集群管理IP.| |[NGINX by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nginx_http/README.md)|**{\$NGINX.STUB\_STATUS.HOST}** - NGINX stub\_status 主机或者容器的主机名或IP地址 (默认: localhost).<br>**{\$NGINX.STUB\_STATUS.PATH}** - NGINX stub\_status 页面访问路径 (默认: basic\_status).<br>**{\$NGINX.STUB\_STATUS.PORT}** - NGINX stub\_status 主机或容器监听端口 (默认: 80).<br>**{\$NGINX.STUB\_STATUS.SCHEME}** - 请求协议. 支持: http (默认), https.|`'ngx_http_stub_status_module` 需要被设置 (配置样例详情参见 NGINX [文档](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html) 或模板的 Readme.md文件).<br>可用性检查, 执行:<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 访问格式 `<scheme>://<host>:<port>/<location>/` (默认: ' ').|1\. 启用 NGINX Plus API (详情参见 NGINX [文档](https://wwhttps://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refsw.nginx.com/products/nginx/live-activity-monitoring/)).<br>2. 设置宏 {\$NGINX.API.ENDPOINT}<br>3. 如果需要, 使用其他模板的宏过滤自动发现操作，仅需配置 zones 和 upstreams.| |[OpenWeatherMap by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/openweathermap_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$OPENWEATHERMAP.API.ENDPOINT}** - OpenWeatherMap API endpoint (默认: api.openweathermap.org/data/2.5/weather?).<br>**{$OPENWEATHERMAP.API.TOKEN}** - OpenWeatherMap API key (默认:' ')<br>**{$LOCATION}** - 要检索其指标的位置 (默认: Riga) |有关获取 API 密钥的说明，参考 OpenWeatherMap [文档](https://home.openweathermap.org/api_key)。 <br><br> **{$LOCATION}** 宏支持如下格式： <br> *geocoordinates* - 例如，`56.95,24.0833`<br> *location name* - 例如， `Chicago`<br> *OpenWeatherMap location ID* - [下载 ID 列表](http://bulk.openweathermap.org/sample/city.list.json.gz)<br>*zip/postal code with a country code* - 例如， `94040,us`<br> 使用 \| 分隔符来指定多个 location。 <br> 例如：<br>`43.81821,7.76115|Riga|2643743|94040,us` | |[PHP-FPM by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/php-fpm_agent/README.md)|**{\$PHP\_FPM.HOST}** - PHP-FPM 主机或容器的主机名或IP地址 (默认: localhost).<br>**{\$PHP\_FPM.PING.PAGE}** - PHP-FPM ping页面访问路径 (默认:ping).<br>**{\$PHP\_FPM.PORT}** - PHP-FPM 主机或容器的端口号 (默认: 80).<br>**{\$PHP\_FPM.PROCESS\_NAME}** - PHP-FPM 进程名 (默认: php-fpm).<br>**{\$PHP\_FPM.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$PHP\_FPM.STATUS.PAGE}** - PHP-FPM 状态页面访问路径 (默认:`status`).|1\. 打开配置文件并启用状态页:<br>`pm.status_path = /status`<br>`ping.path = /ping`<br><br>2. 语法验证: `$ php-fpm7 -t`<br><br>3. 重新加载 php-fpm 服务.<br><br>4. 在Nginx配置文件Server配置块(虚拟主机) 中, 添加 (带注释的扩展样例参见模板的*Readme.md* ):<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. 语法检查: `$ nginx -t`<br><br>6. 重新加载Nginx<br><br>7. 检查状态页: `curl -L 127.0.0.1/status`| |[Proxmox VE by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{\$PVE.TOKEN.ID}** - API token 允许对 REST API 的大多数部分进行无状态访问 (默认: 未设置)。 <br> **{\$PVE.TOKEN.SECRET}** - secret key (默认: 未设置). <br> **{\$PVE.URL.PORT}** - 服务器侦听的端口 (默认： 8006)。 |创建一个单独的用户进行监控，然后为此用户生成 API token。 <br> 向 token 和用户授予以下访问级别: <br>``Check: ["perm","/",["Sys.Audit"]]``<br>``Check: ["perm","/nodes/{node}",["Sys.Audit"]]``<br>``Check: ["perm","/vms/{vmid}",["VM.Audit"]]``  | |[RabbitMQ cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/rabbitmq_http/README.md)|**{\$RABBITMQ.API.CLUSTER\_HOST}** - RabbitMQ 集群 API 端点的主机名或IP地址 (默认: 127.0.0.1).<br>**{\$RABBITMQ.API.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$RABBITMQ.API.USER}**, **{\$RABBITMQ.API.PASSWORD}** - RabbitMQ 登陆凭证 (默认 用户: zbx\_monitor, 密码: zabbix).|启用RabbitMQ管理插件 (参见[RabbitMQ 文档](https://www.rabbitmq.com/management.html)).<br><br>创建一个 RabbitMQ监控用户，赋予必要的权限, 执行:<br>'' rabbitmqctl add\_user zbx\_monitor <PASSWORD> ''<br>`rabbitmqctl set_permissions -p / zbx_monitor %% "" "" ".*"%%`<br>`rabbitmqctl set_user_tags zbx_monitor monitoring`<br><br>单节点安装时,可将集群模板分配给已安装节点模板的主机。如果群集由多个节点组成，建议将群集模板分配给一个单独的负载主机使用.| |[TiDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_tidb_http/README.md)|**{\$TIDB.PORT}** - TiDB 服务器指标信息web端点的端口 (默认: 10080)<br>**{\$TIDB.URL}** - TiDB 服务器 UR (默认: localhost). |模板适用于PingCAP TiDB 集群的TiDB服务器.<br>内部指标将从TiDB /metrics和TiDB监控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}** - TiDB 服务器指标信息web端点的端口 (默认: 2379)<br>**{\$TIDB.URL}** - TiDB 服务器 URL (默认: localhost).|模板适用于PingCAP TiDB 集群的PD服务器.<br>内部指标将从PD /metrics和TiDB监控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}** - TiDB 服务器指标信息web端点的端口 (默认: 20180)<br>**{\$TIDB.URL}** - TiDB 服务器 UR (默认: localhost).|模板适用于PingCAP TiDB 集群的TiKV服务器.<br>内部指标将从TiKV /metrics中采集.| |[Travis CI by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/travis_ci_http/README.md)|**{\$TRAVIS.API.TOKEN}** - Travis API Token (默认: 不设置)<br>**{\$TRAVIS.API.URL}** - Travis API URL (默认: api.travis-ci.com).| 可在 *用于→ 设置→ API 授权* 查找Travis API token.<br>{\$TRAVIS.API.URL} 私有项目格式为 *api.travis-ci.com*.<br>{\$TRAVIS.API.URL} 企业项目格式为 *api.example.com* (将example.com替换成Travis CI所在的域名).| |[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 (默认: \`\`).<br>**{\$VELOCLOUD.URL}** - VMware SD-WAN Orchestrator URL, 例如, *velocloud.net* (默认: \`\`).|必须在VMware SD-WAN Orchestrator中创建API token (详情参见[VMware 文档](https://docs.vmware.com/en/VMware-SD-WAN/4.0/vmware-sd-wan-operator-guide/GUID-C150D536-A75F-47C1-8AFF-17C417F40C1D.html)).| |[ZooKeeper by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zookeeper_http/README.md)|**{\$ZOOKEEPER.COMMAND\_URL}** - admin.commandURL; 相对根URL，该URL用于列出和发出命令 (默认: commands).<br>**{ZOOKEEPER.PORT}** - admin.serverPort; 内置 Jetty服务的侦听端口号 (默认: 8080).<br>**{\$ZOOKEEPER.SCHEME}** - 请求协议. 支持: http (默认), https.| 通过对AdminServer发出请求，可从每个Zookeep节点采集指标(默认启用). 启用或配置 AdminServer 参见 [ZooKeeper 文档](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_adminserver_config).|

en-us	# 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/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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*.| |[CockroachDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/cockroachdb_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$COCKROACHDB.API.PORT}** - the port of CockroachDB API and Prometheus endpoint. (default: 8080).<br>**{$COCKROACHDB.API.SCHEME}** - the request scheme. Supported: http (default), https.|Internal node metrics are collected from Prometheus `/_status/vars` endpoint. <br> Node health metrics are collected from `/health` and `/health?ready=1` endpoints. <br><br>The template doesn't require usage of session token. <br><br> Depending on your CockroachDB version and configuration, some metrics may not be collected.| |[DELL PowerEdge R720 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r720_http/README.md?at=refs%2Fheads%2Frelease%2F6.0),<br>[DELL PowerEdge R740 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r740_http/README.md?at=refs%2Fheads%2Frelease%2F6.0),<br>[DELL PowerEdge R820 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r820_http/README.md?at=refs%2Fheads%2Frelease%2F6.0),<br>[DELL PowerEdge R840 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/server/dell/dell_r840_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.| | |[Envoy Proxy by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/envoy_proxy_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$ENVOY.METRICS.PATH}** - the path from where to retrieve metrics in the Prometheus format (default: `/stats/prometheus`).<br>**{$ENVOY.URL}** - Envoy Proxy instance URL (default: http://localhost:9901)|  Depending on your Envoy Proxy instance version and configuration, some metrics may not be collected. | |[Etcd by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/etcd_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.| |[Kubernetes API server by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_api_server_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.API.SERVER.URL}** - instance URL (default: http://localhost:8086/metrics).<br>**{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes Controller manager by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_controller_manager_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.CONTROLLER.SERVER.URL}** - instance URL (default: http://localhost:10252/metrics).<br>**{$KUBE.CONTROLLER.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes kubelet by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_kubelet_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.KUBELET.URL}** - instance URL (default: https://localhost:10250).<br>**{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes nodes by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_nodes_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.API.ENDPOINT}** - Kubernetes API endpoint in the format <scheme>://<host>:<port>/api (default: not set).<br>**{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> To generate a service account token, run: <br> `kubectl get secret zabbix-service-account -n zabbix -o jsonpath={.data.token} | base64 -d` <br><br> See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details.<br><br> The template contains additional macros, which can be used to filter out certain metrics of discovered worker nodes. | |[Kubernetes Scheduler by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_scheduler_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.SCHEDULER.SERVER.URL}** - instance URL (default: http://localhost:10251/metrics).<br>**{$KUBE.SCHEDULER.TOKEN}** - Scheduler API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal metrics are collected from the /metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details. | |[Kubernetes cluster state by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_state_http/README.md?at=refs%2Fheads%2Frelease%2F6.0) |**{$KUBE.API.HOST}** - Kubernetes API host (default: not set).<br>**{$KUBE.API.PORT}**- Kubernetes API port (default:6443). <br> **{$KUBE.API.TOKEN}** - API authorization token (default: \`\`).| The template requires [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) to be installed in your Kubernetes cluster. <br><br> Internal service metrics are collected from the kube-state-metrics endpoint. <br><br> Use bearer API token for authorization. See Kubernetes [documentation](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/) for details.<br><br> The template contains additional macros, which can be used to filter out certain metrics of discovered worker nodes. | |[Microsoft SharePoint by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0) 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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.| |[OpenWeatherMap by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/openweathermap_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$OPENWEATHERMAP.API.ENDPOINT}** - OpenWeatherMap API endpoint (default: api.openweathermap.org/data/2.5/weather?).<br>**{$OPENWEATHERMAP.API.TOKEN}** - OpenWeatherMap API key (default:' ')<br>**{$LOCATION}** - locations for which to retrieve the metrics (default: Riga) |For instructions on getting the API key, see OpenWeatherMap [documentation](https://home.openweathermap.org/api_key). <br><br> **{$LOCATION}** macro supports the following formats: <br> *geo coordinates* - for example, `56.95,24.0833`<br> *location name* - for example, `Chicago`<br> *OpenWeatherMap location ID* - [download the ID list](http://bulk.openweathermap.org/sample/city.list.json.gz)<br>*zip/postal code with a country code* - for example, `94040,us`<br> To specify multiple locations, use the \| delimiter. <br> Example:<br>`43.81821,7.76115|Riga|2643743|94040,us` | |[PHP-FPM by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/php-fpm_agent/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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`| |[Proxmox VE by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$PVE.TOKEN.ID}** - API token that allows stateless access to most parts of the REST API (default: not set). <br> **{$PVE.TOKEN.SECRET}** - secret key (default: not set). <br> **{$PVE.URL.PORT}** - the port the server listens to (default: 8006). |Create a separate user for monitoring, then generate an API token for this user. <br> Grant the following access levels to the token and user: <br>``Check: ["perm","/",["Sys.Audit"]]``<br>``Check: ["perm","/nodes/{node}",["Sys.Audit"]]``<br>``Check: ["perm","/vms/{vmid}",["VM.Audit"]]``  | |[RabbitMQ cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/rabbitmq_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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_ci_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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?at=refs%2Fheads%2Frelease%2F6.0)|**{$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.|
zh-cn	     # HTTP 模板操作  使用[HTTP agent](/manual/config/items/itemtypes/http)方式收集模板指标数据的正确操作步骤:  1\. 在Zabbix 中创建一个主机，指定监控目标的IP地址或DNS名称为主接口。这需要宏{HOST.CONN}在模板项中正确的解析。\ 2. 将模板 [链接](/manual/config/templates/linking#linking_a_template) 到步骤1中创建的主机(如果模板在Zabbix安装中不可用，您可能需要首先导入模板的`.xml`文件 - 参见 [开箱即用的模板](/manual/config/templates_out_of_the_box) 说明).\ 3. 根据需要调整必配宏的值。\ 4. 配置被监视的主机实例，以允许与Zabbix共享数据 - 请参阅 *附加步骤/注释* 列3中的说明。  ::: notetip 此页仅包含正确模板操作所需的最小宏的集和设置步骤。在模板的`Readme.md`文件中（可通过单击模板名称进行访问），可查看模板的详细描述，包括宏、监控项和触发器的完整列表。 :::  |模板|必配宏|附加步骤/注释| |--------|----------------|-------------------------| |[Apache by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/apache_http)|**{\$APACHE.STATUS.HOST}** - - Apache 状态页的主机名或IP地址 (默认: 127.0.0.1).<br>**{\$APACHE.STATUS.PATH}** -URL 路径 (默认: server-status?auto).<br>**{\$APACHE.STATUS.PORT}** - Apache 状态页的端口号 (默认: 80).<br>**{\$APACHE.STATUS.SCHEME}** -请求协议. 支持: http (默认), https.|Apache模块 mod\_status 需要设置 (详情参见Apache [文档](https://httpd.apache.org/docs/current/mod/mod_status.html)).<br>可用性检查, 执行:<br>`httpd -M 2>/dev/null \| grep status_module`<br><br>Apache 配置样例:<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 端口号(默认： 8088).<br>**{\$AMI.SECRET}** - Asterisk Manager的secret(默认: zabbix).<br>**{\$AMI.URL}** - Asterisk Manager 的 API URL 格式<br>`<scheme>://<host>:<port>/<prefix>/rawman`<br>(默认: http://asterisk:8088/asterisk/rawman).<br>**{\$AMI.USERNAME}** - the Asterisk Manager用户名.|1\. 启用 [mini-HTTP Server](https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server).<br><br>2. 添加选项 `webenabled=yes` 到配置文件 *manager.conf*.<br><br>3. 在Asterisk实例中创建 *Asterisk Manager* 用户.| |[ClickHouse by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/clickhouse_http/README.md)|**{\$CLICKHOUSE.PORT}** - ClickHouse HTTP 端点的端口号 (默认： 8123).<br>**{\$CLICKHOUSE.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$CLICKHOUSE.USER}**, **{\$CLICKHOUSE.PASSWORD}** - ClickHouse 登陆凭据 (默认用户名: zabbix, 密码: zabbix\_pass).<br>如果不需要身份验证，请从监控项的HTTP agent类型配置项的请求头中删除.|通过'web'配置文件创建ClickHouse用户，并赋予数据库查询权限(详情参见ClickHouse [文档](https://clickhouse.tech/docs/en/operations/settings/settings-users/)).<br><br>请参阅模板的Readme.md文件，了解zabbix.xml的文件配置.| |[Cloudflare by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/cloudflare_http/README.md)|**{\$CLOUDFLARE.API.TOKEN}** - Cloudflare API token (默认: \`\<change\>\`).<br>**{\$CLOUDFLARE.ZONE\_ID}** - Cloudflare站点Zone ID (默认: \`<change>\`).|在Cloudflare账户下*我的个人资料→ API Tokens*中获取Cloudflare API Tokens.<br>在Cloudflare账户下*账户主页→ 站点*中获取Zone ID.| |[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格式 `<scheme>://<host>:<port>` (默认: \<输入您的URL地址\>)<br>**{\$API.USER}**, **{\$API.PASSWORD}** - Dell iDRAC 登陆凭证 (默认: 不设置).|Dell服务器上的iDRAC接口:<br>1. 启用Redfish API .<br>2. 创建一个用户监控用户，赋予只读权限.| |[Elasticsearch Cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/elasticsearch_http/README.md)|**{\$ELASTICSEARCH.PORT}** - Elasticsearch 主机的端口号 (默认: 9200).<br>**{\$ELASTICSEARCH.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$ELASTICSEARCH.USERNAME}**, **{\$ELASTICSEARCH.PASSWORD}** - 登陆凭证, 仅当用于Elasticsearch身份验证时才需要.|<| |[Etcd by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/etcd_http/README.md)|**{\$ETCD.PORT}**- Etcd API 端点的端口号 (默认: 2379).<br>**{\$ETCD.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$ETCD.USER}**, **{\$ETCD.PASSWORD}** - 登陆凭证, 仅当用于Etcd身份验证时才需要.|端点的接口路径/metrics采集指标; 指定API端点的接口路径，请使用 `--listen-metrics-urls` 参数(详情参见Etcd [文档](https://github.com/etcd-io/website/blob/master/content/docs/v3.4.0/op-guide/configuration.md#--listen-metrics-urls)).<br><br>本地验证Etcd指标采集，执行:<br>`curl -L http://localhost:2379/metrics`<br><br>检查 Etcd 指标可以从 Zabbix proxy 或 Zabbix server 采集，执行:<br>`curl -L http:%%//<etcd_node_adress>:2379/metrics%%`<br><br>每个 Etcd 的节点都需要链接这个模板.| |[GitLab by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/gitlab_http)|**{\$GITLAB.PORT}** - GitLab Web端点的端口号 (默认: 80)<br>**{\$GITLAB.URL}** - GitLab 实例URL (默认: localhost)|该模板只适用与本地 GitLab 实例; 指标采集路径为 `/metrics` .<br><br>需要设置客户IP白名单，才能访问指标(详情参见 [GitLab 文档](https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html)).<br><br>请注意，某些指标可能不适用于特定的GitLab实例版本和配置.| |[Hadoop by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/hadoop_http/README.md)|**{\$HADOOP.NAMENODE.HOST}** - Hadoop NameNode 节点的主机IP 或 FQDN (默认: NameNode).<br>**{\$HADOOP.NAMENODE.PORT}** - Hadoop NameNode 节点的 web-UI 端口号 (默认: 9870).<br>**{\$HADOOP.RESOURCEMANAGER.HOST}** - Hadoop ResourceManager 节点的 IP 地址或 FQDN (默认: ResourceManager).<br>**{\$HADOOP.RESOURCEMANAGER.PORT}** - Hadoop ResourceManager 的 web-UI 端口号 (默认: 8088).|采用HTTP agent和JSONPath预处理方式远程轮询 Hadoop API 来收集指标数据。Zabbix服务器（或代理）完成对ResourceManager、NodeManager、NameNode、DataNodes API的直接请求处理.| |[HAProxy by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/haproxy_http/README.md)|**{\$HAPROXY.STATS.PATH}** - HAProxy 状态页的路径 (默认: stats).<br>**{\$HAPROXY.STATS.PORT}** - HAProxy 状态页主机或容器的端口号 (默认: 8404).<br>**{\$HAPROXY.STATS.SCHEME}** - 请求协议. 支持: http (默认), https.|需设置HAProxy 状态页 (详情参见HAProxy [博客文档](https://www.haproxy.com/blog/exploring-the-haproxy-stats-page/) 或 模板的 Readme.md 配置样例).| |[HashiCorp Vault by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/vault_http/README.md)|**{\$VAULT.API.PORT}** - Vault API请求的监听端口(默认: 8200).<br>**{\$VAULT.API.SCHEME}** - Vault API请求的协议. 支持: http (默认), https.<br>**{\$VAULT.HOST}** - Vault主机名 (默认: \<填写您的Vaultu主机名\>).<br>**{\$VAULT.TOKEN}** - Vault 认证令牌 (默认: \<填写您的TOKEN\>).|1\. 配置 Vault API (详情参见 [官方文档](https://www.vaultproject.io/docs/configuration)).<br>2. 创建 Vault 服务的token, 并将其赋值于宏{\$VAULT.TOKEN}.| |[Hikvision camera by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cctv/hikvision/README.md)|**{\$HIKVISION\_ISAPI\_PORT}** - 设备上的 ISAPI 端口 (默认: 80).<br>**{\$USER}**, **{\$PASSWORD}** - camera 登陆凭证 (默认 用户: admin, 密码: 1234).|<| |[InfluxDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/influxdb_http/README.md)|**{\$INFLUXDB.API.TOKEN}** - InfluxDB API 授权token (默认: \`\`).<br>**{\$INFLUXDB.URL}** - InfluxDB 实例 URL 格式`<scheme>://<host>:<port>` (默认: http://localhost:8086).|此模板从本地InfluxDB实例/metrics路径中采集InfluxDB服务指标.<br><br>详情参见 InfluxDB [文档](https://docs.influxdata.com/influxdb/v2.0/security/tokens/).| |[Jenkins by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/jenkins/README.md)|**{\$JENKINS.API.KEY}** - 访问Metrics Servlet的API 秘钥; 采集通用指标时必须配置 (默认: \`\`).<br>**{\$JENKINS.API.TOKEN}** - 用于HTTP BASIC 授权的API token; 监控执行节点和构建过程所需 (默认: \`\`).<br>**{\$JENKINS.URL}** - Jenkins URL 格式 `<scheme>://<host>:<port>`; 监控执行节点和构建过程所需 (默认: \`\`).<br>**{\$JENKINS.USER}** - HTTP BASIC 授权用户; 监控执行节点和构建过程所需 (默认: zabbix).|通过请求 Metrics API 采集指标.<br><br>通用指标: 安装配置 Metrics 插件， 配置参数参考 [官方文档](https://plugins.jenkins.io/metrics/). 发行一个API秘钥用于接入Metrics Servlet，并将其赋值于宏{\$JENKINS.API.KEY}.<br><br>监控执行节点和构建过程所需: 创建一个API token用于Jenkins监控用户，并将其赋值于宏 {\$JENKINS.API.TOKEN}. 详情参见Jenkins [文档](https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/).| |[Kubernetes API server by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_api_server_http/README.md) |**{\$KUBE.API.SERVER.URL}** - 实例URL (默认: http://localhost:8086/metrics).<br>**{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见 Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes Controller manager by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_controller_manager_http/README.md) |**{\$KUBE.CONTROLLER.SERVER.URL}** - 实例 URL (默认: http://localhost:10252/metrics).<br>**{\$KUBE.CONTROLLER.TOKEN}** - API authorization token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0) . <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见 Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes kubelet by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_kubelet_http/README.md) |**{\$KUBE.KUBELET.URL}** - instance URL (默认: https://localhost:10250).<br>**{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes nodes by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_nodes_http/README.md) |**{\$KUBE.API.ENDPOINT}** - Kubernetes API 访问地址格式 <scheme>://<host>:<port>/api (默认: 不设置).<br>**{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 生成服务账户token, 执行: <br> `kubectl get secret zabbix-service-account -n zabbix -o jsonpath={.data.token} | base64 -d` <br><br> 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/).<br><br> 模板中包含有一些额外的宏，可用于过滤被发现的工作节点的某些指标. | |[Kubernetes Scheduler by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_scheduler_http/README.md) |**{\$KUBE.SCHEDULER.SERVER.URL}** - 实例 URL (默认: http://localhost:10251/metrics).<br>**{\$KUBE.SCHEDULER.TOKEN}** - Scheduler API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部指标将从/metrics中采集. <br><br> 使用Bearer API token授权方式. 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/). | |[Kubernetes cluster state by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/kubernetes_http/kubernetes_state_http/README.md) |**{\$KUBE.API.HOST}** - Kubernetes API 服务器(默认: 不设置).<br>**{\$KUBE.API.PORT}**- Kubernetes API 端口(默认:6443). <br> **{\$KUBE.API.TOKEN}** - API 授权token (默认: \`\`).| 模板要求 Kubernetes 集群中必须安装 [Zabbix Helm Chart](https://git.zabbix.com/projects/ZT/repos/kubernetes-helm/browse?at=refs%2Fheads%2Frelease%2F6.0). <br><br> 内部服务指标将从kube-state-metrics端点中采集. <br><br> 使用Bearer API token授权方式. 详情参见Kubernetes [文档](https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/).<br><br> 模板中包含有一些额外的宏，可用于过滤被发现的工作节点的某些指标. | |[Microsoft SharePoint by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md)|**{\$SHAREPOINT.URL}** - 门户页面URL, 例如 *http://sharepoint.companyname.local/* (默认: \`\`).<br>**{\$SHAREPOINT.ROOT}** - 根目录; 只监控根目录及其所有子文件夹(默认: /Shared Documents)<br>**{\$SHAREPOINT.USER}**, **{\$SHAREPOINT.PASSWORD}** - SharePoint 登陆凭证 (默认: 不设置).|模板中包含有一些额外的宏，可用于在LLD中过滤掉某些字典和类型(可用于过滤的宏的说明请参见模板的 [Readme.md](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/sharepoint_http/README.md)).| |[NetApp AFF A700 by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/san/netapp_aff_a700_http/README.md)|**{\$URL}** - AFF700 集群 URL 地址(默认: ' ' )<br>**{\$USERNAME}**, **{PASSWORD}** - AFF700 登陆凭证 (默认: 不设置).|创建 AFF A700主机，Zabbix客户端接口配置集群管理IP.| |[NGINX by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/nginx_http/README.md)|**{\$NGINX.STUB\_STATUS.HOST}** - NGINX stub\_status 主机或者容器的主机名或IP地址 (默认: localhost).<br>**{\$NGINX.STUB\_STATUS.PATH}** - NGINX stub\_status 页面访问路径 (默认: basic\_status).<br>**{\$NGINX.STUB\_STATUS.PORT}** - NGINX stub\_status 主机或容器监听端口 (默认: 80).<br>**{\$NGINX.STUB\_STATUS.SCHEME}** - 请求协议. 支持: http (默认), https.|`'ngx_http_stub_status_module` 需要被设置 (配置样例详情参见 NGINX [文档](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html) 或模板的 Readme.md文件).<br>可用性检查, 执行:<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 访问格式 `<scheme>://<host>:<port>/<location>/` (默认: ' ').|1\. 启用 NGINX Plus API (详情参见 NGINX [文档](https://wwhttps://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refsw.nginx.com/products/nginx/live-activity-monitoring/)).<br>2. 设置宏 {\$NGINX.API.ENDPOINT}<br>3. 如果需要, 使用其他模板的宏过滤自动发现操作，仅需配置 zones 和 upstreams.| |[OpenWeatherMap by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/openweathermap_http/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{$OPENWEATHERMAP.API.ENDPOINT}** - OpenWeatherMap API endpoint (默认: api.openweathermap.org/data/2.5/weather?).<br>**{$OPENWEATHERMAP.API.TOKEN}** - OpenWeatherMap API key (默认:' ')<br>**{$LOCATION}** - 要检索其指标的位置 (默认: Riga) |有关获取 API 密钥的说明，参考 OpenWeatherMap [文档](https://home.openweathermap.org/api_key)。 <br><br> **{$LOCATION}** 宏支持如下格式： <br> *geocoordinates* - 例如，`56.95,24.0833`<br> *location name* - 例如， `Chicago`<br> *OpenWeatherMap location ID* - [下载 ID 列表](http://bulk.openweathermap.org/sample/city.list.json.gz)<br>*zip/postal code with a country code* - 例如， `94040,us`<br> 使用 \| 分隔符来指定多个 location。 <br> 例如：<br>`43.81821,7.76115|Riga|2643743|94040,us` | |[PHP-FPM by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/php-fpm_agent/README.md)|**{\$PHP\_FPM.HOST}** - PHP-FPM 主机或容器的主机名或IP地址 (默认: localhost).<br>**{\$PHP\_FPM.PING.PAGE}** - PHP-FPM ping页面访问路径 (默认:ping).<br>**{\$PHP\_FPM.PORT}** - PHP-FPM 主机或容器的端口号 (默认: 80).<br>**{\$PHP\_FPM.PROCESS\_NAME}** - PHP-FPM 进程名 (默认: php-fpm).<br>**{\$PHP\_FPM.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$PHP\_FPM.STATUS.PAGE}** - PHP-FPM 状态页面访问路径 (默认:`status`).|1\. 打开配置文件并启用状态页:<br>`pm.status_path = /status`<br>`ping.path = /ping`<br><br>2. 语法验证: `$ php-fpm7 -t`<br><br>3. 重新加载 php-fpm 服务.<br><br>4. 在Nginx配置文件Server配置块(虚拟主机) 中, 添加 (带注释的扩展样例参见模板的*Readme.md* ):<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. 语法检查: `$ nginx -t`<br><br>6. 重新加载Nginx<br><br>7. 检查状态页: `curl -L 127.0.0.1/status`| |[Proxmox VE by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/proxmox/README.md?at=refs%2Fheads%2Frelease%2F6.0)|**{\$PVE.TOKEN.ID}** - API token 允许对 REST API 的大多数部分进行无状态访问 (默认: 未设置)。 <br> **{\$PVE.TOKEN.SECRET}** - secret key (默认: 未设置). <br> **{\$PVE.URL.PORT}** - 服务器侦听的端口 (默认： 8006)。 |创建一个单独的用户进行监控，然后为此用户生成 API token。 <br> 向 token 和用户授予以下访问级别: <br>``Check: ["perm","/",["Sys.Audit"]]``<br>``Check: ["perm","/nodes/{node}",["Sys.Audit"]]``<br>``Check: ["perm","/vms/{vmid}",["VM.Audit"]]``  | |[RabbitMQ cluster by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/rabbitmq_http/README.md)|**{\$RABBITMQ.API.CLUSTER\_HOST}** - RabbitMQ 集群 API 端点的主机名或IP地址 (默认: 127.0.0.1).<br>**{\$RABBITMQ.API.SCHEME}** - 请求协议. 支持: http (默认), https.<br>**{\$RABBITMQ.API.USER}**, **{\$RABBITMQ.API.PASSWORD}** - RabbitMQ 登陆凭证 (默认 用户: zbx\_monitor, 密码: zabbix).|启用RabbitMQ管理插件 (参见[RabbitMQ 文档](https://www.rabbitmq.com/management.html)).<br><br>创建一个 RabbitMQ监控用户，赋予必要的权限, 执行:<br>'' rabbitmqctl add\_user zbx\_monitor <PASSWORD> ''<br>`rabbitmqctl set_permissions -p / zbx_monitor %% "" "" ".*"%%`<br>`rabbitmqctl set_user_tags zbx_monitor monitoring`<br><br>单节点安装时,可将集群模板分配给已安装节点模板的主机。如果群集由多个节点组成，建议将群集模板分配给一个单独的负载主机使用.| |[TiDB by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/db/tidb_http/tidb_tidb_http/README.md)|**{\$TIDB.PORT}** - TiDB 服务器指标信息web端点的端口 (默认: 10080)<br>**{\$TIDB.URL}** - TiDB 服务器 UR (默认: localhost). |模板适用于PingCAP TiDB 集群的TiDB服务器.<br>内部指标将从TiDB /metrics和TiDB监控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}** - TiDB 服务器指标信息web端点的端口 (默认: 2379)<br>**{\$TIDB.URL}** - TiDB 服务器 URL (默认: localhost).|模板适用于PingCAP TiDB 集群的PD服务器.<br>内部指标将从PD /metrics和TiDB监控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}** - TiDB 服务器指标信息web端点的端口 (默认: 20180)<br>**{\$TIDB.URL}** - TiDB 服务器 UR (默认: localhost).|模板适用于PingCAP TiDB 集群的TiKV服务器.<br>内部指标将从TiKV /metrics中采集.| |[Travis CI by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/travis_ci_http/README.md)|**{\$TRAVIS.API.TOKEN}** - Travis API Token (默认: 不设置)<br>**{\$TRAVIS.API.URL}** - Travis API URL (默认: api.travis-ci.com).| 可在 *用于→ 设置→ API 授权* 查找Travis API token.<br>{\$TRAVIS.API.URL} 私有项目格式为 *api.travis-ci.com*.<br>{\$TRAVIS.API.URL} 企业项目格式为 *api.example.com* (将example.com替换成Travis CI所在的域名).| |[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 (默认: \`\`).<br>**{\$VELOCLOUD.URL}** - VMware SD-WAN Orchestrator URL, 例如, *velocloud.net* (默认: \`\`).|必须在VMware SD-WAN Orchestrator中创建API token (详情参见[VMware 文档](https://docs.vmware.com/en/VMware-SD-WAN/4.0/vmware-sd-wan-operator-guide/GUID-C150D536-A75F-47C1-8AFF-17C417F40C1D.html)).| |[ZooKeeper by HTTP](https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/zookeeper_http/README.md)|**{\$ZOOKEEPER.COMMAND\_URL}** - admin.commandURL; 相对根URL，该URL用于列出和发出命令 (默认: commands).<br>**{ZOOKEEPER.PORT}** - admin.serverPort; 内置 Jetty服务的侦听端口号 (默认: 8080).<br>**{\$ZOOKEEPER.SCHEME}** - 请求协议. 支持: http (默认), https.| 通过对AdminServer发出请求，可从每个Zookeep节点采集指标(默认启用). 启用或配置 AdminServer 参见 [ZooKeeper 文档](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_adminserver_config).|

en-us	# httptest.create
zh-cn	 # 创建

en-us	# httptest.delete
zh-cn	 # 删除

en-us	# httptest.get
zh-cn	 # 获取

en-us	# httptest.update
zh-cn	 # 更新

en-us	#### 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! :::
zh-cn	#### 滞后  有时，问题和恢复状态之间需要一个间隔，而不是一个简单的阈值。例如，如果我们想定义一个触发器，它在服务器机房温度高于20°C时报告问题，并且我们想让它在温度低于15°C之前保持问题状态，那么简单的触发器阈值为20°C是不够的。  相反，我们需要首先为问题事件定义一个触发器表达式(温度高于20°C)。然后我们需要定义一个额外的恢复条件(温度低于15°C)。这是通过在[defining定义](/manual/config/triggers/trigger)触发器时定义一个额外的*Recovery expression 恢复表达式*参数来实现的。  在这种情况下，问题恢复将分两步进行：  - 首先，问题表达式（温度高于 20°C）评估为 FALSE - 其次，恢复表达式（温度低于 15°C）评估为 TRUE  仅当问题事件为 先解决。  ::: notewarning 当问题表达式为TRUE时，即使恢复表达式为TRUE也不会恢复。 :::

en-us	##### 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).
zh-cn	##### 图标高亮显示  如果一个拓扑图元素处于问题状态，则以圆圈突出显示。圆的填充颜色对应于问题触发器的严重性颜色。该元素仅展示选定严重性级别或更高级别的问题。如果所有问题都得到确认，圆形周围会显示一个加粗的绿色边框。  另外：  - · 如果一个主机在[维护](/manual/maintenance) 状态状态， 则以橙色背景块高亮显示。请注意，维护期高亮显示的优先级高于问题严重性高亮显示。 *禁用（未监视）主机以灰色背景块高亮显示。  如果在拓扑图[配置](/manual/config/visualization/maps/map#creating_a_map)中选中了图标高亮复选框，则图标会高亮显示。

en-us	#### iconmap  Changes:\ [ZBXNEXT-6914](https://support.zabbix.com/browse/ZBXNEXT-6914) `iconmap.create`, `iconmap.update`: dropped support of the icon mapping object property `sortorder`.\
zh-cn	 #### 图标映射  变更：\ [ZBXNEXT-6914](https://support.zabbix.com/browse/ZBXNEXT-6914) `iconmap.create`，`iconmap.update`：删除对图标映射对象属性`sortorder`的支持。\

en-us	#### iconmap  Changes:\ [ZBXNEXT-6914](https://support.zabbix.com/browse/ZBXNEXT-6914) `iconmap.create`, `iconmap.update`: dropped support of the icon mapping object property `sortorder`.\
zh-cn	 #### 图标映射  变更：\ [ZBXNEXT-6914](https://support.zabbix.com/browse/ZBXNEXT-6914) `iconmap.create`，`iconmap.update`：删除对图标映射对象属性`sortorder`的支持。\

en-us	# iconmap.create
zh-cn	## iconmap.create

en-us	# iconmap.delete
zh-cn	## iconmap.delete

en-us	# iconmap.get
zh-cn	# 获取

en-us	# > Icon map object  The following objects are directly related to the `iconmap` API.
zh-cn	# > 图标映射对象  以下是和 `iconmap` API 直接相关的对象。

en-us	### 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.|
zh-cn	### 图标映射关系（icon mapping）  图标映射关系（icon mapping）对象定义了一个具体的图标，以供具有特定资产清单字段值的主机使用。它有以下属性。  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |----|---------------------------------------------------|----| |iconmappingid|字符串|*（只读）*图标映射关系（icon mapping）的 ID。| |**iconid**<br>（必需）|字符串|被图标映射关系（icon mapping）使用的图标 ID。| |**expression**<br>（必需）|字符串|匹配资产清单字段的表达式。| |**inventory\_link**<br>（必需）|整数|主机资产清单字段的 ID。<br><br>参考[主机资产清单对象（host inventory object）](/manual/api/reference/host/object#host_inventory)以获取支持的资产清单字段列表。| |iconmapid|字符串|*（只读）*图标映射关系（icon mapping）所属的图标映射（icon map）的 ID。| |sortorder|整数|*（只读）*图标映射关系（icon mapping）在图标映射（icon map）中的位置。|

en-us	### 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.|
zh-cn	### 图标映射关系（icon mapping）  图标映射关系（icon mapping）对象定义了一个具体的图标，以供具有特定资产清单字段值的主机使用。它有以下属性。  |属性|[类型](/manual/api/reference_commentary#data_types)|描述| |----|---------------------------------------------------|----| |iconmappingid|字符串|*（只读）*图标映射关系（icon mapping）的 ID。| |**iconid**<br>（必需）|字符串|被图标映射关系（icon mapping）使用的图标 ID。| |**expression**<br>（必需）|字符串|匹配资产清单字段的表达式。| |**inventory\_link**<br>（必需）|整数|主机资产清单字段的 ID。<br><br>参考[主机资产清单对象（host inventory object）](/manual/api/reference/host/object#host_inventory)以获取支持的资产清单字段列表。| |iconmapid|字符串|*（只读）*图标映射关系（icon mapping）所属的图标映射（icon map）的 ID。| |sortorder|整数|*（只读）*图标映射关系（icon mapping）在图标映射（icon map）中的位置。|

en-us	#### - Icon mapping  This section allows creating the mapping of certain hosts with certain icons. Host inventory field information is used to create the mapping.  The mappings can then be used in [network map configuration](/manual/config/ visualization/maps/map) to assign appropriate icons to matching hosts automatically.  To create a new icon map, click on *Create icon map* in the top right corner.  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/general_icon_map.png){width="600"}  Configuration parameters:  |Parameter|Description| |---------|-----------| |*Name*|Unique name of icon map.| |*Mappings*|A list of mappings. The order of mappings determines which one will have priority. You can move mappings up and down the list with drag-and-drop.| |*Inventory field*|Host inventory field that will be looked into to seek a match.| |*Expression*|Regular expression describing the match.| |*Icon*|Icon to use if a match for the expression is found.| |*Default*|Default icon to use.|
zh-cn	#### - 图标映射  本节允许创建特定主机与特定主机的映射图标。主机清单字段信息用于创建映射。  然后可以在 [网络拓扑图配置](/manual/config/visualization/maps/map) 分配 自动匹配主机的适当图标。  要创建新的图标地图，请单击右上角的*创建图标地图* 角落。  ![](../../../../../assets/en/manual/web_interface/frontend_sections/administration/general_icon_map.png){width="600"}  配置参数：  |参数|说明| |---------|------------| |*名称*|图标图片的唯一名称。| |*映射*|映射列表。映射的顺序决定了哪个优先。您可以通过拖放在列表中上下移动映射。| |*库存字段*|将被调查以寻找匹配的主机库存字段。| |*表达式*|描述匹配的正则表达式。| |*图标*|找到表达式匹配时使用的图标。| |*默认*|要使用的默认图标。|