14 主机导航器

说明

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

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

参数

以下参数适用于主机导航小组件。

参数 类型 名称 值
刷新间隔 0 rf_rate 0 - 不刷新；
10 - 10 秒；
30 - 30 秒；
60 - (默认) 1 分钟；
120 - 2 分钟；
600 - 10 分钟；
900 - 15 分钟。
主机群组 2 groupids.0 主机群组 ID。

注意：要配置多个主机群组，请为每个主机群组创建一个小组件字段对象，并在属性名称中使用递增的数字。

如果在模板仪表板上配置小组件，则不支持此参数。
主机群组（小组件） 1 groupids._reference 替代主机群组 ID：
ABCDE._hostgroupids - 将一个兼容的小组件（其引用参数设置为"ABCDE"）设置为主机群组的数据源。

如果在模板仪表板上配置小组件，则不支持此参数。
主机模式 1 hosts.0 主机名称或模式。

注意：要配置多个主机模式，请为每个主机模式创建一个小组件字段对象，并在属性名称中使用递增的数字。对于多个主机模式，参数主机群组必须完全不配置，或至少配置一个包含与所配置主机模式匹配的主机的主机群组。

如果在模板仪表板上配置小组件，则不支持此参数。
主机状态 0 status -1 - (默认) 任意；
0 - 已启用；
1 - 已禁用。

如果在模板仪表板上配置小组件，则不支持此参数。
主机标签
评估类型 0 host_tags_evaltype 0 - (默认) And/Or；
2 - Or。

如果在模板仪表板上配置小组件，则不支持此参数。
标签名称 1 host_tags.0.tag 任意字符串值。

注意：属性名称中的数字表示标签评估列表中的标签顺序。

参数行为：
- 配置主机标签时必需

如果在模板仪表板上配置小组件，则不支持此参数。
运算符 0 host_tags.0.operator 0 - 包含；
1 - 等于；
2 - 不包含；
3 - 不等于；
4 - 存在；
5 - 不存在。

注意：属性名称中的数字表示标签评估列表中的标签顺序。

参数行为：
- 配置主机标签时必需

如果在模板仪表板上配置小组件，则不支持此参数。
标签值 1 host_tags.0.value 任意字符串值。

注意：属性名称中的数字表示标签评估列表中的标签顺序。

参数行为：
- 配置主机标签时必需

如果在模板仪表板上配置小组件，则不支持此参数。
严重性 0 severities.0 0 - 未分类；
1 - 信息；
2 - 警告；
3 - 一般；
4 - 高；
5 - 灾难。

默认值：空（全部启用）。

注意：要配置多个值，请为每个值创建一个小组件字段对象，并在属性名称中使用递增的数字。
显示处于维护状态的主机 0 maintenance 0 - (默认) 已禁用；
1 - 已启用。
显示问题 0 show_problems 0 - 全部；
1 - (默认) 未抑制；
2 - 无。
分组依据
属性 0 group_by.0.attribute 0 - 主机群组；
1 - 标签值；
2 - 严重性。

注意：属性名称中的数字表示分组属性列表中的属性顺序。

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

注意：属性名称中的数字表示属性参数中设置的分组属性。

参数行为：
- 配置分组依据且属性设置为“标签值”时必需
主机限制 0 show_lines 可能值范围为 1 至 9999。

默认值：100。

如果在模板仪表板上配置小组件，则不支持此参数。
引用 1 reference 由 5 个字符组成的任意字符串值（例如 ABCDE 或 JBPNL）。此值在小组件所属的仪表板中必须唯一。

参数行为：
- 必需

示例

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

配置 主机导航器 小组件

配置一个 主机导航器 小组件，使其显示按主机组分组、然后再按“city”标签值分组的主机。

请求:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "hostnavigator",
                        "name": "Host navigator",
                        "x": "0",
                        "y": "0",
                        "width": "12",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 2
                            },
                            {
                                "type": 2,
                                "name": "groupids.1",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "group_by.0.attribute",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "group_by.1.attribute",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "group_by.1.tag_name",
                                "value": "city"
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "SWKLB"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参考