[comment]: # translation:outdated

[comment]: # ({38a58fd8-4df1faf7})
# 14 Hostnavigator

[comment]: # ({/38a58fd8-4df1faf7})

[comment]: # ({1c22a8ad-eca9765b})
### Beschrijving

Deze parameters en de mogelijke eigenschapswaarden voor de respectievelijke dashboardwidgetveldobjecten maken het mogelijk om de widget [*Host navigator*](/manual/web_interface/frontend_sections/dashboards/widgets/host_navigator) te configureren in de methoden `dashboard.create` en `dashboard.update`.

::: noteimportant
Widget `fields`-eigenschappen worden niet gevalideerd tijdens het maken of bijwerken van een dashboard.
Hierdoor kunnen gebruikers [ingebouwde widgets](/manual/web_interface/frontend_sections/dashboards/widgets) wijzigen en [aangepaste widgets](/devel/modules/tutorials/widget) maken, maar dit brengt ook het risico met zich mee dat widgets onjuist worden gemaakt of bijgewerkt.
Om de succesvolle creatie of update van de widget *Host navigator* te garanderen, raadpleegt u het parametergedrag dat in de onderstaande tabellen wordt beschreven.
:::

[comment]: # ({/1c22a8ad-eca9765b})

[comment]: # ({new-1636ce04})
### Parameters

The following parameters are supported for the *Host navigator* widget.

|Parameter|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-|--------|--|--------|-------------------------------|
|*Refresh interval*|<|0|rf_rate|0 - No refresh;<br>10 - 10 seconds;<br>30 - 30 seconds;<br>60 - *(default)* 1 minute;<br>120 - 2 minutes;<br>600 - 10 minutes;<br>900 - 15 minutes.|
|*Host groups*|<|2|groupids.0|[Host group](/manual/api/reference/hostgroup/get) ID.<br><br>Note: To configure multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|<|*Host groups (Widget)*|1|groupids.\_reference|Instead of [Host group](/manual/api/reference/hostgroup/get) ID:<br>`ABCDE._hostgroupids` - set a [compatible widget](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (with its *Reference* parameter set to "`ABCDE`") as the data source for host groups.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Host patterns*|<|1|hosts.0|[Host](/manual/api/reference/host/get) name or pattern.<br><br>Note: To configure multiple host patterns, create a dashboard widget field object for each host pattern with an incremented number in the property name. For multiple host patterns, the parameter *Host groups* must either be not configured at all or configured with at least one host group that the hosts matching the configured host patterns belong to.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Host status*|<|0|status|-1 - *(default)* Any;<br>0 - Enabled;<br>1 - Disabled.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Host tags*|<|<|<|<|
|<|*Evaluation type*|0|host_tags_evaltype|0 - *(default)* And/Or;<br>2 - Or.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Tag name*|1|host_tags.0.tag|Any string value.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Host tags*<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Operator*|0|host_tags.0.operator|0 - Contains;<br>1 - Equals;<br>2 - Does not contain;<br>3 - Does not equal;<br>4 - Exists;<br>5 - Does not exist.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Host tags*<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Tag value*|1|host_tags.0.value|Any string value.<br><br>Note: The number in the property name references tag order in the tag evaluation list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Host tags*<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Severity*|<|0|severities.0|0 - Not classified;<br>1 - Information;<br>2 - Warning;<br>3 - Average;<br>4 - High;<br>5 - Disaster.<br><br>Default: empty (all enabled).<br><br>Note: To configure multiple values, create a dashboard widget field object for each value with an incremented number in the property name.|
|*Show hosts in maintenance*|<|0|maintenance|0 - *(default)* Disabled;<br>1 - Enabled.|
|*Show problems*|<|0|show_problems|0 - All;<br>1 - *(default)* Unsuppressed;<br>2 - None.|
|*Group by*|<|<|<|<|
|<|*Attribute*|0|group_by.0.attribute|0 - Host group;<br>1 - Tag value;<br>2 - Severity.<br><br>Note: The number in the property name references attribute order in the grouping attribute list.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Group by*|
|^|*Value*|1|group_by.0.tag_name|Any string value.<br><br>Note: The number in the property name references the grouping attribute set in the *Attribute* parameter.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required* if configuring *Group by* and *Attribute* is set to "Tag value"|
|*Host limit*|<|0|show_lines|Possible values range from 1-9999.<br><br>Default: 100.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Reference*|<|1|reference|Any string value consisting of 5 characters (e.g., `ABCDE` or `JBPNL`). This value must be unique within the dashboard to which the widget belongs.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required*|

[comment]: # ({/new-1636ce04})

[comment]: # ({256a1b51-1d66ab00})
### Voorbeelden

De volgende voorbeelden zijn bedoeld om alleen de configuratie van de dashboardwidgetveldobjecten voor de *Host navigator*-widget te beschrijven.
Voor meer informatie over het configureren van een dashboard, zie [`dashboard.create`](/manual/api/reference/dashboard/create).

[comment]: # ({/256a1b51-1d66ab00})

[comment]: # ({new-0e8f355d})
#### Configuring a *Host navigator* widget

Configure a *Host navigator* widget that displays hosts grouped by their host group and, then, by the "city" tag value.

[Request](/manual/api#performing-requests):

```json
{
    "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
}
```

Response:

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

[comment]: # ({/new-0e8f355d})

[comment]: # ({e9d30322-5c9cbeda})
### Zie ook

-   [Dashboard-widgetveld](/manual/api/reference/dashboard/object#dashboard-widget-field)
-   [`dashboard.create`](/manual/api/reference/dashboard/create)
-   [`dashboard.update`](/manual/api/reference/dashboard/update)

[comment]: # ({/e9d30322-5c9cbeda})