mikrotik_create_backupCreates a system backup on MikroTik device.
name (optional): Backup filenamedont_encrypt (optional): Don’t encrypt backupinclude_password (optional): Include passwordscomment (optional): Descriptionmikrotik_create_backup(name="backup-2024-01-01")
mikrotik_list_backupsLists backup files on MikroTik device.
name_filter (optional): Filter by nameinclude_exports (optional): Include export filesmikrotik_list_backups()
mikrotik_create_exportCreates a configuration export on MikroTik device.
name (optional): Export filenamefile_format (optional): Format (“rsc”, “json”, “xml”)export_type (optional): Type (“full”, “compact”, “verbose”)hide_sensitive (optional): Hide sensitive dataverbose (optional): Verbose outputcompact (optional): Compact outputcomment (optional): Descriptionmikrotik_create_export(name="config-export", file_format="rsc")
mikrotik_export_sectionReturns a configuration section as an export script, straight from the device.
A genuine read: nothing is written to device storage, so it works on
read-only accounts (policy=ssh,read). To produce an export file on the
device, use mikrotik_create_export instead.
section (required): Menu path without leading slash, e.g. ip firewall filterhide_sensitive (optional): Keep secrets out of the output (default true)compact (optional): Compact outputmikrotik_export_section(section="ip firewall filter")
mikrotik_download_fileDownloads a file from MikroTik device.
filename (required): Filename to downloadfile_type (optional): File type (“backup” or “export”)mikrotik_download_file(filename="backup-2024-01-01.backup")
mikrotik_upload_fileUploads a file to MikroTik device.
filename (required): Filenamecontent_base64 (required): Base64 encoded contentmikrotik_upload_file(filename="config.rsc", content_base64="...")
mikrotik_restore_backupRestores a system backup on MikroTik device.
filename (required): Backup filenamepassword (optional): Backup passwordmikrotik_restore_backup(filename="backup-2024-01-01.backup")
mikrotik_import_configurationImports a configuration script file.
filename (required): Script filenamerun_after_reset (optional): Run after resetverbose (optional): Verbose outputmikrotik_import_configuration(filename="config.rsc")
mikrotik_remove_fileRemoves a file from MikroTik device.
filename (required): Filename to removemikrotik_remove_file(filename="old-backup.backup")
mikrotik_backup_infoGets detailed information about a backup file.
filename (required): Backup filenamemikrotik_backup_info(filename="backup-2024-01-01.backup")