Get Backup Configuration

Get Backup configuration

Request

URI

GET

https://vrni.example.com/api/ni/config/backup

COPY

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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,
        "pinboards": true,
        "applications": true,
        "analytics_outliers": true,
        "analytics_thresholds": 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",
        "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"
            }
        ]
    }
}

ConfigDataFilter

data_filter

Optional

data_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

S3FileServer

s3_file_server

Optional

s3_file_server

boolean

schedule_now

Optional

True, to run backup now (on demand)

boolean

is_ondemand

Optional

Internal, to be used by VMware services.

CollectorMapping

collector_mapping

Optional

collector_mapping

UserMapping

user_mapping

Optional

user_mapping

SyslogCollectorMapping

syslog_collector_mapping

Optional

syslog_collector_mapping

SnmpDestinationCollectorMapping

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

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

404

Not Found

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