NSX-T Data Center REST API

Configure backup

Configure file server and timers for automated backup.
If secret fields are omitted (password, passphrase)
then use the previously set value.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/cluster/backups/config
/api/v1/cluster/backups/config

Request Headers:

n/a

Query Parameters:

BackupFrameRequestParameters+

BackupFrameRequestParameters (schema)

Name	Description	Type	Notes
frame_type	Frame type This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.	string	Readonly Enum: GLOBAL_MANAGER, LOCAL_MANAGER, LOCAL_LOCAL_MANAGER, NSX_INTELLIGENCE Default: "LOCAL_LOCAL_MANAGER"
site_id	Site ID Site ID of LM site, which will be supported in a frame	string	Default: "localhost"

Request Body:

BackupConfiguration+

BackupConfiguration (schema)

Name	Description	Type	Notes
after_inventory_update_interval	A number of seconds after a last backup, that needs to pass, before a topology change will trigger a generation of a new cluster/node backups. If parameter is not provided, then changes in a topology will not trigger a generation of cluster/node backups.	integer	Minimum: 300 Maximum: 86400
backup_enabled	true if automated backup is enabled	boolean	Default: "False"
backup_schedule	Set when backups should be taken - on a weekly schedule or at regular intervals.	BackupSchedule (Abstract type: pass one of the following concrete types) IntervalBackupSchedule WeeklyBackupSchedule
inventory_summary_interval	The minimum number of seconds between each upload of the inventory summary to backup server.	integer	Minimum: 30 Maximum: 3600 Default: "240"
passphrase	Passphrase used to encrypt backup files. Passphrase used to encrypt backup files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (any other non-space character).	string	Pattern: "^$|^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[^a-zA-Z\d\s]).{8,}$"
remote_file_server	The server to which backups will be sent.	RemoteFileServer

Example Request:

PUT https://<nsx-mgr>/api/v1/cluster/backups/config?site_id=fec18cee-ccf7-4d7c-bcc2-8634b08195cd&frame_type=LOCAL_MANAGER { "backup_enabled" : true, "backup_schedule":{ "resource_type": "WeeklyBackupSchedule", "days_of_week":[ 1, 3, 5 ], "hour_of_day":0, "minute_of_day":0 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin", "password":"default" } }, "directory_path":"/nsx-backups" }, "passphrase":"swordfish", "inventory_summary_interval":300 }| PUT https://<nsx-mgr>/api/v1/cluster/backups/config { "backup_enabled" : true, "backup_schedule":{ "resource_type": "IntervalBackupSchedule", "seconds_between_backups":3600 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin", "password":"default" } }, "directory_path":"/nsx-backups" }, "passphrase":"swordfish", "inventory_summary_interval":300 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BackupConfiguration+

BackupConfiguration (schema)

Name	Description	Type	Notes
after_inventory_update_interval	A number of seconds after a last backup, that needs to pass, before a topology change will trigger a generation of a new cluster/node backups. If parameter is not provided, then changes in a topology will not trigger a generation of cluster/node backups.	integer	Minimum: 300 Maximum: 86400
backup_enabled	true if automated backup is enabled	boolean	Default: "False"
backup_schedule	Set when backups should be taken - on a weekly schedule or at regular intervals.	BackupSchedule (Abstract type: pass one of the following concrete types) IntervalBackupSchedule WeeklyBackupSchedule
inventory_summary_interval	The minimum number of seconds between each upload of the inventory summary to backup server.	integer	Minimum: 30 Maximum: 3600 Default: "240"
passphrase	Passphrase used to encrypt backup files. Passphrase used to encrypt backup files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (any other non-space character).	string	Pattern: "^$|^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[^a-zA-Z\d\s]).{8,}$"
remote_file_server	The server to which backups will be sent.	RemoteFileServer

Required Permissions:

crud

Feature:

utilities_backup

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable