Add Restore Configuration
Configure restore of platform configuration and triggers restore operation. Must be done on a clean platform deployment.
Request
URI
POST
https://{api_host}/api/ni/config/restore
COPY
Request Body
Restore configuration
BackupRestoreRequest of type(s) application/json
Required
{
"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"
}
]
}
}boolean
schedule_now
Optional
True, to run backup now (on demand)
boolean
is_ondemand
Optional
Internal, to be used by VMware services.
snmp_destination_collector_mapping
Optional
snmp_destination_collector_mapping
Responses
201
Success
Returns BackupRestoreRequest of type(s) application/json
{
"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"
}
]
}
}boolean
schedule_now
Optional
True, to run backup now (on demand)
boolean
is_ondemand
Optional
Internal, to be used by VMware services.
snmp_destination_collector_mapping
Optional
snmp_destination_collector_mapping
400
Bad Request
Returns ApiError of type(s) application/json
{
"code": 0,
"message": "string",
"details": [
{
"code": 0,
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
401
Unauthorized
Returns ApiError of type(s) application/json
{
"code": 0,
"message": "string",
"details": [
{
"code": 0,
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
403
Forbidden
Returns ApiError of type(s) application/json
{
"code": 0,
"message": "string",
"details": [
{
"code": 0,
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
500
Internal Error
Returns ApiError of type(s) application/json
{
"code": 0,
"message": "string",
"details": [
{
"code": 0,
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message