backup mssql_database

Creates a backup of the specified Microsoft SQL Server instances or databases.

Examples

Parameters

What to back up

--items=<items>
--sql_credentials=<user name>,<password>,encrypted

Credentials of a user who is a member of the sysadmin role in the instance that you want to back up.

Where to save the backup

--loc=<path>
--credentials=<user name>,<password>,encrypted
--arc=<archive name>
--password=<password>,encrypted

How to back up

--archive_comment=<comments>
--backup_comment=<comments>
--backuptype={full|incremental}
--mssql_truncate_logs

Backup options

--compression={none|normal|high}
--encryption={none|aes128|aes192|aes256}
--force_yes
--hdd_speed=<speed>{kb|p}
--network_speed=<speed>{kb|p}
--post_cmd=<command>
--pre_cmd=<command>
--process_priority={low|normal|high}
--retry_count=<number of attempts>
--retry_delay=<delay>
--silent_mode={on|off}
--split=<size>
--use_registry_defaults

General parameters

--log=<full path>
--log_format={structured|unstructured}
--progress
{-f|--file_params}=<full local path>

Access to a remote machine

--host=<IP address or hostname>
--credentials=<user name>,<password>,encrypted
--address=<IP addresses or hostnames>

Access to a specific service within a machine

--service={mms|ams}