Veritas System Recovery 21 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.

IProtectorAuto Interface

Description: An automation object exposing APIs to connect to VproSvc and run backup, restore, and conversion functionalities exposed by BESR.

IID: {349C4523-2477-4BC4-99D4-D6B9BEB6CDFD}

Properties

VT_DISPATCH	Status	Read	Current status of the connected agent.
VT_DISPATCH	Abilities	Read	Supported abilities and limitations of the agent.
VT_DISPATCH	About	Read	Product information about the connected agent.
VT_VARIANT	Volumes(VT_BOOL BackupHistory)	Read	An array of all volumes those are available from the connected agent.
VT_VARIANT	Destinations	Read	Returns a list of valid destinations for copy or restore.
VT_VARIANT	ImageJobs	Read	Specifies a list of all Imagejobs.
VT_VARIANT	Disks	Read	Specifies a list of all disks.
VT_VARIANT	ImageLocations	Read	An array of all supported image locations (see ImageLocation derivatives).
VT_VARIANT	SupportedEventMonitors	Read	An array of all supported event monitors.
VT_DISPATCH	Volume(VT_BSTR ID)	Read	A specific volume by ID.
VT_DISPATCH	ImageJob(VT_BSTR ID)	Read	A specific ImageJob by ID.
VT_DISPATCH	Destination(VT_BSTR ID)	Read	A specific destination by ID (for copy or restore).
VT_DISPATCH	DefaultImageLocation	Read Write	The default location where the images will be stored.
VT_VARIANT	CommandFiles	Read	Returns a list of command files (.cmd;.bat;*.exe) at the default command file location.
VT_BSTR	CommandFilesFolder	Read	Returns the folder that is used to hold command files.
VT_VARIANT	AvailableDriveLetters	Read	Gets a list of available (unused / mounted) drive letters.
VT_BSTR	ConnectedComputer	Read	Retrieves the name of the computer you are connected to.
VT_DISPATCH	Constants	Read	Constants used for scripting.
VT_DISPATCH	License	Read	Licensing information for the connected agent.
VT_DISPATCH	NotificationHandler(VT_BSTR HandlerID)	Read Write	A specific notification Hhandler by ID.
VT_UINT	Throttle	Read Write	Gets the maximum resource usage for the current operation.
VT_UINT	DefaultThrottle	Read Write	The default CPU throttle value that is used during imaging. An integer value between 0 and 100
VT_BOOL	IsThrottleAvailable	Read	Determines if the throttle is available.
VT_DISPATCH	NotificationHandlerObject(VT_BSTR HandlerID)	Read	A specific notification handler by ID.

Methods

VT_VOID Connect(VT_BSTR Computer)	Connects to a computer that you want to manage. Uses computer name as a parameter.
VT_VOID Refresh	Forces the agent to update its system view.
VT_DISPATCH WaitForStatusChange	Blocks until the agent's status changes.
VT_VOID WaitForVolumeChange	Blocks until a volume's properties change.
VT_VOID WaitForJobChange	Blocks until an ImageJob's properties change.
VT_DISPATCH WaitForJobCompletedChange	Blocks until the agent's job completes.
VT_VOID DoImageJob(VT_BSTR ImageJobID, eIMAGE_TYPE ImageType)	Uses a saved ImageJob to create the specified type of image immediately. Uses imagejobID and ,imagetype (Full, base, incremental, or consolidated) as parameters.
VT_VOID AddImageJob(VT_DISPATCH ImageJob)	Adds or updates an ImageJob to the list of ImageJobs for the current agent/ or computer. Uses imagejob as a parameter.
VT_VOID RemoveImageJob(VT_BSTR ImageJobID)	Removes a saved ImageJob.
VT_VOID RestoreImage(VT_DISPATCH RestoreJob)	Restores an Image to a Destination.
VT_VOID CopyVolume(VT_DISPATCH CopyJob)	Copies a volume to a new disk/ or partition. Uses copyjob as a parameter.
VT_VOID ForgetVolume(VT_BSTR Volume)	Deletes history for an invalid volume.
VT_VOID DisableImageJob(VT_BSTR ImageJobID)	Disables an ImageJob (will not execute according to the schedule).
VT_VOID EnableImageJob(VT_BSTR ImageJobID)	Enables an ImageJob (will execute according to the schedule).
VT_VOID Cancel	Attempts to cancel the current operation (If possible).
VT_VOID SetNotificationProperty(VT_BSTR Handler, VT_I4 Property, VT_VARIANT newVal)	Sets an individual notification property.
VT_VARIANT GetNotificationProperty(VT_BSTR Handler, VT_I4 Property)	Retrieve an individual notification property.
VT_VOID Notify(ePQ_NOTIFY_TYPE Type, ePQ_NOTIFY_PRIORITY Priority, VT_UI4 Code, VT_BSTR Description, VT_BSTR Source)	Submits an event to the agent's notification system. Uses type (Unknown, Error, Warning, Info), priority (Unknown, High, Medium, Low), code, description, and source as parameters.
VT_VOID ValidateLocation(VT_DISPATCH ImageLocation, VT_DISPATCH LocationConstraints)	Validates an image location based on given constraints.
VT_VOID Resume	Resumes the agent's current operation (if the operation is in WAITING state).
VT_VOID InstallLicense(VT_BSTR bsLicenseData)	Installs license. Uses license data (slf or key) as a parameter.
VT_VOID ValidateRestoreDestination(VT_DISPATCH RestoreJob, VT_VARIANT Destinations)	Validates an array of destinations for a RestoreJob operation. Uses restoreJobID, and destinations as parameters.
VT_VOID ValidateCopyDestination(VT_BSTR VolumeID, VT_VARIANT Destinations)	Validates an array of destinations for a CopyJob operation.
VT_VOID CleanImageHistory	Removes old entries from the image file sets from the image history.
VT_VOID RebootToRestore(VT_BSTR UserName, VT_BSTR Password, VT_BSTR Filename, VT_BOOL ModifyBoot)	Sets up network credentials for restore within the recovery environment. Uses restore job as a parameter.
VT_VOID RegisterForErrorNotification	Method RegisterForNotification - to be called by applications that require error notifications.
VT_VOID DisableGoBack	Method DisableGoBack -ï¿½ to disable GoBack service. Must be called before a volume is restored or copied if GoBack service is active.
VT_VOID ConsolidateIncrementals(VT_DISPATCH ConsolidateJob)	Consolidates incremental backup data into a single incremental backup file. Uses consolidatejob as a parameter.

Home