Veritas System Recovery 16 Automation - THIS SCRIPTING DOCUMENTATION IS PROVIDED IN CONJUNCTION WITH YOUR LICENSE FOR VERITAS SYSTEM RECOVERY SOFTWARE PRODUCTS, AND MAY BE USED ONLY IN CONJUNCTION WITH THAT SOFTWARE, UNDER THE TERMS OF THE END USER LICENSE AGREEMENT THAT ACCOMPANIED THE SOFTWARE. THIS SCRIPTING DOCUMENTATION IS PROPRIETARY VERITAS PROPERTY. YOU MAY NOT COPY, DISTRIBUTE, LICENSE OR SUBLICENSE THE SCRIPTING DOCUMENTATION.

Getting Started

Overview

Veritas VProRecovery Automation Framework lets you use Veritas System Recovery in powerful ways customized to the needs of your organization. All of Veritas System Recovery's functionality is exposed as scriptable objects. Using these objects and their associated functions, you can create scripts to accomplish anything that can be done within the Veritas System Recovery main user interface, such as retrieving a list of scheduled backup jobs or creating a new backup job. When you combine VProRecovery Automation with other scripting applications and the operating system, powerful tasks such as creating backup reports and distributing backup jobs to many computers are simple.

Using scripts to tap the power of an application is typically called "automation". Automating Veritas System Recovery involves writing script code to connect to the Veritas System Recovery service on a given computer, creating job objects describing the actions you want to perform, and passing the job objects to the connected agent so they can run. This is the basic design followed by each of the example scripts that are included.

The VProRecovery Automation Framework includes a central object (ProtectorAuto) that is used to connect to the agent, and several smaller objects which are used to describe the actions you want the agent to perform. Descriptions of these objects and their functions and properties are included in the online documentation.

The objects within the VProRecovery Automation Framework are accessible from any scripting host or application that supports Microsoft's COM Automation. You can create the scripts using a plain text editor, a PowerShell editor, or a PowerShell Interactive Development Environment (IDE), such as PowerShell SE or PowerShell GUI. To run the PowerShell scripts, PowerShell must be installed on your computer. After you install PowerShell on your computer, you can run the scripts using the Windows PowerShell command-line.

Note: Veritas does not provide support for customizing products using the Veritas System Recovery Automation Framework. However, you can contact support if you face any issues while using the APIs or the commands as described in the documentation.

Important! The VProRecovery Automation Framework support files must be installed on the computer where the script is run. These support files are automatically installed when the agent or management console is installed.

The scripting documentation provided herein can only be used in conjunction with the software with which it is distributed. It cannot be copied, distributed, licensed or sublicensed and is governed by the terms and conditions of the End User License Agreement provided with the software.

Example scripts

Each of the included example scripts follow the same general steps. Each script uses the ProtectorAuto object to connect to the agent on a computer, creates objects to describe the required actions, and gives the objects to the connected agent. These steps will likely be followed when you create scripts to meet your specific needs. More powerful scripts can be created by combining the functionality of Veritas System Recovery with other scriptable applications or the operating system.

To run the included scripts, save them with a .ps1 file extension and run them using Windows PowerShell command-line. You may need to modify the included scripts to run correctly in your environment. When they run successfully, modify them to meet your needs or to better integrate into your existing processes.

CreateImageNow.ps1 - Connects to the agent on a computer, retrieves a list of available volumes, and finds a specific volume. It then creates a job to image that volume to an existing network share (passed to the script on the Windows PowerShell command-line), and gives the backup job to the connected agent to run.

AddImageJob.ps1 - Connects to the agent on a computer, retrieves a list of available volumes, and finds a specific volume. It then creates a backup job to image that volume to an existing local folder (passed to the script on the Windows PowerShell command-line). It creates a task object to describe when the backup job should occur, and gives the job to the connected agent to run.

RemoveAllJobs.ps1 - Connects to the agent on a computer, retrieves a list of saved jobs, and removes each one.

CopyVolume.ps1 - Connects to the agent on a computer, finds a specific volume, creates a copy job to copy the volume to unallocated space, and gives the job to the connected agent to run.

Writing your own scripts

When writing your own scripts, you will most likely follow the steps used in the included example scripts. Your script must first determine which computer to connect to by reading from a file or Windows PowerShell command-line input. An instance of the ProtectorAuto object must be created and used to connect to the agent on the desired computer. The functions of the ProtectorAuto object must be used to communicate with the connected agent to accomplish the required actions.

Scripts must be written in a language that supports Microsoft's COM Automation interface, such as PowerShell Script or Visual Basic Script.

Also, numerous resources are available on the Internet to help you learn how to create scripts in these languages.

Scripts must be run on a computer where the VProRecovery Automation Framework support files are installed. These support files are automatically installed when the agent or management console is installed. Scripts can use the ProtectorAuto object to connect to the agent on any computer where the Veritas System Recovery service is installed and where the running user has rights to connect to that agent. The same security restrictions apply when running scripts that apply when connecting to the agent from the Veritas System Recovery main user interface.

Home