Saltar al contenido principal

Comandos CLI

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)

Opciones:

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)

Opciones:

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|pruebas).

Modo desarrollador​

También puedes gestionar las opciones de desarrollador a través de la interfaz web en Settings → Management Access → Developer Options en la WebGUI.

unraid-api developer                       # Interactive prompt for tools
unraid-api developer --sandbox true        # Enable %%GraphQL|graphql%% sandbox
unraid-api developer --sandbox false       # Disable %%GraphQL|graphql%% sandbox
unraid-api developer --enable-modal        # Enable modal testing tool
unraid-api developer --disable-modal       # Disable modal testing tool

Configura las características del desarrollador para la API:

  • GraphQL Sandbox: Habilitar/deshabilitar el 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​

También puedes gestionar las claves API a través de la interfaz web en Settings → Management Access → API Keys en la WebGUI.

Comandos de clave API​

unraid-api apikey [options]

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)​

Para la configuración del proveedor OIDC/SSO, consulta la interfaz web en Settings → Management Access → API → OIDC en la WebGUI o consulta la guía OIDC Provider Setup.

Comando base de SSO​

unraid-api sso

Opciones:

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

Eliminar usuario SSO:

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

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.

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

Validar token SSO:

Valida un token SSO y devuelve su estado.

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

Generación de informes​

Eliminar Usuario SSO​

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

Valida un token SSO y devuelve su estado.

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

La mayoría de los comandos requieren los permisos adecuados para modificar el estado del sistema. Algunos comandos requieren que la API esté en ejecución o detenida. Almacena las claves API de forma segura, ya que proporcionan acceso al sistema. Los cambios de configuración de SSO pueden requerir reiniciar el servicio.