diff --git a/.editorconfig b/.editorconfig index 160403d..172a51a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -13,7 +13,7 @@ insert_final_newline = true [*.rsc] indent_style = space -indent_size = 4 +indent_size = 2 [*.{yml,yaml,sls}] indent_style = space diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index a888ef0..b77fe0e 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,2 +1,4 @@ # These are supported funding model platforms -custom: https://buymeacoffee.com/beeyev +ko_fi: beeyev +liberapay: beeyev +buy_me_a_coffee: beeyev diff --git a/.gitignore b/.gitignore index 2771fe3..1ea45ab 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ -/ignore \ No newline at end of file +ignore/ +.idea/ +.vscode/ diff --git a/BackupAndUpdate.rsc b/BackupAndUpdate.rsc index fc126bb..8d3d5d3 100644 --- a/BackupAndUpdate.rsc +++ b/BackupAndUpdate.rsc @@ -1,11 +1,11 @@ # Script name: BackupAndUpdate # -#----------SCRIPT INFORMATION--------------------------------------------------- +# SCRIPT INFORMATION # # Script: Mikrotik RouterOS automatic backup & update -# Version: 22.11.12 +# Version: 25.04.15 # Created: 07/08/2018 -# Updated: 12/11/2022 +# Updated: 15/04/2025 # Author: Alexander Tebiev # Website: https://github.com/beeyev # You can contact me by e-mail at tebiev@mail.com @@ -13,417 +13,680 @@ # IMPORTANT! # Minimum supported RouterOS version is v6.43.7 # -#----------MODIFY THIS SECTION AS NEEDED---------------------------------------- -## Notification e-mail -## (Make sure you have configurated Email settings in Tools -> Email) +# --- MODIFY THIS SECTION AS NEEDED --- +# Notification e-mail +# (Make sure you have configured Email settings in Tools -> Email) :local emailAddress "yourmail@example.com"; -## Script mode, possible values: backup, osupdate, osnotify. +# Script mode, possible values: backup, osupdate, osnotify. # backup - Only backup will be performed. (default value, if none provided) # -# osupdate - The Script will install a new RouterOS if it is available. -# It will also create backups before and after update process (does not matter what value is set to `forceBackup`) -# Email will be sent only if a new RouterOS version is available. -# Change parameter `forceBackup` if you need the script to create backups every time when it runs (even when no updates were found). +# osupdate - Installs new RouterOS if available and creates backups before/after update (ignores `forceBackup`) +# Sends email only when an update is found. +# Set `forceBackup` to true to always create backups, even without updates # -# osnotify - The script will send email notification only (without backups) if a new RouterOS is available. -# Change parameter `forceBackup` if you need the script to create backups every time when it runs. -:local scriptMode "osupdate"; +# osnotify - Sends email only if a new RouterOS update is found (no backups) +# Set `forceBackup` to always create backups on every run +:local scriptMode "osupdate" -## Additional parameter if you set `scriptMode` to `osupdate` or `osnotify` -# Set `true` if you want the script to perform backup every time it's fired, whatever script mode is set. -:local forceBackup false; +# Additional parameter if you set `scriptMode` to `osupdate` or `osnotify` +# Set `true` if you want the script to perform backup every time its fired, whatever script mode is set. +:local forceBackup false -## Backup encryption password, no encryption if no password. +# Backup encryption password, no encryption if no password. :local backupPassword "" -## If true, passwords will be included in exported config. -:local sensetiveDataInConfig true; +# If true, passwords will be included in exported config. +:local sensitiveDataInConfig true ## Update channel. Possible values: stable, long-term, testing, development -:local updateChannel "stable"; +:local updateChannel "stable" -## Install only patch versions of RouterOS updates. -## Works only if you set scriptMode to "osupdate" -## Means that new update will be installed only if MAJOR and MINOR version numbers remained the same as currently installed RouterOS. -## Example: v6.43.6 => major.minor.PATCH -## Script will send information if new version is greater than just patch. -:local installOnlyPatchUpdates false; +# Installs patch updates only (scriptMode = "osupdate"). +# Works for `stable` and `long-term` channels. +# Updates only if MAJOR.MINOR match (e.g. 6.43.2 β†’ 6.43.6 allowed, 6.44.1 skipped). +# Sends info if a newer (non-patch) version is found. +:local installOnlyPatchUpdates false -##------------------------------------------------------------------------------------------## -# !!!! DO NOT CHANGE ANYTHING BELOW THIS LINE, IF YOU ARE NOT SURE WHAT YOU ARE DOING !!!! # -##------------------------------------------------------------------------------------------## +# Include public IP info in email if set to true +:local detectPublicIpAddress true + +## Allow anonymous statistics collection. (script mode and generic non-sensitive device info) +:local anonStats true + +# !!! DO NOT EDIT BELOW THIS LINE UNLESS YOU KNOW WHAT YOU’RE DOING !!! + +:local scriptVersion "25.04.15" + +# default and fallback public IP detection services +:local ipAddressDetectServiceDefault "https://ipv4.mikrotik.ovh/" +:local ipAddressDetectServiceFallback "https://api.ipify.org/" #Script messages prefix :local SMP "Bkp&Upd:" -:log info "\r\n$SMP script \"Mikrotik RouterOS automatic backup & update\" started."; -:log info "$SMP Script Mode: $scriptMode, forceBackup: $forceBackup"; +:local exitErrorMessage "$SMP script stopped due to an error. Please check logs for more details." +:log info "\n\n$SMP Script \"Mikrotik RouterOS automatic backup & update\" v.$scriptVersion started." +:log info "$SMP Script Mode: `$scriptMode`, Update channel: `$updateChannel`, Force backup: `$forceBackup`, Install only patch updates: `$installOnlyPatchUpdates`" -#Check proper email config -:if ([:len $emailAddress] = 0 or [:len [/tool e-mail get address]] = 0 or [:len [/tool e-mail get from]] = 0) do={ - :log error ("$SMP Email configuration is not correct, please check Tools -> Email. Script stopped."); - :error "$SMP bye!"; +## vv FUNCTIONS vv ## + +# Returns currently running RouterOS version +# :put [$FuncGetRunningOsVersion] # Output: 6.48.1 +:local FuncGetRunningOsVersion do={ + :local runningOsAndChannel [/system resource get version] + + :local spacePos [:find $runningOsAndChannel " "] + :if ([:len $spacePos] = 0) do={ + :log error "Bkp&Upd: Could not extract installed OS version string: `$runningOsAndChannel`." + :error "Bkp&Upd: error, check logs" + } + + :local versionOnly [:pick $runningOsAndChannel 0 $spacePos] + + :return $versionOnly } -#Check if proper identity name is set -if ([:len [/system identity get name]] = 0 or [/system identity get name] = "MikroTik") do={ - :log warning ("$SMP Please set identity name of your device (System -> Identity), keep it short and informative."); -}; +# Returns currently running RouterOS channel +# :put [$FuncGetRunningOsChannel] # Output: stable +:local FuncGetRunningOsChannel do={ + :local runningOsAndChannel [/system resource get version] -############### vvvvvvvvv GLOBALS vvvvvvvvv ############### -# Function converts standard mikrotik build versions to the number. -# Possible arguments: paramOsVer -# Example: -# :put [$buGlobalFuncGetOsVerNum paramOsVer=[/system routerboard get current-RouterOS]]; -# result will be: 64301, because current RouterOS version is: 6.43.1 -:global buGlobalFuncGetOsVerNum do={ - :local osVer $paramOsVer; - :local osVerNum; - :local osVerMicroPart; - :local zro 0; - :local tmp; + :local open [:find $runningOsAndChannel "("] + :if ([:len $open] = 0) do={ + :log error "Bkp&Upd: Could not extract installed OS channel from version string: `$runningOsAndChannel`." + :error "Bkp&Upd: error, check logs" + } - # Replace word `beta` with dot - :local isBetaPos [:tonum [:find $osVer "beta" 0]]; - :if ($isBetaPos > 1) do={ - :set osVer ([:pick $osVer 0 $isBetaPos] . "." . [:pick $osVer ($isBetaPos + 4) [:len $osVer]]); - } - # Replace word `rc` with dot - :local isRcPos [:tonum [:find $osVer "rc" 0]]; - :if ($isRcPos > 1) do={ - :set osVer ([:pick $osVer 0 $isRcPos] . "." . [:pick $osVer ($isRcPos + 2) [:len $osVer]]); - } + :local rest [:pick $runningOsAndChannel ($open+1) [:len $runningOsAndChannel]] + :local close [:find $rest ")"] + :local channel [:pick $rest 0 $close] - :local dotPos1 [:find $osVer "." 0]; - - :if ($dotPos1 > 0) do={ - - # AA - :set osVerNum [:pick $osVer 0 $dotPos1]; - - :local dotPos2 [:find $osVer "." $dotPos1]; - #Taking minor version, everything after first dot - :if ([:len $dotPos2] = 0) do={:set tmp [:pick $osVer ($dotPos1+1) [:len $osVer]];} - #Taking minor version, everything between first and second dots - :if ($dotPos2 > 0) do={:set tmp [:pick $osVer ($dotPos1+1) $dotPos2];} - - # AA 0B - :if ([:len $tmp] = 1) do={:set osVerNum "$osVerNum$zro$tmp";} - # AA BB - :if ([:len $tmp] = 2) do={:set osVerNum "$osVerNum$tmp";} - - :if ($dotPos2 > 0) do={ - :set tmp [:pick $osVer ($dotPos2+1) [:len $osVer]]; - # AA BB 0C - :if ([:len $tmp] = 1) do={:set osVerNum "$osVerNum$zro$tmp";} - # AA BB CC - :if ([:len $tmp] = 2) do={:set osVerNum "$osVerNum$tmp";} - } else={ - # AA BB 00 - :set osVerNum "$osVerNum$zro$zro"; - } - } else={ - # AA 00 00 - :set osVerNum "$osVer$zro$zro$zro$zro"; - } - - :return $osVerNum; + :return $channel } +# Checks if two RouterOS version strings differ only by the patch version +# :put [$FuncIsPatchUpdateOnly "6.2.1" "6.2.4"] # Output: true +# :put [$FuncIsPatchUpdateOnly "6.2.1" "6.3.1"] # Output: false +:local FuncIsPatchUpdateOnly do={ + :local ver1 $1 + :local ver2 $2 -# Function creates backups (system and config) and returns array with names + # Extract the major and minor components from a version + :local extractMajorMinor do={ + :local ver $1 + :local dot1 [:find $ver "."] + :if ($dot1 = -1) do={ :return $ver } + + :local major [:pick $ver 0 $dot1] + :local rest [:pick $ver ($dot1 + 1) [:len $ver]] + :local dot2 [:find $rest "."] + :local minor $rest + :if ($dot2 >= 0) do={ :set minor [:pick $rest 0 $dot2] } + + :return ($major . "." . $minor) + } + + # Compare the major and minor components of both version strings + :if ([$extractMajorMinor $ver1] = [$extractMajorMinor $ver2]) do={ + :return true + } + :return false +} + +# Creates backups and returns array of names # Possible arguments: -# `backupName` | string | backup file name, without extension! -# `backupPassword` | string | -# `sensetiveDataInConfig` | boolean | +# $1 - file name, without extension +# $2 - password (optional) +# $3 - sensitive data in config (optional, default: false) # Example: -# :put [$buGlobalFuncCreateBackups name="daily-backup"]; -:global buGlobalFuncCreateBackups do={ - :log info ("$SMP Global function \"buGlobalFuncCreateBackups\" was fired."); +# :put [$FuncCreateBackups "daily-backup"] +:local FuncCreateBackups do={ + :local backupName $1 + :local backupPassword $2 + :local sensitiveDataInConfig $3 - :local backupFileSys "$backupName.backup"; - :local backupFileConfig "$backupName.rsc"; - :local backupNames {$backupFileSys;$backupFileConfig}; + #Script messages prefix + :local SMP "Bkp&Upd:" + :local exitErrorMessage "$SMP script stopped due to an error. Please check logs for more details." + :log info ("$SMP global function `FuncCreateBackups` started, input: `$backupName`") - ## Make system backup - :if ([:len $backupPassword] = 0) do={ - /system backup save dont-encrypt=yes name=$backupName; - } else={ - /system backup save password=$backupPassword name=$backupName; - } - :log info ("$SMP System backup created. $backupFileSys"); + # validate required parameter: backupName + :if ([:typeof $backupName] != "str" or [:len $backupName] = 0) do={ + :log error "$SMP parameter 'backupName' is required and must be a non-empty string" + :error $exitErrorMessage + } + + :local backupFileSys "$backupName.backup" + :local backupFileConfig "$backupName.rsc" + :local backupNames {$backupFileSys;$backupFileConfig} + + ## Perform system backup + :if ([:len $backupPassword] = 0) do={ + :log info ("$SMP starting backup without password, backup name: `$backupName`") + /system backup save dont-encrypt=yes name=$backupName + } else={ + :log info ("$SMP starting backup with password, backup name: `$backupName`") + /system backup save password=$backupPassword name=$backupName + } + + :log info ("$SMP system backup created: `$backupFileSys`") ## Export config file - :if ($sensetiveDataInConfig = true) do={ - # since RouterOS v7 it needs to be set precise that we want to export sensitive data - :if ([:pick [/system package update get installed-version] 0 1] < 7) do={ - :execute "/export compact terse file=$backupName"; - } else={ - :execute "/export compact show-sensitive terse file=$backupName"; - } + :if ($sensitiveDataInConfig = true) do={ + :log info ("$SMP starting export config with sensitive data, backup name: `$backupName`") + # Since RouterOS v7 it needs to be explicitly set that we want to export sensitive data + :if ([:pick [/system resource get version] 0 1] < 7) do={ + :execute "/export compact terse file=$backupName" } else={ - /export compact hide-sensitive terse file=$backupName; + :execute "/export compact show-sensitive terse file=$backupName" } - :log info ("$SMP Config file was exported. $backupFileConfig, the script execution will be paused for a moment."); + } else={ + :log info ("$SMP starting export config without sensitive data, backup name: `$backupName`") + /export compact hide-sensitive terse file=$backupName + } - #Delay after creating backups - :delay 20s; - :return $backupNames; + :log info ("$SMP Config export complete: `$backupFileConfig`") + :log info ("$SMP Waiting a little to ensure backup files are written") + + :delay 40s + + :if ([:len [/file find name=$backupFileSys]] > 0) do={ + :log info ("$SMP system backup file successfully saved to the file system: `$backupFileSys`") + } else={ + :log error ("$SMP system backup was not created, file does not exist: `$backupFileSys`") + :error $exitErrorMessage + } + + :if ([:len [/file find name=$backupFileConfig]] > 0) do={ + :log info ("$SMP config backup file successfully saved to the file system: `$backupFileConfig`") + } else={ + :log error ("$SMP config backup was not created, file does not exist: `$backupFileConfig`") + :error $exitErrorMessage + } + + :log info ("$SMP global function `FuncCreateBackups` finished. Created backups, system: `$backupFileSys`, config: `$backupFileConfig`") + + :return $backupNames } -:global buGlobalVarUpdateStep; -############### ^^^^^^^^^ GLOBALS ^^^^^^^^^ ############### +# Sends an email +# Parameters: +# $1 - to (email address) +# $2 - subject +# $3 - body +# $4 - file attachments (optional; pass "" if not needed) +# +# Example: +# $FuncSendEmailSafe "admin@domain.com" "Backup Done" "Backup complete." "backup1.backup" +:local FuncSendEmailSafe do={ -:local scriptVersion "22.11.12"; + :local emailTo $1 + :local emailSubject $2 + :local emailBody $3 + :local emailAttachments $4 -#Current date time in format: 2020jan15-221324 -:local dateTime ([:pick [/system clock get date] 7 11] . [:pick [/system clock get date] 0 3] . [:pick [/system clock get date] 4 6] . "-" . [:pick [/system clock get time] 0 2] . [:pick [/system clock get time] 3 5] . [:pick [/system clock get time] 6 8]); + :local SMP "Bkp&Upd:" + :local exitErrorMessage "$SMP script stopped due to an error. Please check logs for more details." -:local isSoftBased false; -:if ([/system resource get board-name] = "CHR" or [/system resource get board-name] = "x86") do={ - :set isSoftBased true; + :log info "$SMP Attempting to send email to `$emailTo`" + + # SAFETY: wait for any previously queued email to finish + :local waitTimeoutPre 60 + :local waitCounterPre 0 + :while (([/tool e-mail get last-status] = "resolving-dns" or [/tool e-mail get last-status] = "in-progress")) do={ + :if ($waitCounterPre >= $waitTimeoutPre) do={ + :log error "$SMP Email send aborted: previous send did not complete after $waitTimeoutPre seconds" + :error $exitErrorMessage + } + + :log info "$SMP Waiting for previous email to finish (status: $[/tool e-mail get last-status])..." + :delay 1s + :set waitCounterPre ($waitCounterPre + 1) + } + + # Send the email + :do { + /tool e-mail send to=$emailTo subject=$emailSubject body=$emailBody file=$emailAttachments + } on-error={ + :log error "$SMP Email send command failed to execute. Check logs and verify email settings." + :error $exitErrorMessage + } + + # Wait for send status to change from "in-progress" / "resolving-dns" + :local waitTimeout 60 + :local waitCounter 0 + :local emailStatus "" + :log info "$SMP Waiting for email to be sent, timeout in `$waitTimeout` seconds..." + :while ($waitCounter < $waitTimeout) do={ + :set emailStatus [/tool e-mail get last-status] + :if ($emailStatus != "in-progress" and $emailStatus != "resolving-dns") do={ + :log info "$SMP Email send status received: $emailStatus" + + # exit loop + :set waitCounter $waitTimeout + } else={ + :delay 1s + :set waitCounter ($waitCounter + 1) + } + } + + # Final decision based on last status + :if ($emailStatus = "succeeded") do={ + :log info "$SMP Email successfully sent to `$emailTo`" + } else={ + :log error "$SMP Email failed to send. Status: `$emailStatus`. Check logs for more details and verify email settings." + :error $exitErrorMessage + } } -:local deviceOsVerInst [/system package update get installed-version]; -:local deviceOsVerInstNum [$buGlobalFuncGetOsVerNum paramOsVer=$deviceOsVerInst]; -:local deviceOsVerAvail ""; -:local deviceOsVerAvailNum 0; -:local deviceIdentityName [/system identity get name]; -:local deviceIdentityNameShort [:pick $deviceIdentityName 0 18] -:local deviceUpdateChannel [/system package update get channel]; +# Global variable to track current update step +# They need to be initialized here first to be available in the script +:global buGlobalVarTargetOsVersion + +:global buGlobalVarScriptStep +:local scriptStep $buGlobalVarScriptStep +:do {/system script environment remove buGlobalVarScriptStep} on-error={} +:if ([:len $scriptStep] = 0) do={ + :set scriptStep 1 +} +## ^^ FUNCTIONS ^^ ## -:local deviceRbModel "CloudHostedRouter"; -:local deviceRbSerialNumber "--"; -:local deviceRbCurrentFw "--"; -:local deviceRbUpgradeFw "--"; +# +# Initial validation +# -:if ($isSoftBased = false) do={ - :set deviceRbModel [/system routerboard get model]; - :set deviceRbSerialNumber [/system routerboard get serial-number]; - :set deviceRbCurrentFw [/system routerboard get current-firmware]; - :set deviceRbUpgradeFw [/system routerboard get upgrade-firmware]; +## Check email settings +:if ([:len $emailAddress] < 3) do={ + :log error ("$SMP Parameter `\$emailAddress` is not set, or contains invalid value. Script stopped.") + :error $exitErrorMessage +} + +# Values will be defined later in the script +:local emailServer "" +:local emailFromAddress [/tool e-mail get from] + +:log info "$SMP Validating email settings..." +:do { + :set emailServer [/tool e-mail get server] +} on-error={ + # This is a workaround for the RouterOS v7.12 and older versions + :set emailServer [/tool e-mail get address] +} +:if ($emailServer = "0.0.0.0") do={ + :log error ("$SMP Email server address is not correct: `$emailServer`, check `Tools -> Email`. Script stopped."); + :error $exitErrorMessage +} +:if ([:len $emailFromAddress] < 3) do={ + :log error ("$SMP Email configuration FROM address is not correct: `$emailFromAddress`, check `Tools -> Email`. Script stopped."); + :error $exitErrorMessage +} + +# Script mode validation +:if ($scriptMode != "backup" and $scriptMode != "osupdate" and $scriptMode != "osnotify") do={ + :log error ("$SMP Script parameter `\$scriptMode` is not set, or contains invalid value: `$scriptMode`. Script stopped.") + :error $exitErrorMessage +} + +# Update channel validation +:if ($updateChannel != "stable" and $updateChannel != "long-term" and $updateChannel != "testing" and $updateChannel != "development") do={ + :log error ("$SMP Script parameter `\$updateChannel` is not set, or contains invalid value: `$updateChannel`. Script stopped.") + :error $exitErrorMessage +} + +# Verify if script is set to install patch updates and if the update channel is valid +:if ($scriptMode = "osupdate" and $installOnlyPatchUpdates = true) do={ + :if ($updateChannel != "stable" and $updateChannel != "long-term") do={ + :log error ("$SMP Patch-only updates enabled, but update channel `$updateChannel` is invalid. Only `stable` and `long-term` are supported. Script stopped") + :error $exitErrorMessage + } + + :local susRunningOsChannel [$FuncGetRunningOsChannel] + + :if ($susRunningOsChannel != "stable" and $susRunningOsChannel != "long-term") do={ + :log error ("$SMP Script is set to install only patch updates, but the installed RouterOS version is not from `stable` or `long-term` channel: `$susRunningOsChannel`. Script stopped") + :error $exitErrorMessage + } +} + +# +# Get current date and time +# +:local rawTime [/system clock get time] +:local rawDate [/system clock get date] + +# Current time in specific format `hh-mm-ss` +:local currentTime ([:pick $rawTime 0 2] . "-" . [:pick $rawTime 3 5] . "-" . [:pick $rawTime 6 8]) + +# Current date `YYYY-MM-DD` or `YYYY-Mon-DD` +:local currentDate "undefined" + +# Check if the date is in the old format +:if ([:len [:tonum [:pick $rawDate 0 1]]] = 0) do={ + # Convert old format `nov/11/2023` β†’ `2023-nov-11` + :set currentDate ([:pick $rawDate 7 11] . "-" . [:pick $rawDate 0 3] . "-" . [:pick $rawDate 4 6]) +} else={ + # Use new format as is `YYYY-MM-DD` + :set currentDate $rawDate +} + +:local currentDateTime ($currentDate . "-" . $currentTime) + +:local deviceBoardName [/system resource get board-name] + +## Check if it's a cloud hosted router +:local isCloudHostedRouter false; +:if ([:pick $deviceBoardName 0 3] = "CHR" or [:pick $deviceBoardName 0 3] = "x86") do={ + :set isCloudHostedRouter true; }; -:local isOsUpdateAvailable false; -:local isOsNeedsToBeUpdated false; +:local deviceIdentityName [/system identity get name]; +:local deviceIdentityNameShort [:pick $deviceIdentityName 0 18] -:local isSendEmailRequired true; +:local deviceRbModel "CloudHostedRouter"; +:local deviceRbSerialNumber "--" +:local deviceRbCurrentFw "--" +:local deviceRbUpgradeFw "--" -:local mailSubject "$SMP Device - $deviceIdentityNameShort."; -:local mailBody ""; +:if ($isCloudHostedRouter = false) do={ + :set deviceRbModel [/system routerboard get model] + :set deviceRbSerialNumber [/system routerboard get serial-number] + :set deviceRbCurrentFw [/system routerboard get current-firmware] + :set deviceRbUpgradeFw [/system routerboard get upgrade-firmware] +}; -:local mailBodyDeviceInfo "\r\n\r\nDevice information: \r\nIdentity: $deviceIdentityName \r\nModel: $deviceRbModel \r\nSerial number: $deviceRbSerialNumber \r\nCurrent RouterOS: $deviceOsVerInst ($[/system package update get channel]) $[/system resource get build-time] \r\nCurrent routerboard FW: $deviceRbCurrentFw \r\nDevice uptime: $[/system resource get uptime]"; -:local mailBodyCopyright "\r\n\r\nMikrotik RouterOS automatic backup & update (ver. $scriptVersion) \r\nhttps://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update"; -:local changelogUrl ("Check RouterOS changelog: https://mikrotik.com/download/changelogs/" . $updateChannel . "-release-tree"); +:local runningOsChannel [$FuncGetRunningOsChannel] +:local runningOsVersion [$FuncGetRunningOsVersion] +:local deviceOsVerAndChannelRunning [/system resource get version] -:local backupName "v$deviceOsVerInst_$deviceUpdateChannel_$dateTime"; -:local backupNameBeforeUpd "backup_before_update_$backupName"; -:local backupNameAfterUpd "backup_after_update_$backupName"; +:local backupNameTemplate "backup_v$runningOsVersion_$runningOsChannel_$currentDateTime" +:local backupNameBeforeUpdate "backup_before_update_$backupNameTemplate" +:local backupNameAfterUpdate "backup_after_update_$backupNameTemplate" -:local backupNameFinal $backupName; -:local mailAttachments [:toarray ""]; +## Email body template +:local mailSubjectPrefix "$SMP Device - `$deviceIdentityNameShort`" -:local updateStep $buGlobalVarUpdateStep; -:do {/system script environment remove buGlobalVarUpdateStep;} on-error={} -:if ([:len $updateStep] = 0) do={ - :set updateStep 1; -} +:local mailBodyCopyright "Mikrotik RouterOS automatic backup & update (ver. $scriptVersion) \nhttps://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update" +:local changelogUrl "Check RouterOS changelog: https://mikrotik.com/download/changelogs/" +:local mailBodyDeviceInfo "" +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "Device information:") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\n---------------------") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nName: $deviceIdentityName") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nModel: $deviceRbModel") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nBoard: $deviceBoardName") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nSerial number: $deviceRbSerialNumber") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nRouterOS version: v$deviceOsVerAndChannelRunning") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nBuild time: $[/system resource get build-time]") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nRouterboard FW: $deviceRbCurrentFw") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nDevice date-time: $rawDate $rawTime ($[/system clock get time-zone-name ])") +:set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nUptime: $[/system resource get uptime]") +# IP address will be appended later if needed -## STEP ONE: Creating backups, checking for new RouterOs version and sending email with backups, -## steps 2 and 3 are fired only if script is set to automatically update device and if new RouterOs is available. -:if ($updateStep = 1) do={ - :log info ("$SMP Performing the first step."); +:local mailAttachments [:toarray ""] - # Checking for new RouterOS version - if ($scriptMode = "osupdate" or $scriptMode = "osnotify") do={ - log info ("$SMP Checking for new RouterOS version. Current version is: $deviceOsVerInst"); - /system package update set channel=$updateChannel; - /system package update check-for-updates; - :delay 5s; - :set deviceOsVerAvail [/system package update get latest-version]; +## IP address detection +:if ($scriptStep = 1 or $scriptStep = 3) do={ + :if ($scriptStep = 3) do={ + :log info ("$SMP Waiting for one minute before continuing to the final step.") + :delay 1m + } + # default values + :local publicIpAddress "not-detected" + :local telemetryDataQuery "" - # If there is a problem getting information about available RouterOS from server - :if ([:len $deviceOsVerAvail] = 0) do={ - :log warning ("$SMP There is a problem getting information about new RouterOS from server."); - :set mailSubject ($mailSubject . " Error: No data about new RouterOS!") - :set mailBody ($mailBody . "Error occured! \r\nMikrotik couldn't get any information about new RouterOS from server! \r\nWatch additional information in device logs.") - } else={ - #Get numeric version of OS - :set deviceOsVerAvailNum [$buGlobalFuncGetOsVerNum paramOsVer=$deviceOsVerAvail]; - - # Checking if OS on server is greater than installed one. - :if ($deviceOsVerAvailNum > $deviceOsVerInstNum) do={ - :set isOsUpdateAvailable true; - :log info ("$SMP New RouterOS is available! $deviceOsVerAvail"); - } else={ - :set isSendEmailRequired false; - :log info ("$SMP System is already up to date."); - :set mailSubject ($mailSubject . " No new OS updates."); - :set mailBody ($mailBody . "Your system is up to date."); - } - }; - } else={ - :set scriptMode "backup"; - }; - - if ($forceBackup = true) do={ - # In this case the script will always send email, because it has to create backups - :set isSendEmailRequired true; + :if ($detectPublicIpAddress = true or $anonStats = true) do={ + :if ($anonStats = true) do={ + :set telemetryDataQuery ("\?mode=" . $scriptMode . "&scriptver=" . $scriptVersion . "&updatechannel=" . $updateChannel . "&osver=" . $runningOsVersion . "&step=" . $scriptStep . "&forcebackup=" . $forceBackup . "&onlypatchupdates=" . $installOnlyPatchUpdates . "&model=" . $deviceRbModel . "&deviceboard=" . $deviceBoardName) } - # if new OS version is available to install - if ($isOsUpdateAvailable = true and $isSendEmailRequired = true) do={ - # If we only need to notify about new available version - if ($scriptMode = "osnotify") do={ - :set mailSubject ($mailSubject . " New RouterOS is available! v.$deviceOsVerAvail.") - :set mailBody ($mailBody . "New RouterOS version is available to install: v.$deviceOsVerAvail ($updateChannel) \r\n$changelogUrl") - } - - # if we need to initiate RouterOs update process - if ($scriptMode = "osupdate") do={ - :set isOsNeedsToBeUpdated true; - # if we need to install only patch updates - :if ($installOnlyPatchUpdates = true) do={ - #Check if Major and Minor builds are the same. - :if ([:pick $deviceOsVerInstNum 0 ([:len $deviceOsVerInstNum]-2)] = [:pick $deviceOsVerAvailNum 0 ([:len $deviceOsVerAvailNum]-2)]) do={ - :log info ("$SMP New patch version of RouterOS firmware is available."); - } else={ - :log info ("$SMP New major or minor version of RouterOS firmware is available. You need to update it manually."); - :set mailSubject ($mailSubject . " New RouterOS: v.$deviceOsVerAvail needs to be installed manually."); - :set mailBody ($mailBody . "New major or minor RouterOS version is available to install: v.$deviceOsVerAvail ($updateChannel). \r\nYou chose to automatically install only patch updates, so this major update you need to install manually. \r\n$changelogUrl"); - :set isOsNeedsToBeUpdated false; - } - } - - #Check again, because this variable could be changed during checking for installing only patch updats - if ($isOsNeedsToBeUpdated = true) do={ - :log info ("$SMP New RouterOS is going to be installed! v.$deviceOsVerInst -> v.$deviceOsVerAvail"); - :set mailSubject ($mailSubject . " New RouterOS is going to be installed! v.$deviceOsVerInst -> v.$deviceOsVerAvail."); - :set mailBody ($mailBody . "Your Mikrotik will be updated to the new RouterOS version from v.$deviceOsVerInst to v.$deviceOsVerAvail (Update channel: $updateChannel) \r\nFinal report with the detailed information will be sent when update process is completed. \r\nIf you have not received second email in the next 10 minutes, then probably something went wrong. (Check your device logs)"); - #!! There is more code connected to this part and first step at the end of the script. - } - + :do {:set publicIpAddress ([/tool fetch http-method="get" url=($ipAddressDetectServiceDefault . $telemetryDataQuery) output=user as-value]->"data")} on-error={ + :if ($detectPublicIpAddress = true) do={ + :log warning "$SMP Failed to detect public IP using default service: `$ipAddressDetectServiceDefault`" + :log warning "$SMP Trying fallback service: `$ipAddressDetectServiceFallback`" + + :do {:set publicIpAddress ([/tool fetch http-method="get" url=$ipAddressDetectServiceFallback output=user as-value]->"data")} on-error={ + :log warning "$SMP Could not detect public IP address using fallback detection service: `$ipAddressDetectServiceFallback`" } + } } - ## Checking If the script needs to create a backup - :log info ("$SMP Checking If the script needs to create a backup."); - if ($forceBackup = true or $scriptMode = "backup" or $isOsNeedsToBeUpdated = true) do={ - :log info ("$SMP Creating system backups."); - if ($isOsNeedsToBeUpdated = true) do={ - :set backupNameFinal $backupNameBeforeUpd; - }; - if ($scriptMode != "backup") do={ - :set mailBody ($mailBody . "\r\n\r\n"); - }; + # basic safety + :set publicIpAddress ([:pick $publicIpAddress 0 15]) - :set mailSubject ($mailSubject . " Backup was created."); - :set mailBody ($mailBody . "System backups were created and attached to this email."); + :if ($detectPublicIpAddress = true) do={ + :set mailBodyDeviceInfo ($mailBodyDeviceInfo . "\nPublic IP address: $publicIpAddress") + :log info "$SMP Public IP address detected: `$publicIpAddress`" + } + } +} - :set mailAttachments [$buGlobalFuncCreateBackups backupName=$backupNameFinal backupPassword=$backupPassword sensetiveDataInConfig=$sensetiveDataInConfig]; +## STEP 1: Create backups, check for new RouterOS, and send email +## Steps 2–3 run only if auto-update is enabled and a new version is available +:if ($scriptStep = 1) do={ + :local routerOsVersionAvailable "0.0.0" + :local isNewOsUpdateAvailable false + :local isLatestOsAlreadyInstalled true + :local isOsNeedsToBeUpdated false + :local isUpdateCheckSucceeded false + :local isEmailNeedsToBeSent false + + :local mailSubjectPartAction "" + :local mailPtBodyAction "" + + :local mailPtSubjectBackup "" + :local mailPtBodyBackup "" + + # Checking for new version + :if ($scriptMode = "osupdate" or $scriptMode = "osnotify") do={ + log info ("$SMP Setting update channel to `$updateChannel`") + /system package update set channel=$updateChannel + log info ("$SMP Checking for new RouterOS version. Current installed version is: `$runningOsVersion`") + /system package update check-for-updates + + # Wait to allow the system to check for updates + :delay 5s; + + :local packageUpdateStatus "undefined" + + :set routerOsVersionAvailable [/system package update get latest-version] + :set packageUpdateStatus [/system package update get status] + + :if ($packageUpdateStatus = "New version is available") do={ + :log info ("$SMP New RouterOS version is available: `$routerOsVersionAvailable`") + :set isNewOsUpdateAvailable true + :set isLatestOsAlreadyInstalled false + :set isUpdateCheckSucceeded true + :set isEmailNeedsToBeSent true + + :set mailSubjectPartAction "New RouterOS available" + :set mailPtBodyAction "New RouterOS version is available, current version: v$runningOsVersion, new version: v$routerOsVersionAvailable. \n$changelogUrl" } else={ - :log info ("$SMP There is no need to create a backup."); + :if ($packageUpdateStatus = "System is already up to date") do={ + :log info ("$SMP No new RouterOS version is available, the latest version is already installed: `v$runningOsVersion`") + :set isUpdateCheckSucceeded true + + :set mailSubjectPartAction "No os update available" + :set mailPtBodyAction "No new RouterOS version is available, the latest version is already installed: `v$runningOsVersion`" + } else={ + :log error ("$SMP Failed to check for new RouterOS version. Package check status: `$packageUpdateStatus`") + :set isEmailNeedsToBeSent true + + :set mailSubjectPartAction "Error unable to check new os version" + :set mailPtBodyAction "An error occurred while checking for a new RouterOS version.\nStatus returned: `$packageUpdateStatus`\n\nPlease review the logs on the device for more details and verify internet connectivity." + } } + } - # Combine fisrst step email - :set mailBody ($mailBody . $mailBodyDeviceInfo . $mailBodyCopyright); -} - -## STEP TWO: (after first reboot) routerboard firmware upgrade -## steps 2 and 3 are fired only if script is set to automatically update device and if new RouterOs is available. -:if ($updateStep = 2) do={ - :log info ("$SMP Performing the second step."); - ## RouterOS is the latest, let's check for upgraded routerboard firmware - if ($deviceRbCurrentFw != $deviceRbUpgradeFw) do={ - :set isSendEmailRequired false; - :delay 10s; - :log info "$SMP Upgrading routerboard firmware from v.$deviceRbCurrentFw to v.$deviceRbUpgradeFw"; - ## Start the upgrading process - /system routerboard upgrade; - ## Wait until the upgrade is completed - :delay 5s; - :log info "$SMP routerboard upgrade process was completed, going to reboot in a moment!"; - ## Set scheduled task to send final report on the next boot, task will be deleted when is is done. (That is why you should keep original script name) - /system scheduler add name=BKPUPD-FINAL-REPORT-ON-NEXT-BOOT on-event=":delay 5s; /system scheduler remove BKPUPD-FINAL-REPORT-ON-NEXT-BOOT; :global buGlobalVarUpdateStep 3; :delay 10s; /system script run BackupAndUpdate;" start-time=startup interval=0; - ## Reboot system to boot with new firmware - /system reboot; + # Checking if the script needs to install new os version + :if ($scriptMode = "osupdate" and $isNewOsUpdateAvailable = true) do={ + :if ($installOnlyPatchUpdates = true) do={ + :if ([$FuncIsPatchUpdateOnly $runningOsVersion $routerOsVersionAvailable] = true) do={ + :log info "$SMP New RouterOS version is available, and it is a patch update. Current version: v$runningOsVersion, new version: v$routerOsVersionAvailable" + :set isOsNeedsToBeUpdated true + } else={ + :log info "$SMP The script will not install this update, because it is not a patch update. Current version: v$runningOsVersion, new version: v$routerOsVersionAvailable" + :set mailPtBodyAction ($mailPtBodyAction . "\nThis update will not be installed, because the script is set to install only patch updates.") + } } else={ - :log info "$SMP It appers that your routerboard is already up to date, skipping this step."; - :set updateStep 3; - }; -} + :set isOsNeedsToBeUpdated true + } + } -## STEP THREE: Last step (after second reboot) sending final report -## steps 2 and 3 are fired only if script is set to automatically update device and if new RouterOs is available. -:if ($updateStep = 3) do={ - :log info ("$SMP Performing the third step."); - :log info "Bkp&Upd: RouterOS and routerboard upgrade process was completed. New RouterOS version: v.$deviceOsVerInst, routerboard firmware: v.$deviceRbCurrentFw."; - ## Small delay in case mikrotik needs some time to initialize connections - :log info "$SMP The final email with report and backups of upgraded system will be sent in a minute."; - :delay 1m; - :set mailSubject ($mailSubject . " RouterOS Upgrade is completed, new version: v.$deviceOsVerInst!"); - :set mailBody "RouterOS and routerboard upgrade process was completed. \r\nNew RouterOS version: v.$deviceOsVerInst, routerboard firmware: v.$deviceRbCurrentFw. \r\n$changelogUrl \r\n\r\nBackups of the upgraded system are in the attachment of this email. $mailBodyDeviceInfo $mailBodyCopyright"; - :set mailAttachments [$buGlobalFuncCreateBackups backupName=$backupNameAfterUpd backupPassword=$backupPassword sensetiveDataInConfig=$sensetiveDataInConfig]; -} -# Remove functions from global environment to keep it fresh and clean. -:do {/system script environment remove buGlobalFuncGetOsVerNum;} on-error={} -:do {/system script environment remove buGlobalFuncCreateBackups;} on-error={} + # Checking If the script needs to create a backup + :if ($forceBackup = true or $scriptMode = "backup" or $isOsNeedsToBeUpdated = true) do={ + :log info ("$SMP Starting backup process.") -## -## SENDING EMAIL -## -# Trying to send email with backups in attachment. + :set isEmailNeedsToBeSent true -:if ($isSendEmailRequired = true) do={ - :log info "$SMP Sending email message, it will take around half a minute..."; - :do {/tool e-mail send to=$emailAddress subject=$mailSubject body=$mailBody file=$mailAttachments;} on-error={ - :delay 5s; - :log error "$SMP could not send email message ($[/tool e-mail get last-status]). Going to try it again in a while." + :local backupName $backupNameTemplate - :delay 5m; + # This means it's the first step where we create a backup before the update process + :if ($isOsNeedsToBeUpdated = true) do={ + :set backupName $backupNameBeforeUpdate - :do {/tool e-mail send to=$emailAddress subject=$mailSubject body=$mailBody file=$mailAttachments;} on-error={ - :delay 5s; - :log error "$SMP could not send email message ($[/tool e-mail get last-status]) for the second time." - - if ($isOsNeedsToBeUpdated = true) do={ - :set isOsNeedsToBeUpdated false; - :log warning "$SMP script is not going to initialise update process due to inability to send backups to email." - } - } + #Email body if the purpose of the script is to update the device + :set mailSubjectPartAction "Update preparation" + :set mailPtBodyAction ($mailPtBodyAction . "\nThe update process for device '$deviceIdentityName' is scheduled to upgrade RouterOS from version v.$runningOsVersion to version v.$routerOsVersionAvailable (Update channel: $updateChannel)") + :set mailPtBodyAction ($mailPtBodyAction . "\nPlease note: The update will proceed only after a successful backup.") + :set mailPtBodyAction ($mailPtBodyAction . "\nA final report with detailed information will be sent once the update process is completed.") + :set mailPtBodyAction ($mailPtBodyAction . "\nIf you do not receive a second email within the next 10 minutes, there may be an issue. Please check your device logs for further information.") } - :delay 30s; + :do { + :set mailAttachments [$FuncCreateBackups $backupName $backupPassword $sensitiveDataInConfig]; - :if ([:len $mailAttachments] > 0 and [/tool e-mail get last-status] = "succeeded") do={ - :log info "$SMP File system cleanup." - /file remove $mailAttachments; - :delay 2s; + :set mailPtSubjectBackup "Backup created" + :set mailPtBodyBackup "System backups have been successfully created and attached to this email." + } on-error={ + #failed to create backup + :set isOsNeedsToBeUpdated false + + :set mailPtSubjectBackup "Backup failed" + :set mailPtBodyBackup "The script failed to create backups. Please check device logs for more details." + + :log warning "$SMP Backup creation failed. Update process will be canceled if automatic update is enabled" } + } + :if ($isEmailNeedsToBeSent = true) do={ + :log info "$SMP Preparing to send email..." + + :local mailStep1Subject $mailSubjectPrefix + :local mailStep1Body "" + + # subject + :if ($mailSubjectPartAction != "") do={:set mailStep1Subject ($mailStep1Subject . " - " . $mailSubjectPartAction)} + :if ($mailPtSubjectBackup != "") do={:set mailStep1Subject ($mailStep1Subject . " - " . $mailPtSubjectBackup)} + # body + :if ($mailPtBodyAction != "") do={:set mailStep1Body ($mailStep1Body . $mailPtBodyAction . "\n\n")} + :if ($mailPtBodyBackup != "") do={:set mailStep1Body ($mailStep1Body . $mailPtBodyBackup . "\n\n")} + + :set mailStep1Body ($mailStep1Body . $mailBodyDeviceInfo . "\n\n" . $mailBodyCopyright) + + # Send email with backups + :do {$FuncSendEmailSafe $emailAddress $mailStep1Subject $mailStep1Body $mailAttachments} on-error={ + :set isOsNeedsToBeUpdated false + :log error "$SMP The script will not proceed with the update process, because the email was not sent." + } + } + + :if ([:len $mailAttachments] > 0) do={ + :log info "$SMP Cleaning up backup files from the file system..." + /file remove $mailAttachments; + :delay 2s; + } + + :if ($isOsNeedsToBeUpdated = true) do={ + :log info "$SMP everything is ready to install new RouterOS, going to start the update process and reboot the device." + :do { + :local nextStep 2 + :if ($isCloudHostedRouter = true) do={ + :log info "$SMP The device is a cloud hosted router, the second step updating the Routerboard firmware will be skipped." + :set nextStep 3 + } + + :local scheduledCommand (":delay 5s; /system scheduler remove BKPUPD-NEXT-BOOT-TASK; :global buGlobalVarScriptStep $nextStep; :global buGlobalVarTargetOsVersion \"$routerOsVersionAvailable\"; :delay 10s; /system script run BackupAndUpdate;") + /system scheduler add name=BKPUPD-NEXT-BOOT-TASK on-event=$scheduledCommand start-time=startup interval=0 + + /system package update install + } on-error={ + # Failed to install new os version, remove the task + :do {/system scheduler remove BKPUPD-NEXT-BOOT-TASK} on-error={} + + :log error "$SMP Failed to install new RouterOS version. Please check device logs for more details." + + :local mailUpdateErrorSubject ($mailSubjectPrefix . " - Update failed") + :local mailUpdateErrorBody "The script was unable to install new RouterOS version. Please check device logs for more details." + + # Send email with error + $FuncSendEmailSafe $emailAddress $mailUpdateErrorSubject $mailUpdateErrorBody "" + + :error $exitErrorMessage + } + } } +## STEP 2: (Post-reboot) Upgrade RouterBOARD firmware +## Runs only if auto-update is enabled and a new RouterOS version was found +:if ($scriptStep = 2) do={ + :log info "$SMP The script is in the second step, updating Routerboard firmware." -# Fire RouterOs update process -if ($isOsNeedsToBeUpdated = true) do={ + :log info "$SMP Upgrading routerboard firmware from v.$deviceRbCurrentFw to v.$deviceRbUpgradeFw" - :if ($isSoftBased = false) do={ - ## Set scheduled task to upgrade routerboard firmware on the next boot, task will be deleted when upgrade is done. (That is why you should keep original script name) - /system scheduler add name=BKPUPD-UPGRADE-ON-NEXT-BOOT on-event=":delay 5s; /system scheduler remove BKPUPD-UPGRADE-ON-NEXT-BOOT; :global buGlobalVarUpdateStep 2; :delay 10s; /system script run BackupAndUpdate;" start-time=startup interval=0; - } else= { - ## If the scrip is executed on CHR, step 2 will be skipped - /system scheduler add name=BKPUPD-UPGRADE-ON-NEXT-BOOT on-event=":delay 5s; /system scheduler remove BKPUPD-UPGRADE-ON-NEXT-BOOT; :global buGlobalVarUpdateStep 3; :delay 10s; /system script run BackupAndUpdate;" start-time=startup interval=0; - }; + /system routerboard upgrade + :delay 2s + :log info "$SMP routerboard upgrade process was completed, going to reboot in a moment!"; - :log info "$SMP everything is ready to install new RouterOS, going to reboot in a moment!" - ## command is reincarnation of the "upgrade" command - doing exactly the same but under a different name - /system package update install; + ## Set task to send final report on the next boot + /system scheduler add name=BKPUPD-NEXT-BOOT-TASK on-event=":delay 5s; /system scheduler remove BKPUPD-NEXT-BOOT-TASK; :global buGlobalVarScriptStep 3; :global buGlobalVarTargetOsVersion \"$buGlobalVarTargetOsVersion\"; :delay 10s; /system script run BackupAndUpdate;" start-time=startup interval=0 + + /system reboot; } -:log info "$SMP script \"Mikrotik RouterOS automatic backup & update\" completed it's job.\r\n"; +## STEP 3: Final report (after second reboot, with delay). +## Runs only if auto-update is enabled and a new RouterOS version was found. +:if ($scriptStep = 3) do={ + :log info ("$SMP The script is in the third step, sending final report.") + + :local targetOsVersion $buGlobalVarTargetOsVersion + :do {/system script environment remove buGlobalVarTargetOsVersion} on-error={} + :if ([:len $targetOsVersion] = 0) do={ + :log warning "$SMP Something is wrong, the script was unable to get the target updated OS version from the global variable." + } + + :local mailStep3Subject $mailSubjectPrefix + :local mailStep3Body "" + + :if ($targetOsVersion = $runningOsVersion) do={ + :log info "$SMP Successfully verified new RouterOS version: target: `$targetOsVersion`, current: `$runningOsVersion`" + + :set mailStep3Subject ($mailStep3Subject . " - Update completed - Backup created") + :set mailStep3Body ($mailStep3Body . "RouterOS and routerboard upgrade process was completed") + :set mailStep3Body ($mailStep3Body . "\nNew RouterOS version: v.$targetOsVersion, routerboard firmware: v.$deviceRbCurrentFw") + :set mailStep3Body ($mailStep3Body . "\n$changelogUrl\nBackups of the upgraded system are in the attachment of this email.\n\n$mailBodyDeviceInfo\n\n$mailBodyCopyright") + + :set mailAttachments [$FuncCreateBackups $backupNameAfterUpdate $backupPassword $sensitiveDataInConfig]; + } else={ + :log error "$SMP Failed to verify new RouterOS version: target: `$targetOsVersion`, current: `$runningOsVersion`" + :set mailStep3Subject ($mailStep3Subject . " - Update failed") + + :set mailStep3Body ($mailStep3Body . "The script was unable to verify that the new RouterOS version was installed, target version: `$targetOsVersion`, current version: `$runningOsVersion`\nCheck device logs for more details.\n\n$mailBodyDeviceInfo\n\n$mailBodyCopyright") + } + + $FuncSendEmailSafe $emailAddress $mailStep3Subject $mailStep3Body $mailAttachments + + :if ([:len $mailAttachments] > 0) do={ + :log info "$SMP Cleaning up backup files from the file system..." + /file remove $mailAttachments; + :delay 2s; + } + + :log info "$SMP Final report email sent successfully, and the script has finished." +} + +:log info "$SMP the script has finished, script step: `$scriptStep` \n\n" diff --git a/README.md b/README.md index e1ee748..afee68c 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,42 @@ # Mikrotik RouterOS automatic backup and update -This script provides an ability to create Mikrotik's daily backups to email. You can also enable automatic RouterOS upgrade or leave only notifications about new firmware versions. - - +This script allows you to generate daily backups of MikroTik and send them to an email address. You can also choose to enable automatic RouterOS upgrades or receive notifications exclusively for new firmware versions. > πŸ’‘ If you have any ideas about the script or you just want to share your opinion, you are welcome to [Discussions](https://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update/discussions), or you can open an [issue](https://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update/issues) if you found a bug. ## Features: -- Ability to choose script operating mode according to your needs. *(Read below)* -- Script creates backups of the whole system and exported config. -- You can set a preferred update channel. -- If automatic updates are enabled, you can set script to install only patch versions of RouterOS updates. *This means if the current RouterOS version is v6.43.6, the script will automatically install v6.43.7 (new patch version) but not v6.44.0 (new minor version), for example.* -- Script includes primary information about the device into the email message. So you can easily find the backup you need among multiple devices. -- For safety purposes, an automatic update process will not be started if script could not send backups to email. -- Routerboard firmware can be automatically upgraded according to the installed RouterOS version. - +- Select the script's operational mode according to your specific needs (details provided below). +- This script is designed to create full system backups and export configurations. +- Customize the update channel according to your preference. +- With automatic updates activated, the script can be set to apply only patch updates for RouterOS. For instance, should the current RouterOS version be v6.43.6, the script will autonomously upgrade to v6.43.7 (a patch update), while avoiding v6.44.0 (a minor update).* +- The script also incorporates vital device details in the email alerts, facilitating easy identification of the necessary backup among several devices. +- For added security, the script is programmed to stop the automatic update process if it fails to dispatch backups via email. +- Routerboard firmware can be upgraded automatically based on the installed RouterOS version. ## Script operating modes: -**Backups only** - script creates system and config backups and sends them to specified email as an attachment. Using email account as storage for your backups. -**Backups and notifications about new RouterOS release** - Except backups, script also checks for new RouterOS firmware release and provides this information in the email. -**Backups and automatic RouterOS upgrade** - Script makes a backup, then checks for new RouterOS version, and if new firmware released, script will initiate upgrade process. By the end, you receive two emails. The first one contains system backups of the previous RouterOS version, the second message will be sent when the upgrade process is done (including backups of the updated system). +**Backups only** - The script generates system and configuration backups and forwards them to a specified email as attachments. It uses your email account as a storage for these backups. +**Backups and notifications about new RouterOS release** - In addition to creating backups, the script also monitors for any new releases of RouterOS firmware and communicates this information via email. +**Backups and automatic RouterOS upgrade** - The script begins by creating a backup, followed by a check for any new versions of RouterOS. If a newer firmware version is detected, the script initiates the upgrade process. Upon completion, two emails are sent: the first includes the system backups from the prior RouterOS version, and the second, sent post-upgrade, contains backups of the updated system. ## How to use > ❗️ **Important** -> Make sure that your device identity does not contain any spaces or specific symbols! `System -> Identity` +> Ensure your device identity does not contain spaces and special characters! `System -> Identity` ##### 1. Configure parameters -Take the [script](https://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update/raw/master/BackupAndUpdate.rsc) and configure it's parameters at the begining of the file. -This is not difficult because all parameters are well commented. -**Important!** Don't forget to provide correct email address for backups and pay attention a `scriptMode` variable. +Take the [script](https://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update/raw/master/BackupAndUpdate.rsc) and configure it's parameters at the beginning of the file. +This step is straightforward as all parameters are well-commented. +**Important!** Don't forget to provide correct email address for backups and pay attention to `scriptMode` variable. ##### 2. Create new script System -> Scripts [Add] -**Important!** Script name has to be `BackupAndUpdate` -Put the script which you configured earlier into the source area. +**Important!** Script name must be `BackupAndUpdate` +Insert the script which you configured earlier into the source area. ![](https://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update/raw/master/howto/script-name.png) ##### 3. Configure mail server Tools -> Email -Set your email server parameters. If you don't have one, i recommend to use [smtp2go.com](https://smtp2go.com "smtp2go.com") service, it allows sending a thousand emails per month for free. +Configure your email server parameters. If you don't have one, i recommend using the [smtp2go.com](https://smtp2go.com "smtp2go.com") service, which allows sending a thousand emails per month for free. ![](https://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update/raw/master/howto/email-config.png) To check email settings, send a test message by running the following command in terminal: @@ -50,7 +47,7 @@ To check email settings, send a test message by running the following command in ##### 4. Create scheduled task System -> Scheduler [Add] Name: `Backup And Update` -Start Time: `03:10:00` (the start time has to be different for all your mikrotik device in a chain) +Start Time: `03:10:00` (the start time has to be different for all your mikrotik devices in a chain) Interval: `1d 00:00:00` On Event: `/system script run BackupAndUpdate;` ![](https://github.com/beeyev/Mikrotik-RouterOS-automatic-backup-and-update/raw/master/howto/scheduler-task.png) @@ -60,20 +57,27 @@ Or you can use this command to create the task: /system scheduler add name="Firmware Updater" on-event="/system script run BackupAndUpdate;" start-time=03:10:00 interval=1d comment="" disabled=no ``` ##### 5. Test the script -When everything is done, you need to make sure that the script is working correctly. -To do so, open a New Terminal and Log window in your WinBox, then run the script manually by executing this command `/system script run BackupAndUpdate;` in Terminal. -You will see the script working process in the log window. If the script finished without errors, check your email, there is a fresh message with backups from your MikroTik waiting for you πŸŽ‰ +Once everything is set up, it's important to verify that the script is functioning properly. +To do this, open a New Terminal and a Log window in your WinBox, then manually execute the script by typing `/system script run BackupAndUpdate;` in the Terminal. +You will see the script the script's operation in the log window. If the script completes without any errors, check your email. You'll find a new message with backups from your MikroTik awaiting you. πŸŽ‰ -## Contributors - - [DJ5KP](mailto:dj5kp@dj5kp.de), website: [dj5kp.de](http://dj5kp.de/) + + + + +## Acknowledgements +I would like to extend my sincere gratitude to the following individuals who have contributed to this project: + - DJ5KP, website: [dj5kp.de](http://dj5kp.de/) + +Special thanks to the talented people who are working at [MikroTik](https://mikrotik.com) for their contributions in creating such outstanding products. ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information. --- -If you love this project, please consider giving me a ⭐ +If you love this project, please buy more mikrotiks ;) and consider giving me a ⭐ [__Buy me a coffee! :coffee:__](https://www.buymeacoffee.com/beeyev)