Parámetro

Un valor con nombre que necesita una función. Por ejemplo, la función integrada command necesita un parámetro llamado command. Usted proporciona los valores de los parámetros en el botón.

Algunos parámetros son obligatorios; otros son opcionales y tienen un valor predeterminado definido en el archivo de la función.

Pasar un valor desde un botón

Escriba el nombre del parámetro como clave directamente en el botón. Los campos integrados command, path y args siguen esta regla, al igual que los nombres de parámetros personalizados.

Proporcionar nombres de parámetros personalizados

Registros recientes del servicio

- name: Nginx logs
  type: button
  function: journal-unit
  unit: "nginx.service"
  lines: 100

unit y lines deben estar declarados por journal-unit. El valor numérico de lines no necesita comillas.

No use un mapa params: anidado

Un archivo de función personalizada usa params: para declarar sus parámetros. Un botón no. Escriba host:, unit: o cualquier otro valor directamente en el botón.

Validación

validate comprueba que:

• cada parámetro obligatorio tenga un valor;
• cada valor del botón esté declarado por su función;
• los valores declarados como int contengan un entero;
• los valores declarados como bool contengan un booleano válido;
• los valores predeterminados coincidan con el tipo declarado.

Los parámetros opcionales usan su valor predeterminado cuando el botón los omite.

Los nombres de parámetros no pueden coincidir con ajustes del botón: name, type, icon, id, function, confirm, timeout, workdir, env, columns o items. Los nombres command, path y args están permitidos.

Consulte Funciones → Pasar valores desde un botón para ver la explicación completa y ejemplos.

Configuración

Para los ajustes de botón y las claves de parámetros, consulte Configuración → Menú.

Relacionado

• Función — lo que usa los parámetros
• Reglas — reglas de parámetros para funciones personalizadas