[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

BackupConfiguration

Backup configuration used to configure backup of NSX and SDDC manager

Properties

array of BackupLocation

backupLocations Optional

List of backup locations

array of BackupSchedule

backupSchedules Optional

List of backup schedules

Encryption

encryption Optional

Encryption passphrase used to encrypt and decrypt backup file

boolean

isConfigured Optional

Backup configuration status of both FTP server and passphrase

JSON Example

{
	"backupLocations": [
		{
			"directoryPath": "string",
			"password": "string",
			"port": 0,
			"protocol": "SFTP",
			"server": "string",
			"sshFingerprint": "string",
			"username": "string"
		}
	],
	"backupSchedules": [
		{
			"daysOfWeek": [
				"One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY"
			],
			"frequency": "One among: WEEKLY, HOURLY",
			"hourOfDay": 0,
			"minuteOfHour": 0,
			"resourceType": "SDDC_MANAGER",
			"retentionPolicy": {
				"numberOfDaysOfDailyBackups": 0,
				"numberOfDaysOfHourlyBackups": 0,
				"numberOfMostRecentBackups": 0
			},
			"takeBackupOnStateChange": false,
			"takeScheduledBackups": false
		}
	],
	"encryption": {
		"passphrase": "string"
	},
	"isConfigured": false
}

vcf-for-vxrail

Returned By

Get Backup Configuration

BackupConfiguration

Properties

JSON Example

Returned By

Was this page helpful?