Volver a los resultados
  • Linux

Guía completa: cómo utilizar un script de Linux para comprobar la existencia de archivos o carpetas

  • por Team Ninja

Garantizar la integridad y la presencia de archivos y directorios críticos es primordial en la gestión informática. Tanto si eres un profesional de TI como un proveedor de servicios gestionados (MSP), realizar un seguimiento de los archivos esenciales del sistema o de los directorios de aplicaciones específicas puede ayudar a mantener la estabilidad, la seguridad y el cumplimiento del sistema. Aquí es donde entran en juego los scripts de automatización, en particular uno que puede comprobar la existencia de archivos o carpetas específicas dentro de un directorio o subdirectorio.

Contexto

El script para comprobar la existencia de archivos proporcionado ofrece una solución robusta para la búsqueda y alerta basada en la existencia de archivos o carpetas dentro de una ruta especificada. Este tipo de automatización es crucial en varios escenarios, como la verificación del éxito de la implantación, la supervisión de cambios no autorizados o la garantía de que las configuraciones críticas están en su sitio. Para los profesionales de TI y los MSP, el aprovechamiento de estos scripts puede mejorar la eficacia operativa y reducir los esfuerzos de supervisión manual.

El script para comprobar la existencia de archivos

#!/usr/bin/env bash

# Description: Alert if a specified file or folder is found in a directory or subdirectory you specify.
#
# Release Notes: Initial Release
# By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https://www.ninjaone.com/terms-of-use.
# Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. 
# Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. 
# Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. 
# Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. 
# Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. 
# Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. 
# EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).
#
# Below are all the (case sensitive) valid parameters for this script.
# Only the path to search and name of file or folder are required!
#
# Parameter: --path "/opt/NinjaRMM/programdata"
#   Required
#   Base path to search for files or folders.
#
# Parameter: --name "ninjarmm-cli"
#   Required
#   Name of the file or folder to search for.
#   Notes:
#       If the name is not provided, the script will search for the path only.
#       This is case sensitive and accepts wildcards.
#
# Parameter: --type "Files Or Folders"
#   Required
#   Search for files or folders.
#
# Parameter: --type "Files Only"
#   Required
#   Searches for files only.
#
# Parameter: --type "Folders Only"
#   Required
#   Searches for folder only.
#
# Parameter: --timeout 10
#   Optional and defaults to 30 minutes
#   Time in minutes to wait for the search to complete before timing out.
#
# Parameter: --customfield "myCustomField"
#   Optional
#   Custom Field to save the search results to.

die() {
    local _ret="${2:-1}"
    test "${_PRINT_HELP:-no}" = yes && print_help >&2
    echo "$1" >&2
    exit "${_ret}"
}

begins_with_short_option() {
    local first_option all_short_options='h'
    first_option="${1:0:1}"
    test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0
}

# Initize arguments
_arg_path=
_arg_name=
_arg_type=
_arg_timeout=30
_arg_customfield=

print_help() {
    printf '%s\n' "Check existence of a file or folder"
    printf 'Usage: %s [--path <arg>] [--name <arg>] [--type <"Files Only"|"Folders Only"|"Files Or Folders">] [--timeout <30>] [--customfield <arg>] [-h|--help]\n' "$0"
    printf '\t%s\n' "-h, --help: Prints help"
}

parse_commandline() {
    while test $# -gt 0; do
        _key="$1"
        case "$_key" in
        --path)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_path="$2"
            shift
            ;;
        --path=*)
            _arg_path="${_key##--path=}"
            ;;
        --name)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_name="$2"
            shift
            ;;
        --name=*)
            _arg_name="${_key##--name=}"
            ;;
        --type)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_type="$2"
            shift
            ;;
        --type=*)
            _arg_type="${_key##--type=}"
            ;;
        --timeout)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_timeout="$2"
            shift
            ;;
        --timeout=*)
            _arg_timeout="${_key##--timeout=}"
            ;;
        --customfield)
            test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1
            _arg_customfield="$2"
            shift
            ;;
        --customfield=*)
            _arg_customfield="${_key##--customfield=}"
            ;;
        -h | --help)
            print_help
            exit 0
            ;;
        -h*)
            print_help
            exit 0
            ;;
        *)
            _PRINT_HELP=yes die "FATAL ERROR: Got an unexpected argument '$1'" 1
            ;;
        esac
        shift
    done
}

parse_commandline "$@"

function SetCustomField() {
    customfieldName=$1
    customfieldValue=$2
    if [ -f "${NINJA_DATA_PATH}/ninjarmm-cli" ]; then
        if [ -x "${NINJA_DATA_PATH}/ninjarmm-cli" ]; then
            if "$NINJA_DATA_PATH"/ninjarmm-cli get "$customfieldName" >/dev/null; then
                # check if the value is greater than 10000 characters
                if [ ${#customfieldValue} -gt 10000 ]; then
                    echo "[Warn] Custom field value is greater than 10000 characters"
                fi
                if ! echo "${customfieldValue::10000}" | "$NINJA_DATA_PATH"/ninjarmm-cli set --stdin "$customfieldName"; then
                    echo "[Warn] Failed to set custom field"
                else
                    echo "[Info] Custom field value set successfully"
                fi
            else
                echo "[Warn] Custom Field ($customfieldName) does not exist or agent does not have permission to access it"
            fi
        else
            echo "[Warn] ninjarmm-cli is not executable"
        fi
    else
        echo "[Warn] ninjarmm-cli does not exist"
    fi
}

parentSearchPath=$_arg_path
leafSearchName=$_arg_name
searchType=$_arg_type
timeout=$_arg_timeout
customField=$_arg_customfield

# Get values from Script Variables
if [[ -n "${pathToSearch}" ]]; then
    parentSearchPath="${pathToSearch}"
fi
if [[ -n "${nameOfFileOrFolder}" ]]; then
    leafSearchName="${nameOfFileOrFolder}"
fi
if [[ -n "${filesOrFolders}" && "${filesOrFolders}" != "null" ]]; then
    searchType="${filesOrFolders}"
fi
if [[ -n "${searchTimeout}" && "${searchTimeout}" != "null" ]]; then
    timeout="${searchTimeout}"
fi
if [[ -n "${customFieldName}" && "${customFieldName}" != "null" ]]; then
    customField="${customFieldName}"
fi

if [[ -z "${parentSearchPath}" ]]; then
    echo "[Error] Path to Search is empty"
    exit 1
fi

# Check if path exists
if [ -e "${parentSearchPath}" ]; then
    echo "[Info] Path ${parentSearchPath} exists"
else
    echo "[Error] Path to Search ${parentSearchPath} does not exist or is an invalid path"
    exit 1
fi

# Check if timeout is a number
if ! [[ "${timeout}" =~ ^[0-9]+$ ]]; then
    echo "[Error] Timeout is not a number"
    exit 1
fi
# Check if timeout is not in the range of 1 to 120
if [[ "${timeout}" -lt 1 || "${timeout}" -gt 120 ]]; then
    echo "[Error] Timeout is not in the range of 1 to 120"
    exit 1
fi

# Search for files or folders
if [[ -n "${leafSearchName}" && "${leafSearchName}" != "null" ]]; then
    if [[ "${searchType}" == *"Files"* && "${searchType}" == *"Only"* ]]; then
        echo "[Info] Searching for files only"
        # Search for files only
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}m" find "$parentSearchPath" -type f -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    elif [[ "${searchType}" == *"Folders"* && "${searchType}" == *"Only"* ]]; then
        echo "[Info] Searching for folders only"
        # Search for folders only
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}m" find "$parentSearchPath" -type d -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    elif [[ "${searchType}" == *"Files"* && "${searchType}" == *"Folders"* ]]; then
        echo "[Info] Searching for files or folders"
        # Search for files or folders
        # Use timeout to prevent the find command from running indefinitely
        foundPath=$(timeout "${timeout}m" find "$parentSearchPath" -name "$leafSearchName" 2>/dev/null)
        exitcode=$?
        if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
            if [[ -n $foundPath ]]; then
                echo "[Alert] File Found"
            fi
        fi
    else
        echo "[Error] Invalid search type"
        echo "Valid search types: Files Only, Folders Only, Files Or Folders"
        exit 1
    fi
elif [[ -z "${leafSearchName}" ]]; then
    # Search in path only
    echo "[Info] Searching in path only"
    # Search in path only
    # Use timeout to prevent the find command from running indefinitely
    foundPath=$(timeout "${timeout}m" find "$parentSearchPath")
    exitcode=$?
    if [[ $exitcode -eq 0 || $exitcode -eq 124 ]]; then
        if [[ -n $foundPath ]]; then
            echo "[Alert] File Found"
        fi
    fi
fi

# Check exit code
if [[ -n $foundPath ]]; then
    if [[ -n "${foundPath}" ]]; then
        # Split the string into an array
        IFS=$'\n' read -rd '' -a foundPathArray <<<"${foundPath}"
        # Print each element of the array
        for element in "${foundPathArray[@]}"; do
            echo "[Alert] ${element} exists"
        done
    elif [[ -z "${foundPath}" ]]; then
        echo "[Info] ${foundPath} does not exist"
    fi
elif [[ -z $foundPath ]]; then
    echo "[Warn] Could not find a file or folder"
    exit 1
else
    # If the find command fails to find the file or folder

    # Figure out the grammer for the search type
    if [[ "${searchType}" == *"Only"* ]]; then
        if [[ "${searchType}" == *"Files"* ]]; then
            searchTypeInfo="file"
        elif [[ "${searchType}" == *"Folders"* ]]; then
            searchTypeInfo="folder"
        fi
    elif [[ "${searchType}" == *"Files"* && "${searchType}" == *"Folders"* ]]; then
        searchTypeInfo="file or folder"
    fi
    echo "[Info] Could not find a ${searchTypeInfo} in the path ${parentSearchPath} with the name containing: ${leafSearchName}"
fi

# If command times out
if [[ $exitcode -ge 124 && $exitcode -le 127 || $exitcode -eq 137 ]]; then
    echo "[Alert] Timed out searching for file or folder"
    echo "timeout exit code: $exitcode"
    echo "  124  if COMMAND times out, and --preserve-status is not specified"
    echo "  125  if the timeout command itself fails"
    echo "  126  if COMMAND is found but cannot be invoked"
    echo "  127  if COMMAND cannot be found"
    echo "  137  if COMMAND (or timeout itself) is sent the KILL (9) signal (128+9)"
    echo "find command result: $foundPath"
    exit 1
fi

# Save to custom field
if [[ -n "${customField}" && "${customField}" != "null" ]]; then
    SetCustomField "${customField}" "${foundPath}"
fi

 

Análisis detallado

Profundicemos en el script para comprobar la existencia de archivos para entender su funcionamiento, parámetros y funcionalidad:

Parámetros y opciones

El script para comprobar la existencia de archivos acepta varios parámetros para personalizar la operación de búsqueda:

  • –path “/opt/NinjaRMM/programdata”: Especifica la ruta base para buscar archivos o carpetas. Este parámetro es obligatorio.
  • –name “ninjarmm-cli”: Define el nombre del archivo o carpeta a buscar. También es necesario y admite mayúsculas y minúsculas y comodines.
  • –type “Files Or Folders”: Determina si se buscan archivos, carpetas o ambos. Parámetro obligatorio con opciones:
  • Sólo archivos
  • Sólo carpetas
  • Archivos o carpetas
  • –timeout 10: Un parámetro opcional que especifica el tiempo (en minutos) que se debe esperar a que finalice la búsqueda antes de que se agote el tiempo de espera, por defecto 30 minutos.
  • –customfield “myCustomField”: Un parámetro opcional para guardar los resultados de la búsqueda en un campo personalizado.

Flujo de ejecución del script para comprobar la existencia de archivos

1. Argumentos de inicialización y análisis sintáctico: el script comienza definiendo funciones de utilidad (die y begins_with_short_option) e inicializando variables de argumento. La función parse_commandline procesa los argumentos proporcionados, validándolos y asignándolos a las variables respectivas.

2. Función SetCustomField: esta función establece un campo personalizado con los resultados de la búsqueda si la herramienta ninjarmm-cli está disponible y es ejecutable. Comprueba varias condiciones, como la existencia de la herramienta y del campo personalizado, y gestiona las restricciones de longitud de los valores.

3. Lógica principal:

  • El script valida el parámetro de ruta requerido y se asegura de que el directorio especificado existe.
  • Comprueba si el valor del tiempo de espera es un número dentro del rango aceptable (de 1 a 120 minutos).
  • Dependiendo del tipo especificado (Sólo archivos, Sólo carpetas, Archivos o carpetas), realiza la búsqueda utilizando el comando find con un tiempo de espera para evitar una ejecución indefinida.
  • Los resultados de la búsqueda se gestionan adecuadamente, alertando si se encuentra el archivo o carpeta y guardando los resultados en un campo personalizado si se especifica.

Posibles casos de uso

  1. Verificación del despliegue: Asegurarse de que los archivos críticos están presentes después de la implementación para confirmar que la aplicación se ha instalado correctamente.
  2. Vigilancia de la seguridad: Detección de adiciones no autorizadas de archivos o directorios, que podrían indicar un fallo de seguridad o una violación de la política.
  3. Auditorías de conformidad: Verificación de la presencia de los archivos de configuración o registros necesarios para el cumplimiento de las normas del sector.

Estudio de un caso hipotético

Imagina un MSP que gestiona entornos de múltiples clientes. Al desplegar este script en los sistemas cliente, el MSP puede automatizar el proceso de verificación de archivos importantes, como definiciones de antivirus o configuraciones del sistema, garantizando que están actualizados y cumplen las políticas de seguridad. Si se encuentra alguna discrepancia, el script alerta al MSP, lo que permite una rápida solución.

Comparaciones

Los métodos tradicionales de comprobación de la existencia de archivos pueden implicar comandos manuales o scripts básicos que carecen de un tratamiento de errores sólido y de opciones de personalización. El script proporcionado destaca por ofrecer una amplia parametrización, gestión de tiempos de espera e integración con campos personalizados para el almacenamiento de resultados. Este nivel de automatización y flexibilidad aumenta considerablemente la eficacia operativa.

FAQ

P: ¿Este script para comprobar la existencia de archivos puede buscar varios archivos o carpetas a la vez?

R: No, el script está diseñado para buscar un único archivo o carpeta especificado. Las búsquedas múltiples requerirían múltiples ejecuciones de script.

P: ¿Cómo gestiona el script los directorios grandes?

R: El script para comprobar la existencia de archivos utiliza el comando find con un tiempo de espera para evitar búsquedas de larga duración. Esto asegura que no se cuelgue indefinidamente en directorios grandes.

P: ¿Qué ocurre si la herramienta ninjarmm-cli no está disponible?

R: El script registra una advertencia y continúa su operación. La funcionalidad de campos personalizados se omitiría si la herramienta no es ejecutable.

Implicaciones

La posibilidad de automatizar la comprobación de la existencia de archivos y carpetas tiene importantes implicaciones para la seguridad y la gestión de TI. Las alertas automáticas ayudan a identificar rápidamente cambios no autorizados, posibles infracciones y problemas de cumplimiento. Este enfoque proactivo mejora la seguridad y fiabilidad general del sistema.

Recomendaciones

  • Establece tiempos de espera adecuados: asegúrate de que el valor del tiempo de espera es realista para el tamaño del directorio para evitar terminaciones innecesarias del script para comprobar la existencia de archivos.
  • Actualiza periódicamente los criterios de búsqueda: adapta los parámetros de búsqueda en función de la evolución de las necesidades, como nuevos archivos o directorios críticos.
  • Intégralo con sistemas de vigilancia: utiliza la funcionalidad de campos personalizados para integrarte con sistemas de supervisión y alerta más amplios, proporcionando una visión unificada del estado y el cumplimiento del sistema.

Reflexiones finales

Los scripts de automatización como el comentado para comprobar la existencia de archivos son herramientas inestimables para los profesionales de TI y los MSP. Proporcionan una forma fiable y eficaz de garantizar que los archivos y directorios críticos están presentes y son correctos. Al integrar este script en tus prácticas de gestión de TI, puedes mejorar la seguridad, el cumplimiento y la eficacia operativa. NinjaOne ofrece un conjunto de herramientas que pueden complementar dichos scripts, proporcionando soluciones integrales de gestión de TI adaptadas a tus necesidades.

Comienza tu prueba gratuita

Categorías:

  • Supervisión

Quizá también te interese…

×

¡Vean a NinjaOne en acción!

Al enviar este formulario, acepto la política de privacidad de NinjaOne.

Download the script

Términos y condiciones de NinjaOne

Al hacer clic en el botón “Acepto” que aparece a continuación, estás aceptando los siguientes términos legales, así como nuestras Condiciones de uso:

  • Derechos de propiedad: NinjaOne posee y seguirá poseyendo todos los derechos, títulos e intereses sobre el script (incluidos los derechos de autor). NinjaOne concede al usuario una licencia limitada para utilizar el script de acuerdo con estos términos legales.
  • Limitación de uso: solo podrás utilizar el script para tus legítimos fines personales o comerciales internos, y no podrás compartirlo con terceros.
  • Prohibición de republicación: bajo ninguna circunstancia está permitido volver a publicar el script en ninguna biblioteca de scripts que pertenezca o esté bajo el control de cualquier otro proveedor de software.
  • Exclusión de garantía: el script se proporciona “tal cual” y “según disponibilidad”, sin garantía de ningún tipo. NinjaOne no promete ni garantiza que el script esté libre de defectos o que satisfaga las necesidades o expectativas específicas del usuario.
  • Asunción de riesgos: el uso que el usuario haga del script corre por su cuenta y riesgo. El usuario reconoce que existen ciertos riesgos inherentes al uso del script, y entiende y asume cada uno de esos riesgos.
  • Renuncia y exención: el usuario no hará responsable a NinjaOne de cualquier consecuencia adversa o no deseada que resulte del uso del script y renuncia a cualquier derecho o recurso legal o equitativo que pueda tener contra NinjaOne en relación con su uso del script.
  • CLUF: si el usuario es cliente de NinjaOne, su uso del script está sujeto al Contrato de Licencia para el Usuario Final (CLUF).
Acepto