asc backup

Use this command to backup and restore the CloudControl configuration. You can use the backup files for disaster recovery and configuration migration.

Syntax

asc backup [options]

Option

Description

-b, --backup [file]

Create a configuration backup archive. Specifying the archive file name is optional.

-h, --help

Display usage text.

-n, --nocrypt

Create an unencrypted backup image. Unencrypted backup data must be stored and transported securely.

Must be used with the asc backup --backup command.

Once you use the --password option, you can no longer use the --nocrypt option on the same backup file.

-p, --password <password>

Set or verify the configuration backup archive password.

The configuration backup archive password can also be specified using the PASSWORD environment variable. For example, export PASSWORD='secret123!'.

If a password was specified when you created the archive, you must use the --password option to restore the archive.

Important:

Once you use the --password option, you can no longer use the --nocrypt option on the same backup file.

-r, --restore [file]

Restore a configuration backup archive. This option uses the CD-ROM by default or takes an optional backup ISO filename.

The --password argument or environment variable is required if the archive is encrypted.

-t, --test

Validate the command line arguments without performing any actions.

-v, --verify [file]

Validate the configuration backup archive file. This option uses the CD-ROM by default or takes an optional backup ISO filename.

The --password argument or environment variable is required if the archive is encrypted.

--setpassword

Sets the default password used to encrypt the backup archive.

--setlocation

Sets the default location used to archive the backup ISO. Use one of the following parameters:

scp://<user>:<password>@<host>/<destination_directory>
nfs://<host>/<destination_directory>
local

Note:

All parameters are validated, and passwords are not logged.

--getlocation

Retrieves the location used to store the backup images using --setlocation. If the location includes a password, it will be obfuscated.

--schedule

Set the schedule for the backup job. Requires the --interval parameter.

--interval

The frequency to perform the backup used with the schedule command. This can be one of the following:

d—days
h—hours
m—minutes

Setting the schedule overwrites any existing schedule. Schedules can be manually modified with 'crontab -e'.

--setcopies

Sets the number of backup images to keep. Set to '0' to retain all copies.

--getcopies

Retrieves the number of backup images that you set.

--unschedule

Deletes the schedule. This can also be achieved with 'crontab -r'.

--start <time>

Specifies when the backup will be run. Requires the time in hh:mm format.

Examples

Create an encrypted backup with a specified filename:

asc backup --backup /tmp/20120515_backup.iso --password 'secret123!'

Create an encrypted backup with the default filename:

export PASSWORD='secret123!'

asc backup --backup

Create an unencrypted backup with the default filename:

asc backup --backup --nocrypt

Validate a backup file:

asc backup --verify /tmp/20120515_backup.iso --password 'secret123!'

Validate a backup on the CD-ROM:

asc backup --verify --password 'secret123!'

Restore an encrypted backup file:

asc backup --restore /tmp/20120515_backup.iso --password 'secret123!'

Restore an encrypted backup from the CD-ROM:

asc backup --restore --password 'secret123!'

export PASSWORD='secret123!'

asc backup --restore

Create an ongoing remote backup at the specified location.

asc backup --setlocation scp://admin:password123@10.1.1.1/root/backups --setcopies 5 --schedule --start 03:45 --interval 24h

Retrieve the remote location information:

asc backup --getlocation