Documentation Home
MySQL Enterprise Backup 9.3 User's Guide
Related Documentation Download this Manual
PDF (US Ltr) - 1.3Mb
PDF (A4) - 1.3Mb


20.13 Encryption Options

These options are for creating encrypted single-file backups and for decrypting them. SeeChapter 10,Encryption for Backups for more details and usage examples for the encryption and decryption functions of MySQL Enterprise Backup.

  • --encrypt

    Encrypt the data when creating a backup image by abackup-to-image operation, or when packing a backup directory into a single file with thebackup-dir-to-image command. It cannot be used with thebackup orbackup-and-apply-log command.

  • --decrypt

    Decrypt an encrypted backup image when performing anextract,image-to-backup-dir, orcopy-back-and-apply-log operation. It is also used for performing avalidate orlist-image operation on an encrypted backup image.

    The option cannot be used in aapply-log,backup-and-apply-log, orcopy-back operation. For restoration using thecopy-back command, the encrypted backup image has to be unpacked and decrypted first using theimage-to-backup-dir orextract command, together with the--decrypt option.

  • --key=STRING

    Command-Line Format--key=KEY
    TypeString

    The symmetric key for encryption and decryption of a backup image. It should be a 256-bit key, encoded as a string of 64 hexadecimal digits. SeeChapter 10,Encryption for Backups on how to create a key. The option is incompatible with the--key-file option.

  • --key-file=PATH

    Command-Line Format--key-file=FILE
    TypeFile name

    The pathname to file that contains a 256-bit key, encoded as a string of 64 hexadecimal digits, for encryption and decryption of a backup image. The option is incompatible with the--key option.