Add Backup Config

Add Backup Config

Configure backup of setup data

Request
URI
POST
https://vrni.example.com/api/ni/settings/backup
COPY
Request Body

Backup configuration

BackupRestoreRequest of type(s) application/json
Required 
{
    "config_filter": {
        "applications": false,
        "snmp": false,
        "smtp": false,
        "data_sources": false,
        "analytics_thresholds": false,
        "analytics_outliers": false,
        "events": false,
        "syslog": false,
        "pinboards": false,
        "ldap": false,
        "vidm": false,
        "user_data": false,
        "user_preferences": false,
        "physical_subnet_vlan": false,
        "saved_searches": false,
        "physical_ip_dns_mapping": false,
        "east_west_ip": false,
        "north_south_ip": false
    },
    "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"
    },
    "schedule_now": false
}
ConfigDataFilter
config_filter
Optional

config_filter

BackupSchedule
backup_schedule
Optional

backup_schedule

FileServerType
backup_file_server_type
Optional

backup_file_server_type

LocalFileServer
local_file_server
Optional

local_file_server

SshFileServer
ssh_file_server
Optional

ssh_file_server

FtpFileServer
ftp_file_server
Optional

ftp_file_server

boolean
schedule_now
Optional

True, to run backup now (on demand)

Authentication
This operation uses the following authentication methods.
Responses
201

Success

Returns BackupRestoreRequest of type(s) application/json 
{
    "config_filter": {
        "applications": false,
        "snmp": false,
        "smtp": false,
        "data_sources": false,
        "analytics_thresholds": false,
        "analytics_outliers": false,
        "events": false,
        "syslog": false,
        "pinboards": false,
        "ldap": false,
        "vidm": false,
        "user_data": false,
        "user_preferences": false,
        "physical_subnet_vlan": false,
        "saved_searches": false,
        "physical_ip_dns_mapping": false,
        "east_west_ip": false,
        "north_south_ip": false
    },
    "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"
    },
    "schedule_now": false
}
ConfigDataFilter
config_filter
Optional

config_filter

BackupSchedule
backup_schedule
Optional

backup_schedule

FileServerType
backup_file_server_type
Optional

backup_file_server_type

LocalFileServer
local_file_server
Optional

local_file_server

SshFileServer
ssh_file_server
Optional

ssh_file_server

FtpFileServer
ftp_file_server
Optional

ftp_file_server

boolean
schedule_now
Optional

True, to run backup now (on demand)


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

array of ErrorDetail
details
Optional

details


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

array of ErrorDetail
details
Optional

details


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

array of ErrorDetail
details
Optional

details


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

array of ErrorDetail
details
Optional

details


On This Page
Settings Operations
POST
Add new SNMP destination profile
POST
Add Backup Config
POST
Add Ip Tag
POST
Add Restore Config
POST
Add Vidm User
POST
Add Vidm User Group
POST
Create Subnet Mapping
POST
Create User Defined Event
DELETE
Delete An existing SNMP destination profile
DELETE
Delete Backup Config
DELETE
Delete Restore Config
DELETE
Delete Subnet Mapping
DELETE
Delete User
DELETE
Delete User Defined Event
DELETE
Delete User Group
DELETE
Delete Vidm Configuration
POST
Disable Backup
POST
Disable User Defined Event
POST
Disable Vidm
POST
Enable Backup
POST
Enable User Defined Event
POST
Enable Vidm
GET
Get details Of An existing SNMP destination profile
GET
Get All User Defined Events
GET
Get Backup Config
GET
Get Backup Status Report
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get Subnet Mappings
GET
Get User
GET
Get User Defined Event
GET
Get User Group
GET
Get User Groups
GET
Get Users
GET
Get Vidm Configuration
GET
List the configured SNMP destination profiles
POST
Migrate event subscriptions To other SNMP destination profiles
POST
Remove Ip Tag
POST
Save Vidm Configuration
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
PUT
Update Backup Config
PUT
Update Subnet Mapping
PUT
Update User Defined Event
PUT
Update Vidm Configuration
PUT
Update Vidm User Group Role
PUT
Update Vidm User Role