27 Elements principals

Descripció

Aquests paràmetres i els possibles valors de propietat per als objectes de camp del giny del tauler de control respectius permeten configurar el giny Elements principals als mètodes dashboard.create i dashboard.update.

Les propietats dels camps del giny no es validen pas durant la creació o actualització d'un tauler. Això permet als usuaris modificarels ginys integrats i crear ginys personalitzats, però també afegeix el risc de creació o actualització incorrectes dels ginys. Per garantir la creació o actualització correcta del giny Elements principals, consulteu el comportament dels paràmetres que es descriuen a les taules següents.

Paràmetres

Els paràmetres següents són compatibles amb el giny Elements principals.

|Paràmetre|<|tipus|nom|valor| |-|--------|--|---------|---------------------------- -----| |Interval d'actualització|<|0|rf_rate|0 - Sense actualització;
10 - 10 segons;
30 - 30 segons;
60 - (per defecte) 1 minut;
120 - 2 minuts;
600 - 10 minuts;
900 - 15 minuts.| |Grups d'amfitrió|<|2|groupids.0|Grup d'amfitrió ID.

Nota: per configurar diversos grups d'amfitrió, creeu un widget de tauler objecte de camp per a cada grup d'equips amb un nombre incrementat al nom de la propietat.

Aquest paràmetre no s'admet si es configura el giny en una plantilla. tauler de control.| |<|Grups d'equips (Giny)|1|groupids._reference|En lloc de Grup d'amfitrió ID:
ABCDE._hostgroupids - establiu un giny compatible (amb el seu conjunt de paràmetres Reference a "ABCDE") com a font de dades per als grups d'equips.

Aquest paràmetre no s'admet si es configura el giny a un tauler de plantilla.| |Hosts|<|3|hostids.0|Host ID.

Nota: per configurar diversos amfitrions, creeu un objecte de camp de giny de tauler per a cada host amb un número incrementat al nom de la propietat. Per a diversos amfitrions, el paràmetre Grups d'equips no s'ha de configurar en absolut o bé s'ha de configurar com a mínim amb un grup d'equips al qual pertanyen els equips configurats.

Aquest paràmetre no s'admet si es configura el giny a un tauler de plantilla.| |<|Equips (Giny/Tauler)|1|hostids._reference|En lloc de Host ID:
DASHBOARD.hostids - establiu la Tria d'Equip com a font de dades per a equips;
ABCDE._hostids - estableix un giny compatible (amb el seu paràmetre Reference establert a "ABCDE") com a font de dades per als amfitrions.

Aquest paràmetre no s'admet si es configura el giny a una plantilla tauler de control.| |Etiquetes d'equips|<|<|<|<| |<|Tipus d'avaluació|0|host_tags_evaltype|0 - (per defecte) I/O;
2 - O.

Aquest paràmetre no s'admet si es configura el giny en un tauler de control de plantilla.| |^|Nom de l'etiqueta|1|host_tags.0.tag|Qualsevol valor de cadena.

Nota: el número del nom de la propietat fa referència a l'ordre de l'etiqueta a la llista d'avaluació d'etiquetes.

Comportament del paràmetre:
- obligatori si es configura etiquetes d'amfitrió

Aquest paràmetre no és suportat si es configura el widget en un tauler de plantilla.| |^|Operador|0|host_tags.0.operator|0 - Conté;
1 - És igual;
2 - No conté;
3 - No és igual;
4 - Existeix ;
5 - No existeix.

Nota: el número del nom de la propietat fa referència a l'ordre de l'etiqueta a la llista d'avaluació de l'etiqueta.

Paràmetre behavior:
- obligatori si es configura etiquetes d'equips

Aquest paràmetre no s'admet si es configura el giny a un tauler de plantilla.| |^|Valor de l'etiqueta|1|host_tags.0.value|Qualsevol valor de cadena.

Nota: el número del nom de la propietat fa referència a l'ordre de l'etiqueta a la llista d'avaluació d'etiquetes.

Comportament del paràmetre:
- obligatori si es configura etiquetes d'equips

Aquest paràmetre no és compatible si es configura el giny en un tauler de plantilla.| |Disposició|<|0|disposició|0 - (per defecte) Horitzontal;
1 - Vertical.| |Veure els problemes|<|0|mostra els_problemes|0 - Tots;
1 - (per defecte) No esborrat;
2 - Cap.| |Items (vegeu més avall)|<|<|<|<|

Configuració avançada

Els següents paràmetres de configuració avançada són compatibles amb el giny Elements principals.

|Paràmetre|<|tipus|nom|valor| |-|--------|--|---------|---------------------------- -----| |Comandes d'equips|<|<|<|<| |Ordenar per|<|0|host_ordering_order_by|0 - (per defecte) Nom de l'amfitrió;
3 - Valor de l'element.| |<|Patrons d'elements|1|host_ordering_item.0|Item nom o patró (p. ex., "*: Nombre de *valors per segon").

Nota: per configurar diversos patrons d'element, creeu un objecte de camp de giny de tauler per a cada patró d'element amb un nombre incrementat al nom de la propietat.

Quan configureu el giny al tauler de control de plantilla, només s'han d'establir els patrons dels elements configurats a la plantilla.

Comportament del paràmetre:
- obligatori si Ordena per s'estableix a "Valor de l'element"| |Ordre|<|0|host_ordering_order|2 - (per defecte) N superior;
3 - N. inferior| |Límit|<|0|host_ordering_limit|Els valors possibles oscil·len entre 1 i 100.

Per defecte: 10.| |Ordena d'articles|<|<|<|<| |Ordenar per|<|0|item_ordering_order_by|1 - Amfitrió;
2 - Nom de l'element;
3 - (per defecte) Valor de l'element.| |<|Patrons d'equips|1|item_ordering_host.0|Nom o patró d'Equip.

Nota: per configurar diversos patrons d'equips, creeu un tauler objecte camp de giny per a cada patró d'equip amb un nombre incrementat al nom de la propietat.

Comportament del paràmetre:
- obligatori si Ordenar per és establert a "Equip"| |Ordre|<|0|item_ordering_order|2 - (per defecte) N superior;
3 - N. inferior| |Límit|<|0|item_ordering_limit|Els valors possibles oscil·len entre 1 i 100.

Per defecte: 10.|

Columnes

El primer nombre del nom de la propietat (p. ex. columns.0.items.0, columns.0.item_tags_evaltype) representa la columna concreta, mentre que el segon nombre, si és present, representa l'entitat configurada (p. ex., patró d'element, etiqueta).

|Paràmetre|<|tipus|nom|valor| |-|--------|--|---------|---------------------------- -----| |Patrons d'element|<|1|columns.0.items.0|Item nom o patró (p. ex., "*: Nombre de *valors processats per segon").

Nota: per configurar diversos patrons d'elements, creeu un objecte de camp de widget de tauler per a cada patró d'element amb un segon nombre incrementat al nom de la propietat.

Quan configurant el widget en un tauler de control de plantilla, només s'han d'establir els patrons dels elements configurats a la plantilla.

Comportament dels paràmetres:
- obligatori| |Etiquetes d'element|<|<|<|<| |<|Tipus d'avaluació|0|columns.0.item_tags_evaltype|0 - (per defecte) I/O;
2 - Or.| |^|Nom de l'etiqueta|1|columns.0.item_tags.0.tag|Qualsevol valor de cadena.

Nota: el segon nombre del nom de propietat fa referència a l'ordre de l'etiqueta a la llista d'avaluació d'etiquetes.<br >
Comportament del paràmetre:
- obligatori si es configura Etiquetes d'element| |^|Operador|0|columns.0.item_tags.0.operator|0 - Conté;
1 - És igual;
2 - No conté;
3 - No és igual;<br >4 - Existeix;
5 - No existeix.

Nota: el segon nombre del nom de la propietat fa referència a l'ordre de l'etiqueta a l'avaluació de l'etiqueta llista.

Comportament del paràmetre:
- obligatori si s'està configurant Etiquetes d'element| |^|Valor de l'etiqueta|1|columns.0.item_tags.0.value|Qualsevol valor de cadena.

Nota: el segon nombre del nom de la propietat fa referència a l'ordre de l'etiqueta a la llista d'avaluació d'etiquetes.<br >
Comportament del paràmetre:
- obligatori si es configura Etiquetes d'element| |Color base|<|1|columns.0.color_base|Codi de color hexadecimal (p. ex., FF0000).| |Mostra el valor com a|<|0|columns.0.display_value_as|1 - (per defecte) Numèric;
2 - Text.| |Display|<|0|columns.0.display|1 - (per defecte) Tal com és;
2 - Barra;
3 - Indicadors;
6 - Sparkline.| |Min|<|1|columns.0.min|Qualsevol valor numèric. S'admeten Sufixos (p. ex., "1d", "2w", "4K", "8G").

Comportament dels paràmetres:
- admès si Mostra el valor com a s'estableix en "Numèric" i Display s'estableix en "Barra" o "Indicadors" | |Max|<|1|columns.0.max|Qualsevol valor numèric. S'admeten Sufixos (p. ex., "1d", "2w", "4K", "8G").

Comportament dels paràmetres:
- admès si Mostra el valor com a s'estableix en "Numèric" i Display s'estableix en "Barra" o "Indicadors" | |Sparkline|<|<|<|<| |<|Width|0|columns.0.sparkline.width|Els valors possibles oscil·len entre 0 i 10.

Per defecte: 1.

Comportament del paràmetre:
- supported si Display és establert en "Sparkline"| |^|Fill|0|columns.0.sparkline.fill|Els valors possibles oscil·len entre 0 i 10.

Per defecte: 3.

Comportament del paràmetre:
- supported si Display és establert en "Sparkline"| |^|Color|1|columns.0.sparkline.color|Codi de color hexadecimal (p. ex., FF0000).

Per defecte: 42A5F5.

Comportament del paràmetre:
- supported si Display és establert en "Sparkline"| |^|Període de temps|1|columns.0.sparkline.time_period._reference|DASHBOARD._timeperiod - estableix el Time period selector com a font de dades;< br>ABCDE._timeperiod - estableix un compatible widget (amb el seu paràmetre reference igual a ABCDE) com a font de dades.

Per defecte: DASHBOARD._timeperiod< br>
Com alternativa, podeu establir el període de temps només a De i A paràmetres.

Comportament dels paràmetres:
- admès si Display és establert en "Sparkline" | |^|From|1|columns.0.sparkline.time_period.from|Cadena de temps vàlida en absolut (AAAA-MM-DD hh:mm:ss) o relatiu sintaxi de temps ('ara', 'ara/d', 'ara/w-1w', etc.).

Comportament dels paràmetres:
- admès si Display s'estableix en "Sparkline"| |^|To|1|columns.0.sparkline.time_period.to|Cadena de temps vàlida en absolut (AAAA-MM-DD hh:mm:ss) o relatiu sintaxi de temps (ara, ara/d, ara/w-1w, etc.).

Paràmetre behavior:
- admesa si Display és definit en "Sparkline"| |^|Dades de l'historial|0|columns.0.sparkline.history|0 - (per defecte) Automàtic;
1 - Historial;
2 - Tendències.

Comportament del paràmetre:
- supported si Display és establert en "Sparkline"| |Llindars|<|<|<|<| |<|Color|1|columns.0.thresholds.0.color|Codi de color hexadecimal (per exemple, FF0000).

Comportament del paràmetre:
- admès si Mostra el valor com a està definit en "Numèric"| |^|Llindar|1|columns.0.thresholds.0.threshold|Qualsevol valor numèric. S'admeten Sufixos (p. ex., "1d", "2w", "4K", "8G").

Comportament dels paràmetres:
- admès si Mostra el valor com a s'estableix en "Numèric"| |Destacats|<|<|<|<| |<|Highlight|1|columns.0.highlights.0.color|Codi de color hexadecimal (per exemple, FF0000).

Comportament del paràmetre:
- admesa si Mostra el valor com a s'estableix en "Text"| |^|Llindar|1|columns.0.highlights.0.pattern|Qualsevol expressió regular.

Comportament del paràmetre:
- admès si Mostra el valor com a s'estableix en "Text"| |Llocs decimals|<|0|columns.0.llocs_decimals|Els valors possibles oscil·len entre 0 i 10.

Per defecte: 2.| |Configuració avançada|<|<|<|<| |Funció d'agregació|<|0|columns.0.aggregate_function|Si Mostra el valor com a s'estableix en "Numèric":
0 - (per defecte) no utilitzat;
1 - min;< br>2 - màxim;
3 - mitjana;
4 - recompte;
5 - suma;
6 - primer;
7 - últim.

Si Mostra el valor com a està definit com a "Text":
0 - (per defecte) no utilitzat;
4 - recompte;
6 - primer;<br >7 - darrer.| |Període de temps|<|1|columns.0.time_period._reference|DASHBOARD._timeperiod - estableix el Time period selector com a font de dades;
ABCDE._timeperiod - estableix un compatible widget (amb el seu paràmetre reference igual a ABCDE) com a font de dades.

Per defecte: DASHBOARD._timeperiod< br>
Com alternativa, podeu establir el període de temps només a De i A paràmetres.

Comportament del paràmetre:
- admès si la funció d'agregació s'estableix en "mínim", "màx", "mitjana". ", "compte", "suma", "primer", "últim"| |<|From|1|columns.0.time_period.from|Cadena de temps vàlida en la sintaxi temporal absoluta (AAAA-MM-DD hh:mm:ss) o relativa (ara, ara/d, ara/w-1w, etc.).

Paràmetre behavior:
- admès si no s'estableix Període de temps i la Funció d'agregació s'estableix en "mínim", "màx", "mitjana", "compte", "suma", "primer", "últim"| |^|To|1|columns.0.time_period.to|Cadena de temps vàlida en sintaxi de temps absoluta (AAAA-MM-DD hh:mm:ss) o relativa (ara, ara/d, ara/w-1w, etc.).

Paràmetre behavior:
- admès si no s'estableix Període de temps i la Funció d'agregació s'estableix en "mínim", "màx", "mitjana", "compte", "suma", "primer", "últim"| |Dades de l'historial|<|0|columns.0.history|0 - (per defecte) Automàtic;
1 - Historial;
2 - Tendències.

Comportament dels paràmetres:
- supported si Mostra el valor com a és establert en "Numèric"|

Exemples

Els exemples següents només tenen com a objectiu descriure la configuració dels objectes de camp del giny del tauler de control per al giny Elements principals. Per obtindre més informació sobre la configuració d'un tauler, veieu dashboard.create.

Configuració d'un giny Elements principals

Configureu un giny Elements principals que ensenyi dades per a l'equip "10084" i només per als elements per als quals l'etiqueta amb el nom "component" conté el valor "cpu". A més, mostreu les dades amb els equips situats a la part superior i empreu una barra de color per a la representació de les cel·les.

Petició:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "topitems",
                               "name": "Top items",
                               "x": 0,
                               "y": 0,
                               "width": 36,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 3,
                                       "name": "hostids.0",
                                       "value": 10084
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.0.items.0",
                                       "value": "*"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.0.item_tags.0.tag",
                                       "value": "component"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.0.item_tags.0.operator",
                                       "value": 0
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.0.item_tags.0.value",
                                       "value": "cpu"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.0.display",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "layout",
                                       "value": 1
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

Resposta:

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

Veieu també