Create a Restore Job Definition - InterSystems Caché
ECX leverages Copy Data Management technology for recovering application databases through Database Restore jobs. Your InterSystems Caché clones can be utilized and consumed instantly through ECX Instant Disk Restore jobs. ECX catalogs and tracks all cloned instances. Instant Access leverages ISCSI or fibre channel protocols to provide immediate mount of LUNs without transferring data. Snapshotted databases are cataloged and instantly recoverable with no physical transfer of data.
BEFORE YOU BEGIN:
- Create and run an InterSystems Caché Backup job. See Create a Backup Job Definition - InterSystems Caché.
- Review InterSystems Caché requirements. See InterSystems Caché Requirements.
- For email notifications, at least one SMTP server must be configured. Before defining a job, add SMTP resources. See Register a Provider.
- You must add credentials to the destination virtual machine when recovering with the subnet option. See Add Credentials to a Virtual Machine.
CONSIDERATIONS:
-
Note that the following users and groups must be created on the target host: instance owner, effective user for InterSystems Caché superserver and its jobs, effective group for InterSystems Caché processes, and a group that has permissions to start and stop InterSystems Caché instances. The user and group IDs should match those on the source host. The instance will be brought up using the same points as those found on the source machine, so ensure these mounts are not in use on the target.
- When creating an InterSystems Caché restore job definition, select only one instance to restore. If more than once instance is selected, the InterSystems Caché agent only restores the last instance it receives in the command request.
- When restoring to a target with running InterSystems Caché instances, the instances display as valid targets. Note that ECX will not interact with these instances, but instead bring up a new instance using mapped mount points. When restoring to a target with no prior InterSystems Caché instances, ECX creates an instance named cache_general. This instance does not need to be registered as an InterSystems Caché server.
- Single InterSystems Caché databases can be restored through an Instant Disk Restore job, which mounts physical volumes on the target machine. Granular recovery can then be performed through InterSystems Caché commands.
Best Practice: Create a schedule before creating a job definition so that you can easily add the schedule to the job definition.
To create an InterSystems Caché Restore job definition:
- Click the Jobs tab. Expand the Database folder, then select InterSystems Caché .
- Click New , then select Restore. The job editor opens.
- Enter a name for your job definition and a meaningful description.
- Select a template. Available options include Instant Database Restore and Instant Disk Restore .
- Click Source . From the drop-down menu select Application Browse to select a source site and an application server to view available database recovery points. Select resources, and change the order in which the resources are recovered by dragging and dropping the resources in the grid.
- Alternatively, select Application Search from the drop-down menu to search for application servers with available recovery points. Add copies to the job definition by clicking Add. Change the order in which the resources are recovered by dragging and dropping the resources in the grid.
- Click Copy . Sites containing copies of the selected data display. Select a site. By default the latest copy of your data is used. To choose a specific version, select a site and click Select Version. Click the Version field to view specific copies and their associated job and completion time. If recovery from one snapshot fails, another copy from the same site is used.
- Click Destination . Select a source site and an associated destination. If creating an Instant Disk Restore job definition, review the destination's database name mapping settings. Optionally, click the New database name field to create an alternate database name.
- To create the job definition using default options, click Create Job. The job can be run manually from the Jobs tab.
- To edit options before creating the job definition, click Advanced. Set the job definition options.
- Rename Mount Points
- For more information about the Rename Mount Points options, see Restore Jobs - Rename Mount Points and Initialization Parameter Options.
- If creating an Instant Database Restore job definition, this option is set to Do Not Rename by default. ECX will mount the mount points with the same path/name as the source.
- Continue with next source on failure
- Toggle the recovery of a resource in a series if the previous resource recovery fails. If unselected, the Restore job stops if the recovery of a resource fails.
- Automatically clean up resources on failure
- Enable to automatically clean up allocated resources as part of a restore if the database recovery fails.
- Allow to overwrite and force clean up of pending old sessions
- Enabling this option allows a scheduled session of a recovery job to force an existing pending session to clean up associated resources so the new session can run. Disable this option to keep an existing test environment running without being cleaned up.
- Job-Level Scripts
- 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.
- 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 view on the Configure tab. See Configure Scripts.
- 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.
- Repeat the above procedure to add additional Pre-Scripts and Post-Scripts. For information about script return codes, see Return Code Reference.
- For Restore job post-scripts only, the positional arguments state and status can be passed to the script. For information about this feature, see Using State and Status Arguments in Postscripts. State and status arguments are not supported for Backup jobs.
- Select Continue operation on script failure to continue running the job if a command in any of the scripts associated with the job fails.
- Make Permanent
- Set the default permanent restoration action of the job. All database recovery operations can leverage Instant or Test modes and then either be deleted or promoted to permanent mode. This behavior is controlled through the Make Permanent option.
- Enabled - Always make permanent through full copy FlashCopy
- Disabled - Never make permanent
- User Selection - Allows the user to select Make Permanent or Cleanup when the job session is pending
- Protocol Priority
- If more than one storage network protocol is available, select the protocol to take priority in the job. Available protocols include iSCSI and Fibre Channel.
- Optionally, expand the Notification section to select the job notification options.
- SMTP Server
- 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.
- Email Address
- Enter the email addresses of the status email notifications recipients. Click Add to add it to the list.
- Optionally, expand the Schedule section to select the job scheduling options. Select Start job now to create a job definition that starts the job immediately. Select Schedule job to start at later time to view the list of available schedules. Optionally select one or more schedules for the job. As each schedule is selected, the schedule's name and description displays.
- Note: To create and select a new schedule, click the Configure tab, then select Schedules . Create a schedule, return to the job editor, refresh the Available Schedules pane, and select the new schedule.
- When you are satisfied that the job-specific information is correct, click Create Job. The job runs as defined by your schedule, or can be run manually from the Jobs tab.
NEXT STEPS:
- If you do not want to wait until the next scheduled job run, run the job session on demand. See Start, Pause, and Hold a Job Session.
- Track the progress of the job session on the Jobs tab. See Monitor a Job Session.
- If notification options are enabled, an email message with information about the status of each task is sent when the job completes.
Catalogic ECX™ 2.6
© 2017 Catalogic Software, Inc. | All rights reserved.
MySupport | Knowledge Base | Trademarks | info@catalogicsoftware.com