Saltar al contenido principal

Comandos CLI

:::info[Command Estructura

All commands follow the pattern: unraid-api <command> [options]

:::

🚀 Gestión de Servicios​

Iniciar​

unraid-api start [--log-level <level>]

Inicia el servicio de API de Unraid.

Opciones:

  • --log-level: Establecer nivel de registro (trace|debug|info|warn|error|fatal)

Alternativa: También puedes establecer el nivel de registro usando la variable de entorno LOG_LEVEL:

LOG_LEVEL=trace unraid-api start

Detener​

unraid-api stop [--delete]

Detiene el servicio de API de Unraid.

  • --delete: Opcional. Eliminar el directorio principal de PM2

Reiniciar​

unraid-api restart [--log-level <level>]

Reinicia el servicio de API de Unraid.

Opciones:

  • --log-level: Establecer nivel de registro (trace|debug|info|warn|error|fatal)

Alternativa: También puedes establecer el nivel de registro usando la variable de entorno LOG_LEVEL:

LOG_LEVEL=trace unraid-api restart

Registros​

unraid-api logs [-l <lines>]

Ver los registros de la API.

  • -l, --lines: Opcional. Número de líneas para mostrar (predeterminado: 100)

⚙️ Comandos de Configuración​

Configuración​

unraid-api config

Muestra los valores de configuración actuales.

Cambiar Entorno​

unraid-api switch-env [-e <environment>]

Cambiar entre entornos de producción y pruebas.

  • -e, --environment: Opcional. Entorno de destino (producción|staging)

Modo Desarrollador​

Web Gestión de GUI

También puedes gestionar opciones de desarrollador a través de la interfaz web en Configuraciones → Acceso de Gestión → Opciones de Desarrollador

unraid-api developer                       # Prompt interactivo para herramientas
unraid-api developer --sandbox true        # Habilitar sandbox de GraphQL
unraid-api developer --sandbox false       # Deshabilitar sandbox de GraphQL
unraid-api developer --enable-modal        # Habilitar herramienta de pruebas modal
unraid-api developer --disable-modal       # Deshabilitar herramienta de pruebas modal

Configura las características del desarrollador para la API:

  • Sandbox GraphQL: Habilitar/deshabilitar sandbox de Apollo GraphQL en /graphql
  • Herramienta de Pruebas Modal: Habilitar/deshabilitar pruebas de interfaz modal en el menú de Unraid

Gestión de Claves API​

Web Gestión de GUI

También puedes gestionar las claves de API a través de la interfaz web en Configuraciones → Acceso de Gestión → Claves API

Comandos de Clave API​

unraid-api apikey [opciones]

Crear y gestionar claves API mediante CLI.

Opciones:

  • --name <name>: Name of the key
  • --create: Crear una nueva clave
  • -r, --roles <roles>: Lista separada por comas de funciones
  • -p, --permissions <permissions>: Comma-separated list of permissions
  • -d, --description <description>: Description for the key

Gestión de SSO (Inicio de Sesión Único)​

OIDC Configuración

Para la configuración del proveedor OIDC/SSO, consulta la interfaz web en Configuraciones → Acceso de Gestión → API → OIDC o consulta la guía Configuración del Proveedor OIDC.

Comando Base de SSO​

unraid-api sso

Agregar Usuario SSO​

unraid-api sso add-user
# o
unraid-api sso add
# o
unraid-api sso a

Agregar un nuevo usuario para autenticación SSO.

Eliminar Usuario SSO​

unraid-api sso remove-user
# o
unraid-api sso remove
# o
unraid-api sso r

Eliminar un usuario (o todos los usuarios) de SSO.

Listar Usuarios SSO​

unraid-api sso list-users
# o
unraid-api sso list
# o
unraid-api sso l

Listar todos los usuarios SSO configurados.

Validar Token SSO​

unraid-api sso validate-token <token>
# o
unraid-api sso validate
# o
unraid-api sso v

Valida un token SSO y devuelve su estado.

Generación de Informes​

Generar Informe​

unraid-api report [-r] [-j]

Generar un informe del sistema.

  • -r, --raw: Mostrar salida en crudo de comando
  • -j, --json: Mostrar salida en formato JSON

Notas​

  1. La mayoría de los comandos requieren permisos apropiados para modificar el estado del sistema
  2. Algunos comandos requieren que la API esté en ejecución o detenida.
  3. Guarda las claves de la API de forma segura ya que proporcionan acceso al sistema
  4. Los cambios de configuración de SSO pueden requerir un reinicio del servicio