Skip to main content

Schedule OnePlan Backup Utility Backups

  • Updated

This article explains how to set up scheduled backups using the OnePlan Backup Utility.

To run scheduled backups of your OnePlan environment, you will use the OnePlan Backup Utility and Microsoft Task Scheduler. You must be a system administrator with access to the AppData folder for the OnePlan Backup Utility, as well as an Owner for your OnePlan group.

We recommend running these scheduled backups on a server or virtual machine.

  1. Locate the file OnePlanBackupUtil.exe in the AppData folder on your machine. Save the file path for use in a later step.

  2. Open Microsoft Task Scheduler.

  3. Select Action > Create Basic Task. The Create Basic Task wizard will open.

    image1.png

  4. Complete the Create a Basic Task form.

    • Name: Enter a name for the task

    • Description: Enter a description for the task.

    image2.png

  5. Click Next.

  6. Complete the Trigger form.

    • When do you want the task to start?: Select the frequency you would like the task to run.

    image3.png

  7. Click Next.

  8. Complete the task start details form

    • Set the schedule details for the task.

    Note

    The options on this screen are dependent on the frequency you chose in the previous step.

    image4.png

  9. Click Next.

  10. Complete the Action form.

    • What action do you want the task to perform?: Select Start a Program.

    image5.png

  11. Click Next.

  12. Complete the Start a Program form.

    • Program/script: Enter the file path to OnePlanBackupUtil.exe from step 1. Or browse to the file location.

    • Add arguments: Enter the required and desired arguments for the backup utility.

      • -k keyvalue (required): Include an authentication key for your OnePlan environment.

      • -fn filename: Enter a name for the backup file

      • -s siteurl (required): Enter the URL for your OnePlan environment.

      • -l logfilename: Enter a name for the logfile

      • -includecontent: Include this argument if you would like to include content from the group. If left out, the backup will just save the group configuration.

      • -allresource: Include if you would like to save named resources.

    • Start in: Leave blank.

    image6.png

  13. Click Next.

  14. Review the task details. If everything is correct, click Finish.

    image7.png

Related articles

Comments

0 comments

Article is closed for comments.