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.

IVolume3 Interface

Description: Extension of the IVolume interface that exposes more APIs.

IID: {E96C2034-A0FC-464F-BC76-0F513FC5B748}

Properties

VT_BSTR	FileSystem	Read Write	File system type (FAT32, NTFS, etc).
VT_BOOL	System	Read Write	Whether this represents the system volume.
VT_BSTR	HistoryFile	Read Write	Name of the file containing image history information.
VT_BSTR	Label	Read Write	Volume label.
VT_BSTR	Machine	Read Write	Name of the computer on which the volume resides.
VT_BSTR	MountPoint	Read Write	Volume mount point (generally a drive letter).
VT_BSTR	ID	Read	Unique, automatically generated identifier.
VT_BOOL	Valid	Read Write	Whether this volume can be imaged.
IImage	LastImage	Read	The last image of this volume.
VT_I4	SizeMB	Read Write	Size of the volume in MB.
VT_I4	FreeSpaceMB	Read Write	Amount of free MB in the volume.
VT_BOOL	Mounted	Read Write	Volume is mounted.
VT_BSTR	DisplayName	Read	User-friendly description of volume.
VT_VARIANT	Images	Read	Array of Image objects representing the images captured for this volume.
VT_BSTR	Type	Read Write	Volume type (Simple, Basic, Dynamic, etc).
VT_BOOL	Hidden	Read Write	Whether this represents a hidden volume.
VT_BOOL	Active	Read Write	Whether this represents the boot volume.
VT_BSTR	GeneratedFilename	Read	Default generated file name, often used for the ImageLocation object's FileSpec property.
VT_BSTR	TrackingJob	Read Write	ID of the ImageJob tracking this volume (for incremental support).
VT_DISPATCH	Constants	Read	Named constants for scripting. See VProObjConstants.
VT_VARIANT	ActiveImageSet	Read	An array of Image objects containing the current base image and its dependent incremental images.
VT_BSTR	OldID	Read	Unique, automatically generated identifier (old format).
VT_BOOL	SaveBackupHistory	Write	Save backup history with volume.
VT_VARIANT	ImageSet(VT_BSTR ImageID)	Read	The array of Image objects containing the incremental chain (base + incrementals) that includes the requested image.
VT_BOOL	IsDomainController	Read Write	Whether this volume represents a Domain Controller.
VT_BSTR	AddActiveDirectoryVolumeId	Write	Inserts a dependant Active Directory volume ID
VT_I4	ActiveDirectoryVolumeCount	Read	Current size of Active Directory volume ID array.
VT_BSTR	ActiveDirectoryVolumeId	Read	Gets the current Active Directory volume ID in the iteration.
VT_BSTR	OSVersion	Read Write	Operating System verson of the volume.
VT_BSTR	OSServicePackVersion	Read Write	Operating System service pack verson.
VT_BOOL	IsExchangeServer	Read Write	Whether this volume is an Exchange Server.
VT_BSTR	ExchangeServerVersion	Read Write	Exchange Server version.
VT_BSTR	ExchangeServerServicePackVersion	Read Write	Exchange Server service pack version.
VT_VARIANT	ImagesEx(eIMAGE_FILTER nImageFilter)	Read	Array of Image objects representing THE images captured for this volume.
VT_BOOL	FileSystemEncrypted	Read Write	Checks whether the volume is protected by BitLocker.
VT_BOOL	Dynamic	Read Write	Volume resides on a dynamic disk.
VT_I4	EstMaxIncCount	Read Write	Estimated maximum number of incrementals.

Methods

VT_VOID ValidateProperties	Determines if the current volume properties are valid.
VT_VOID CleanHistory	Removes old entries from the image history.
VT_VOID ResetIterationForActiveDirectoryVolumeIds	Resets the iteration of the Active Directory volumes to the beginning.
VT_VOID NextActiveDirectoryVolumeId	Increments to the next Active Directory volume ID for the domain controller.
VT_VOID DeleteOldestImageSet(VT_BSTR pDrive, VT_VARIANT pImageFilesDeleted, VT_BSTR pJobID, VT_DATE pdate, VT_UI8 pi64Size)	Deletes the oldest ImageSet of this volume on a particular backup drive. Uses Drive, ImageFilesDeleted, JobID, Date, and Size as parameters.
VT_VOID RemoveImageSet(VT_BSTR ImageID)	Removes a base image and all of its incrementals. Uses ImageIdentifier as a parameter.
VT_BOOL IsBackupLocation(IFolderLocation Location)	Checks whether backups for this volume exist at the given location. Uses FolderLocation object as a parameter.

Home