Using QScripts on the Command Line

Table of Contents

Running QScripts

Qscripts are pre-defined SQL scripts that enable you to query and, in some cases, directly modify the CommServe database. Each QScript includes a readme file that provides instructions and argument parameters to query the CommServe database. Some QScripts take argument values. For a list of these values, see Command Line - FAQ.

QScripts are pre-defined by the software, so they cannot be modified by end users. You can run QScripts on legacy versions of the software which do not support XML files. However, each QScript can only modify one specific property on the entity.

You can execute QScripts using the qoperation execscript qcommand. The parameters depend on the QScript used. For example:

qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si QSDKSessionsAudit -si y -si 1

QScripts are recommended for advanced users only. QScripts can be directly executed using qoperation execscript qcommand. Therefore caution is recommended while using them since the operations performed using the QScripts do not have the same safety protocols that are available with other options from the CommCell Console.

Executing QScripts requires CommCell level administrator permissions unless otherwise stated.

Available QScripts

The following table lists all available QScripts:

QScript Description Readme Files
AppSetOverrideSPcompression Enable or disable Storage Policy Compression Override setting for selected subClient(s). -- qoperation execscript -sn QS_AppSetOverrideSPcompression -si 'enable|disable' -si 'c=clientName|cg=clientGroupName' [-si 'a=appType'] [-si 'i=instanceName'] [-si 'b=backupsetName'] [-si s=subClientName] .. if the subclient name is not specified, all the subClients in the backupset will be modified. .. if the backupset name is not specified, all the subClients in the instance will be modified. .. if the instance name is not specified (for idataAgents that can have multiple isntances), all the instances in the iDa will be modified. .. if the idataAgent is not specified, all the iDataAgents in the client or clientGroup will be modified CommServ.QS_AppSetOverrideSPcompression.Readme.html
archIndexSize Return index space for the jobs run over the input number of days. CommServ.QS_archIndexSize.Readme.html
archViewSISavings Return dedup savings for a given client, appTypeId, Job. CommServ.QS_archViewSISavings.Readme.html
AssociateBillableEntity Associate billable entity to a client/iDA/Instance/Backupset/SubClient. Takes CSV file holding associations as input. This input file contains one or more lines of this format [ , , , , , ] Billable Entity Name and Client Name are mandatory. Others are conditionally optional. CommServ.QS_AssociateBillableEntity.Readme.html
associateGlobalDedupPolicyToCopy This command is for associating copy to global dedup host policy. Copy must be already created using GUI or Command line. Run the following command from Base using qlogin qoperation execscript -sn associateGlobalDedupPolicyToCopy -si "c=copyname" -si "sp=storage policy name" -si "gsp=global dedup storage policy name" example - qoperation execscript -sn QS_associateGlobalDedupPolicyToCopy -si "copy1" -si "sp1" -si "gdp1" CommServ.QS_associateGlobalDedupPolicyToCopy.Readme.html
AuxCopyReport Aux copy report. CommServ.QS_AuxCopyReport.Readme.html
BackendStorage Returns Backend Storage Utilizaiton by Client. CommServ.QS_BackendStorage.Readme.html
BackendSubclientStorage Backend Storage utilization history at the subclient level along with prediction. CommServ.QS_BackendSubclientStorage.Readme.html
BackupStrikes Consecutive backup failures for last N days CommServ.QS_BackupStrikes.Readme.html
BulkInsertSubClientPolicyContent Bulk insert content to subClient policy subclient -- CommServ.QS_BulkInsertSubClientPolicyContent.Readme.html
ChangeCSHostNameAfterMigration This script changes csHostName and marks the client as no more pointing to this CommServer for given client. CommServ.QS_ChangeCSHostNameAfterMigration.Readme.html
ChangeDefaultBackupset Script to change the default backup set CommServ.QS_ChangeDefaultBackupset.Readme.html
ChangeDeviceControllerPathForMP Qscript to update the device access path for a given library name and media agent Usage: qoperation execscript -sn ChangeDeviceControllerPathForMP -si Media_Agent_Name -si Library_Name CommServ.QS_ChangeDeviceControllerPathForMP.Readme.html
changeMediaType Note - if the mediatype or library name has spaces, use double quotes! 1. List ALL compatible media types for that library qscript -f changeMediaType.sql -i ListMediaTypes -i 2. change mediatype of a specific media qscript -f changeMediaType.sql -i media -i -i 3. Change mediatype of all available media in library qscript -f changeMediaType.sql -i inlibrary -i -i 4. Change mediatype of all available media in library whose barcode ends with suffix qscript -f changeMediaType.sql -i inlibrary -i -i restrictbysuffix 5. Change mediatype of all existing AND exported media of library qscript -f changeMediaType.sql -i inlibraryandexported -i -i 6. Change mediatype of all existing AND exported media of library whose barcode ends with suffix qscript -f changeMediaType.sql -i inlibraryandexported -i -i restrictbysuffix Note:- In addition to "inlibraryandexported" an additional option "inlibraryandexportedgui" can be used. "inlibraryandexported" selects the media in the library and media which were last exported from the library. "inlibraryandexportedgui" selects the same as above but in addition also selects media that were at one point written to inside the specified library. The name GUI comes from the fact that the exported media it selects uses a similar logic as the exported media node in the GUI. CommServ.QS_changeMediaType.Readme.html
changeScheduleOwner QScript to transfer schedule ownership to another user CommServ.QS_changeScheduleOwner.Readme.html
ChangeSearchEngineAdminRole Mark ADMIN role for given search engine and remove ADMIN role from other if any. -- qoperation execscript -sn QS_ChangeSearchEngineAdminRole -si SearchEngineNodeName -si AuthenticationCode -- SearchEngineNodeName: Name of the search engine node AuthenticationCode: Authentication Code required to execute the script CommServ.QS_ChangeSearchEngineAdminRole.Readme.html
CLAGetVSADetails List the VM list of VSA jobs used for capacity license usage. CommServ.QS_CLAGetVSADetails.Readme.html
CleanBillingEntityHistory Clean billing entity history CommServ.QS_CleanBillingEntityHistory.Readme.html
CleanupVirtualServerDuplicateGUIDs Cleanup the vm association of pseudo clients with duplicate GUIDs. CommServ.QS_CleanupVirtualServerDuplicateGUIDs.Readme.html
ClearDDBValidationFlag Clears the DDB Validation failed status on DDB SubStore. CommServ.QS_ClearDDBValidationFlag.Readme.html
CNSetCoHostedCCNames Use this script to correct co-hosted CommCell names (display name and host name) discrepancy in CommNet registration. This script when run will correct co-hosted CommCell's display name and host name in CommNet database. CommServ.QS_CNSetCoHostedCCNames.Readme.html
Commcellaveragedatatransfer Lists the Max / Average amount of data transferred by each backup type (Full, Incremental, Differential) for all subclients in the given time range. Returns data only for completed jobs. Since the CommServe database does not contain information for jobs pruned more than a week ago, for the most accurate information, do not use older time ranges. Typical use is to find Max / Average amount of data transferred in the last month. CommServ.QS_Commcellaveragedatatransfer.Readme.html
CommCellUsageReport List the detail usage of backup/archiver jobs used for computing totals towards capacity usage. CommServ.QS_CommCellUsageReport.Readme.html
CommNetCreateBillableEntity Creates a new billable entity. CommServ.QS_CommNetCreateBillableEntity.Readme.html
CommServAssociateBillableEntity Associates a billable entity with a client. CommServ.QS_CommServAssociateBillableEntity.Readme.html
CompressionConfig To set the Media Agent attributes CommServ.QS_CompressionConfig.Readme.html
ConfigureRemoteCache Script to configure the remote software cache and associate the input client group with the configured remote cache. Usage: Qoperation execscript –sn QS_ConfigureRemoteCache -si 'Clientname' -si 'SoftwareCachePath' -si 'ClientGroupName' -si '1 or 0 (isNetworkShare)' -si 'cachePathUserName' -si 'encryptedPasswd' Example: qoperation execscript -sn QS_ConfigureRemoteCache -si myClient -si C:\SWCache Example: qoperation execscript -sn QS_ConfigureRemoteCache -si myClient -si C:\SWCache -si mygroup Example: qoperation execscript -sn QS_ConfigureRemoteCache -si myClient -si \\xxx\SWCache -si mygroup -si 1 -si 'domainusername' -si 'Password' CommServ.QS_ConfigureRemoteCache.Readme.html
ConvertNextGRCExportAsFull This script converts the next GRC Export job as full for the given GRC CommCell. Run this script on Source CommServe by passing destination CommServe name as parameter. Usage: qoperation execscript -sn ConvertNextGRCExportAsFull -si CommServ.QS_ConvertNextGRCExportAsFull.Readme.html
ConvertSelectiveToSyncCopy Convert Selective copy to Synchronous copy. This script is applicable only to none snap copies. Synchronous behavior is applicable only to future jobs. CommServ.QS_ConvertSelectiveToSyncCopy.Readme.html
ConvertSyncToSelectiveCopy Convert Synchronous copy to Selective copy. Converted Selective copy will have All FULLs selected by default. WARNING: Improper use of the ConvertSyncToSelectiveCopy qscript might result in data loss. Before you run this script, contact your software provider. CommServ.QS_ConvertSyncToSelectiveCopy.Readme.html
CreateClientGroup Create client group. CommServ.QS_CreateClientGroup.Readme.html
Qs_CreateDB2BackupSet Creates DB2 Backup set under given client and db2 instance. CommServ.Qs_CreateDB2BackupSet.Readme.html
CreateDB2Subclient Creates DB2 subclient under given client, db2 instance and backupset. CommServ.QS_CreateDB2Subclient.Readme.html
CreateOracleInstance Create new oracle instance or On demand instance. CommServ.QS_CreateOracleInstance.Readme.html
CreateSAPMAXDBInstance Creates new SAP MAX DB instance for given client. CommServ.QS_CreateSAPMAXDBInstance.Readme.html
CreateSAPOracleInstance Creates new SAP Oracle instancet for given client. CommServ.QS_CreateSAPOracleInstance.Readme.html
CreateSAPOracleSubclient Creates new SAP Oracle subclient under the given client and instance name CommServ.QS_CreateSAPOracleSubclient.Readme.html
CreateScheduleHoliday Script to create Schedule holiday qoperation execscript -sn createscheduleholiday -si ClientName/commserve -si Startdate -si Enddate -si Yearly Where (ClientName/commserve) would be 'NameOfClient' for client name OR 'commserve' StartDate Format is MM-DD-YYYY EndDate Optional parameter, format is MM-DD-YYYY Yearly Optional parameter, true/false Example: To create a schedule holiday for client 'ClientName' on 10th April 2012. This will create a schedule holiday for 1 day on client 'ClientName'. qoperation execscript -sn createscheduleholiday -si 'ClientName' -si '04-10-2012' To create a schedule holoday for client 'ClientName' on 10th April 2012 to 12th April 2012. This will create a schedule holiday for 3 days on client 'Client Name'. qoperation execscript -sn createscheduleholiday -si 'ClientName' -si '04-10-2012' -si '04-12-2012' To create a yearly schedule holiday for client 'ClientName' on 10th April 2012. qoperation execscript -sn createscheduleholiday -si 'ClientName' -si '04-10-2012' -si true To create a schedule holiday for client 'ClientName' on 10th April 2012 on a commserve. qoperation execscript -sn createscheduleholiday -si 'commserve' -si '04-10-2012' GUI will show schedule holiday on successful creation from commandline. CommServ.QS_CreateScheduleHoliday.Readme.html
CreateVM Create a VM using input xml file CommServ.QS_CreateVM.Readme.html
DataGrowthPerCopy Returns data size on media for the given time intervals per storage policy copy. CommServ.QS_DataGrowthPerCopy.Readme.html
DataGrowthSummary Returns average data growth rate, current free space and estimated number of days that the current free space will be used for each libraries. CommServ.QS_DataGrowthSummary.Readme.html
DataInterfacePairConfig Qscript to Add, Delete or list client data interface pair. Add or Delete one data interface pair Delete or list all data interface pairs for a given client Delete or list all data interface pairs for all clients CommServ.QS_DataInterfacePairConfig.Readme.html
DataProtectionJobSummary It returns data protection (Backup, Snap and Archive) jobs ended in the given time range. Active jobs that were running in the given time range are also included. Jobs of Virtual Server Agent are shown for each VMs. Usage: qoperation execscript -sn QS_DataProtectionJobSummary [-si @FromTime = ''] [-si @ToTime = ''] [-si @LastNDays = '1'] [-si @IncludeAged = '1'] [-si @IncludeRunning = '1'] [-si @BackupType = ''] [-si @OrderBy = 'JobID'] Example: qoperation execscript -sn QS_DataProtectionJobSummary -si '2013-09-01' -si '2013/09/30 23:59:59' qoperation execscript -sn QS_DataProtectionJobSummary -si @LastNDays = '7' Parameters: 1. Time range can be specified by either FromTime and ToTime or by LastNDays. Default is last 1 day. FromTime and ToTime should be in 'mm/dd/yyyy hh:mm:ss' or 'yyyy-mm-dd hh:mm:ss' format. 2. Default is IncludeAged = 1 for including aged jobs. 3. Default is IncludeRunning = 1 for including jobs that are running but not completed in the given time range. 4. BackupType can be 'Full' or 'Incr'. Default is '' for all backup types. 5. OrderBy can be 'JobID', 'Client' or 'Agent'. Default is descending order of JobID. Columns: Client - Client computer name Agent - Data agent type name Instance - Instance name Backupset - Backupset name Subclient - Subclient name Job Id - Data Protection job ID Job Status - Running, Completed, Failed or Completed with warnings etc. VM - Virtual Machine name VM Status - Completed, Failed or Completed with warnings etc. VM Failure Reason - VM Failure Reason Operation - Backup, Synthetic Full, Snap Backup etc. Job Type - Full, Incremental or Differential etc. Scan Type - Classic, Change Journal, Mixed or Optimized Scan Start Date - Job start date (mm/dd/yyyy) Start Time - Job start time (hh:mm:ss) End Date - Job end date (mm/dd/yyyy) End Time - Job end time (hh:mm:ss) Application Size (GB) - Protected application data size in GB Compression Rate (%) - Software compression rate in percentage Data Transferred (GB) - Data transferred over network in GB Data Written (GB) - Data written on media in GB Space Saving (%) - Space saving due to compression and deduplication Data Size Change (%) - Change of application size in percentage Transfer Time - Data transfer time in hh:mm:ss Throughput (GB/Hour) - Data transfer throughput in GB/Hour Protected Objects - Number of Protected files and folders Failed Objects - Number of files not protected Failed Folders - Number of folders not protected Failure Code - Failure code in form of xx:xxx Storage Policy - Storage Policy name Client Group - Names of client groups associated by the client CommServ.QS_DataProtectionJobSummary.Readme.html
DDBGrowthPerCopy Returns data size on media for the given time intervals per storage policy copy. CommServ.QS_DDBGrowthPerCopy.Readme.html
DDBParam Qscript to set or get the DDB Params CommServ.QS_DDBParam.Readme.html
DeconfigureAgent Deconfigure a client or iDataAgent. Note Example: 1) Deconfigure a particular iDa of a client: qoperation execscript -sn DeconfigureAgent.sql -si jellyfish -si ; -si file system 2) Deconfigure a client and all iDataAgents: qoperation execscript -sn DeconfigureAgent.sql -si jellyfish CommServ.QS_DeconfigureAgent.Readme.html
DeleteClientGroup qoperation execscript -sn DeleteClientGroup -si '[group_name]' script_name: DeleteClientGroup. [group_name] - name of the group to be deleted CommServ.QS_DeleteClientGroup.Readme.html
DeleteContainer To delete container belonging to ReviewSet/Export/Query Set Container Type qoperation execscript -sn DeleteContainer -si 'UserName' -si 'ContainerName' -si 'ContainerType' 'UserName' -- Owner of the container that needs to be deleted. 'ContainerName' -- Name of the container that needs to be deleted.[excluding the username] 'ContainerType' -- Optional. Type of the container that needs to be deleted. Can be 1,2 or 3. Default – ReviewSet. [1 - ReviewSet ; 2 – QuerySet ; 3 - DownloadSet] Eg: To delete Review Set [ PEKO(Deleted, 59)@efgz\My ReviewSet ] whose owner is [efgz\PEKO] Run as : qoperation execscript -sn DeleteContainer -si 'efgz\PEKO' -si 'My ReviewSet' -si 1 CommServ.QS_DeleteContainer.Readme.html
DeleteDataSet Delete the dataset CommServ.QS_DeleteDataSet.Readme.html
DeleteFASTDanglingRow qoperation execscript -sn QS_DeleteFASTDanglingRow -si 'NodeclientName' -si AuthenticationCode Example: qoperation execscript -sn QS_DeleteFASTDanglingRow -si solr56 -si 970168066 script_name: QS_DeleteFASTDanglingRow. NodeclientName - Delete dangling rows from Commserv database for which FAST cloud is already deleted. AuthenticationCode - Authentication Code. CommServ.QS_DeleteFASTDanglingRow.Readme.html
DeleteMediaFromList Delete media listed in the input file Example: qoperation execscript -sn DeleteMediaFromList -si '' -si ' ' CommServ.QS_DeleteMediaFromList.Readme.html
DeleteScheduletemplate Delete schedule policy CommServ.QS_DeleteScheduletemplate.Readme.html
DeleteSearchEngineNode qoperation execscript -sn QS_DeleteSearchEngineNode -si 'NodeclientName' -si AuthenticationCode Example: qoperation execscript -sn QS_DeleteSearchEngineNode -si solr56 -si 970168066 script_name: QS_DeleteSearchEngineNode. NodeclientName - Delete the Search Engine Node from multi-node cloud. AuthenticationCode - Authentication Code. CommServ.QS_DeleteSearchEngineNode.Readme.html
DeleteStaleSnapsforRepset Qscript to remove stale snaps for given repset CommServ.QS_DeleteStaleSnapsforRepset.Readme.html
DeleteTFASecretForUser Delete the Two-Factor Authentication Secret and One Time PIN (if any) for the given user. Next time the user logs in, a new Secret and OTP will be generated and emailed to the user. CommServ.QS_DeleteTFASecretForUser.Readme.html
DeleteVirtualMachineGUIDs Qscript to delete virtual machine guid and instance UUID client properties. qoperation execscript -sn QS_DeleteVirtualMachineGUIDs.sql -si 'clientName' clientName - Name of the Client CommServ.QS_DeleteVirtualMachineGUIDs.Readme.html
DetectSyncBreakingChars Detects the characters causing failures in CommNet sync because of XML serialization failure CommServ.QS_DetectSyncBreakingChars.Readme.html
DisablePreviousJobsOnNewFull Mark previous cycle jobs as do not copy when most recent full job option is selected during auxcopy job. CommServ.QS_DisablePreviousJobsOnNewFull.Readme.html
DisableSearchEngineNode qoperation execscript -sn DisableSearchEngineNode -si '[clientName]' script_name: DisableSearchEngineNode. [clientName] - client name of the Search Engine node to be disabled. CommServ.QS_DisableSearchEngineNode.Readme.html
EligibleJobsForAgingByTimeRange Get the list of jobs which are eligible for aging in a given time frame . qoperation execscript -sn QS_EligibleJobsForAgingByTimeRange -si startTime -si endTime [-si outputType -si @clientName = 'Client Name' -si @storagePolicyName = 'Storage Policy Name' -si @storagePolicyCopyName = 'Storage Policy Copy Name'] startTime - Start time (Format YYYY\MM\DD) endTime - End time (Format YYYY\MM\DD) outputType - 1 [Job ID, Client Name, App Type, Backupset Name, Subclient Name, Storage Policy Name, Storage Policy Copy Name] outputType - 2 [ClientName, AppType, Backupset, Subclient, JobCount] outputType - 3 [Output in CSV format - Job ID, Client Name, App Type, Backupset Name, Subclient Name, Storage Policy Name, Storage Policy Copy Name] clientName - Name of the client. storagePolicyName - Name of the storage policy. storagePolicyCopyName - Name of the storage policy copy. CommServ.QS_EligibleJobsForAgingByTimeRange.Readme.html
EnableAuxCopySizeLimit Qscript to Enable or Disable the Auxiliary Copy Size limit criteria feature CommServ.QS_EnableAuxCopySizeLimit.Readme.html
EnableCIForClientsInClientGroup qoperation execscript -sn EnableCIForClientsInClientGroup -si 'clientGroupName' script_name: EnableCIForClientsInClientGroup. [clientGroupName] - Enable CI option for all clients belong to the client Group name. CommServ.QS_EnableCIForClientsInClientGroup.Readme.html
enableLaptopBackup Set client for laptop backup -- qoperation execscript -sn enableLaptopBackup -si 'ON'|'OFF' -si 'clientName' enable/disable laptop backup for a particular client CommServ.QS_enableLaptopBackup.Readme.html
EnableSCActivityControl Qscript to enable/disable backup activity on a sub client. CommServ.QS_EnableSCActivityControl.Readme.html
EnableSearchEngineNode qoperation execscript -sn QS_EnableSearchEngineNode -si 'clientName' script_name: QS_EnableSearchEngineNode. [clientName] - client name of the Search Engine node to be enabled. CommServ.QS_EnableSearchEngineNode.Readme.html
EnableSystemState Script to enable system state on all default subclietns across the commserve. This script can take client name and backup set name as input.(Both are optional.) If both are given the default subclient under system state backup is enabled on the given client and backupset and disabled on all its peer subclients. If only the client name is given then the same is done on all active backupsets under the client. When 'allclients' is used the system state is enabled all default subclients across the CS. CommServ.QS_EnableSystemState.Readme.html
EncryptionConfig Qscript to Get/Set encryption properties for sublcients CommServ.QS_EncryptionConfig.Readme.html
ExecuteView Executes a SQL View CommServ.QS_ExecuteView.Readme.html
ExtendRetainAllJobsInCycle Retain all jobs in a cycle with selected Full job for Extended Retention. CommServ.QS_ExtendRetainAllJobsInCycle.Readme.html
FindJobsOnStore This script give the details of jobs on all the ddbstores associated with mountpaths identified by a mountpathid or libraryalias name or library-device combination or library-device-mountpathname combination It takes 4 parameters in the order :QS_LINE- MountPathId, LibraryName , DeviceName , MountPathName when MountPathId is nonzero , then jobs are listed from stores associated with this mountpath. No other parameter values are considered Eg Usage : qoperation execscript -sn QS_FindJobsOnStore [-si 20] [-si ''] [-si ''] [-si ''] when @MountPathId = 0 , LibraryName <> NULL , all other params are NULL , Jobs from stores associated with the MouthPath under this library are listed Eg Usage : qoperation execscript -sn QS_FindJobsOnStore [-si 0] [-si 'Lib1'] when @MountPathId = 0 , LibraryName <> NULL , Devicename <> NULL , all other params are NULL , Jobs from stores associated with the MouthPath under this library-device combination are listed Eg Usage : qoperation execscript -sn QS_FindJobsOnStore [-si 0] [-si 'Lib1'] [-si 'Device_10'] when @MountPathId = 0 , LibraryName <> NULL ,Devicename <> NULL , Mountpathname <> NULL , Jobs from stores associated with the MouthPath identified by this library-device-mountpathname combination are listed Eg Usage : qoperation execscript -sn QS_FindJobsOnStore [-si 0] [-si 'Lib1'] [-si 'Device_10'][-si 'Folder1'] CommServ.QS_FindJobsOnStore.Readme.html
FixDuplicateADUserEntry qoperation execscript -sn FixDuplicateADUserEntry script_name: FixDuplicateADUserEntry. Fix duplicate entries in users table for AD users, if any. Example: qoperation execscript -sn FixDuplicateADUserEntry CommServ.QS_FixDuplicateADUserEntry.Readme.html
FrontendCapacityUsage License Capacity Usage history along with prediciton for last N weeks/months/years CommServ.QS_FrontendCapacityUsage.Readme.html
GenerateBillingReport Qscript to Generate billing report CommServ.QS_GenerateBillingReport.Readme.html
getAlertSNMPnotification Return alert name , alert type and whether SNMP is configured. CommServ.QS_getAlertSNMPnotification.Readme.html
GetAllLockedClientsAndOwners Get All locked clients, client owners login and email. -- CommServ.QS_GetAllLockedClientsAndOwners.Readme.html
GetAllRunningJobs Get the list of running jobs (backup, admin, restore) on the clients CommServ.QS_GetAllRunningJobs.Readme.html
GetClientDescription Get the description of a client given client name. CommServ.QS_GetClientDescription.Readme.html
GetClientGroup Gets the list of clients associated with a client group or the list of client groups a client is member of. CommServ.QS_GetClientGroup.Readme.html
GetClientInfo Qscript to Get Clients Information Name Ip OS Name and Active status. CommServ.QS_GetClientInfo.Readme.html
GetClients Get the display name and host name(or Ip address) of the Active nodes of clients in a Commserve. CommServ.QS_GetClients.Readme.html
GetClient_Info Qscript to Get Clients Information Name Ip OS Name and Active status. CommServ.QS_GetClient_Info.Readme.html
GetCommcells Get list of Commcells registered to Qnet Server CommServ.QS_GetCommcells.Readme.html
GetCSForClient Get commserve details (name, version, timezone and SQL instanceName) for a client. This script requires Commnet database and Commserve database to be on the same machine. CommServ.QS_GetCSForClient.Readme.html
GetDeconfiguredClientsWithoutBkp Get a list of de-configured clients that have not been backed up longer than given days. CommServ.QS_GetDeconfiguredClientsWithoutBkp.Readme.html
GetDoNotBackupDBName This script can be used to get Clients, subclients and database name which has 'Do Not Backup' status. CommServ.QS_GetDoNotBackupDBName.Readme.html
GetFlaggedJobCount Get the count of jobs that are flagged in GUI needing Administrator's attention. qoperation execscript -sn QS_GetFlaggedJobCount CommServ.QS_GetFlaggedJobCount.Readme.html
GetGlobalFilterState Get the global filter setting of the subclient (OFF | ON | USE CELL LEVEL POLICY) CommServ.QS_GetGlobalFilterState.Readme.html
GetGuiAuditRetention Allow user to list retention days for specific GUI audit operations and users. CommServ.QS_GetGuiAuditRetention.Readme.html
GetHWEncryptionKeys Gets the file marker number , Hardware Encryption Keys for the given Media BarCode. CommServ.QS_GetHWEncryptionKeys.Readme.html
GetIndexingPathForNotesDB Gets the indexing path for the given dbname CommServ.QS_GetIndexingPathForNotesDB.Readme.html
GetJobConfiguration Script to retrieve job configuration of a client. CommServ.QS_GetJobConfiguration.Readme.html
GetJobDescription Gets the description of the job for both running job and completed jobs CommServ.QS_GetJobDescription.Readme.html
GetJobDetails Get the list of Backup Jobs(active and completed) of this entity with application size and total backup size. CommServ.QS_GetJobDetails.Readme.html
GetJobHistory Get the list of Backup Jobs(Completed) of this entity with application size and total backup size. CommServ.QS_GetJobHistory.Readme.html
GetJobList Get the list of Backup Jobs(active and completed) of this entity. Users need any of the following capabilities on the entity to see the job: Job Management, Data Protection / Management Operations, In Place Recover, Out of Place Recover, Browse, Report Management, or View CommServ.QS_GetJobList.Readme.html
GetLicenseInfo This script can be used to retrieve license info from encrypted AAL fields. CommServ.QS_GetLicenseInfo.Readme.html
getMASubClientList returns a list of media agents and the associated subclients of each media agent. CommServ.QS_getMASubClientList.Readme.html
GetMSSQLcredentials Qscript to Globally Get application usernames/password for MS SQL iDA's. CommServ.QS_GetMSSQLcredentials.Readme.html
GetNetworkPendingJobs Get the list of backup jobs that have no attempts and are pending with Network Error pending reason before the specified number of hours. CommServ.QS_GetNetworkPendingJobs.Readme.html
GetOneTouchBackupJobs Return all one touch full backup jobs jobs for given client, app type, backup set and subclient. backupset and subclient are optional arguments. CommServ.QS_GetOneTouchBackupJobs.Readme.html
GetOneTouchBackupJobsAll Return all backup jobs for given client, app type, backup set and subclient. backupset and subclient are optional arguments. CommServ.QS_GetOneTouchBackupJobsAll.Readme.html
GetOperationWindow Get the Operation window rules defined on the Commcell/ Client group/ Client CommServ.QS_GetOperationWindow.Readme.html
GetOperationWindowAll List all operation window rules defined at commcell/clientgroup/client level. CommServ.QS_GetOperationWindowAll.Readme.html
GetOraclecredentials Qscript to Globally get passwords and optionally usernames for Oracle iDa's CommServ.QS_GetOraclecredentials.Readme.html
GetQscriptExec Return qscript execution histories by name, type, status, and a time range. CommServ.QS_GetQscriptExec.Readme.html
GetQscriptInfo Return qscript information by name. CommServ.QS_GetQscriptInfo.Readme.html
GetRegCommcells Get list of Commcells registered to CommNet Server CommServ.QS_GetRegCommcells.Readme.html
GetSchedulePolicy Get the schedule policy name, description and schedule details for a subclient. CommServ.QS_GetSchedulePolicy.Readme.html
GetSQLJobList Return list of SQL jobs and its details. Start and End Time should be client's local Time CommServ.QS_GetSQLJobList.Readme.html
GetSQLSubclientConf Get the list of databases under an SQL subclient. CommServ.QS_GetSQLSubclientConf.Readme.html
GetSubclientConf Get the Contents, Filters, Exception to Filters, Global filter setting, and Schedule policy of a subclient. CommServ.QS_GetSubclientConf.Readme.html
GetSubclientPolicy Gets the list of clients and backupsets associated with a subclientpolicy or the list of subclient policies associated with a client CommServ.QS_GetSubclientPolicy.Readme.html
GetSubclients Get subclientName, id, iDA type and description of subclients in a client CommServ.QS_GetSubclients.Readme.html
GetTimeDifferenceWithCS Script to get the time offset between client and commserver -- operation execscript -sn GetTimeDifferenceWithCS -si 'ClientName' [-si 'CS time'] [-si 'ClientName'] CommServ.QS_GetTimeDifferenceWithCS.Readme.html
GetTopSQLTableInfo Returns Tables having highest number of records. CommServ.QS_GetTopSQLTableInfo.Readme.html
GranularConfigRemoteCache Script to configure packages in remote cache to support granular sync. Script can be executed to configure packages for either all remote caches or a set of given remote caches CommServ.QS_GranularConfigRemoteCache.Readme.html
importBulkMedia Script to incorporate a set of media in Simpana from comma delimited file Usage: qoperation execscript -sn importBulkMedia -si 'fully qualified path of comma delimited file' Example: qoperation execscript -sn importBulkMedia -si D:\media\dataFile.csv CommServ.QS_importBulkMedia.Readme.html
JobsinSPCopy Return list of jobs for a Storage policy copy with input params fromTime, toTime, isAged, backupType, orderBy, policyName, copyName, retention. CommServ.QS_JobsinSPCopy.Readme.html
JobsInStoragePolicyCopy Jobs in the given storage policy copy CommServ.QS_JobsInStoragePolicyCopy.Readme.html
LargestClientDataOnMedia Largest client data on media CommServ.QS_LargestClientDataOnMedia.Readme.html
LargestClients Largest clients for last N days CommServ.QS_LargestClients.Readme.html
LeastDedupedJobs Least deduped data protection jobs for last N days CommServ.QS_LeastDedupedJobs.Readme.html
ListManuallyRetainedJobs View list of jobs that are manually retained on a given Storage Policy Copy. CommServ.QS_ListManuallyRetainedJobs.Readme.html
ListMediaContents View list of jobs for given media barcode CommServ.QS_ListMediaContents.Readme.html
ListRequiredMediaForAuxCopy Lists required media for an auxiliary copy job. Accepts as input running auxiliary copy job Id. CommServ.QS_ListRequiredMediaForAuxCopy.Readme.html
LMCreateDefaultDashBoardAndSearch - The script can be used to create default dashboard and searches. - The default dashboard and search can be deleted. - When the script is ran again,every missing item will be created. CommServ.QS_LMCreateDefaultDashBoardAndSearch.Readme.html
LMCreateDefaultMonitoringPolicy - The script can be used to create default monitoring policy. - Following conditions are checked while creating default monitoring policy. - 1) If the default monitoring policy is already created,then do nothing. - 2) The default monitoring policy will be created with disabled state. - 3) If the analytic engine is configured already,then analytical engine will be associated to the default monitoring policy. - 4) Default monitoring policy cannot be enabled unless analytical engine is configured. CommServ.QS_LMCreateDefaultMonitoringPolicy.Readme.html
LongRunJobs Long running data protection jobs for last N days CommServ.QS_LongRunJobs.Readme.html
ManageContentGrouping The ManageContentGrouping script is used to edit the content grouping monikers which are helpful while specifying the content of subclient. Monikers may be added/edited/removed. The contents of moniker may be added/deleted/overwritten. CommServ.QS_ManageContentGrouping.Readme.html
managedDiskSpaceConfig This script list all the storage policy copies on which Managed DiskSpace configuration is enabled or disabled based on given option. This script can be used to enable or disable Managed DiskSpace configuration on all or given storage policy copies. CommServ.QS_managedDiskSpaceConfig.Readme.html
mappingsForTapeImport Maps the old ids with the new ids for TapeImport. It maps storage policy, copy, backupset and subclient. CommServ.QS_mappingsForTapeImport.Readme.html
MarkJobsOnCopy MarkJobsOnCopy script for marking job on storage policy copy for the auxiliary copy job. Marking operations are allowcopy, recopy and donotcopy job for auxiliary copy job. This script is not applicable for those storage polices which have Jobs from multiple commcells. CommServ.QS_MarkJobsOnCopy.Readme.html
MarkOldSynthfullsForCISuccess Pick latest synthetic-full jobs for content indexing for each subclient and mark older synthetic-full jobs complete. -- qoperation execscript -sn QS_MarkOldSynthfullsForCISuccess -si 'Storage Policy Name' -subclientIds 'Comma separated list of appIds | ALL' -- subclientIds input must be either Comma separated list OR ALL. Note: Only NOT PICKED jobs will be marked as picked. Output returns what jobs are affected and number of rows updated in Database. -- CommServ.QS_MarkOldSynthfullsForCISuccess.Readme.html
MarkSystemMarkedJobsGoodOnCopy To mark the jobs marked bad by Data Verification as good on a copy. Please run a Data Verification on the jobs after marking them as good. CommServ.QS_MarkSystemMarkedJobsGoodOnCopy.Readme.html
matadorCreateVirtualServerInstance Script to create Virtual Server instance. CommServ.QS_matadorCreateVirtualServerInstance.Readme.html
matadorInstallUpdateSchedule Script to set Install Update Schedules for Matador. CommServ.QS_matadorInstallUpdateSchedule.Readme.html
matadorMakeEZAvailable This script adds a row to the GXGlobalParam table in the CommServe Database. The row will have name = Matador and value = 1. CommServ.QS_matadorMakeEZAvailable.Readme.html
matadorSetAlert This script generates an alert notification rule with jobfailed condition for AuxCopy alert for Master Group This script generates an alert notification rule with jobfailed condition for DataVerification alert for Master Group. This script generates an alert notification rule with jobfailed condition for DataProtection alert for Master Group. This script generates an alert notification rule with jobfailed condition for DisasterRecovery alert for Master Group. This script generates an alert notification rule with insufficient storage condition for Library management alert for Master Group. This script generates an alert notification rule with maintenance Required condition for LibraryManagement alert for Master Group. CommServ.QS_matadorSetAlert.Readme.html
matadorSetFreeSpaceUpdatesInterval To set the Media Manager Config parameter to set the Free space updates interval to 10 minutes. CommServ.QS_matadorSetFreeSpaceUpdatesInterval.Readme.html
matadorSetFTPDownloadUpdatesSched To set the Download updates schedule to be 2 hours from the time of install and the same day of the week of the install to reduce the concurrent load on the ftp server which hosts the updates. CommServ.QS_matadorSetFTPDownloadUpdatesSched.Readme.html
matadorSetUserPrefs For Matador, populate the EZ GUI preferences for every user on the CS - includes AD users, and users already having some other prefs set. CommServ.QS_matadorSetUserPrefs.Readme.html
matadorUpdateEmailAndServer Script to Set the Email Address and Server for configuring alerts with the input email id and email server. CommServ.QS_matadorUpdateEmailAndServer.Readme.html
MediaRefreshGetDependentMediaList To get dependent media for a barCode list CommServ.QS_MediaRefreshGetDependentMediaList.Readme.html
mergeVirtualClient Qscript to merge virtual client and galaxy client. CommServ.QS_mergeVirtualClient.Readme.html
MMConvertMagLibToStaticShared Convert a regular magnetic library to static shared library. Script takes library name as input. CommServ.QS_MMConvertMagLibToStaticShared.Readme.html
MMViewDDBListing2 View sealed and active SIDBs across the CommCell. Input "1" to view only sealed store and "0" to view all stores. By default the script will display all stores. CommServ.QS_MMViewDDBListing2.Readme.html
modifySubclientAssociationsForCopy runn the following command from Base using qlogin qoperation execscript -sn QS_modifySubclientAssociationsForCopy -si "e=enable|e=disable" -si "sp=storage policy namename" -si "c=copyname" [-si "cl=clientname"] [-si "a=AgentName"] [-si "i=instanceName"] [-si "b=backupsetName"] [-si "s=subClientName"] example - qoperation execscript -sn QS_modifySubclientAssociationsForCopy -si "e=enable" -si "sp=sp1" -si "c=seccopy" -si "cl=client1" -si "s=subclient1" the entity hierarchy must be maintained client->agent->instance->backupset->subclient the following in put is invalid as backupset appearing before client -si "e=enable" -si "sp=sp1" -si "c=seccopy" -si "b=backupset1" -si "cl=client1" CommServ.QS_modifySubclientAssociationsForCopy.Readme.html
modifysubclientpolicy This script can be used for associating or disassociating a subclient policy to a backupset(s) For association of a subclient policy to a backupset qoperation execscript –sn modifysubclientpolicy –si associate –si c=client_name -si b=backupsetname -si scp=subclient_policy_name For association of a subclient policy to all FS backupsets of a client qoperation execscript –sn modifysubclientpolicy –si associate –si c=client_name -si scp=subclient_policy_name For association of a subclient policy to all FS backupsets of all clients in a client group qoperation execscript –sn modifysubclientpolicy –si associate –si cg=client_group_name -si scp=subclient_policy_name For disassociation of a subclient policy from a backupset qoperation execscript –sn modifysubclientpolicy –si disassociate –si c=client_name –si b=backupsetname When association is tried one/all backupset(s) of a single client, if the file system type of the client and the scp donot match, error will be thrown When association is tried for all clients in a client group, assocciation will be done only for the clients whose flile system type mathces that of the scp Cannot associate a subclient policy to a backupset which is deconfigured or which has user defined subclients or which has a subclient policy associated to it On successful association/disassociation, the sucessfuly associated/disassociated entity names will be displayed CommServ.QS_modifysubclientpolicy.Readme.html
MoveNASSubclient Move a subclient from one NAS client to another CommServ.QS_MoveNASSubclient.Readme.html
MoveOraInstanceToRAC To move an existing Oracle standalone instance to RAC pseudo client qoperation execscript -sn MoveOraInstanceToRAC.sql -i [Source Client Name] [Destination New RAC Client Name] [Source Instance Name] WARNING - Running this qscript will wipe the source instance from its original client. Please do not run without confirming to the product documentation. CommServ.QS_MoveOraInstanceToRAC.Readme.html
NTUpdateRuleForMetricsAlerts Updates custom rule for all commcell level metrics alerts Example: qoperation execscript -sn NTUpdateRuleForMetricsAlerts.sql CommServ.QS_NTUpdateRuleForMetricsAlerts.Readme.html
OraMultiDBCGSnapConfig Script to automatically detect newly added Oracle instances and create sub-clients for snap and clone CommServ.QS_OraMultiDBCGSnapConfig.Readme.html
PerformAlertOp Can be used to disable ,delete or enable an alert which is configured. User should have ALERT MANAGEMENT capability for doing this operation. CommServ.QS_PerformAlertOp.Readme.html
PickLatestCycleJobsForCIForSps Mark backup jobs of latest cycle of each subclient associated to a given Storage policy as Picked for content indexing. -- qoperation execscript -sn QS_PickLatestCycleJobsForCIForSps -si 'storage policy name' -- Storage policy name is the name of a specific storage policy Note: Only NOT PICKED jobs will be marked as picked. Output returns what jobs are affected and number of rows updated in Database. -- CommServ.QS_PickLatestCycleJobsForCIForSps.Readme.html
PinAgingJobsByTimeRange Retain all jobs which are eligible for aging in a given time frame. qoperation execscript -sn QS_PinAgingJobsByTimeRange -si startTime -si endTime -si retentionTime [-si @clientName = 'Client Name' -si @storagePolicyName = 'Storage Policy Name' -si @storagePolicyCopyName = 'Storage Policy Copy Name'] startTime - Start time (Format YYYY\MM\DD) endTime - End time (Format YYYY\MM\DD) retentionTime - Manual retention time (Format YYYY\MM\DD) clientName - Name of the client. storagePolicyName - Name of the storage policy. storagePolicyCopyName - Name of the storage policy copy. CommServ.QS_PinAgingJobsByTimeRange.Readme.html
PopulateAlertTemplate Populates the default alert template for all locales. CommServ.QS_PopulateAlertTemplate.Readme.html
PromoteToFullById Script would force next backup on the subclient to full. CommServ.QS_PromoteToFullById.Readme.html
ProtectedClientsPerPolicy Returns number of completed backup jobs and total data size on media per client in each storage policy. CommServ.QS_ProtectedClientsPerPolicy.Readme.html
ProtectedClientsPerPolicySummary Returns number of protected clients, total protected data size on media and average protected client data size on media per storage policy. CommServ.QS_ProtectedClientsPerPolicySummary.Readme.html
PruneContentDirectorPolicies To delete content director policy that are created. Option to delete all the entries or can explicitly specify names qoperation execscript -sn PruneContentDirectorPolicies -si @username='username' -si @deleteAll='deleteFlag' -si @cdrNames='cdrNames' 'username' -- login name of the user who have admin permission to delete 'deleteFlag' -- TRUE or FALSE Flag to specify if this script needs to delete all content director policy. TRUE to delete all the entries 'cdrNames' -- If deleteFlag is set FALSE, we can provide comma(,) separated list of the names. When deleteFlag flag is TRUE, this param can be skipped CommServ.QS_PruneContentDirectorPolicies.Readme.html
pruneDanglingGxSQLEntries Cleans up dangling entries in GxSQL Lock Detection Tables. CommServ.QS_pruneDanglingGxSQLEntries.Readme.html
QueryDB2Backup qoperation execscript -sn QS_QueryDB2Backup.sql -si clientname -si instancename -si backupsetname -si DATA | LOGS The CommCell user running the script should have browse/view capability on the backupset CommServ.QS_QueryDB2Backup.Readme.html
reassociateReportSchedules Reassociate the report schedules of deleted users to a new valid user CommServ.QS_reassociateReportSchedules.Readme.html
ReassociateWorkflowSchedules QScript to change workflow schedules to a different workflow CommServ.QS_ReassociateWorkflowSchedules.Readme.html
RemoveDuplicateSubclientProp Script to remove the duplicate subclient properties from DB qoperation execscript -sn RemoveDuplicateSubclientProp CommServ.QS_RemoveDuplicateSubclientProp.Readme.html
RemoveUserGUIPreferences Remove the GUI User Preferences for the User corresponding to the login name specified as input. CommServ.QS_RemoveUserGUIPreferences.Readme.html
RenameBackupSet Qscript to rename backupset name CommServ.QS_RenameBackupSet.Readme.html
RenameSearchEngine Qscript to rename Search Engine CommServ.QS_RenameSearchEngine.Readme.html
RenameSubclientName Qscript provided here will rename the Subclient name to a new Subclient name. CommServ.QS_RenameSubclientName.Readme.html
RenameSubclientPolicy Qscript renames the existing Subclient Policy name to the new name provided. CommServ.QS_RenameSubclientPolicy.Readme.html
RePickJobsForCIForSps Mark NOT PICKED jobs under Storage policies as Picked for content indexing. -- qoperation execscript -sn QS_RePickJobsForCIForSps -si 'SP1 Name,SP2 Name...|ALL' -- SPNameList input must be either Comma separated list OR ALL. Note: If jobs for All Storage policies need to be picked for content indexing whose CI state is Not picked, SPNameList parameter should be equal to ALL. Note: Only NOT PICKED jobs will be marked as picked. Output returns what jobs are affected and number of rows updated in Database. -- CommServ.QS_RePickJobsForCIForSps.Readme.html
RePickJobsForContentIndexing Mark ALL OR desired jobs as Re-Picked for content indexing. -- qoperation execscript -sn QS_RePickJobsForContentIndexing -si 'JOBID1,JOBID2...|ALL|filePath=C:\JobList.csv' -si AuthenticationCode -- JobIDList input must be either Comma separated list of Backup Job IDs to be marked as Picked OR ALL OR file path of a CSV file that contains list of jobs as comma seperated values with a prefix as filePath=. WARNING: If all jobs need to be repicked for content indexing whose CI state is success, JobIDList parameter should be equal to ALL Note: If any JOB ID provided is invalid it will skipped/ignored. Output returns what jobs are affected and number of rows updated in Database. Note: If CSV file is used as input, filePath= prefix must be specified and without spaces in suffix or prefix CommServ.QS_RePickJobsForContentIndexing.Readme.html
RepickSnapJobsOnCopy Re-Pick Snap Copy Jobs that has been Backup Copied. -- qoperation execscript -sn RepickSnapJobsOnCopy -si jobId -- Please Note That Re-Picking a snap copy job for Backup Copy will also mark the Snap Jobs which were Backup Copied after the Backup Copy of the Given Job. CommServ.QS_RepickSnapJobsOnCopy.Readme.html
ResetClientDescription Clear description set on a client with the given client name. CommServ.QS_ResetClientDescription.Readme.html
ResetDDBMaintenanceStatus Reset maintenance status for given deduplication database. CommServ.QS_ResetDDBMaintenanceStatus.Readme.html
ResetRefCopyRefTimes Resets the reference copy subclient's reference time CommServ.QS_ResetRefCopyRefTimes.Readme.html
scalereportJobsCompletedBytesXferred The output table gives the list of Media Agents which were used in the last twenty four hours displaying the count of jobs completed by that MA and bytes transferred. CommServ.QS_scalereportJobsCompletedBytesXferred.Readme.html
scalereport_backups_restores_errors_perdrive This script lists the drives which were used in the last twenty four hours along with the name of the Library in which it is present and total backups,restores etc. happened in the last one and twenty four hours. CommServ.QS_scalereport_backups_restores_errors_perdrive.Readme.html
scalereport_commcell_status This script outputs the status of a commcell reporting various parameters like jobs completed, bytes transferred, jobs in the queue etc. CommServ.QS_scalereport_commcell_status.Readme.html
scalereport_drive_usage_throughput_perdrive Report Format: --------------------------------------------------------------------------------------------- LibraryName, DriveName, DriveUsage_hr, DriveUsage_24hr, ThroughputGB_hr, ThroughputGB_24hr --------------------------------------------------------------------------------------------- ********************************** Drive Usage Per Hour ******************************** * * The drive usage is given by the amount of time a drive is used for either * writing or for reading purposes. These details can be obtained from the * MMDriveHistory table. The time at which a write or a read operation has * started is given by TimeStart column. Hence we can obtain the amount of time * a drive is in use by summing up the DataWriteDurationSec+DataReadDurationSec * grouping by the DriveId. Using the above sum we can find the percentage of * time the drive is in use over one hour and twenty four hours duration. * **************************************************************************************** ************************* Throughput of the Drive in GB/Hr ***************************** * * The throughput of a drive is calculated based on the amount of data has been * read or written to a drive in an hour. The columns DataWritten and DataRead in * the same table as above gives the required data. This sum DataWritten+DataRead * is again averaged for the last one hour and for twenty four hours. * **************************************************************************************** CommServ.QS_scalereport_drive_usage_throughput_perdrive.Readme.html
scalereport_jobs_completed_bytes_transferred_perma The output table gives the list of Media Agents which were used in the last twenty four hours displaying the count of jobs completed by that MA and bytes transferred. CommServ.QS_scalereport_jobs_completed_bytes_transferred_perma.Readme.html
scalereport_mounts_streams_reservations_perma The output table gives the list of Media Agents along with the number of mounts, maximum streams transferred and number of reservations made. CommServ.QS_scalereport_mounts_streams_reservations_perma.Readme.html
sealAllActiveStores To seal all active stores on a Commserver, use the following command: qoperation execscript -sn sealallactivestores WARNING - performing this will seal all stores and create new ones. This will cause new base lines to occur in all storage policy copies using deduplication which could lead to a lot of extra network traffic and media usage. Do not run this script without knowing the reason why you would want to seal all stores. CommServ.QS_sealAllActiveStores.Readme.html
SelectAdditionalJobs Select additional jobs (incremental, differential etc) with selected full job on selective copy. CommServ.QS_SelectAdditionalJobs.Readme.html
ServerProtection RBackup status of Physical and Virtual Servers is returned. CommServ.QS_ServerProtection.Readme.html
setAlertSNMPnotification Enable/Disable SNMP notification for all alerts. CommServ.QS_setAlertSNMPnotification.Readme.html
SetAsFBRMA Qscript to set/Unset client as FBR MA. CommServ.QS_SetAsFBRMA.Readme.html
SetAuxCopyJobPriority Set or Remove the combined priority value for Aux Copy Jobs. CommServ.QS_SetAuxCopyJobPriority.Readme.html
SetCleanupTimeOut Set the clean up timeout of all jobs. -- qoperation execscript -sn QS_SetCleanupTimeOut -si CommServ.QS_SetCleanupTimeOut.Readme.html
SetClientDescription Set the description of a client with given client name. CommServ.QS_SetClientDescription.Readme.html
SetClientGroup The SetClientGroup script allows you to add/remove a client from a client group. This script is useful when you want to add/remove multiple clients to the same client group at a given time. CommServ.QS_SetClientGroup.Readme.html
SetClientProp Qscript to enable/disable Use Active Physical Node for virtual clients CommServ.QS_SetClientProp.Readme.html
SetClientProperty Qscript to set client property for specified client qoperation execscript -sn QS_SetClientProperty.sql -si 'clientName' -si 'propertyName' -si 'propertyValue' -si AuthenticationCode clientName - Name of the Client propertyName - specifies the property name (attrName) for which we need to change the value propertyValue - value to be set AuthenticationCode - Authentication Code. CommServ.QS_SetClientProperty.Readme.html
SetClientTimeZone This is script is used to set timeZone of list of clients . USAGE : qoperation execscript -sn QS_setClientTimeZone.sql -si timeZoneName -si clientNameList -si clientGroupNameList -si exludedClientnameList EXAMPLE : qoperation execscript -sn QS_setClientTimeZone.sql -si 'AUS Eastern Standard Time' -si 'myClient1' -si 'myClientGoups' -si NO_CLIENT . This will change the time zone to 'AUS Eastern Standard Time' for all client in the myClientGoups and also for myClient1 . clientNameList : This is a comma separated list of client names for which timezone need to be altered.If nothing need to be specified here please enter 'NO_CLIENT'. You can also use 'ALL_CLIENT' for changing it for all the clients. clientGroupNameList : This is a comma separated list of client group names for which timezone need to be altered. If nothing need to be specified here please enter 'NO_CLIENTGROUP'. You can also use 'ALL_CLIENT_GROUP' for changing it for all the client group. exludedClientnameList : This is a comma separated list of client names which need to be excluded from the list og given client groups .If nothing need to be specified here please enter 'NO_CLIENT' timeZoneName : Standard timezone name which need to be associated to the given clients . The list of all supported timezones are given below. ----List of supported timeZoneNames ---- Afghanistan Standard Time Alaskan Standard Time Arab Standard Time Arabian Standard Time Arabic Standard Time Argentina Standard Time Atlantic Standard Time AUS Central Standard Time AUS Eastern Standard Time Azerbaijan Standard Time Azores Standard Time Canada Central Standard Time Cape Verde Standard Time Caucasus Standard Time Cen. Australia Standard Time Central America Standard Time Central Asia Standard Time Central Brazilian Standard Time Central Europe Standard Time Central European Standard Time Central Pacific Standard Time Central Standard Time Central Standard Time (Mexico) China Standard Time Dateline Standard Time E. Africa Standard Time E. Australia Standard Time E. Europe Standard Time E. South America Standard Time Eastern Standard Time Egypt Standard Time Ekaterinburg Standard Time Fiji Standard Time FLE Standard Time Georgian Standard Time GMT Standard Time Greenland Standard Time Greenwich Standard Time GTB Standard Time Hawaiian Standard Time India Standard Time Iran Standard Time Jordan Standard Time Korea Standard Time Mid-Atlantic Standard Time Middle East Standard Time Montevideo Standard Time Morocco Standard Time Mountain Standard Time Mountain Standard Time (Mexico) Myanmar Standard Time N. Central Asia Standard Time Namibia Standard Time Nepal Standard Time New Zealand Standard Time Newfoundland Standard Time North Asia East Standard Time North Asia Standard Time Pacific SA Standard Time Pacific Standard Time Pacific Standard Time (Mexico) Pakistan Standard Time Romance Standard Time Russian Standard Time Russia Time Zone 10 Russia Time Zone 11 Russia Time Zone 3 SA Eastern Standard Time SA Pacific Standard Time SA Western Standard Time Samoa Standard Time SE Asia Standard Time South Africa Standard Time Sri Lanka Standard Time Taipei Standard Time Tasmania Standard Time Tokyo Standard Time Tonga Standard Time US Eastern Standard Time US Mountain Standard Time Venezuela Standard Time Vladivostok Standard Time W. Australia Standard Time W. Central Africa Standard Time W. Europe Standard Time West Asia Standard Time West Pacific Standard Time Yakutsk Standard Time Singapore Standard Time Israel Standard Time Bahia Standard Time Bangladesh Standard Time Kaliningrad Standard Time Kamchatka Standard Time Libya Standard Time Line Islands Standard Time Magadan Standard Time Mauritius Standard Time Paraguay Standard Time Syria Standard Time Turkey Standard Time Ulaanbaatar Standard Time UTC UTC+12 UTC-02 UTC-11 CommServ.QS_SetClientTimeZone.Readme.html
SetCommcellActivity Enable or disables the following activities at the commcell level. All Job Activity Data Management Activity Data Recovery Activity Auxiliary Copy Activity Data Aging Activity Scheduler Activity Online Content Index Activity Offline Content Index Activity CommServ.QS_SetCommcellActivity.Readme.html
setConfigParam Sets a particular configuration parameter. CommServ.QS_setConfigParam.Readme.html
SetContentIndexingProperty Qscript to set content indexing property qoperation execscript -sn QS_SetContentIndexingProperty.sql -si 'propertryName' -si 'propertyValue' -si AuthenticationCode propertryName - specifies the Conent Indexing property name for which we need to change the value propertyValue - value to be set AuthenticationCode - Authentication Code. CommServ.QS_SetContentIndexingProperty.Readme.html
SetDataPathProperty Set data path property for a given datapath, a storage policy - copy , a library-media agent or all the data paths CommServ.QS_SetDataPathProperty.Readme.html
SetDataReaders Set description on a client with given client name. CommServ.QS_SetDataReaders.Readme.html
SetDeconfClientName Rename a deconfigured client. CommServ.QS_SetDeconfClientName.Readme.html
SetDedupProp Qscript to set or get the Single Instancing Property of Subclients for the Clients CommServ.QS_SetDedupProp.Readme.html
SetDefaultSCContent Set or clear "use global filter" setting per User input (w/aging). CommServ.QS_SetDefaultSCContent.Readme.html
SetDeviceControllerProps Set pruning MediaAgent for cloud library. CommServ.QS_SetDeviceControllerProps.Readme.html
SetDriveProperty Script set drive properties. Parameters: TapeLibraryName : Name of the Tape library. DriveAliasName : Name of the drive. opType : Operation type. CommServ.QS_SetDriveProperty.Readme.html
setEncryptedEntityProp Sets encrypted properties in MMEntityProp. CommServ.QS_setEncryptedEntityProp.Readme.html
SetExchangeDBIDAProp Script to set properties of ExchangeDB IDA qoperation execscript -sn SetExchangeDBIDAProp -si @clientName='Client Name' -si @userName='User Name' -p2 @password='Password' -si @backupType='Incremental' -si @useVss='true' -si @backupFromReplica='true' -si @backupOnActiveNode='true' -si @serverName='Server Name' -si @copyBackup='true' Where ClientName would be client name. UserName User name to be set for IDA Password Password to be set for IDA. BackupType Incremental / Differential UseVss true / false BackupFromReplica true / false BackupOnActiveNode true / false ServerName Name of exchange server CopyBackup true / false Example: qoperation execscript -sn SetExchangeDBIDAProp -si @clientName='Client Name' -si @userName='admin' -p2 @password='Password' -si @backupType='Incremental' -si @useVss='true' -si @backupFromReplica='true' -si @backupOnActiveNode='true' -si @serverName='E12SP3' -si @copyBackup='true' GUI will show all the properties changed from commandline. CommServ.QS_SetExchangeDBIDAProp.Readme.html
SetFlushBlockSize Sets new flush block size for given recording format name. qoperation execscript -sn QS_SetFlushBlockSize -si -si RecordingFormat: Recording format name, FlushBlockSize: New flush block size Example: qoperation execscript -sn QS_SetFlushBlockSize -si 'SDLT' -si 128 CommServ.QS_SetFlushBlockSize.Readme.html
SetGlobalFilterState Set the global filter setting of the subclient to OFF | ON | USE COMMCELL LEVEL POLICY CommServ.QS_SetGlobalFilterState.Readme.html
setGlobalFilterStateForClient To set the Global System State for subClients -- qoperation execscript -sn SetGlobalFilterStateForClient -si 'ON'|'OFF'|'USE CELL LEVEL POLICY' -si 'clientName'|'AllClientsInCommcell' To set Cell Level Policy on for all clients: qoperation execscript -sn SetGlobalFilterStateForClient -si 'USE CELL LEVEL POLICY' -si 'AllClientsInCommcell' To set Cell Level Policy only for for client myClient: qoperation execscript -sn SetGlobalFilterStateForClient -si 'USE CELL LEVEL POLICY' -si 'myClient' To turn off global filters for myClient: qoperation execscript -sn SetGlobalFilterStateForClient -si 'OFF' -si 'myClient' To turn on global filters (not cell level( for myClient: qoperation execscript -sn SetGlobalFilterStateForClient -si 'ON' -si 'myClient' CommServ.QS_setGlobalFilterStateForClient.Readme.html
SetGuiAuditRetention Allow user to add, modify and delete retention days for specific GUI audit operations and users. CommServ.QS_SetGuiAuditRetention.Readme.html
SetHoliday Qscript to Add new holiday and change the description of any old holiday CommServ.QS_SetHoliday.Readme.html
SetIDAVersion Script to set the IDA version for a given client and agent type CommServ.QS_SetIDAVersion.Readme.html
SetInvalidGUID Qscript to make a GUID as invalid. Installing CommServe with existing DataBase and using a new license file(new CommCellId) may cause same GUID exist with different CommCellId. This causes issues with CommCellMigration, we should not use such GUID in mappings. We should treat such GUID as invalid. CommServ.QS_SetInvalidGUID.Readme.html
SetJobConfiguration Qscript to Globally set job configuration CommServ.QS_SetJobConfiguration.Readme.html
SetJobDescription Sets the description of a job CommServ.QS_SetJobDescription.Readme.html
SetKeyIntoGlobalParamTbl Set or Remove the data base key and value from the gxglobalparam table. CommServ.QS_SetKeyIntoGlobalParamTbl.Readme.html
setLibraryProperty To set the Library properties CommServ.QS_setLibraryProperty.Readme.html
SetLimitRunningJobs Qscript to enable\disable Limit Simultaneous Running Jobs on a client and set values for limits. CommServ.QS_SetLimitRunningJobs.Readme.html
setMediaAgentProperty To set the Media Agent attributes CommServ.QS_setMediaAgentProperty.Readme.html
SetMediaDescriptionUsingBarcodeList Qscript to update Description of media Using Barcodes and Description from a CSV file CommServ.QS_SetMediaDescriptionUsingBarcodeList.Readme.html
SetMediaLocation Set export location for media. CommServ.QS_SetMediaLocation.Readme.html
SetMountpathPassword Script to set password for given user of mount path. qoperation execscript -sn SetMountpathPassword -si 'username' -p2 'plainpassword' CommServ.QS_SetMountpathPassword.Readme.html
SetMountPathProperties Set mount path allocation policy. CommServ.QS_SetMountPathProperties.Readme.html
SetMountPathWriters Set mount path allocation policy. CommServ.QS_SetMountPathWriters.Readme.html
SetMSSQLcredentials Qscript to Globally set application usernames/password for MS SQL iDA's. CommServ.QS_SetMSSQLcredentials.Readme.html
SetNasIDAProp Script to set properties of NAS IDA qoperation execscript -sn SetNasIDAProp -si @clientName='Client Name' -si @userName='User Name' -p2 @password='Password' Where ClientName would be client name. UserName User name to be set for IDA Password Password to be set for IDA. Example: qoperation execscript -sn SetNasIDAProp -si @clientName='Client Name' -si @userName='admin' -p2 @password='Password' GUI will show all the properties changed from commandline. CommServ.QS_SetNasIDAProp.Readme.html
SetNetHostName Set the net host name of a client with given name. CommServ.QS_SetNetHostName.Readme.html
SetNetHostNameByID Set the net_hostname of a client with given client ID. CommServ.QS_SetNetHostNameByID.Readme.html
SetNextJobIdCounter Set the next job id counter CommServ.QS_SetNextJobIdCounter.Readme.html
SetOraclecredentials Qscript to Globally set passwords and optionally usernames for Oracle iDa's Notes: 1) Requires Client name, Credential, password and login as an input. Refer to step 2, 3, 4 and 5 2) The script can be used on a specified Client or all clients which must be specified as an input. To change the password for the specific instance, you must use the GUI to do so. 3) Please provide the credentials type as DB, Catalog, Impersonate User (Windows platforms only) or RAC as an input. Parameter 2 (Credentials type) can be in the following format: t=Catalog, t=DB, t=RAC, or t=Impersonate. In the case of RAC, all databases under the Oracle RAC instance will be given the same password/(username). 4) The passwords can be passed as plain text using -p1|-p2|-p3 or encrypted using -si. If you are using -p1|-p2|-p3 argument then the qcommand will essentially encrypt the password before passing it to qscript. No check is/can be performed to validate it. 5) If the username option is specified, the username in addition to the password is modified. If it is omitted, only password(s) are modified. Examples: 1) To change the password for a specific client, where the password is in plain text: qoperation execscript -sn SetOracleCredentials.sql -si c=client1 -si t=RAC -p2 passwd -si cvadmin 2) To change the password for a all client, where the password is in plain text: qoperation execscript -sn SetOracleCredentials.sql -si allclients -si t=DB -p2 passwd -si cvadmin 3) To change the password for a specific client, where the password is encrypted: qoperation execscript -sn SetOracleCredentials.sql -si c=client1 -si t=Catalog -si -si cvadmin 6) t=Impersonate(for only windows clients) option Examples: 1) For specific client qoperation execscript -sn SetOracleCredentials.sql -si c=client1 -si t=Impersonate -p2 passwd -si domainname\username 2) To change for all the clients qoperation execscript -sn SetOracleCredentials.sql -si allclients -si t=Impersonate -p2 passwd -si domainname\username CommServ.QS_SetOraclecredentials.Readme.html
SetOracleInstanceProperties Update the property for a given instance. CommServ.QS_SetOracleInstanceProperties.Readme.html
SetOracleRestoreRestart Qscript provided here is used to enable/disable restartability of Oracle Restore. CommServ.QS_SetOracleRestoreRestart.Readme.html
setQueueJobsIfOtherJobsRunning Enable/Disable queueJobsIfOtherJobsRunning. CommServ.QS_setQueueJobsIfOtherJobsRunning.Readme.html
SetRegisterClient Set auto register client info. CommServ.QS_SetRegisterClient.Readme.html
SetRetentionForUserDeletedItems Sets the retention value in days for all FS subclients under that client group. Example: For setting rention as 'Delete Immediately' use retention option as below. 1) ./qoperation execscript -sn SetRetentionForUserDeletedItems.sql -si ' ' -si 'Immediately' For setting rention as 'Never' use retention option as below. 2) ./qoperation execscript -sn SetRetentionForUserDeletedItems.sql -si ' ' -si 'Never' For setting rention in days, use below retention option and input the number of days as retention parameter. 2) ./qoperation execscript -sn SetRetentionForUserDeletedItems.sql -si ' ' -si 'Days' -si '14' CommServ.QS_SetRetentionForUserDeletedItems.Readme.html
SetScaleLimitForCommNet Alters the Scale Limits used by CommNet CommServ.QS_SetScaleLimitForCommNet.Readme.html
SetScanOptions Usage: qoperation execscript -sn SetScanOptions.sql -si client_group_name -si scan_options Description: Sets the scan option specified for all the backupsets of Windows FS iDA within the given client group Specify the list of scan options to be set, each separated with ; Example: To set the scan options as Use classic file scan and Preserve File Access Time to a client group called ScanGroup, specify them as qoperation execscript -sn setscanoptions.sql -si "ScanGroup" -si "Use Classic File Scan ; Preserve File Access Time" You can specify only these combinations Use Data Classification; Use Classic File Scan; Use Classic File Scan; Check archive bit during backups; Use Classic File Scan; Preserve File Access Time; Use Classic File Scan; Preserve File Access Time; Check archive bit during backups; Use Change Journal; (Use Data Classification corresponds to Optimal Scan) (Use Classic File Scan corresponds to Recursive Scan) CommServ.QS_SetScanOptions.Readme.html
SetScanOptionsForSCP Qscript to set the scan options for the subclients associated to a given subclient policy This script can be used to set scan options for subclients associated to windows subclient policy This script will set the scan options for 10.0 or larger subclients only The scan options must be specified in the same way as displayed in GUI. Any wrong combination of them is treated as error The scan options specified will overwrite the previous scan option values for those subclients. Usage: qoperation execscript -sn "SetScanOptionsForSCP" -si "Subclient_policy_name" -si "Change Journal" qoperation execscript -sn "SetScanOptionsForSCP" -si "Subclient_policy_name" -si "Recursive Scan" qoperation execscript -sn "SetScanOptionsForSCP" -si "Subclient_policy_name" -si "Recursive Scan ; Preserve File Access Time" qoperation execscript -sn "SetScanOptionsForSCP" -si "Subclient_policy_name" -si "Recursive Scan ; Check archive bit during backups" qoperation execscript -sn "SetScanOptionsForSCP" -si "Subclient_policy_name" -si "Recursive Scan ; Preserve File Access Time ; Check archive bit during backups" qoperation execscript -sn "SetScanOptionsForSCP" -si "Subclient_policy_name" -si "Optimal Scan" CommServ.QS_SetScanOptionsForSCP.Readme.html
SetSchedulePolicy Add or remove subclient association from a schedule policy. CommServ.QS_SetSchedulePolicy.Readme.html
setSIDBJobsAged Mark all jobs in a SILO as aged. CommServ.QS_setSIDBJobsAged.Readme.html
SetSPDBSubclientContent The script will create user-defined SharePoint DataBase subclient with Site Collections specified in the text file CommServ.QS_SetSPDBSubclientContent.Readme.html
SetStoragePolicy Change data/log storage policy of a subclient CommServ.QS_SetStoragePolicy.Readme.html
SetStoragePolicyById Change data/log storage policy of a subclient CommServ.QS_SetStoragePolicyById.Readme.html
setSubclientFilter Qscript is used to set the contents, filters and exceptions of file system subclients and subclient policies. Usage: For FSSubclient qoperation execscript -sn SetSubclientFilter.sql -si [p=contents | f=filters | e=exceptions] -si [delimiter] -si [o=y | o=n] -si c=clientname -si a=IDA name -si b=backupsetname -si s=subclientname Usage: For SCPolicy qoperation execscript -sn SetSubclientFilter.sql -si [p=contents | f=filters | e=exceptions] -si [delimiter] -si [o=y | o=n] -si scp=subclient policy name -si S=Subclientname Example: 1) Set contents for FSSubclients: qoperation execscript -sn setSubclientFilter -si p=D:\txtfiles;D:\textfiles -si ; -si o=y -si c=Client1 -si a=Q_FILESYSTEM -si b=backup1 -si s=subcli1 2) Set filters for FSSubclients: qoperation execscript -sn setSubclientFilter -si f=D:\txtfiles\newtxtfiles -si ; -si o=y -si c=Client1 -si a=Q_FILESYSTEM -si b=backup1 -si s=subcli1 3) Set exceptions for FSSubclients: qoperation execscript -sn setSubclientFilter -si e=D:\txtfiles\newtxtfiles\input.txt -si ; -si o=y -si c=Client1 -si a=Q_FILESYSTEM -si b=backup1 -si s=subcli1 4) Set contents for subclient policy qoperation execscript -sn setSubclientFilter -si p=D:\txtfiles;D:\textfiles -si ; -si o=n -si scp=test1 -si s=mytest 5) Set filters for subclient policy qoperation execscript -sn setSubclientFilter -si f=D:\txtfiles\newtxtfiles -si ; -si o=n -si scp=test1 -si s=mytest 6) Set exceptions for SCPOlicy qoperation execscript -sn setSubclientFilter -si e=D:\txtfiles\newtxtfiles\input.txt -si ; -si o=n -si scp=test1 -si s=mytest 7) Set contents with wildcard characters qoperation execscript -sn setSubclientFilter -si p=D:\txtfiles;D:\textfiles -si ; -si o=y -si c=Client1 -si a=Q_FILESYSTEM -si b=backup1 -si s=subcli1 Note: o=y indicates the previous contents to be overwritten. o=n indicates the previous contents will not be overwritten. The added contents will be appended to the existing list CommServ.QS_setSubclientFilter.Readme.html
SetSubClientPolicyForClient Use the SetSubclientPolicyforClient script to set the subclient policy for a client. Note: 1. If the script is set with no backupset name, the subclient policy is set for the default backupset in the File System idataagent of the client. 2. If the qscript is set with a backupset name, the subclient policy is set for the correct backupset. 3. If invalid arguments are used, appropriate error messages are displayed. 4. If the sscript is run for the backupset which is already associated to a subclient policy, the appropriate error message is displayed. 5. If the OS type on the client is different from the OS type used by the subclient policy, the appropriate error message is displayed. Usage: qoperation execscript -sn SetSubClientPolicyForClient -si subclientPolicyName -si clientName -si backupsetName Example: qoperation execscript -sn SetSubClientPolicyForClient -si policy1 -si client1 -si backupset1 CommServ.QS_SetSubClientPolicyForClient.Readme.html
SetSubClientPrePostProcess Qscript to Set Pre/Post Process Batch files and modify user account info user name and password. password is accpted in encrypted format. there is no validation for encrypted password. prefix used: PreScan= To give PreScan batch file PostScan= to give PostScan batch file PreBackup= To give preBackup batch file PostBackup= To give postBackup batch file subclientId scriptsPaths are mandatory feilds isLocalAccout,UserName and Password are optional feild if isLocalAccount is Yes or not given. LocalAccount is assumed if infor is not there in db if isLocalAccount is NO, UserName and Password is required. CommServ.QS_SetSubClientPrePostProcess.Readme.html
SetSubClientProperty Set given subclient property value under given client, db2 instance, backupset and subclient. Example: 1) ./qoperation execscript -sn SetSubClientProperty.sql -si 'c=docserve04' -si 'a=Q_UNIX_DB2' -si 'i=db2inst1' -si 'b=CROSSDB' -si 's=default' -si 'DB2 Data Backup' 2) ./qoperation execscript -sn SetSubClientProperty.sql -si 'c=docserve04' -si 'a=Q_UNIX_DB2' -si 'i=db2inst1' -si 'b=CROSSDB' -si 's=default' -si 'DB2 Data Backup' -si '2' CommServ.QS_SetSubClientProperty.Readme.html
SetUseGlobalFilters Set or clear "use global filter" setting per User input (w/aging). CommServ.QS_SetUseGlobalFilters.Readme.html
SetUseInstanceGUID Qscript to enable or disable the use of VM Instance UUIDs to identify virtual machines for a virtual server instance or all virtual server instances in a CommCell hierarchy. CommServ.QS_SetUseInstanceGUID.Readme.html
SetUseVSSGlobally Enable/Disable the "Use VSS" option for all windows XP, 2003, Vista, and 2008 iDataAgents. CommServ.QS_SetUseVSSGlobally.Readme.html
SetVMClient - The script can be used to remove duplicate virtual machine clients. Virtual machine properties and jobs would be merged to a single client. - Following rules would be used to merge the clients. - 1) Virtual Machine client with Simpana Components would be retained. - 2) If client1 has underscore (_) followed by number in the name and client2 doesn't have underscore(_) follwed by number then jobs would be copied from client1. - 3) If client2 has underscore (_) followed by number in the name and client1 doesn't have underscore(_) followed by number then jobs would be copied from client2. - 4) If both clients either have underscore (_) followed by number or not then client with latest job would be retained. - Next Virtual server job will be associated to the retained client. CommServ.QS_SetVMClient.Readme.html
SetVMOSInfo Qscript to set the virtual machine OS information in CommServe DB qoperation execscript -sn QS_SetVMOSInfo.sql -si 'clientName' -si 'simOSId' clientName - Name of the Client simOSId - sim operating system Id CommServ.QS_SetVMOSInfo.Readme.html
SetVmPolicyProperty This script is to allow us to change (or set) VM Allocation policy properties CommServ.QS_SetVmPolicyProperty.Readme.html
SetVSAExpressParams Set subclient policy for client. Example: qoperation execscript -sn SetVSAExpressParams -si @VCHostName='vcHostName' -si @VCUserName='vcUserName' -p2 @VCPassword='vcPassword' -si @MountPathName='mountPathName' -si @MountPathUserName='mountPathUserName' -p2 @MountPathPassword='mountPathPassword' qoperation execscript -sn SetVSAExpressParams -si 'vcHostName' -si 'vcUserName' -p2 'vcPassword' -si 'mountPathName' -si 'mountPathUserName' -p2 'mountPathPassword' CommServ.QS_SetVSAExpressParams.Readme.html
SetVSAPassword Set password for specified VCenter. Example: qoperation execscript -sn SetVSAPassword -si 'vcHostName' -p2 'vcPassword' CommServ.QS_SetVSAPassword.Readme.html
SlowestClients Slowest clients for last N days CommServ.QS_SlowestClients.Readme.html
StorageUsageBySubclients It returns protected application size and storage usage per subclient for data protected in the given time range. Notes: 1. The entire jobs started before the time range are counted. Jobs completed after the time range are not counted. 2. Data physically deleted from media are not counted. So short retention jobs may not be counted. 3. For VMs, results are grouped by VMs, not by the proxy clients. 4. Deduped storage usage is calculated using the average dedup ratio of each dedup copy. So dedup savings are counted evenly. Usage: qoperation execscript -sn QS_StorageUsageBySubclients [-si @LastTimePeriod="'1 months'"] [-si @FromHour='8'] [-si @FromTime='2013/02/12'] [-si @ToTime='2013/02/20'] [-si @IncludeAgedData='0'] [-si @SyncVolumeSize='0'] [-si @PolicyName='policyName'] [-si @CopyName='copyName'] [-si @SizeUnit='TB'] [-si @GroupBy='Client'] [-si @OrderBy="'Application Size'"] Example: qoperation execscript -sn QS_StorageUsageBySubclients -si "7 days" -si 10 qoperation execscript -sn QS_StorageUsageBySubclients -si @FromTime='2013-09-01' -si @ToTime="'2013/09/30 23:59:59'" Note: Parameter values containing white spaces should be in single quotes inside double quotes, eg. "'30 days'". Parameters: 1. Time range can be specified by either LastTimePeriod and FromHour or FromTime and ToTime. LastTimePeriod and FromHour will be used if LastTimePeriod is specified. Otherwise FromTime and ToTime will be used. a. LastTimePeriod should be in 'N days' or 'N months' format. FromHour should an integrer between 0 and 23. Default is -1 which means the current time. b. FromTime and ToTime should be in 'mm/dd/yyyy hh:mm:ss' or 'yyyy-mm-dd hh:mm:ss' format. 2. Default is IncludeAgedData = 0 for not including aged Data. 3. Default is SyncVolumeSize = 0 for not correcting dedup volume sizes because of backlog of updating size on disk. 4. If PolicyName and/or CopyName are specified, calculation only includes data in the given storage policy and/or copy. 5. SizeUnit can be 'GB' or 'TB'. Default is 'GB'. 6. GroupBy can be set to 'Client' for returning sizes per client. Default is returning sizes per subclient. 7. OrderBy can be set to 'Application Size', 'Data Written', 'Agent', 'Storage Policy' or 'Client Group'. Default order is 'Client', 'Agent', 'Backupset', 'Instance', 'Subclient', 'Storage Policy', 'Copy'. Columns: Client - Client computer name Agent - Data agent type name Instance - Instance name Backupset - Backupset name Subclient - Subclient name Storage Policy - Storage Policy name Copy - Storage Policy Copy name Storage Type - Dedup, Disk or Tape Retention - Storage Policy Copy retention settings Application Size (GB) -- Protected application data size in GB Data Written (GB) - Data written on media in GB Client Group - Names of client groups associated by the client CommServ.QS_StorageUsageBySubclients.Readme.html
StrikeRecovery Recovered backup strikes. CommServ.QS_StrikeRecovery.Readme.html
ToggleMountPathsofDDBMA This script takes as parameter 1. enable (1 or 0) and a DDBMA Name(say test-ma) . The script will then Enable/ Disable the mount paths attached to the SIDBStores of the test-ma . By attached mounts paths we mean the mount paths onto which the backups from the store's deduped storage policy get stored. If input param enable = 1 , then mount paths are enabled. if enable = 0, mount paths are disabled. CommServ.QS_ToggleMountPathsofDDBMA.Readme.html
UnAgeJobsOnMedia Un-Age the aged jobs on given media barcode CommServ.QS_UnAgeJobsOnMedia.Readme.html
updateAgentUpgradeDate Update date time when 'SharePoint Server' or 'SharePoint Archiver' agent is allowed to be upgraded to 10.0 CommServ.QS_updateAgentUpgradeDate.Readme.html
updateAlertRuleEntity Qscript to update entity name from alert rules. qoperation execscript -sn QS_updateAlertRuleEnity [-si 'alertName'] alertName - Name of the alert which need to be modified CommServ.QS_updateAlertRuleEntity.Readme.html
UpdateCIProxyClient Qscript to set client property for specified client qoperation execscript -sn QS_UpdateCIProxyClient.sql -si 'ciClientName' -si 'proxyClientName' clientName - Name of the Client for which need to set the proxy proxyClientName - proxy client name CommServ.QS_UpdateCIProxyClient.Readme.html
UpdateClientDestinationGUID Replace CDR pair destinationGUIDs for all pairs with a particular destination client and original GUID CommServ.QS_UpdateClientDestinationGUID.Readme.html
UpdateCommcellHostName Update the host name for external commsell, if the host name or ip registered is not accessible. CommServ.QS_UpdateCommcellHostName.Readme.html
UpdateCommecellHostName Update the host name for external commsell, if the host name or ip registered is not accessible. CommServ.QS_UpdateCommecellHostName.Readme.html
updateDAGADCredential Update 'DAG Associated AD User Name' and 'DAG Associated AD User Password' for particular client qoperation execscript -sn updateDAGADCredential -si 'clientName' -si 'userName' -p2 'password' CommServ.QS_updateDAGADCredential.Readme.html
updateDAGNameServer Update 'AD Domain Name' for a MS Exchange DAG Client qoperation execscript -sn updateDAGNameServer -si 'clientName' -si 'domainName' CommServ.QS_updateDAGNameServer.Readme.html
UpdateNextEvent Script to change the next event in a schedule policy CommServ.QS_UpdateNextEvent.Readme.html
updateUserGroupUserPropertiesCap Update "cloup Capabilities" property for a user or a user group CommServ.QS_updateUserGroupUserPropertiesCap.Readme.html
VMBackupSizes Return Full/Incremental backup sizes of VM based on time range. Default is 30 days. CommServ.QS_VMBackupSizes.Readme.html
VolSnapCleanup Script to cleanup snap entries CommServ.QS_VolSnapCleanup.Readme.html
VSASubclientContent Use the QS_VSASubclientContent script to move/delete/list/add vm/vms for specified subclient. Note: 1. The script could accept one vm (by @i_vmName) or list of vms placed inside text file (path to file in @i_vmListFileName). 2. @i_OperationName one of {'Move'|'Delete'|'List'|'Add'}. 3. if the script used to move vm/vms (@i_OperationName='Move') you have to specify @i_NewSubclientName also. 4. Use optional parameters @i_BackupSetName/@i_NewBackupSetName if @i_SubclientName/@i_NewSubclientName are not unique for provided client and instance. 5. if @i_OperationName='Add' then file specified by @i_vmListFileName must have comma separated VM name, VM GUID, VM ESX Server on each line of file like: vmName1,vmGUID1,vmESXServer1 vmName2,vmGUID2,vmESXServer2 6. if @i_OperationName='Move' or 'Delete' then file specified by @i_vmListFileName must have just VM name on each line of file like: vmName1 vmName2 7. if @i_OperationName='Add' and file is not specified by @i_vmListFileName then you have to specify VM name via @i_vmName, VM GUID via @i_vmGUID amd VM ESX Server via @i_vmESXServer. 8. If invalid arguments or combination of arguments are used, appropriate error messages are displayed. Usage: qoperation execscript -sn VSASubclientContent -si @i_ClientName='client_name' -si @i_InstanceName='Instance_Name' -si @i_SubclientName='subclient_name' -si @i_OperationName='Operation_Name' [ -si @i_BackupSetName='BackupSetName' -si @i_vmName='VM_Name' -si @i_NewBackupSetName='NewBackupSetName' -si @i_NewSubclientName='New_Subclient_Name' -si @i_vmListFileName='vm_List_File_Name' -si @i_vmGUID='vmGUID' -si @i_vmESXServer='ESXServer'] Example: qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Move' -si @i_vmName='VM1' -si @i_NewBackupSetName='TestBackupSet' -si @i_NewSubclientName='TestSubclient2' qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Delete' -si @i_vmListFileName='c:\VmList.txt' qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_BackupSetName='defaultBackupSet' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='List' qoperation execscript -sn VSASubclientContent -si @i_ClientName='myClient' -si @i_InstanceName='TestInstance' -si @i_SubclientName='SmallSubclient' -si @i_OperationName='Add' -si @i_vmName='VM_Name1' -si @i_vmGUID='vmGUID1' -si @i_vmESXServer='ESXServer1' CommServ.QS_VSASubclientContent.Readme.html
WebFeatures Script to enable or disable a web feature -- CommServ.QS_WebFeatures.Readme.html
WeeklyBackupSummary Weekly summary of clients from a given date CommServ.QS_WeeklyBackupSummary.Readme.html

Additional Information

Most QScripts can be used regardless of application. These QScripts are available in the <software_install_folder>\scripts folder on the CommServe computer. However, some QScripts are stored procedures that are attached to the corresponding databases (for example, the CommServe database). These QScripts are available in the stored procedures folder on the CommServe computer.

QScripts and Associated Readmes

The readmes use one of the following naming convention:
  • readme_<scriptname>.txt

    For example, the readme associated with GetSubclients.sql script is readme_GetSubclients.txt.

  • <scriptname>.Readme.html

    This is used by the qscripts in the stored procedures folder on the CommServe computer. For example, the readme associated with GetQscriptExec.sql script is CommServ.QS_GetQscriptExec.Readme.html.

For information on the available options and parameters that can be used to execute the specific script, refer to the readme associated with the respective QScript.

GUI Audit Trail Report

The GUI Audit Trail Report provides information on the scripts executed by the qoperation execscript command. The report must be generated using the Low Severity option to include this information. The report includes details on the name of the script and the input parameters used to execute the scripts.

Any login and logout sessions from the command line (i.e. using qlogin and qlogout commands) are all audited by the CommCell Console. To enable this for upgraded CommServe, the following command is used:

qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si QSDKSessionsAudit -si y -si 1