Table of Contents
Objeto dashboard
Os seguintes objetos estão diretamente relacionados à API dashboard.
Dashboard
O objeto dashboard possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| dashboardid | ID | ID do dashboard. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| name | string | Nome do dashboard. Comportamento da propriedade: - obrigatório para operações de criação |
| userid | ID | ID do usuário que é o proprietário do dashboard. |
| private | integer | Tipo de compartilhamento do dashboard. Valores possíveis: 0 - dashboard público; 1 - (padrão) dashboard privado. |
| display_period | integer | Período padrão de exibição da página (em segundos). Valores possíveis: 10, 30, 60, 120, 600, 1800, 3600. Padrão: 30. |
| auto_start | integer | Iniciar apresentação de slides automaticamente. Valores possíveis: 0 - não iniciar apresentação de slides automaticamente; 1 - (padrão) iniciar apresentação de slides automaticamente. |
Página do dashboard
O objeto da página do dashboard possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| dashboard_pageid | ID | ID da página do dashboard. Comportamento da propriedade: - somente leitura |
| name | string | Nome da página do dashboard. Padrão: string vazia. |
| display_period | integer | Período de exibição da página do dashboard (em segundos). Valores possíveis: 0, 10, 30, 60, 120, 600, 1800, 3600. Padrão: 0 (será usado o período de exibição padrão da página). |
| widgets | array | Array de objetos dashboard widget. |
Widget do dashboard
O objeto widget do dashboard possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| widgetid | ID | ID do widget do dashboard. Comportamento da propriedade: - somente leitura |
| type | string | Tipo do widget do dashboard. Valores possíveis: actionlog - Log de ação; clock - Relógio; discovery - Status de descoberta; favgraphs - Gráficos favoritos; favmaps - Mapas favoritos; gauge - Medidor; geomap - Geomapa; graph - Gráfico (clássico); graphprototype - Protótipo de gráfico; honeycomb - Favo de mel; hostavail - Disponibilidade do host; hostcard - Cartão do host; hostnavigator - Navegador de host; itemcard - Cartão do item; itemhistory - Histórico do item; itemnavigator - Navegador de item; item - Valor do item; map - Mapa; navtree - Árvore de navegação do mapa; piechart - Gráfico de pizza; problemhosts - Hosts com problemas; problems - Problemas; problemsbysv - Problemas por severidade; slareport - Relatório de SLA; svggraph - Gráfico; systeminfo - Informações do sistema; tophosts - Principais hosts; topitems - Principais itens; toptriggers - Principais triggers; trigover - Visão geral de triggers; url - URL; web - Monitoramento web. Comportamento da propriedade: - obrigatório |
| name | string | Nome personalizado do widget. |
| x | integer | Posição horizontal a partir do lado esquerdo do dashboard. Os valores possíveis variam de 0 a 71. |
| y | integer | Posição vertical a partir do topo do dashboard. Os valores possíveis variam de 0 a 63. |
| width | integer | A largura do widget. Os valores possíveis variam de 1 a 72. |
| height | integer | A altura do widget. Os valores possíveis variam de 1 a 64. |
| view_mode | integer | O modo de visualização do widget. Valores possíveis: 0 - (padrão) visualização padrão do widget; 1 - com cabeçalho oculto; |
| fields | array | Array de objetos campo do widget do dashboard. Comportamento da propriedade: - veja widgets individuais em Campos do widget do dashboard |
Campo do widget do dashboard
O objeto de campo do widget do dashboard possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | integer | Tipo do campo do widget. Valores possíveis: 0 - Inteiro; 1 - String; 2 - Grupo de hosts; 3 - Host; 4 - Item; 5 - Protótipo de item; 6 - Gráfico; 7 - Protótipo de gráfico; 8 - Mapa; 9 - Serviço; 10 - SLA; 11 - Usuário; 12 - Ação; 13 - Tipo de mídia. Comportamento da propriedade: - obrigatório |
| name | string | Nome do campo do widget. Valores possíveis: veja Campos do widget do dashboard. Comportamento da propriedade: - obrigatório |
| value | mixed | Valor do campo do widget dependendo do tipo. Valores possíveis: veja Campos do widget do dashboard. Comportamento da propriedade: - obrigatório |
Grupo de usuários do dashboard
Lista de permissões do dashboard com base nos grupos de usuários. Possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| usrgrpid | ID | ID do grupo de usuários. Comportamento da propriedade: - obrigatório |
| permission | integer | Tipo de nível de permissão. Valores possíveis: 2 - somente leitura; 3 - leitura e gravação. Comportamento da propriedade: - obrigatório |
Usuário do dashboard
Lista de permissões do dashboard com base nos usuários. Possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| userid | ID | ID do usuário. Comportamento da propriedade: - obrigatório |
| permission | integer | Tipo de nível de permissão. Valores possíveis: 2 - somente leitura; 3 - leitura-escrita. Comportamento da propriedade: - obrigatório |