Skip to main content
OnCommand Workflow Automation 5.0
A newer release of this product is available.

Back up (full) the WFA database using the CLI


You can perform a full backup of the OnCommand Workflow Automation (WFA) database by using the WFA command-line interface (CLI). In a full backup, the WFA database, WFA configuration, and key are backed up.

What you'll need

You must have admin user credentials or architect credentials.

About this task

In a high-availability environment, you should create scheduled backups by using REST APIs. You cannot create backups by using the CLI when WFA is in failover mode.

For more information, see the REST documentation.

  1. At the shell prompt, navigate to the following directory on the WFA server:


    WFA_install_location is the WFA installation directory.

  2. Back up the WFA database:

    .\wfa --backup --user=USER [--password=PASS] [--location=PATH] [--full]

    • user is the user name of the backup user.

    • password is the password of the backup user.

      If you have not provided the password, you must enter the password when prompted.

    • path is the complete directory path to the backup file.

  3. Optional: Verify that the backup file was created at the specified location.