Nesta página
27 Principais hosts
Descrição
Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget de dashboard permitem configurar o widget Top hosts nos métodos dashboard.create e dashboard.update.
As propriedades fields do widget não são validadas durante a criação ou atualização de um dashboard.
Isso permite que os usuários modifiquem widgets internos e criem widgets personalizados, mas também introduz o risco de criar ou atualizar widgets incorretamente.
Para garantir a criação ou atualização bem-sucedida do widget Top hosts, consulte o comportamento dos parâmetros descrito nas tabelas abaixo.
Parâmetros
Os seguintes parâmetros são suportados para o widget Top hosts.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - Sem atualização; 10 - 10 segundos; 30 - 30 segundos; 60 - (padrão) 1 minuto; 120 - 2 minutos; 600 - 10 minutos; 900 - 15 minutos. |
|
| Host groups | 2 | groupids.0 | ID do Host group. Nota: Para configurar vários host groups, crie um objeto de campo do widget do dashboard para cada host group com um número incrementado no nome da propriedade. Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Host groups (Widget) | 1 | groupids._reference | Em vez do ID do Host group:ABCDE._hostgroupids - defina um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados para host groups.Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Hosts | 3 | hostids.0 | ID do Host. Nota: Para configurar vários hosts, crie um objeto de campo do widget do dashboard para cada host com um número incrementado no nome da propriedade. Para vários hosts, o parâmetro Host groups deve não estar configurado ou deve estar configurado com pelo menos um host group ao qual os hosts configurados pertençam. Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Em vez do ID do Host:DASHBOARD.hostids - defina o seletor Host como a fonte de dados para hosts;ABCDE._hostids - defina um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados para hosts.Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Host tags | ||||
| Evaluation type | 0 | evaltype | 0 - (padrão) And/Or; 2 - Or. Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Tag name | 1 | tags.0.tag | Qualquer valor de string. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Host tags Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Operator | 0 | tags.0.operator | 0 - Contém; 1 - Igual a; 2 - Não contém; 3 - Não é igual a; 4 - Existe; 5 - Não existe. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Host tags Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Tag value | 1 | tags.0.value | Qualquer valor de string. Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags. Comportamento do parâmetro: - obrigatório ao configurar Host tags Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (padrão) Desativado; 1 - Ativado. |
|
| Columns (see below) | ||||
| Order by | 0 | column | Valor numérico da coluna entre as colunas configuradas. | |
| Order | 0 | order | 2 - (padrão) Top N; 3 - Bottom N. |
|
| Host limit | 0 | show_lines | Os valores possíveis variam de 1 a 1000. Padrão: 10. Este parâmetro não é suportado ao configurar o widget em um template dashboard. |
|
Colunas
As colunas possuem parâmetros comuns e parâmetros adicionais dependendo da configuração do parâmetro Data.
Para todos os parâmetros relacionados às colunas, o número no nome da propriedade (por exemplo, columns.0.name) faz referência a uma coluna para a qual o parâmetro está configurado.
Os seguintes parâmetros são suportados para todas as colunas.
| Parâmetro | tipo | nome | valor |
|---|---|---|---|
| Nome | 1 | columns.0.name | Qualquer valor de string. Comportamento do parâmetro: - obrigatório |
| Dados | 0 | columns.0.data | 1 - Valor do item; 2 - Nome do host; 3 - Texto. Comportamento do parâmetro: - obrigatório |
| Cor base | 1 | columns.0.base_color | Código de cor hexadecimal (por exemplo, FF0000).Comportamento do parâmetro: - obrigatório |
Valor do item
Os seguintes parâmetros são suportados se Data estiver definido como "Item value".
O primeiro número no nome da propriedade Thresholds (por exemplo, columnsthresholds.0.color.0) faz referência à coluna para a qual os thresholds estão configurados, enquanto o segundo número faz referência à posição do threshold em uma lista, classificada em ordem crescente.
No entanto, se os thresholds forem configurados em uma ordem diferente, os valores serão classificados em ordem crescente após a atualização da configuração do widget no frontend do Zabbix (por exemplo, "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parameter | type | name | value | |
|---|---|---|---|---|
| Item | 1 | columns.0.item | Nome válido do item. Ao configurar o widget em um template dashboard, somente os items configurados no template devem ser definidos. |
|
| Display item value as | 0 | columns.0.display_value_as | 0 - (padrão) Numérico; 1 - Texto; 2 - Binário. |
|
| Display | 0 | columns.0.display | 1 - (padrão) Como está; 2 - Barra; 3 - Indicadores; 6 - Sparkline. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" |
|
| Min | 1 | columns.0.min | Qualquer valor numérico. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Bar" ou "Indicators" |
|
| Max | 1 | columns.0.max | Qualquer valor numérico. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Bar" ou "Indicators" |
|
| Decimal places | 0 | columns.0.decimal_places | Valores possíveis de 0 a 10. Padrão: 2. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" |
|
| Sparkline | ||||
| Width | 0 | columns.0.sparkline.width | Valores possíveis de 0 a 10. Padrão: 1. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Sparkline" |
|
| Fill | 0 | columns.0.sparkline.fill | Valores possíveis de 0 a 10. Padrão: 3. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Sparkline" |
|
| Color | 1 | columns.0.sparkline.color | Código de cor hexadecimal (por exemplo, FF0000).Padrão: 42A5F5.Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Sparkline" |
|
| Time period | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - define o seletor de Time period como a fonte de dados;ABCDE._timeperiod - define um widget compatível (com o parâmetro reference igual a ABCDE) como a fonte de dados.Padrão: DASHBOARD._timeperiodAlternativamente, você pode definir o período de tempo apenas nos parâmetros From e To. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Sparkline" |
|
| From | 1 | columns.0.sparkline.time_period.from | String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Sparkline" - obrigatório se columns.0.sparkline.time_period.to estiver definido |
|
| To | 1 | columns.0.sparkline.time_period.to | String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Sparkline" - obrigatório se columns.0.sparkline.time_period.from estiver definido |
|
| History data | 0 | columns.0.sparkline.history | 0 - (padrão) Automático; 1 - History; 2 - Trends. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" e Display estiver definido como "Sparkline" |
|
| Thresholds | ||||
| Color | 1 | columnsthresholds.0.color.0 | Código de cor hexadecimal (por exemplo, FF0000).Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" |
|
| Threshold | 1 | columnsthresholds.0.threshold.0 | Qualquer valor de string. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" |
|
| Highlights | ||||
| Color | 1 | columns.0.highlights.0.color | Código de cor hexadecimal (por exemplo, FF0000).Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Text" |
|
| Pattern | 1 | columns.0.highlights.0.pattern | Qualquer valor de string. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Text" |
|
| Show thumbnail | 0 | columns.0.show_thumbnail | 0 - (padrão) Desativado; 1 - Ativado. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Binary" |
|
| Aggregation function | 0 | columns.0.aggregate_function | 0 - (padrão) não usado; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - define o seletor de Time period como a fonte de dados;ABCDE._timeperiod - define um widget compatível (com o parâmetro reference igual a ABCDE) como a fonte de dados.Padrão: DASHBOARD._timeperiodAlternativamente, você pode definir o período de tempo apenas nos parâmetros From e To. Comportamento do parâmetro: - suportado se Aggregation function estiver definido como "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 1 | columns.0.time_period.from | String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Time period não estiver definido e Aggregation function estiver definido como "min", "max", "avg", "count", "sum", "first", "last" - obrigatório se columns.0.time_period.to estiver definido- obrigatório se columns.0.time_period.to estiver definido |
|
| To | 1 | columns.0.time_period.to | String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou relativa (now, now/d, now/w-1w, etc.).Comportamento do parâmetro: - suportado se Time period não estiver definido e Aggregation function estiver definido como "min", "max", "avg", "count", "sum", "first", "last" - obrigatório se columns.0.time_period.from estiver definido |
|
| History data | 0 | columns.0.history | 0 - (padrão) Automático; 1 - History; 2 - Trends. Comportamento do parâmetro: - suportado se Display item value as estiver definido como "Numeric" |
|
| Reference | 1 | reference | Qualquer valor de string composto por 5 caracteres (por exemplo, ABCDE ou JBPNL). Esse valor deve ser exclusivo dentro do dashboard ao qual o widget pertence.Comportamento do parâmetro: - obrigatório |
|
Texto
Os seguintes parâmetros são suportados se Data estiver definido como "Texto".
| Parâmetro | tipo | nome | valor |
|---|---|---|---|
| Texto | 1 | columns.0.text | Qualquer valor de string, incluindo macros. Macros suportadas: {HOST.*}, {INVENTORY.*}. Comportamento do parâmetro: - obrigatório se Data estiver definido como "Texto" |
Exemplos
Os exemplos a seguir têm como objetivo apenas descrever a configuração dos objetos de campo do widget de dashboard para o widget Top hosts.
Para mais informações sobre como configurar um dashboard, consulte dashboard.create.
Configurando um widget Top hosts
Configure um widget Top hosts que exibe os principais hosts por utilização de CPU no grupo de hosts "4". Além disso, configure as seguintes colunas personalizadas: "Nome do host", "Utilização da CPU em %", "1m avg", "5m avg", "15m avg", "Processos".
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "columns.0.name",
"value": "Host"
},
{
"type": 0,
"name": "columns.0.data",
"value": 2
},
{
"type": 1,
"name": "columns.0.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.1.name",
"value": "CPU utilization in %"
},
{
"type": 0,
"name": "columns.1.data",
"value": 1
},
{
"type": 1,
"name": "columns.1.base_color",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.1.item",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.1.display",
"value": 3
},
{
"type": 1,
"name": "columns.1.min",
"value": "0"
},
{
"type": 1,
"name": "columns.1.max",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.1.color.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.1.color.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.1.color.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.2",
"value": "90"
},
{
"type": 1,
"name": "columns.2.name",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.2.data",
"value": 1
},
{
"type": 1,
"name": "columns.2.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.2.item",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.3.name",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.3.data",
"value": 1
},
{
"type": 1,
"name": "columns.3.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.3.item",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.4.name",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.4.data",
"value": 1
},
{
"type": 1,
"name": "columns.4.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.4.item",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.5.name",
"value": "Processes"
},
{
"type": 0,
"name": "columns.5.data",
"value": 1
},
{
"type": 1,
"name": "columns.5.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.5.item",
"value": "Number of processes"
},
{
"type": 0,
"name": "columns.5.decimal_places",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}