8 Geomap

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 Geomap 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 Geomap, consulte o comportamento dos parâmetros descritos nas tabelas abaixo.

Parâmetros

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

Parameter type name value
Intervalo de atualização 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.
Grupos de host 2 groupids.0 ID do grupo de host.

Nota: Para configurar vários grupos de host, crie um objeto de campo do widget do dashboard para cada grupo de host com um número incrementado no nome da propriedade.

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Grupos de host (Widget) 1 groupids._reference Em vez do ID do grupo de host:
ABCDE._hostgroupids - defina um widget compatível (com seu parâmetro Reference definido como "ABCDE") como a fonte de dados para grupos de host.

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 grupo de host 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 seu 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.
Tags
Tipo de avaliação 0 evaltype 0 - (padrão) E/OU;
2 - Ou.

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Nome da tag 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 Tags

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Operador 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 Tags

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Valor da tag 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 Tags

Este parâmetro não é suportado ao configurar o widget em um template dashboard.
Visualização inicial 1 default_view latitude, longitude e nível de zoom separados por vírgula (opcional, valores possíveis de 0 a 30).
Exemplo: 40.6892494,-74.0466891,10.
Referência 1 reference Qualquer valor de string composto por 5 caracteres (por exemplo, ABCDE ou JBPNL). Esse valor deve ser exclusivo no dashboard ao qual o widget pertence.

Comportamento do parâmetro:
- obrigatório

Exemplos

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

Configurando um widget Geomap

Configure um widget Geomap que exibe hosts dos grupos de hosts "2" e "22" com base na seguinte configuração de tag: a tag com o nome "component" contém o valor "node" e a tag com o nome "location" é igual ao valor "New York". Além disso, defina a visualização inicial do mapa para as coordenadas "40.6892494" (latitude), "-74.0466891" (longitude) com o nível de zoom "10".

Requisição:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "geomap",
                        "name": "Geomap",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 22
                            },
                            {
                                "type": 2,
                                "name": "groupids.1",
                                "value": 2
                            },
                            {
                                "type": 1,
                                "name": "default_view",
                                "value": "40.6892494,-74.0466891,10"
                            },
                            {
                                "type": 0,
                                "name": "evaltype",
                                "value": 2
                            },
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "node"
                            },
                            {
                                "type": 1,
                                "name": "tags.1.tag",
                                "value": "location"
                            },
                            {
                                "type": 0,
                                "name": "tags.1.operator",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "tags.1.value",
                                "value": "New York"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Resposta:

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

Veja também