Documentation
Table of Contents
> Objeto del tablero
Los siguientes objetos están directamente relacionados con la API dashboard.
Panel
El objeto del tablero tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| dashboardid | cadena | (sololectura) ID del tablero. |
| nombre (obligatorio) |
cadena | Nombre del tablero. |
| userid | cadena | ID de usuario del propietario del tablero. |
| private | número entero | Tipo de tablero compartido. Valores posibles: 0 - tablero público; 1 - (predeterminado) tablero privado. |
| display_period | número entero | Período de visualización de página predeterminado (en segundos). Valores posibles: 10, 30, 60, 120, 600, 1800, 3600. Predeterminado: 30. |
| auto_start | número entero | Iniciar presentación de diapositivas automáticamente. Valores posibles: 0 - no iniciar presentación de diapositivas automáticamente; 1 - (predeterminado) iniciar presentación de diapositivas automáticamente. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.
Página del panel de control
El objeto de la página del panel tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| paneldecontrol_iddepagina | cadena | (sololectura) ID de la página del panel. |
| nombre | cadena | Nombre de la página del panel decontrol. Predeterminado: cadena vacía. |
| mostrar_período | número entero | Periodo de visualización de la página del panel de control (en segundos). Valores posibles: 0, 10, 30, 60, 120, 600, 1800, 3600. Predeterminado: 0 (Utilizará el período de visualización de página predeterminado). |
| widgets | matriz | Matriz de widget del panel_de_control los objetos. |
Widget del panel de control
El objeto del widget del tablero tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| widgetid | cadena | (sololectura) ID del widget del tablero. |
| type (obligatorio) |
cadena | Tipo de widget del tablero. Valores posibles: actionlog - Action log; clock - Reloj; ( en desuso) dataover - Descripción general de datos; discovery - Estado de descubrimiento; favgraphs - Gráficas favoritas; favmaps - Mapas favoritos; graph - Gráfico (clásico); graphprototype - Prototipo de gráficas; hostavail - Disponibilidad de equipo; item - Valor de métrica; map - Mapa; navtree - Árbol de navegación del mapa; plaintext - Texto sin formato; problemhosts - Problemas de hosts;<br >problems - Problemas; problemsbysv - Problemas por gravedad; slareport - Informe SLA; svggraph - Gráfica; systeminfo - Información del sistema; tophosts - Principales hosts; trigover - Descripción general del iniciador; url - URL; web - Monitoreo web. |
| name | cadena | Personalizar nombre del widget. |
| x | número entero | Una posición horizontal desde el lado izquierdo del panel de control. Los valores válidos van de 0 a 23. |
| y | número entero | Una posición vertical desde la parte superior del panel de control. Los valores válidos van de 0 a 62. |
| width | número entero | El ancho del widget. Los valores válidos oscilan entre 1 y 24. |
| height | número entero | La altura del widget. Los valores válidos oscilan entre 2 y 32. |
| view_mode | número entero | El modo de vista del widget. Valores posibles: 0 - (predeterminado) vista predeterminada del widget; 1 - con encabezado oculto; |
| fields | matriz | Matriz de objetos de campo del widget del tablero . Obligatorio para widgets específicos; vea widgets individuales en campos de widgets del tablero. |
Campo del widget del tablero
El objeto de campo del widget del tablero tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type (obligatorio) |
entero | Tipo del campo del widget. Valores posibles: 0 - Entero; 1 - Cadena; 2 - Grupo de equipos; 3 - Equipo; 4 - Métrica; 5 - Prototipo de métrica; 6 - Gráfico; 7 - Prototipo de gráfico; 8 - Mapa; 9 - Servicio; 10 - SLA. |
| name (obligatorio) |
cadena | Nombre del campo del widget. Valores posibles: consulte Campos del widget del panel. |
| value (obligatorio) |
mixto | Valor del campo del widget según el tipo. Valores posibles: consulte Campos del widget del tablero . |
Grupo de usuarios del tablero
Lista de permisos del tablero basados en grupos de usuarios. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| usrgrpid (obligatorio) |
cadena | ID del grupo de usuarios. |
| permission (obligatorio) |
entero | Tipo de nivel de permiso. Valores posibles: 2 - solo lectura; 3 - lectura-escritura. |
Usuario del tablero
Lista de permisos del tablero basados en usuarios. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| userid (obligatorio) |
cadena | ID de usuario. |
| permission (obligatorio) |
entero | Tipo de nivel de permiso. Valores posibles: 2 - solo lectura; 3 - lectura-escritura. |