17 Navegador de item

Descrição

Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget do dashboard permitem configurar o widget Navegador de item 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 Navegador de item, consulte o comportamento dos parâmetros descrito nas tabelas abaixo.

Parâmetros

Os seguintes parâmetros são suportados para o widget Item navigator.

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 compatible widget (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.hostid - defina o Host selector como a fonte de dados para hosts;
ABCDE._hostid - defina um compatible widget (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 host_tags_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 host_tags.0.tag Qualquer valor de string.

Nota: O número no nome da propriedade referencia a ordem da tag na lista de avaliação de tags.

Parameter behavior:
- obrigatório ao configurar Host tags

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Operator 0 host_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 referencia a ordem da tag na lista de avaliação de tags.

Parameter behavior:
- obrigatório ao configurar Host tags

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Tag value 1 host_tags.0.value Qualquer valor de string.

Nota: O número no nome da propriedade referencia a ordem da tag na lista de avaliação de tags.

Parameter behavior:
- obrigatório ao configurar Host tags

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Item patterns 1 items.0 Nome ou padrão do Item.

Nota: Para configurar vários padrões de item, crie um objeto de campo do widget do dashboard para cada padrão de item com um número incrementado no nome da propriedade.
Item tags
Evaluation type 0 item_tags_evaltype 0 - (padrão) And/Or;
2 - Or.
Tag name 1 item_tags.0.tag Qualquer valor de string.

Nota: O número no nome da propriedade referencia a ordem da tag na lista de avaliação de tags.

Parameter behavior:
- obrigatório ao configurar Item tags
Operator 0 item_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 referencia a ordem da tag na lista de avaliação de tags.

Parameter behavior:
- obrigatório ao configurar Item tags
Tag value 1 item_tags.0.value Qualquer valor de string.

Nota: O número no nome da propriedade referencia a ordem da tag na lista de avaliação de tags.

Parameter behavior:
- obrigatório ao configurar Item tags
State 0 state -1 - (padrão) Todos;
0 - Normal;
1 - Não suportado.
Show problems 0 show_problems 0 - Todos;
1 - (padrão) Sem supressão;
2 - Nenhum.
Group by
Attribute 0 group_by.0.attribute 0 - Host group;
1 - Nome do host;
2 - Valor da tag do host;
3 - Valor da tag do item.

Nota: O número no nome da propriedade referencia a ordem do atributo na lista de atributos de agrupamento.

Parameter behavior:
- obrigatório ao configurar Group by
Value 1 group_by.0.tag_name Qualquer valor de string.

Nota: O número no nome da propriedade referencia o atributo de agrupamento definido no parâmetro Attribute.

Parameter behavior:
- obrigatório ao configurar Group by e Attribute estiver definido como "Valor da tag do host" ou "Valor da tag do item"
Item limit 0 show_lines Os valores possíveis variam de 1 a 9999.

Padrão: 100.
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.

Parameter behavior:
- obrigatório

Exemplos

Os exemplos a seguir têm como objetivo descrever apenas a configuração dos objetos de campo do widget do painel para o widget Navegador de item. Para mais informações sobre como configurar um painel, consulte dashboard.create.

Configurando um widget Navegador de item

Configure um widget Navegador de item que exibe até 1000 items agrupados por seu host e, em seguida, pelo valor da tag de item "component".

Requisição:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemnavigator",
                        "name": "Item navigator",
                        "x": "0",
                        "y": "0",
                        "width": "12",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 0,
                                "name": "group_by.0.attribute",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "group_by.1.attribute",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "group_by.1.tag_name",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "show_lines",
                                "value": 1000
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "DFNLK"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Resposta:

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

Veja também