docs_in_draft:autoshutdown

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
docs_in_draft:autoshutdown [2025/12/31 18:08] – chentedocs_in_draft:autoshutdown [2026/01/06 15:16] (current) – [Contenido del archivo autoshutdown.default] chente
Line 5: Line 5:
 ---- ----
 \\ \\
-<html><center><b>XXXX Plugin For OMV8</b></center></html>+<html><center><b>AutoShutdown Plugin For OMV8</b></center></html>
  
 {{ :omvextras_logo4.jpg?400 |}} {{ :omvextras_logo4.jpg?400 |}}
  
-====== XXXX Plugin For OMV8 ======+====== AutoShutdown Plugin For OMV8 ======
 \\ \\
 \\ \\
Line 15: Line 15:
 ===== Summary ===== ===== Summary =====
  
-XXXX +El complemento AutoShutdown permite apagar automáticamente el sistema cuando no hay actividad y, opcionalmente, programar el siguiente arranque mediante una alarma RTC.
  
-==== Third Party Software Note ====+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.
  
-(If applicable)\\ +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.
-\\ +
-While this OMV plugin makes the XXXXX package easy to integrate into openmediavault, the XXXXX package itself was created by a third party.  See the project / author's ->  XXXXX web page  for more detailed information and support. +
- +
-==== Acknowledgements ==== +
- +
-(If applicable)\\ +
-\\ +
-Credits to third party doc writers.+
  
 ===== Prerequisites ===== ===== Prerequisites =====
  
   * [[https://wiki.omv-extras.org/doku.php?id=misc_docs:omv_extras|OMV-Extras]] must be pre-installed.     * [[https://wiki.omv-extras.org/doku.php?id=misc_docs:omv_extras|OMV-Extras]] must be pre-installed.  
- 
- 
- 
- 
  
 ===== Installation ===== ===== Installation =====
  
 In OMV8's GUI:\\ In OMV8's GUI:\\
-Under **System**, **Plugins**, find and highlight **XXXX 6.X**, and click the **install** button. +Under **System**, **Plugins**, find and highlight **autoshutdown 8.X**, and click the **install** button.
- +
-===== Configuration ===== +
- +
-Place Holder\\ +
-\\ +
- +
-===== AutoShutdown Plugin para OpenMediaVault ===== +
- +
-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.+
  
 ==== Instalación ==== ==== Instalación ====
Line 65: Line 40:
 Este archivo contiene todas las opciones reales, comentarios explicativos y ejemplos. La GUI no expone todas las posibilidades. Este archivo contiene todas las opciones reales, comentarios explicativos y ejemplos. La GUI no expone todas las posibilidades.
  
-==== Conceptos básicos ====+===== Configuration =====
  
 AutoShutdown funciona en ciclos periódicos: 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.
  
-Cada X segundos, el plugin comprueba distintos indicadores de actividad.+==== General Settings ====
  
-Si ningún criterio bloquea el apagado, se incrementa el contador de ciclos.+  * **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
  
-Cuando se alcanza el número máximo de ciclos sin actividad, el sistema se apaga. +==== Forced Uptime ====
- +
-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. +
- +
-==== Opciones principales ==== +
- +
-=== Ciclos === +
- +
-Ciclos: Número de ciclos consecutivos sin actividad antes de apagar +
- +
-Segundos: Intervalo de tiempo entre cada ciclo +
- +
-Ejemplo: Ciclos = 6, Segundos = 300 → el sistema se apagará tras 30 minutos sin actividad. +
- +
-=== Comando de apagado === +
- +
-Apagar: Comando que se ejecuta para apagar el sistema +
- +
-Valor típico: shutdown -h now +
- +
-Puede personalizarse si se requiere lógica adicional. +
- +
-==== Tiempo en funcionamiento (ventana horaria) ====+
  
 Permite limitar el funcionamiento del servidor a una franja horaria concreta. Permite limitar el funcionamiento del servidor a una franja horaria concreta.
  
-Hora de inicio / Minuto de inicio +  * Habilite el botón **Forced Uptime** 
- +  * Defina los valores de inicio y fin
-Hora fin / Minuto fin+
  
 Fuera de esta ventana, el sistema podrá apagarse automáticamente. Fuera de esta ventana, el sistema podrá apagarse automáticamente.
Line 109: Line 72:
 Nota: Esta opción es obligatoria para poder usar la alarma de despertado. Nota: Esta opción es obligatoria para poder usar la alarma de despertado.
  
-==== Alarma para despertarse (RTC wake-up) ====+==== Wake Alarm ====
  
 Permite definir una hora de encendido automático usando el reloj RTC del sistema. 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.
  
-Hora +Si se ha habilitado Forced Uptime puede condicionar Wake alarm al horario definido. 
- +  * Habilite el boton **Set using 'Forced Uptime' begin time** 
-Minutos+    * El horario de inicio será el definido en Forced Uptime.
  
 Condiciones importantes: Condiciones importantes:
- +  * Solo se programa cuando AutoShutdown apaga el sistema 
-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
-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 Advertencia: Esta función no sustituye completamente al plugin Scheduled Alarms
  
-==== Configuración de supervisión ====+==== Supervision Configuration ====
  
 Estos criterios determinan si el sistema se considera activo. Estos criterios determinan si el sistema se considera activo.
Line 133: Line 95:
 === Supervisión de red === === Supervisión de red ===
  
-Rango de IPs: Lista de direcciones IP, rangos o FQDN que se escanean para detectar actividad+  * **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
  
-Soporta:+==== Syslog Configuration ====
  
-Rangos IPv4+  * 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
  
-Direcciones IPv4 individuales+===== Archivo autoshutdown.default =====
  
-Rangos IPv6+El archivo **/etc/autoshutdown.default** contiene **todas las opciones configurables** del plugin, incluyendo:
  
-Direcciones IPv6 individuales+  * 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
  
-FQDN+<note> 
 +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 
 +</note>
  
-Advertencia: En IPv4 asegúrese de excluir 1 y 255 del rango+==== Cómo usarlo ====
  
-Socket: Puerto TCP/UDP a comprobar para actividad+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.
  
-Tráfico de red (kB/s): Si el tráfico medio supera este valor, NO se apaga+==== Contenido del archivo autoshutdown.default ====
  
-=== Supervisión de discos ===+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]]
  
-E/S de HDD (kB/s): Si el valor medio de I/O del disco supera este umbral, NO se apaga +===== Ejemplos prácticos =====
- +
-Útil para evitar apagados durante copias o procesos intensivos. +
- +
-=== Carga del sistema === +
- +
-Carga media: Valor basado en load average +
- +
-Ejemplos: +
- +
-50 → carga 0.50 +
- +
-220 → carga 2.20 +
- +
-Si la carga supera este valor, el sistema se considera activo. +
- +
-=== Procesos === +
- +
-Procesos con carga: Procesos que bloquean el apagado si están activos +
- +
-Procesos temporales: Procesos que solo se revisan cuando están en ejecución +
- +
-Use - para deshabilitar una lista. +
- +
-=== Otros checks === +
- +
-Clientes SMB conectados +
- +
-Usuarios conectados al sistema +
- +
-Tests S.M.A.R.T. activos +
- +
-Plugins definidos por el usuario +
- +
-==== Plugins definidos por el usuario ==== +
- +
-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 +
- +
-Esto convierte AutoShutdown en un framework extensible, no solo un plugin básico. +
- +
-==== Syslog y depuración ==== +
- +
-Escribir en Syslog: Registra información en los logs del sistema +
- +
-Modo de información ampliada: Muestra detalles adicionales sobre cada ciclo +
- +
-Modo prueba/test: No apaga el sistema. Solo informa de qué criterio bloquea el apagado +
- +
-Nota: Muy recomendado durante la configuración inicial +
- +
-==== Ejemplos prácticos ====+
  
 === Servidor de respaldo === === Servidor de respaldo ===
- +  * Arranque automático: 06:00 
-Arranque automático: 06:00 +  * Ventana de funcionamiento: 06:00 – 08:00 
- +  * Apagado tras 30 min sin actividad 
-Ventana de funcionamiento: 06:00 – 08:00 +  * Supervisión de: tráfico de red y carga de disco
- +
-Apagado tras 30 min sin actividad +
- +
-Supervisión de: tráfico de red y carga de disco+
  
 === NAS doméstico === === NAS doméstico ===
- +  * Apagado nocturno automático 
-Apagado nocturno automático +  * No apagar si hay clientes SMB conectados 
- +  * No apagar si hay usuarios activos
-No apagar si hay clientes SMB conectados +
- +
-No apagar si hay usuarios activos+
  
 ==== Limitaciones conocidas ==== ==== Limitaciones conocidas ====
  • docs_in_draft/autoshutdown.1767204491.txt.gz
  • Last modified: 2025/12/31 18:08
  • by chente