14 主机导航器

说明

各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.create 和 dashboard.update 方法中配置主机导航器组件。

在创建或更新仪表盘期间不会验证组件的 fields 属性。 这个方法允许用户修改内置组件和创建自定义组件，但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新主机导航器组件，请参阅下表中概述的参数行为。

参数

主机导航器组件支持以下参数：

参数类型参数名称参数值或参数说明
刷新频率0rf_rate0 - 不刷新；
10 - 10 秒；
30 - 30 秒；
60 - (默认) 1 分钟；
120 - 2 分钟；
600 - 10 分钟；
900 - 15 分钟。
主机组2groupids.0主机组 ID。

注意：如果需要配置多个主机组，则需要给每个主机组创建一个仪表盘组件字段对象，参数名称 groupids.0 中的数字按照顺序进行递增。

在仪表盘模板上配置组件时，这个参数不受支持。
主机组 (组件)1groupids._reference用于替代主机组 ID：
ABCDE._hostgroupids - 将一个 标识符 参数为 ABCDE 的兼容性组件作为数据源。

在仪表盘模板上配置组件时，这个参数不受支持。
主机表达式1hosts.0主机名称或表达式。

注意：如果需要配置多个主机，则需要给每个主机创建一个仪表盘组件字段对象，参数名称 hostids.0 中的数字按照顺序进行递增。配置多个主机时，主机组 必须不进行配置或配置中至少包含一个主机所属的主机组。

在仪表盘模板上配置组件时，这个参数不受支持。
主机状态0status-1 - (默认) 任意；
0 - 启用；
1 - 禁用。

在仪表盘模板上配置组件时，这个参数不受支持。
主机标签
评估类型0host_tags_evaltype0 - (默认) And/Or；
2 - Or。

在仪表盘模板上配置组件时，这个参数不受支持。
标签名称1host_tags.0.tag任意字符串。

注意：参数名称 tags.0.value 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。

参数行为：
- 必需的 (配置 主机标签 时)。

在仪表盘模板上配置组件时，这个参数不受支持。
操作0host_tags.0.operator0 - 包含；
1 - 相等；
2 - 不包含；
3 - 不相等；
4 - 存在；
5 - 不存在

注意：参数名称 tags.0.value 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。

参数行为：
- 必需的 (配置 主机标签 时)。

在仪表盘模板上配置组件时，这个参数不受支持。
标签值1host_tags.0.value任意字符串。

注意：参数名称 tags.0.value 中的数字与提供的参数列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。

参数行为：
- 必需的 (配置 主机标签 时)。

在仪表盘模板上配置组件时，这个参数不受支持。
严重性0severities.00 - 未定义；
1 - 信息；
2 - 警告；
3 - 一般；
4 - 严重；
5 - 灾难。

默认值： 空 (全部启用)

注意：如果需要配置多个值，则需要给每个值创建一个仪表盘组件字段对象，参数名称 statuses.0 中的数字按照顺序进行递增。
显示维护中的主机0maintenance0 - (默认) 禁用；
1 - 启用。
显示问题0show_problems0 - 所有；
1 - (默认) 未被抑制；
2 - 无。
分组
属性0group_by.0.attribute0 - 主机组；
1 - 标签值；
2 - 严重性。

注意：参数名称 group_by.0.attribute 中的数字与提供的主机列表需要一致，例如：总数为 3，则下标参数名称中的数字分别为：0、1、2。

参数行为：
- 必需的 (配置 分组 时)。
值1group_by.0.tag_name任意字符串。

注意：参数名称 group_by.0.tag_name 中的数字需要与 属性 参数中一致

参数行为：
- 必需的 (配置 分组 时，如果 属性 被设置为 “标签值”)。
主机限制数量0show_lines可用值范围： 1-9999。

默认值： 100。

在仪表盘模板上配置组件时，这个参数不受支持。
标识符1reference任意 5 个英文字符组成的字符串(例如：ABCDE 或 JBPNL)。在这个组件所属的仪表盘中，这个值必须是唯一的。

参数行为：
- 必需的。

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 主机导航器 组件。 更多信息，请参考 创建仪表盘。

配置一个主机导航器组件

配置一个主机导航器组件，展示先按照主机分组，然后按照标签 “City” 的值分组的主机。

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "dashboard.create",
  4.            "params": {
  5.                "name": "My dashboard",
  6.                "display_period": "30",
  7.                "auto_start": "1",
  8.                "pages": [
  9.                    {
  10.                        "widgets": [
  11.                            {
  12.                                "type": "hostnavigator",
  13.                                "name": "Host navigator",
  14.                                "x": "0",
  15.                                "y": "0",
  16.                                "width": "12",
  17.                                "height": "5",
  18.                                "view_mode": "0",
  19.                                "fields": [
  20.                                    {
  21.                                        "type": 2,
  22.                                        "name": "groupids.0",
  23.                                        "value": 2
  24.                                    },
  25.                                    {
  26.                                        "type": 2,
  27.                                        "name": "groupids.1",
  28.                                        "value": 4
  29.                                    },
  30.                                    {
  31.                                        "type": 0,
  32.                                        "name": "group_by.0.attribute",
  33.                                        "value": 0
  34.                                    },
  35.                                    {
  36.                                        "type": 0,
  37.                                        "name": "group_by.1.attribute",
  38.                                        "value": 1
  39.                                    },
  40.                                    {
  41.                                        "type": 1,
  42.                                        "name": "group_by.1.tag_name",
  43.                                        "value": "City"
  44.                                    },
  45.                                    {
  46.                                        "type": 1,
  47.                                        "name": "reference",
  48.                                        "value": "SWKLB"
  49.                                    }
  50.                                ]
  51.                            }
  52.                        ]
  53.                    }
  54.                ],
  55.                "userGroups": [
  56.                    {
  57.                        "usrgrpid": 7,
  58.                        "permission": 2
  59.                    }
  60.                ],
  61.                "users": [
  62.                    {
  63.                        "userid": 1,
  64.                        "permission": 3
  65.                    }
  66.                ]
  67.            },
  68.            "id": 1
  69.        }

响应：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "dashboardids": [
  5.                    "3"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

参考