Backup and Restore
In
VMware Aria
Operations for Networks
, you can store the backup on the local storage (up to five latest backup files), SSH or FTP servers. You can start the backup immediately or schedule a periodic backup.- The backup and restore setups must have identical versions.
- To avoid any inconsistencies, the restore setup must be a fresh deployment. Take the snapshots of the VMs before you run the restore commands.
- OnlyAdminandConsoleusers can configure backup and restore through public APIs and CLI commands respectively. TheAuditoruser can only see if any backup and restore configuration exists on the setup.
- Trigger the backup process.MethodDescriptionUsing CLI commandbackup-restore backup --action add --path <config-file-path>For additional CLI commands, see the CLI Documentation.Create a backup configuration file on one of the platform nodes under/home/ubuntu. To create the file, you must login asSupportuser.To run the CLI commands, you must log in as aConsoleuser on the same platform where you created the backup configuration file.Using APISeesettings/backupon the API Reference page.You must provide the configuration as the JSON body in the API request.Configurations for the backup processScenarioDescriptionFile ConfigurationConfiguration to trigger backupCreates the backup file on local file server in the default directory:/var/lib/backup-restoreor,any user specified backup directory{"backup_file_server_type":"LOCAL"}or{"backup_file_server_type": "LOCAL", "local_file_server": { "backup_directory": "backup_directory_path" } }Creates the backup on FTP server in the user specified backup directory{ "backup_file_server_type": "FTP", "ftp_file_server": { "server_address": "IP address", "port":port_number, "username": "username", "password": "password", "backup_directory": "backup_directory_path" } }Creates the backup on SSH server in the user specified backup directory"backup_file_server_type": "SSH", "ssh_file_server": { "server_address": "IP address", "port":port_number, "username": "username", "password": "password", "backup_directory": "backup_directory_path" }Configuration to schedule the backup processImmediate Backup"schedule_now": true,Daily BackupThe permissible value forhour: 0-23 The permissible value forminute: 0-59"backup_schedule": { "schedule_period": "DAILY", "hour": 16, "minute": 51 },Weekly BackupThe permissible value forhour: 0-23 The permissible value forminute: 0-59 The permissible value forday_of_week: 1(Sunday) - 7 (Saturday)"backup_schedule": { "schedule_period": "WEEKLY", "hour": 16, "minute": 56, "day_of_week": 3 },Backup only few configurationsIn thedata_filterparameter of the configuration file, set the configuration totrueto backup selected configurations. To skip the backup of a particular configuration, set the value tofalse.If you do not specify thedata_filterparameter,VMware Aria Operations for Networksbacks up all the configurations."data_filter": { "snmp": true, "smtp": true, "web_proxy": false, "data_sources": false, "events": false, "syslog": true, "ldap": true, "vidm": true, "user_data": true, "physical_subnet_vlan": true, "physical_ip_dns_mapping": true, "system_configuration": true, "east_west_ip": false, "north_south_ip": true, "data_management": true, "online_update_status": true, "ceip_status": true, "audit_logs_pii_status": false }An example of the configuration file for a weekly backup (every Tuesday) on a FTP server with selected configurations.{ "backup_schedule": { "schedule_period": "WEEKLY", "hour": 16, "minute": 56, "day_of_week": 3 }, "backup_file_server_type": "FTP", "ftp_file_server": { "server_address": "10.125.48.146", "port": 22011, "username": "testuser", "password": "password!", "backup_directory": "/backup" }, "data_filter": { "snmp": true, "smtp": true, "web_proxy": false, "data_sources": false, "events": false, "syslog": true, "ldap": true, "vidm": true, "user_data": true, "physical_subnet_vlan": true, "physical_ip_dns_mapping": true, "system_configuration": true, "east_west_ip": false, "north_south_ip": true, "data_management": true, "online_update_status": true, "ceip_status": true, "audit_logs_pii_status": false } }
- Trigger the restore process.The sequence for restore is as follows:MethodDescriptionUsing CLI commandsbackup-restore restore --action add --path <config-file-path>For additional CLI commands, see the CLI Documentation.Create a restore configuration file on one of the platform nodes under/home/ubuntu. To create the file, you must login asSupportuser.To run the CLI commands, you must log in as aConsoleuser on the same platform where you created the restore configuration file.Using APISeesettings/restoreon the API Reference page.You must provide the configuration as the JSON body in the API request.Configurations for the restore processScenarioDescriptionFile ConfigurationConfiguration to trigger restoreRestores from the local file server{ "backup_file_server_type": "LOCAL", "local_file_server": { "backup_directory": "backup_directory_path", "backup_file_name": "file_name.tar" } }Restores from the FTP file server{ "backup_file_server_type": "FTP", "ftp_file_server": { "server_address": "IP address", "port":port_number, "username": "username", "password": "password", "backup_directory": "backup_directory_path" "backup_file_name": "file_name.tar" } }Restores from SSH file server"backup_file_server_type": "SSH", "ssh_file_server": { "server_address": "IP address", "port":port_number, "username": "username", "password": "password", "backup_directory": "backup_directory_path" "backup_file_name": "" }file_name.tarRestore only few configurationsIn thedata_filterparameter of the configuration file, set the configuration totrueto restore selected configurations. To skip the restore of a particular configuration, set the value tofalse.If you do not specify thedata_filterparameter,VMware Aria Operations for Networksrestores all the configurations."data_filter": { "snmp": true, "smtp": true, "web_proxy": false, "data_sources": false, "events": false, "syslog": true, "ldap": true, "vidm": true, "user_data": true, "physical_subnet_vlan": true, "physical_ip_dns_mapping": true, "system_configuration": true, "east_west_ip": false, "north_south_ip": true, "data_management": true, "online_update_status": true, "ceip_status": true, "audit_logs_pii_status": false }If you do not specify thecollector_mappingparameter, all the restored data sources will be mapped to a random collector on the restore setup.
If you specify"collector_mapping": { "default_collector": "default_collector_ip", "mappings": [ { "source": "source_collector_ip", "destination": "destination_collector_ip" } ] }collector_mapping, all data sources mapped tosource_collector_ipon the backup setup will be mapped todestination_collector_ipon the restore setup. If mapping is not specified for any collector on the backup setup, the corresponding data sources will be mapped to thedefault_collectoron the restore setup. You can specify mapping for multiple source collectors to destination collectors.An example of the configuration file to restore from a FTP server with selected configurations."backup_file_server_type": "FTP", "ftp_file_server": { "server_address": "10.120.18.146", "port": 22011, "username": "testuser", "password": "Password!", "backup_directory": "/backup" "backup_file_name": "vrni_backup-19801-10.79.197.0-2020-08-26-06.56.44.tar" }, "collector_mapping": { "default_collector": "10.120.135.2", "mappings": [ { "source": "10.134.135.3", "destination": "10.120.2.120" } ] }, "data_filter": { "snmp": true, "smtp": true, "web_proxy": false, "data_sources": false, "events": false, "syslog": true, "ldap": true, "vidm": true, "user_data": true, "physical_subnet_vlan": true, "physical_ip_dns_mapping": true, "system_configuration": true, "east_west_ip": false, "north_south_ip": true, "data_management": true, "online_update_status": true, "ceip_status": true, "audit_logs_pii_status": false } }