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

Description: IPPIManager - PPI Management Interface
IID: {6C4A44B5-A9F6-4721-A636-1DFC3192E0FE}
Properties
VT_BSTRStatus Readproperty Status - retrieve status information of this object.
VT_BSTRAbout Readproperty About - returns information about this service (version, etc) for display purposes
VT_VARIANTVolumes(VT_BOOL BackupHistory) Readproperty Volumes - an array of all volumes on this machine.
VT_VARIANTDestinations Readproperty Destinations - an array of all copy or restore destinations on this machine.
VT_VARIANTCommandFiles Readproperty CommandFiles - an array of all command files installed
VT_VARIANTImageLocations Readproperty ImageLocations - retrieve image locations supported on this machine.
VT_VARIANTImageJobs Readproperty ImageJobs - an array of all image jobs on this machine.
VT_VARIANTDisks Readproperty Disks
VT_BSTRAbilities Readproperty Abilities - retrieve the abilities of this object.
VT_BSTRLicense ReadGets the AgentLicense object for this agent.
VT_BSTRNotificationHandler(VT_BSTR HandlerID) Read WriteA specific Notification Handler by ID.
VT_UINTThrottle Read WriteGet the maximum resource usage for the current operation.
VT_UINTDefaultThrottle Read WriteGet the default maximum resource usage for all operations.
VT_DISPATCHAbilitiesObject ReadGet the Abilities object.
VT_DISPATCHLicenseObject ReadGet the License object.
VT_BOOLIsThrottleAvailable ReadDetermine if the throttle is available.
VT_DISPATCHAboutObject ReadGet the About object.
VT_VARIANTSupportedEventMonitors ReadGet the operating system information for the currently connected agent.
VT_DISPATCHDefaultImageLocationObject ReadGet the default ImageLocation object.
VT_DISPATCHNotificationHandlerObject(VT_BSTR HandlerID) ReadA specific Notification Handler by ID.
Methods
VT_BSTR WaitForStatusChangemethod WaitForStatusChange - WARNING: this will block until a status change occurs.
VT_HRESULT WaitForVolumeChangesmethod WaitForVolumeChanges - WARNING: this will block until volume changes occur.
VT_BSTR GetVolume(VT_BSTR ID)method GetVolume - get a single volume by ID
VT_HRESULT ForgetVolume(VT_BSTR ID)method ForgetVolume - removes all information about a deleted volume (image history, etc) from the system.
VT_HRESULT DoImageJob(VT_BSTR ImageJobID, eIMAGE_TYPE ImageType)method DoImageJob - use the specififed image job to create the specified type of image now.
VT_HRESULT AddImageJob(VT_BSTR NewImageJob)method AddImageJob - add an image job to a volume's schedule
VT_HRESULT RemoveImageJob(VT_BSTR ImageJobID)method RemoveImageJob - remove an image job from a volume's schedule
VT_BSTR GetDestination(VT_BSTR ID)method GetDestination - get a single copy or restore destination by ID
VT_BSTR GetImageJob(VT_BSTR ID)method GetImageJob - get a single image job by ID
VT_HRESULT RestoreImage(VT_BSTR RestoreJob)method RestoreImage
VT_BSTR GetDefaultImageLocationmethod GetDefaultImageLocation - where image files will be stored unless otherwise specified.
VT_HRESULT SetDefaultImageLocation(VT_BSTR newVal)method SetDefaultImageLocation - where image files will be stored unless otherwise specified.
VT_HRESULT PutNotificationProperty(VT_BSTR Handler, VT_I4 Property, VT_VARIANT newVal)method PutNotificationProperty - access properties of the notification handlers.
VT_VARIANT GetNotificationProperty(VT_BSTR Handler, VT_I4 Property)method GetNotificationProperty - access properties of the notification handlers.
VT_HRESULT RebootToRestore(VT_BSTR UserName, VT_BSTR Password, VT_BSTR Filename, VT_BOOL bModifyBoot)method RebootToRestore - reboot to the Veritas Recovery Environment and finish the volume restore operation
VT_HRESULT Cancelmethod Cancel - cancel the current image or restore operation. S_FALSE if no operation is in progress.
VT_HRESULT Refreshmethod Refresh - rescan system for device changes (may take a few seconds)
VT_UINT GetAvailableDrivesmethod GetAvailableDrives - return bitmap representation of available logical drives
VT_HRESULT Notify(ePQ_NOTIFY_TYPE Type, ePQ_NOTIFY_PRIORITY Priority, VT_UI4 Code, VT_BSTR Description, VT_BSTR Source, VT_DATE TimeStamp)method Notify - submit a message to this object's notification system.
VT_HRESULT ValidateRestoreDestination(VT_BSTR RestoreJob, VT_VARIANT Destinations)method ValidateRestoreDestination - confirm that the selected destination is valid for a restore operation.
VT_BSTR GetCommandFileFoldermethod GetCommandFileFolder - folder where command files are stored
VT_HRESULT DisableImageJob(VT_BSTR ImageJobID)method DisableImageJob
VT_HRESULT EnableImageJob(VT_BSTR ImageJobID)method EnableImageJob
VT_HRESULT CopyVolume(VT_BSTR CopyJob)method CopyVolume
VT_HRESULT WaitForJobChangesmethod WaitForJobChanges - WARNING: this will block until job changes occur.
VT_HRESULT ValidateLocation(VT_BSTR ImageLocation, VT_BSTR LocationConstraints)method ValidateLocation - validates an image location using certain constraints.
VT_HRESULT Resumemethod Resume
VT_HRESULT InstallLicense(VT_BSTR bsLicenseData)Install license
VT_HRESULT ValidateCopyDestination(VT_BSTR VolumeID, VT_VARIANT Destinations)method ValidateCopyDestination - confirm that the selected destination is valid for a copy operation.
VT_HRESULT CleanImageHistorymethod CleanImageHistory - remove old entries from the image history list.
VT_HRESULT ConsolidateIncrementals(VT_BSTR ConsolidateJob)method ConsolidateIncrementals - consolidate the backup data from multiple incremental backups into one backup image file.
VT_HRESULT RegisterForErrorNotificationmethod RegisterForErrorNotification - called by clients that require error notifications
VT_BSTR WaitForJobCompletedChangemethod WaitForJobCompletedChange - WARNING: this will block until a job completes.
VT_HRESULT DisableGoBackmethod DisableGoBack - Disable GoBack service. Must be called before a volume is restored or copied if GoBack is active.
VT_HRESULT CheckAccessLevel(VT_BOOL StatusOnly)method CheckAccessLevel - check access credentials

Home


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