Incomplete Document
Not for public use
{{ :underconstruction.jpg?400 |}} \\ ---- \\
AutoShutdown Plugin For OMV8
{{ :omvextras_logo4.jpg?400 |}} ====== AutoShutdown Plugin For OMV8 ====== \\ \\ ===== Summary ===== El complemento AutoShutdown permite apagar automáticamente el sistema cuando no hay actividad y, opcionalmente, programar el siguiente arranque mediante una alarma RTC. Está pensado principalmente para servidores que no necesitan estar encendidos permanentemente (servidores de respaldo, NAS domésticos, servidores de pruebas, etc.), ayudando a reducir consumo eléctrico y desgaste del hardware. Nota: AutoShutdown no es un gestor de energía completo. El arranque automático solo se programa en el momento del apagado y depende del soporte RTC del hardware. ===== Prerequisites ===== * [[https://wiki.omv-extras.org/doku.php?id=misc_docs:omv_extras|OMV-Extras]] must be pre-installed. ===== Installation ===== In OMV8's GUI:\\ Under **System**, **Plugins**, find and highlight **autoshutdown 8.X**, and click the **install** button. ==== Instalación ==== Instalar el plugin desde OMV-Extras → Plugins → openmediavault-autoshutdown Activar el servicio desde Servicios → Apagado Automático (Opcional) Revisar el archivo de configuración base del plugin: /etc/autoshutdown.default Este archivo contiene todas las opciones reales, comentarios explicativos y ejemplos. La GUI no expone todas las posibilidades. ===== Configuration ===== AutoShutdown funciona en ciclos periódicos: * Cada X segundos, el plugin comprueba distintos indicadores de actividad. * Si ningún criterio bloquea el apagado, se incrementa el contador de ciclos. * Cuando se alcanza el número máximo de ciclos sin actividad, el sistema se apaga. * Si está configurada una alarma de despertado, se programa el RTC justo antes del apagado. * Si en cualquier ciclo se detecta actividad, el contador se reinicia. ==== General Settings ==== * **Cicles**: Número de ciclos consecutivos sin actividad antes de apagar * **Seconds**: Intervalo de tiempo entre cada ciclo * Ejemplo: Ciclos = 6, Segundos = 300 → el sistema se apagará tras 30 minutos sin actividad. * **Shutdown command**: Determina el método de apagado: * Shutdown * Hibernate * Suspend * Hybrid sleep * Suspend then Hibernate ==== Forced Uptime ==== Permite limitar el funcionamiento del servidor a una franja horaria concreta. * Habilite el botón **Forced Uptime** * Defina los valores de inicio y fin Fuera de esta ventana, el sistema podrá apagarse automáticamente. Nota: Esta opción es obligatoria para poder usar la alarma de despertado. ==== Wake Alarm ==== Permite definir una hora de encendido automático usando el reloj RTC del sistema. * Habilite el botón **Wake Alarm** * Defina la hora y minuto de encendido. Si se ha habilitado Forced Uptime puede condicionar Wake alarm al horario definido. * Habilite el boton **Set using 'Forced Uptime' begin time** * El horario de inicio será el definido en Forced Uptime. Condiciones importantes: * Solo se programa cuando AutoShutdown apaga el sistema * Si el sistema no llega a apagarse, la alarma no se programa * Requiere soporte de RTC wake-up en la BIOS/UEFI Advertencia: Esta función no sustituye completamente al plugin Scheduled Alarms ==== Supervision Configuration ==== Estos criterios determinan si el sistema se considera activo. === Supervisión de red === * **Ip-Range**: Lista de direcciones IP, rangos o FQDN que se escanean para detectar actividad * Soporta: * Rangos IPv4 * Direcciones IPv4 individuales * Rangos IPv6 * Direcciones IPv6 individuales * FQDN * Advertencia: En IPv4 asegúrese de excluir 1 y 255 del rango * **Socket**: Puerto TCP/UDP a comprobar para actividad * **ULDL Rate** (kB/s): Si el tráfico medio supera este valor, NO se apaga * **HDD-IO** (kB/s): Si el valor medio de I/O del disco supera este umbral, NO se apaga * Útil para evitar apagados durante copias o procesos intensivos. * **Load Average**: Carga media del sistema. Si la carga supera este valor, el sistema se considera activo. * Ejemplos: * 50 → carga 0.50 * 220 → carga 2.20 * **Active Processes**: (Use ''-'' para deshabilitar una lista) * **Load processes**: Procesos que bloquean el apagado si están activos * Por defecto: smbd,nfsd,mt-daapd,forked-daapd * **Temp processes**: Procesos que solo se revisan cuando están en ejecución * Por defecto: in.tftpd * **SMB status**: Clientes SMB conectados * **Users**: Usuarios conectados al sistema * **SMART Tests**: Tests S.M.A.R.T. activos * **Plugins**: * AutoShutdown permite añadir checks personalizados definidos por el usuario. * Se describen en: /etc/autoshutdown.default * Ejemplos: * No apagar si existe /tmp/backup.lock * No apagar si hay un rsync activo * Integración con scripts externos o contenedores ==== Syslog Configuration ==== * Habilita el botón "Log to syslog" para registrar información en los logs del sistema (syslog) * Habilita el botón **Verbose** para el modo de información ampliada: * Muestra detalles adicionales sobre cada ciclo * Habilita el botón **Fake** para activar el modo prueba: * No apaga el sistema. Solo informa de qué criterio bloquea el apagado * Muy recomendado durante la configuración inicial ===== Archivo autoshutdown.default ===== El archivo **/etc/autoshutdown.default** contiene **todas las opciones configurables** del plugin, incluyendo: * Ciclos y segundos de comprobación * Comando de apagado (shutdown, suspend, hibernate, hybrid, etc.) * Ventana horaria (Forced Uptime) * Alarma de encendido (Wake Alarm / RTC) * Supervisión de red (IP ranges, sockets, tráfico kB/s) * Supervisión de disco (HDD I/O) * Carga del sistema (Load Average) * Procesos activos (Load / Temp) * Usuarios y clientes SMB * Tests S.M.A.R.T. * Checks de plugins definidos por el usuario * Logs y modo verbose/test Editar este archivo permite **extender AutoShutdown** con tus propios checks o scripts personalizados. Por ejemplo: * No apagar si existe un archivo de bloqueo (/tmp/backup.lock) * No apagar si hay procesos de backup en ejecución (rsync, borg, etc.) * Integración con contenedores o servicios externos ==== Cómo usarlo ==== 1. Revisar el archivo y **comprender las variables**. 2. Habilitar/Deshabilitar opciones según necesidades del sistema. 3. Guardar cambios y **reiniciar el servicio AutoShutdown** desde la GUI: * System → Services → AutoShutdown → Stop / Start 4. Siempre probar primero con el **modo Fake / Test** para asegurarse de que los criterios de apagado funcionan como se espera. ==== Contenido del archivo autoshutdown.default ==== Para ver la configuración completa en tiempo real, consulte el archivo en GitHub: [[https://raw.githubusercontent.com/OpenMediaVault-Plugin-Developers/openmediavault-autoshutdown/master/etc/autoshutdown.default|autoshutdown.default]] ===== Ejemplos prácticos ===== === Servidor de respaldo === * Arranque automático: 06:00 * Ventana de funcionamiento: 06:00 – 08:00 * Apagado tras 30 min sin actividad * Supervisión de: tráfico de red y carga de disco === NAS doméstico === * Apagado nocturno automático * No apagar si hay clientes SMB conectados * No apagar si hay usuarios activos ==== Limitaciones conocidas ==== El wake-up RTC depende del hardware En SBC (Raspberry Pi, algunos ARM) puede no funcionar Si el sistema no se apaga, no se programa el siguiente arranque ==== Enlaces útiles ==== Repositorio del plugin AutoShutdown Archivo de configuración por defecto (autoshutdown.default) Debian man pages: rtcwake, shutdown, wakeonlan ==== Recomendaciones finales ==== Use siempre modo test antes de activar el apagado real Documente cualquier personalización en autoshutdown.default Para escenarios complejos o críticos, considere usar Scheduled Alarms junto con AutoShutdown ===== Source Code ===== -> [[https://github.com/OpenMediaVault-Plugin-Developers/openmediavault-XXXXX|Source Code]]