Add Backup Configuration
Configure backup of platform configuration; system settings, data sources, SMTP and SNMP settings, and more. This can be sent to a local filesystem, or a remove SSH or FTP server.
Backup configuration
{
"data_filter": {
"snmp": true,
"smtp": true,
"web_proxy": true,
"data_sources": true,
"events": true,
"syslog": true,
"ldap": true,
"vidm": true,
"user_data": true,
"physical_subnet_vlan": true,
"physical_ip_dns_mapping": true,
"system_configuration": true,
"east_west_ip": true,
"north_south_ip": true,
"data_management": true,
"online_update_status": true,
"ceip_status": true,
"audit_logs_pii_status": true,
"applications": true,
"analytics_outliers": true,
"analytics_thresholds": true,
"custom_dashboards": true,
"policies": true
},
"backup_schedule": {
"enable": false,
"schedule_period": "DAILY",
"minute": 30,
"hour": 12,
"day_of_week": 1
},
"backup_file_server_type": "SSH",
"local_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"ssh_file_server": {
"server_address": "10.234.12.134",
"port": 22,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"ftp_file_server": {
"server_address": "10.234.12.134",
"port": 21,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"s3_file_server": {
"orgId": "string",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"schedule_now": true,
"is_ondemand": true,
"collector_mapping": {
"default_collector": "10.78.89.125",
"public_cloud_collector": "10.78.89.125",
"mappings": [
{
"source": "10.78.89.125",
"destination": "10.78.89.126"
}
]
},
"user_mapping": {
"mappings": [
{
"source": "10.78.89.125",
"destination": "10.78.89.126"
}
]
},
"syslog_collector_mapping": {
"mappings": [
{
"server": "10.78.89.125",
"collector": "10.78.89.126"
}
]
},
"snmp_destination_collector_mapping": {
"mappings": [
{
"server": "10.78.89.125",
"collector": "10.78.89.126"
}
]
}
}
data_filter
backup_schedule
File Server type.
local_file_server
ssh_file_server
ftp_file_server
s3_file_server
True, to run backup now (on demand)
Internal, to be used by VMware services.
Mappings for source collector (backup setup) to destination collector (restore setup)
Mappings for users on source (backup setup) to users on destination (restore setup)
Mappings for Syslog server IP to the collector VM IP through which the logs will be routed
Mappings for SNMP destination IP to the collector VM IP through which the traps will be routed
Success
"BackupRestoreRequest Object"
data_filter
backup_schedule
File Server type.
local_file_server
ssh_file_server
ftp_file_server
s3_file_server
True, to run backup now (on demand)
Internal, to be used by VMware services.
Mappings for source collector (backup setup) to destination collector (restore setup)
Mappings for users on source (backup setup) to users on destination (restore setup)
Mappings for Syslog server IP to the collector VM IP through which the logs will be routed
Mappings for SNMP destination IP to the collector VM IP through which the traps will be routed
Bad Request
"ApiError Object"
code
message
details
Unauthorized
"ApiError Object"
code
message
details
Forbidden
"ApiError Object"
code
message
details
Internal Error
"ApiError Object"
code
message
details
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/config/backup