SQL Admin Provider::BackupDBToDisk
The BackupDBToDisk method allows you to create a full database backup to disk.
Arguments
| Input argument | Required | Description |
|---|---|---|
Name |
Yes |
The name of the database to back up. |
FilePath |
Yes |
The full file path to the file to write the backup to. |
Description |
Yes |
The description or details about the backup. |
Overwrite |
Yes |
Flag indicating if the backup should be appended to the indicated file. Valid values are 0 (append) or 1 (overwrite). |
ServerName |
Yes |
A string representing the name of the server. This can be a NetBIOS name, a FQDN, or an IP address. It is vital that the server upon which MPS is running be able to resolve server names using whichever naming convention you employ. |
[sqlUserName] |
No |
User name for connecting to the SQL server via SQL Authentication. If this node is present the connection will be made via SQL Authentication rather than Windows Authentication. The existence of this node also requires that the <sqlUserPass/> node exist. |
[sqlUserPass] |
No |
The password for connecting to the SQL server via SQL Authentication using the username indicated by <sqlUserName/>. If the <sqlUserName/> node is not present, this node is ignored. |
Remarks
Rollback Calls
The BackupDBToDisk method has no transaction rollback support.
Sample Code
Example XML Request
The following is an example of an XML request for the BackupDBToDisk method:
<?xml version="1.0" encoding="iso-8859-1" ?>
<request>
<data>
<name>SampleSQL01</name>
<filePath>D:\Backups\SampleSQL01.bak</filePath>
<description></description>
<overwrite>1</overwrite>
<serverName>SQL01</serverName>
<sqlUserName>sampleUser</sqlUserName>
<sqlUserPass>Pass1Word</sqlUserPass>
</data>
<procedure>
<execute namespace="SQL Admin Provider"
procedure="BackupDBToDisk">
<before source="data" destination="executeData" mode="merge"/>
<after source="executeData" destination="data" mode="insert"/>
</execute>
</procedure>
</request>
Example XML Response
The following is an example the structure of an XML response for the BackupDBToDisk method. The actual returned data will be filled in within the <data> nodes:
<?xml version="1.0" encoding="iso-8859-1" ?>
<response>
<data></data>
</response>
Applies To
for:
Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0
Hosted Messaging and Collaboration version 3.5
Hosted Messaging and Collaboration version 3.0
Windows-based Hosting version 4.5
Windows-based Hosting version 4.0
Windows-based Hosting version 3.5
Windows-based Hosting for Applications version 1.0