[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Add Backup Config

Description

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.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/settings/backup
Copy

Request Body

Request Body

BackupRestoreRequest of type(s) application/json Required

Backup configuration

{
	"backup_file_server_type": "SSH",
	"backup_schedule": {
		"day_of_week": 1,
		"enable": false,
		"hour": 12,
		"minute": 30,
		"schedule_period": "DAILY"
	},
	"collector_mapping": {
		"default_collector": "10.78.89.125",
		"mappings": [
			{
				"destination": "10.78.89.126",
				"source": "10.78.89.125"
			}
		]
	},
	"data_filter": {
		"audit_logs_pii_status": true,
		"ceip_status": true,
		"data_management": true,
		"data_sources": true,
		"east_west_ip": true,
		"events": true,
		"ldap": true,
		"north_south_ip": true,
		"online_update_status": true,
		"physical_ip_dns_mapping": true,
		"physical_subnet_vlan": true,
		"smtp": true,
		"snmp": true,
		"syslog": true,
		"system_configuration": true,
		"user_data": true,
		"vidm": true,
		"web_proxy": true
	},
	"ftp_file_server": {
		"backup_directory": "/home/testuser",
		"backup_file_name": "vrni-backup-12-4-5.tar",
		"password": "password",
		"port": 21,
		"server_address": "10.234.12.134",
		"username": "testuser"
	},
	"local_file_server": {
		"backup_directory": "/home/testuser",
		"backup_file_name": "vrni-backup-12-4-5.tar"
	},
	"schedule_now": true,
	"ssh_file_server": {
		"backup_directory": "/home/testuser",
		"backup_file_name": "vrni-backup-12-4-5.tar",
		"password": "password",
		"port": 22,
		"server_address": "10.234.12.134",
		"username": "testuser"
	}
}
backup_file_server_type Optional

File Server type.

Possible values are: LOCALSSHFTP


backup_schedule Optional

collector_mapping Optional

Mappings for source collector (backup setup) to destination collector (restore setup)


data_filter Optional

ftp_file_server Optional

local_file_server Optional

boolean
schedule_now Optional

True, to run backup now (on demand)


ssh_file_server Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns BackupRestoreRequest of type(s) application/json
{
	"backup_file_server_type": "SSH",
	"backup_schedule": {
		"day_of_week": 1,
		"enable": false,
		"hour": 12,
		"minute": 30,
		"schedule_period": "DAILY"
	},
	"collector_mapping": {
		"default_collector": "10.78.89.125",
		"mappings": [
			{
				"destination": "10.78.89.126",
				"source": "10.78.89.125"
			}
		]
	},
	"data_filter": {
		"audit_logs_pii_status": true,
		"ceip_status": true,
		"data_management": true,
		"data_sources": true,
		"east_west_ip": true,
		"events": true,
		"ldap": true,
		"north_south_ip": true,
		"online_update_status": true,
		"physical_ip_dns_mapping": true,
		"physical_subnet_vlan": true,
		"smtp": true,
		"snmp": true,
		"syslog": true,
		"system_configuration": true,
		"user_data": true,
		"vidm": true,
		"web_proxy": true
	},
	"ftp_file_server": {
		"backup_directory": "/home/testuser",
		"backup_file_name": "vrni-backup-12-4-5.tar",
		"password": "password",
		"port": 21,
		"server_address": "10.234.12.134",
		"username": "testuser"
	},
	"local_file_server": {
		"backup_directory": "/home/testuser",
		"backup_file_name": "vrni-backup-12-4-5.tar"
	},
	"schedule_now": true,
	"ssh_file_server": {
		"backup_directory": "/home/testuser",
		"backup_file_name": "vrni-backup-12-4-5.tar",
		"password": "password",
		"port": 22,
		"server_address": "10.234.12.134",
		"username": "testuser"
	}
}
backup_file_server_type Optional

File Server type.

Possible values are: LOCALSSHFTP


backup_schedule Optional

collector_mapping Optional

Mappings for source collector (backup setup) to destination collector (restore setup)


data_filter Optional

ftp_file_server Optional

local_file_server Optional

boolean
schedule_now Optional

True, to run backup now (on demand)


ssh_file_server Optional
Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"backup_file_server_type":"SSH","backup_schedule":{"day_of_week":1,"enable":false,"hour":12,"minute":30,"schedule_period":"DAILY"},"collector_mapping":{"default_collector":"10.78.89.125","mappings":[{"destination":"10.78.89.126","source":"10.78.89.125"}]},"data_filter":{"audit_logs_pii_status":true,"ceip_status":true,"data_management":true,"data_sources":true,"east_west_ip":true,"events":true,"ldap":true,"north_south_ip":true,"online_update_status":true,"physical_ip_dns_mapping":true,"physical_subnet_vlan":true,"smtp":true,"snmp":true,"syslog":true,"system_configuration":true,"user_data":true,"vidm":true,"web_proxy":true},"ftp_file_server":{"backup_directory":"/home/testuser","backup_file_name":"vrni-backup-12-4-5.tar","password":"password","port":21,"server_address":"10.234.12.134","username":"testuser"},"local_file_server":{"backup_directory":"/home/testuser","backup_file_name":"vrni-backup-12-4-5.tar"},"schedule_now":true,"ssh_file_server":{"backup_directory":"/home/testuser","backup_file_name":"vrni-backup-12-4-5.tar","password":"password","port":22,"server_address":"10.234.12.134","username":"testuser"}}' https://vrni.example.com/api/ni/settings/backup


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?