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.
IProtectorAuto8 Interface

Description: Extension of the IProtectorAuto interface that exposes more APIs.
IID: {2C718948-1A43-490B-A1D7-8A9BBD20FF01}
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.
VT_BOOLPrependUniqueFileName Read WriteSpecifies whether to use unique file names for images.
VT_BSTRConnectedComputerName ReadReturns the name of the computer you are currently connected to.
VT_DISPATCHLicenseEx(VT_BSTR licenseName, VT_BSTR version) ReadLicensing information for named AgentLicense object.
VT_VARIANTFeatures(VT_BOOL bIncludeProduct) ReadGets the installed features that can be licensed separately
VT_BOOLTrayVisibility Read WriteSpecifies whether to show or hide icon in the tray.
VT_UINTFilterMessages Read WriteSpecifies whether to show All or Only Error messages in the tray.
VT_VARIANTRestorePoints(VT_BSTR BackupLocation, VT_BOOL SearchRecursive) ReadProperty RestorePoints - an array of all volumes with each of its restore points in the given location on this machine.
VT_UINTNetworkThrottle Read WriteGets the current value for network throttle (KBytes per second).
VT_UINTActualNetworkKBytesPerSec ReadGets the actual network Kilo bytes per second.
VT_VARIANTCommandFilesEx(VT_BSTR sFolder, VT_BSTR sUserName, VT_BSTR sPassword, VT_BOOL bPasswordEncrypted) ReadReturns a list of command files (*.cmd;*.bat;*.exe) at the specified command file location.
VT_VARIANTExtensionGroups ReadProperty to get extension groups
VT_INTLastSystemBackupInterval ReadProperty GetLastSystemBackupInterval - Returns the number of days since the last system volume backup. -1 if the system volume is not backed up earlier.
VT_INTProductElapsedDays ReadReturns the number of days since the product is installed.
VT_VARIANTffbHistory(VT_BOOL BackupHistory) ReadAn array of all FIle Folder Backups available from the connected agent.
VT_BOOLMissedBackupVisibility Read WriteSpecifies whether to show dialog from the tray.
VT_VARIANTMissedBackupImageJobs ReadAn array of all missed backup ImageJobs.
VT_BSTRLicensingModel ReadProperty LicensingModel - gets the licensing model for the service.
VT_BOOLEnableGoogleDesktop Read WriteSpecifies whether to enable GoogleDesktop file and folder recovery.
eALERTPOLICY_LEVELComputerPolicyLevel(VT_BOOL IncludeFFB, VT_VARIANT Volumes, VT_VARIANT Policies) ReadAggregate of policy level for all volumes and file/ and folder jobs.
eALERTPOLICY_LEVELVolumePolicyLevel(VT_BSTR VolumeID, VT_DISPATCH PolicyList) ReadPolicy level for the requested volume.
VT_DISPATCHVolumePolicy(VT_BSTR VolumeID) ReadPolicy list for the specified volume.
VT_DISPATCHFileFolderPolicy ReadPolicy for file folder backups.
eALERTPOLICY_LEVELFileFolderPolicyLevel(VT_DISPATCH PolicyList) ReadPolicy level for file folder backups.
VT_DISPATCHImageForFile(VT_DISPATCH ImageLocation, VT_DISPATCH LocationConstraints) ReadGets an Image object for the given Location object.
VT_VARIANTffbHistoryEx(eIMAGE_FILTER nImageFilter, VT_BOOL BackupHistory) ReadAn array of all file folder Backups available from the connected agent. You can select the history type. Uses imagefilter (Normal, Deleted, Unavailable, Check_available, Success, Failed, All) and backuphistory as parameters.
ePPI_OSTYPEOSType ReadOperating System type running on the machine. For example, desktop, server, or small business server.
VT_BSTROptionLicensingModel ReadProperty OptionLicensingModel - gets the option licensing model for the service.
VT_VARIANTEventLogRecords(VT_UI4 RecordNumber) ReadProperty EventLogRecords - gets the application EventLog entries generated by the service.
VT_VARIANTBackupLocations ReadProperty BackupLocations - gets a list of backup locations.
VT_BOOLServiceAutoStart WriteSpecifies whether the service should be started automatically during system startup.
VT_VARIANTDriveMappings ReadProperty DriveMappings - gets a list of drive mappings for external (USB or FireWire) drives.
VT_BSTRMasterID ReadProperty MasterID - gets the Master management system id.
VT_BOOLCreateMachineSpecificFolder Read WriteCreates a machine specific folder for backup files.
VT_DISPATCHFtpParameters Read WriteGets the FTP parameters (for offsite copies to FTP locations).
VT_INTThreatConLevel ReadGets the current ThreatCon level from the Veritas website.
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.
VT_BOOL LicenseFileIsValid(VT_BSTR bsFeatureName, VT_BSTR bsVersion, VT_BSTR bsLicenseData)Validates if the license data is valid for this product and version. Uses feature name (LSR,BESR,SSR..), version (7.0,7.5,..), and license data as parameters.
VT_VOID InstallLicenseEx(VT_BSTR bsFeatureName, VT_BSTR bsVersion, VT_BSTR bsLicenseData)Installs license data for a specific product/ or feature and version. Uses feature name, version, and license data (.slf or key) as parameters.
VT_VOID RemoveImage(VT_BSTR bsVolID, VT_BSTR bsImageID)Deletes an image from a volume and updates the volume history.
VT_VOID RefreshLicenseDataReloads the licensing data into the config keys.
VT_BOOL CheckBestPracticeCompliance(VT_BSTR bsBackupDrive)Checks for best backup practice compliance. Uses backup drive (c:,etc) as a parameter.
VT_VOID RestoreMultipleImages(VT_VARIANT vRestoreJobs)Restores multiple image files.
VT_BOOL IsBestPracticeCheckSupportedSpecifies if best backup practice is supported or not.
VT_VOID ShowErrorDialog(VT_BSTR bstrCaption, VT_BSTR bstrSerializedResult)Shows the Error Dialog. Uses caption, and serialized result as parameters.
VT_VOID GetResultError(VT_BSTR bstrSerializedResult, VT_BSTR pbstrError, VT_BOOL bTopLevelOnly)Gets the consolidated error message. Uses serialized results, error name, topleveonly (true, false) as parameters.
VT_BOOL IsSNMPTrapEnabledSpecifies whether to the use of SNMP Traps is enabled during message notification.
VT_VARIANT MoveAllRecoveryPoints(VT_VARIANT vJobs, VT_BOOL bCleanHistory)Iterates through all the ImageJobs and calls MoveRecoverypoint.
VT_VOID CopyProgressFileStatus(VT_BOOL bCopyCancel, VT_UINT pVal, VT_BSTR pCurrrentCopyFileName, VT_BSTR psCopyDestFileName)Copies the progress file status. Uses copycancel, val, currentcopyfilename, and copydestinationfilename as parameters.
VT_VARIANT GetJobsNotInBestBackupGets jobs that do not follow the best backup practice.
VT_BOOL IsStorageThresholdExceededSpecifies if it is time to enforce quota.
VT_VOID ChangeImageHistory(VT_BSTR bsOldPath, VT_BSTR bsNewPath)Changes image history from old path to new path.
VT_BOOL IsEventLogDisplayRequired(VT_I8 i64DateTime)Specifies if there are any event logs that need to be displayed
VT_VOID DisableVolumeTrackingForJob(VT_BSTR ImageJobID)Stops sector tracking for a disabled job
VT_VOID CheckAccessLevel(VT_BOOL bStatusOnly)Checks the access level of the currently logged on user
VT_BOOL CheckBackupSize(VT_VARIANT vJobs, VT_BSTR bsBackupPath)check size for all the jobs passed
VT_BOOL IsMaxtorDrive(VT_BSTR btrDrive)Checks whether the drive is Maxtor One touch.
VT_EMPTY IsMaxtorOneTouchInstalledChecks whether Maxtor One Touch software is installed.
VT_BOOL IsMaxtorOneTouchAssociatedChecks whether Maxtor One Touch software is associated.
VT_BOOL IsOneTouchDisassociatedChecks whether Maxtor One Touch software disassociation needs to be informed to the user.
VT_BOOL AssociateMaxtorOneTouchAssociates Maxtor One Touch software.
VT_BOOL IsImageJobLocked(VT_BSTR ImageJobID)Checks whether the ImageJob is locked.
VT_UI8 ImageFileSize(VT_BSTR sVolID, VT_BSTR sImageID)Checks the size of the Image file on disk.
VT_BSTR GetDeviceDescription(VT_BSTR bsDriveID)Returns device description for a given drive.
VT_VOID AddExtensionGroup(VT_DISPATCH ExtensionGroup)Adds an extension group to be saved.
VT_VOID RemoveExtensionGroup(VT_BSTR ExtensionGroupID)Method RemoveExtensionGroup � removes an extension group.
VT_VOID GetBestJobAvailable(VT_BSTR bsJobID)Returns the best backup job available.
VT_VOID ConvertSystem(VT_DISPATCH pP2vSystemInfo)Uses the specified P2vSystemInfo object to convert a physical system to a virtual system. Uses p2vSysteminfo as a parameter.
VT_VOID CleanFileFolderHistoryRemoves old entries and file folder from the image history.
VT_VOID SaveImageHistorySaves history files with the updated status.
VT_VOID ConvertVolume(VT_VARIANT vP2vVolumeInfos)Uses an array of P2vVolumeInfo objects to archive a set of recovery points.
VT_BOOL RebootSystemReboots the system
VT_VOID DeleteLicenseEx(VT_BSTR FeatureName, VT_BSTR FeatureVersion)Deletes a previously installed license. Uses feature name and feature version as parameters.
VT_VOID ModifyRestrictedRegistryKey(VT_BSTR keyPath, VT_BSTR keyName, VT_BSTR keyValue, VT_INT keyValueType)Method modifyRestrictedRegistryKeyString - creates/ or modifies the keyname's value that is identified by appending HKLM_LOCAL_MACHINE to key path and key name with the passed keyvalue and type.
VT_VOID UpdateImageStatusUpdates the image status iterating through all volumes and all images. � It updates the image status with IMAGE_NORMAL or IMAGE_UNAVAILABLE.
VT_BSTR ReadAppData(VT_BSTR bsSection, VT_BSTR bsKey)Provides an option to read the INI file with the passed key name and key value.
VT_VOID WriteAppData(VT_BSTR bsSection, VT_BSTR bsKey, VT_BSTR bsValue)Provides an option to write to the INI file with the passed key name and key value.
VT_I4 GetVolumeSizeMBFromV2i(VT_DISPATCH pP2vVolumeInfo)Method GetVolumeSizeMBFromV2i - gets the volumes defined size (not used size) in MB from the part store of the image file passed in.
VT_VOID SetTrayOptions(eTRAY_OPTIONS eOptions, VT_BOOL newVal)Sets the value to specify whether to show try Questions or not. Uses trayoptions (TRAY_TOASTER_QUESTIONS) and newVal (True, or false) as parameters.
VT_BOOL GetTrayOptions(eTRAY_OPTIONS eOptions)Gets tray options for showing the tray questions or not. Uses trayoptions (TRAY_TOASTER_QUESTIONS) as a parameter.
VT_BSTR GetEncryptedESXServerKey(VT_DISPATCH pESXLocation)Gets the encrypted SSH key for the ESX Server referenced by ESXLocation object.
VT_DISPATCH LoadSV2i(VT_DISPATCH pSV2iLocation)Creates a p2vSystemInfo object based on the SV2i file referenced by the pSv2i Location object.
VT_VOID ConnectEx(VT_BSTR Computer, VT_BSTR UserName, VT_BSTR userPassword, VT_BSTR userDomain)Connects to a computer that you want to manage. Uses computername, username, userpassword, and userdomain as parameters.
VT_BOOL ValidateExternalDevice(VT_BSTR bsDeviceID, VT_BSTR bsGuid, VT_BSTR bsJobID)Method ValidateExternalDevice - checks whether the external device is the same as stored in AppDataSettings.INI.
VT_BSTR GetSV2iFilePathA service that returns the path to the system�s copy of the sv2i file.
VT_VOID MoveFileBackup(VT_BSTR bImgJobID, VT_BSTR bSrcPath, VT_BSTR bDestPath) Warning: this method is deprecated. Use MoveFileBackupLocation instead. � MoveFileBackupLocation - moves the file folder backup to the destination. Uses imagejobID, sourcePath, and destinationPath as parameters.
VT_BSTR GetNetworkPath(VT_BSTR sFolder, VT_BSTR sUserName, VT_BOOL bEncryptedPassword, VT_BSTR sPassword)Gets the network path of the V2i file. Uses folder, username, encryptedpassword (True, or false) and password as parameters.
VT_BOOL IsBackupLocation(VT_BSTR VolumeID)Specifies whether a given volume is a backup location.
VT_BOOL IsAgentSupportedChecks whether the agent is supported or not.
VT_VOID UserLogonSignals service that a user has logged on.
VT_VOID UserLogoffSignals service that a user has logged off.
VT_VOID RemoveImageSet(VT_BSTR bsVolID, VT_BSTR bsImageID)Removes a base image and its associated incrementals.
VT_VOID SetPolicyCheckLevel(VT_BSTR VolumeID, ePOLICYLIST_TYPE CheckLevel, VT_DISPATCH CustomPolicy)Sets policy check level for a volume. Uses volumeID, checklevel (Defaultproblemsonly, Ignore, Cutom) and custompolicy as parameters.
VT_VOID RemoveExtraVersions(VT_DISPATCH ImageJob, VT_UI4 versionLimit)Removes file versions to limit versions for all files in the ImageJob location.
VT_VOID WaitForEventLogChangesBlocks until the service adds new entries to the application event log.
VT_VOID NotifyEvent(ePPI_NOTIFYEVENT_TYPE nEventType)Fires event to enable event monitors. Uses eventtype (userlogon, userlogoff, onetouch, threatcon) as a parameter.
VT_VOID UnregisterForErrorNotificationMethod UnregisterForNotification - to be called by applications (VProtray.exe) that no longer require error notifications.
VT_VOID NameVolume(VT_BSTR VolumeID, VT_BSTR VolumeName)Assigns a user-defined name to a volume. Uses volumeID and volumename (LabelName of the volume (C:,etc)) as parameters.
VT_VOID CancelOffsiteOpAttempts to cancel the current offsite operation (if possible).
VT_VOID AgentAbilitiesChangedSpecifies if the agent abilities have to be updated.
VT_VOID MoveFileBackupLocation(VT_BSTR bImgJobID, VT_DISPATCH srcLoc, VT_DISPATCH dstLoc)Moves the file folder backup to the destination location. Uses imagejobID, source location, and destination location as parameters.
VT_DISPATCH GetDestinationVolume(VT_DISPATCH folderLocation)Gets the DestinationVolume object that is associated with the given path.
VT_VOID AddConversionJob(VT_DISPATCH pP2vSystemInfo)Adds /or Updates a conversion job to the list of conversion jobs for the current agent/ or computer. Uses P2vSystemInfo as a parameter.
VT_VOID RemoveConversionJob(VT_BSTR jobId)Removes a saved conversion job. Uses the job id as a parameter.
VT_DISPATCH GetConversionJob(VT_BSTR jobId)Returns a specific conversion job by ID.
VT_VARIANT GetConversionJobsReturns the list of conversion jobs.
VT_VOID DoConversionJob(VT_BSTR jobId)Runs the conversion job specified by the ID.
VT_VOID DisableConversionJob(VT_BSTR jobId)Disables the conversion job specified by the ID.
VT_VOID EnableConversionJob(VT_BSTR jobId)Enables the conversion job specified by the ID.
VT_VARIANT GetInstalledOstPluginNamesReturns an array of installed OST plugin names.
VT_DISPATCH GetOstServerInfo(VT_BSTR serverName, VT_BSTR pluginName)Returns the OST server info.
VT_VARIANT GetOstServerLSUs(VT_BSTR serverName, VT_BSTR pluginName, VT_BSTR UserName, VT_BSTR Password, VT_BOOL isEncryptedPassword)Returns an array of OST dedupe server LSUs.
VT_VARIANT GetFilesAndFolders(VT_DISPATCH piLoc, VT_BSTR filter, VT_BOOL filesOnly)Returns an array of OST location files.
VT_VOID UpdateImageLocation(VT_DISPATCH NewImgLoc)Updates all instances of an image location.
VT_VOID MoveBackupLocation(VT_DISPATCH OrigImgLoc, VT_DISPATCH NewImgLoc)Replaces all instances of a backup location, moving files as needed.
VT_DISPATCH GetSystemInformationReturns system information.
VT_UINT GetDriveTypeFromPath(VT_BSTR path)Returns windows drive type.
VT_VOID RefreshEx(VT_BOOL refreshAll)Refresh all.

Home


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