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.
ProtectorAuto Object

Description: Central automation object for accessing exposed BESR functionalities such as backup, restore, and p2v conversions.
ProgId: ProtectorAuto
CLSID: {485EE909-9AE9-4F5D-8A59-73DF014CB8F7}
Implemented Interfaces: IProtectorAuto (default), IProtectorAuto2, IProtectorAuto3, IProtectorAuto4, IProtectorAuto5, IProtectorAuto6, IProtectorAuto7, IProtectorAuto8, IProtectorAuto9, IProtectorAuto10, IProtectorAuto11, IProtectorAuto12, IProtectorAuto13, IProtectorAuto14, IProtectorAuto15, IProtectorAuto16
Properties
VT_DISPATCHStatus ReadCurrent status of the connected agent.
VT_DISPATCHAbilities ReadSupported abilities and limitations of the agent.
VT_DISPATCHAbout ReadProduct information about the connected agent.
VT_VARIANTVolumes(VT_BOOL BackupHistory) ReadAn array of all volumes those are available from the connected agent.
VT_VARIANTDestinations ReadReturns a list of valid destinations for copy or restore.
VT_VARIANTImageJobs ReadSpecifies a list of all Imagejobs.
VT_VARIANTDisks ReadSpecifies a list of all disks.
VT_VARIANTImageLocations ReadAn array of all supported image locations (see ImageLocation derivatives).
VT_VARIANTSupportedEventMonitors ReadAn array of all supported event monitors.
VT_DISPATCHVolume(VT_BSTR ID) ReadA specific volume by ID.
VT_DISPATCHImageJob(VT_BSTR ID) ReadA specific ImageJob by ID.
VT_DISPATCHDestination(VT_BSTR ID) ReadA specific destination by ID (for copy or restore).
VT_DISPATCHDefaultImageLocation Read WriteThe default location where the images will be stored.
VT_VARIANTCommandFiles ReadReturns a list of command files (*.cmd;*.bat;*.exe) at the default command file location.
VT_BSTRCommandFilesFolder ReadReturns the folder that is used to hold command files.
VT_VARIANTAvailableDriveLetters ReadGets a list of available (unused / mounted) drive letters.
VT_BSTRConnectedComputer ReadRetrieves the name of the computer you are connected to.
VT_DISPATCHConstants ReadConstants used for scripting.
VT_DISPATCHLicense ReadLicensing information for the connected agent.
VT_DISPATCHNotificationHandler(VT_BSTR HandlerID) Read WriteA specific notification Hhandler by ID.
VT_UINTThrottle Read WriteGets the maximum resource usage for the current operation.
VT_UINTDefaultThrottle Read WriteThe default CPU throttle value that is used during imaging. An integer value between 0 and 100
VT_BOOLIsThrottleAvailable ReadDetermines if the throttle is available.
VT_DISPATCHNotificationHandlerObject(VT_BSTR HandlerID) ReadA 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 RefreshForces the agent to update its system view.
VT_DISPATCH WaitForStatusChangeBlocks until the agent's status changes.
VT_VOID WaitForVolumeChangeBlocks until a volume's properties change.
VT_VOID WaitForJobChangeBlocks until an ImageJob's properties change.
VT_DISPATCH WaitForJobCompletedChangeBlocks 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 CancelAttempts 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 ResumeResumes 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 CleanImageHistoryRemoves 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 RegisterForErrorNotificationMethod RegisterForNotification - to be called by applications that require error notifications.
VT_VOID DisableGoBackMethod 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


Copyright © 2004-2019 Veritas Technologies LLC. All Rights Reserved.