VMware Aria Operations for Networks 6.14

6.14 6.13 6.12 6.11 6.10
简体中文 Deutsch Español Français 日本語 한국어 繁體中文 English

Backup and Restore
Last Updated February 7, 2025

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.
  • Only
    Admin
     and
    Console
     users can configure backup and restore through public APIs and CLI commands respectively. The
    Auditor
     user can only see if any backup and restore configuration exists on the setup.
  1. Trigger the backup process.
    Method
    Description
    Using CLI command
    backup-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 as
    Support
     user.
    To run the CLI commands, you must log in as a
    Console
     user on the same platform where you created the backup configuration file.
    Using API
    See
    settings/backup
     on the API Reference page.
    You must provide the configuration as the JSON body in the API request.
    Configurations for the backup process
    Scenario
    Description
    File Configuration
    Configuration to trigger backup
    Creates the backup file on local file server in the default directory:
    /var/lib/backup-restore
    or,
    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 process
    Immediate Backup
    "schedule_now": true,
    Daily Backup
    The permissible value for
    hour
     : 0-23 The permissible value for
    minute
     : 0-59 
    "backup_schedule":
  {
      "schedule_period": "DAILY",
      "hour": 16,
      "minute": 51
  },
    Weekly Backup
    The permissible value for
    hour
     : 0-23 The permissible value for
    minute
     : 0-59 The permissible value for
    day_of_week
     : 1(Sunday) - 7 (Saturday)
    "backup_schedule":
  {
      "schedule_period": "WEEKLY",
      "hour": 16,
      "minute": 56,
      "day_of_week": 3
  },
    Backup only few configurations
    In the
    data_filter
     parameter of the configuration file, set the configuration to
    true
     to backup selected configurations. To skip the backup of a particular configuration, set the value to
    false
    .
    If you do not specify the
    data_filter
     parameter,
    VMware Aria Operations for Networks
     backs 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
  }
}
  2. Trigger the restore process.
    The sequence for restore is as follows:
    Method
    Description
    Using CLI commands
    backup-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 as
    Support
     user.
    To run the CLI commands, you must log in as a
    Console
     user on the same platform where you created the restore configuration file.
    Using API
    See
    settings/restore
     on the API Reference page.
    You must provide the configuration as the JSON body in the API request.
    Configurations for the restore process
    Scenario
    Description
    File Configuration
    Configuration to trigger restore
    Restores 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.tar"
}
    Restore only few configurations
    In the
    data_filter
     parameter of the configuration file, set the configuration to
    true
     to restore selected configurations. To skip the restore of a particular configuration, set the value to
    false
    .
    If you do not specify the
    data_filter
     parameter,
    VMware Aria Operations for Networks
     restores 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 the
    collector_mapping
     parameter, all the restored data sources will be mapped to a random collector on the restore setup. 
    "collector_mapping": {
"default_collector": "default_collector_ip",
"mappings": [
{
  "source": "source_collector_ip",
  "destination": "destination_collector_ip"
}
]
}
    If you specify
    collector_mapping
    , all data sources mapped to
    source_collector_ip
     on the backup setup will be mapped to
    destination_collector_ip
     on the restore setup. If mapping is not specified for any collector on the backup setup, the corresponding data sources will be mapped to the
    default_collector
     on 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
  }
}

Content feedback and comments