Documentation
Table of Contents
Objecte de macros d'usuaris
Els següents objectes són relacionats amb l'API usermacro.
Macro global
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| globalmacroid | ID | ID de macro global. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| description | cadena | Descripció de la macro. |
| macro | cadena | Cadena de macro. Comportament de la propietat: - obligatori per operacions de creació |
| type | enter | Tipus de la macro. Valors possibles: 0 - (per defecte) Text de la macro; 1 - Macro secreta; 2 - Secret de caixa de cabals. |
| value | cadena | Valor de la macro. Comportament de la propietat: - només lectura - només escriptura si type és "Macro secreta"- obligatori per operacions de creació |
Macro d'equip
L'objecte defineix una macro disponible a un equip, prototip d'equip o plantilla. Té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| hostmacroid | ID | ID de la macro d'equip. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| automàtic | integer | Defineix si la macro és controlada per la regla de descoberta. Valors possibles: 0 - (per defecte) La macro la gestiona l'usuari; 1 - La macro la gestiona la regla de descoberta. L'usuari no pot crear una macro automàtica. Per actualitzar la macro automàtica, s'ha de convertir a manual. |
| config | object/array | Configuració de macro responsable de com es mostra la macro a l'Auxiliar d'equip. |
| description | string | Descripció de la macro. |
| hostid | string | ID de l'equip a qui pertany la macro. Comportament de la propietat: - constant - obligatori per operacions de creació |
| macro | string | Cadena de la macro. Comportament de la propietat: - obligatori per operacions de creació |
| type | integer | Tipus de la macro. Valors possibles: 0 - (per defecte) Text de la macro; 1 - Macro secreta; 2 - Secret de caixa de cabals. |
| value | string | Valor de la macro. Comportament de la propietat: - només escriptura si type és "Macro secreta"- obligatori per operacions de creació |
Configuració de macros
L'objecte de configuració de macros defineix com es veu una macro a l'Auxiliar d'equip.
| Propietat | Tipus | Descripció |
|---|---|---|
| tipus | enter | Tipus de camp d'entrada de macro. Valors possibles: 0 - La macro no s'utilitza a l'Auxiliar d'equip; 1 - Quadre de text; 2 - Llista; 3 - Casella de selecció. Comportament de la propietat: - obligatori |
| label | cadena | Etiqueta per al camp d'entrada de macro. Comportament de la propietat: - obligatori si type és definit a "Quadre de text", "Llista" o "Casella de selecció" |
| description | text | Text d'ajuda que es mostra al costat del camp d'entrada de macro. Admet el format Markdown. |
| priority | enter | Posició del camp d'entrada de macro a la llista de macros. Si priority no és definit, la macro s'afegeix al final de la llista de macros no agrupades. |
| required | enter | Marca la macro com a obligatòria. Valors possibles: 0 - No obligatori; 1 - Obligatori. Comportament de la propietat: - admès si type és definit a "Quadre de text" o "Llista" |
| regex | cadena | Expressió regular per validar l'entrada de l'usuari en un camp de quadre de text. Comportament de la propietat: - admès si type està definit com a "Quadre de text" |
| section_name | string | Etiqueta de la secció plegable on s'agrupa la macro. Si section_name no és definit, la macro es desagrupa. Les macros desagrupades es mostren primer; Les macros agrupades es veuen tot seguit, ordenades per la seva prioritat dins de cada secció plegable. |
| opcions | text | Cadena JSON que defineix elements de llista o valors de casella de selecció. Per a llistes: una matriu d'objectes amb les propietats valor i text.Exemple: [{"valor": "http", "text": "HTTP"}, {"valor": "https", "text": "HTTPS"}]Per a caselles de selecció: un objecte amb les propietats marcat i no marcat.Exemple: {"marcat": true, "no marcat": false}Comportament de la propietat: - requerit si tipus és definit com a "Llista" o "Casella de selecció" |