Get Backup Config

Get Backup Config

Get Backup configuration

Request
URI
GET
https://www.mgmt.cloud.vmware.com/ni/api/ni/settings/backup
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

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"
            }
        ]
    }
}
data_filter
Optional

data_filter

backup_schedule
Optional

backup_schedule

backup_file_server_type
Optional

backup_file_server_type

local_file_server
Optional

local_file_server

ssh_file_server
Optional

ssh_file_server

ftp_file_server
Optional

ftp_file_server

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.

collector_mapping
Optional

collector_mapping

user_mapping
Optional

user_mapping

syslog_collector_mapping
Optional

syslog_collector_mapping

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

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

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

details
Optional

details


500

Internal Error

Operation doesn't return any data structure

Settings Operations
POST
Add new SNMP Trap destination profile
POST
Add Backup Config
POST
Add Ip Tag
POST
Add Restore Config
POST
Add Search Based Alert Config
POST
Add Syslog Target
POST
Add Tag V2
POST
Add Web Proxy
POST
Create Subnet Mapping
POST
Create Subscriber
POST
Create User Defined Event
DELETE
Delete An existing SNMP Trap destination profile
DELETE
Delete Backup Config
DELETE
Delete Restore Config
DELETE
Delete Search Based Alert Config
DELETE
Delete Subnet Mapping
DELETE
Delete Subscriber
DELETE
Delete Syslog Target
DELETE
Delete User Defined Event
DELETE
Delete Web Proxy
POST
Disable Search Based Alert Config
POST
Disable User Defined Event
POST
Enable Search Based Alert Config
POST
Enable User Defined Event
GET
Get details Of An existing SNMP destination profile
GET
Get All Search Based Alert Configs
GET
Get All Subscriber
GET
Get All User Defined Events
GET
Get Backup Config
GET
Get Backup Status Report
GET
Get Connected Clients To Web Proxy
GET
Get Infra Nodes Web Proxy
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Ip Tag V2
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get Search Based Alert Config
GET
Get Subnet Mappings
GET
Get Subscriber
GET
Get Syslog Mapping
GET
Get Syslog Status
GET
Get Syslog Target List
GET
Get Tag Ids V2
GET
Get User Defined Event
GET
Get Web Proxies
GET
Get Web Proxy
GET
List the configured SNMP Trap destination profiles
POST
Migrate event subscriptions To other SNMP Trap destination profiles
POST
Remove Ip Tag
POST
Remove Tag V2
POST
Send Test trap To SNMP destination profile
POST
Send Syslog Test Message
PUT
Update An existing SNMP destination profile
PUT
Update user password
PUT
Update Backup Config
PUT
Update Search Based Alert Config
PUT
Update Subnet Mapping
PUT
Update Subscriber
POST
Update Syslog Mapping
PATCH
Update Syslog Status
PUT
Update Syslog Target
PUT
Update User Defined Event
PUT
Update Web Proxy
POST
Validate Connections Via Web Proxy
POST
Validate Web Proxy Migration