Create a Backup Job Definition - InterSystems Caché

ECX provides application database copy management through application-consistent backup creation, cloning, and recovery. ECX copy management leverages the snapshot and replication features of the underlying storage platform to create, replicate, clone, and restore backups of InterSystems Caché instances.

ECX auto-discovers databases and enables backups only of eligible instances. To be eligible for backup, instances must reside on supported storage platforms.

BEFORE YOU BEGIN:

CONSIDERATIONS:

  • InterSystems Caché backup jobs occur at the instance level.
  • Note that it is possible to scan in an InterSystems Caché backup failover member instance or an async member instance and run snapshots against the mirror copy instead of the primary failover member.

  • For email notifications, at least one SMTP server must be configured. Before defining a job, add SMTP resources. See Register a Provider.
  • One or more schedules might also be associated with a job. Job sessions run based on the triggers defined in the schedule. See Create a Schedule.

To create an InterSystems Caché Backup job definition:

  1. Click the Jobs Monitor tab icon tab. Expand the Database folder, then select InterSystems Caché .
  2. Click New New icon, then select Backup. The job editor opens.
  3. Enter a name for your job definition and a meaningful description.
  4. From the list of available sites select one or more resources to back up.
  5. Select an SLA Policy that meets your backup data criteria.
  6. Click the job definition's associated Schedule Time field and select Enable Schedule to set a time to run the SLA Policy. If a schedule is not enabled, run the job on demand through the Jobs Monitor tab icon tab. Repeat as necessary to add additional SLA Policies to the job definition.
  7. If configuring more than one SLA Policy in a job definition, select the Same as workflow option to trigger multiple SLA Policies to run concurrently.
  8. Note: Only SLA Policies with the same RPO frequencies can be linked through the Same as workflow option. Define an RPO frequency when creating an SLA Policy.
  9. To create the job definition using default options, click Create Job. The job runs as defined by your triggers, or can be run manually from the Jobs Monitor tab icon tab.
  10. To edit options before creating the job definition, click Advanced. Set the job definition options.
  11. Skip IA Mount points and/or databases
  12. Enable to skip Instant Disk Restore objects. By default, this option is enabled.
  13. Job-Level Scripts
  14. Job-level pre-scripts and post-scripts are scripts that can be run before or after a job runs at the job-level. A script can consist of one or many commands, such as a shell script for Linux-based virtual machines or Batch and PowerShell scripts for Windows-based virtual machines.
  15. In the Pre-Script and/or Post-Script section, click Select to select a previously uploaded script, or click Upload to upload a new script. Note that scripts can also be uploaded and edited through the Scripts Scripts icon view on the Configure Configure tab icon tab. See Configure Scripts.
  16. Once complete, the script displays in the Pre-Script or Post-Script section. Click the Parameters field at add a parameter to the script, then click Add. Note additional parameters can be added to a script by entering parameters one at a time in the field, then clicking Add. Next, click the Identity field to add or create the credentials required to run the script. Finally, click the Application Server field to define the location where the script will be injected and executed. For parameter examples, see Using State and Status Arguments in Postscripts.
  17. Repeat the above procedure to add additional Pre-Scripts and Post-Scripts. For information about script return codes, see Return Code Reference.
  18. Select Continue operation on script failure to continue running the job if a command in any of the scripts associated with the job fails.
  19. Optionally, expand the Notification section to select the job notification options.
  20. SMTP Server
  21. From the list of available SMTP resources, select the SMTP Server to use for job status email notifications. If an SMTP server is not selected, an email is not sent.
  22. Email Address
  23. Enter the email addresses of the status email notifications recipients. Click Add Add Node icon to add it to the list.
  24. When you are satisfied that the job-specific information is correct, click Create Job. The job runs as defined by your triggers, or can be run manually from the Jobs Monitor tab icon tab.

NEXT STEPS:

 


Catalogic ECX™ 2.7.3

© 2018 Catalogic Software, Inc. | All rights reserved. | 9/18/2018

MySupportKnowledge Base | Trademarks | info@catalogicsoftware.com