Topics | QScripts | How To | Troubleshoot | Support | Related Topics
QScripts are SQL scripts that enable you to directly query the Commserve database engine. Each QScript includes a readme file that provides instructions and argument parameters to query the commserve database. You can execute QScripts using the qoperation execscript qcommand.
You can download latest version of QScripts from the Maintenance Advantage web site. Contact your software provider for assistance.
| WARNING: 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. |
Note the following when using QScripts:
| Refer to the readme associated with the respective
QScript for information on the available options and parameters that can
be used to execute the specific script. The readmes use the following
naming convention: readme_<scriptname>.txt For example, the readme associated with GetSubclients.sql script is readme_GetSubclients.txt. |
| QScript | Description | Readme Files |
| CommCellAverageDataTransfer | The QScript 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. | readme_CommCellAverageDataTransfer |
| CompressionConfig | Qscript to Get/Set compression properties for subclients | readme_CompressionConfig |
| CreateOracleInstance | QScript to create a new oracle instance or on demand instance. | readme_createOracleInstance.txt |
| DataInterfacePairConfig | QScript to add, delete or list client data interface pair. | readme_DataInterfacePairConfig.txt |
| DeleteLastNsnaps | Qscript to remove oldest N Number of Fan in Snaps | readme_deleteLastNSnaps |
| DeleteScheduleTemplate | QScript to Delete schedule policy | readme_DeleteScheduleTemplate |
| EncryptionConfig | Qscript to Get/Set encryption properties for subclients | readme_EncryptionConfig |
| GetAllRunningJobs | QScript to Get list of all running jobs i.e. Backup, admin, restore from clients | readme_GetAllRunningJobs |
| GetClientDescription | QScript to get description of a client. | readme_GetClientDescription.txt |
| GetClientGroup | QScript here gets the list of clients associated with a client group or the list of client groups a client is member of. | readme_GetClientGroup.txt |
| GetClients | QScript here gets the display name and host name (or IP address) of the Active nodes of clients in a Commserve. | readme_GetClients.txt |
| GetClients_Info | Qscript to get client's Information such as Name, IP, OS Name and Active status. | readme_GetClients_Info.txt |
| GetCommcells | QScript here gets the list of CommCells registered to CommNet Server. This script would fetch the list of CommCells. | readme_GetCommcells.txt |
| GetCSForClient | This Qscript gets commserve details such as name, version, time zone and SQL instanceName for a client. This script requires CommNet database and Commserve database to be on the same machine. | readme_GetCSForClient.txt |
| GetDoNotBackupDBName | This QScript can be used to provide Clients, subclients and database names which has 'Do Not Backup' status. | readme_GetDoNotBackupDBName.txt |
| GetGlobalFilterState | This QScript gets global filter setting of the subclient (ON/OFF/USE CELL LEVEL POLICY) | readme_GetGlobalFilterState.txt |
| GetJobConfiguration | QScript to retrieve job configuration of a client. | readme_GetJobConfiguration.txt |
| GetJobDescription | QScript to get the job description of running job/historical job. | readme_GetJobDescription.txt |
| GetJobDetails | QScript to get Backup Job details of a client (active and completed) with application size and total backup size. | readme_GetJobDetails.txt |
| GetJobList | QScript to get Backup Job details (active and completed) of a client. | readme_GetJobList.txt |
| GetLicenseInfo | This QScript can be used to retrieve license information from encrypted AAL fields. | readme_GetLicenseInfo.txt |
| GetNetworkPendingJobs | QScript to get the list of backup jobs that have no attempts and are pending with Network Error pending reason before the specified number of hours. | readme_GetNetworkPendingJobs.txt |
| GetOperationWindow | QScript to get the list of all operation window rules defined at commcell/clientgroup/client level. It gives the list of operations, start and end times and name of the entity for each rule. | readme_GetOperationWindow.txt |
| GetOperationWindowAll | QScript to get list of all operation window rules defined at commcell/clientgroup/client level. It gives the list of operations, start and end times, and name of the entity for each rule. | readme_GetOperationWindowAll.txt |
| GetRegCommcells | QScript to get list of Commcells registered to CommNet Server. This script would fetch the list of commcells. | readme_GetRegCommcells.txt |
| GetSchedulePolicy | QScript to get the schedule policy name, description and schedule details for a subclient. | readme_GetSchedulePolicy.txt |
| GetSQLSubclientConf | QScript to get the list of databases under an SQL subclient. | readme_GetSQLSubclientConf.txt |
| GetSubclientConf | QScript to get the Contents, Filters, Exception to Filters, Global filter setting, and Schedule policy of a subclient. | readme_GetSubclientConf |
| GetSubclientPolicy | QScript that gets the list of clients and backupsets associated with a subclientpolicy or the list of subclient policies associated with a client | readme_GetSubclientPolicy |
| GetSubclients | QScript to get subclientName, id, iDA type and description of subclients in a client | readme_GetSubclients |
| ListMediaContents | QScript to Get list of jobs for given media barcode. | readme_ListMediaContents |
| PromoteToFullById | This QScript would force next backup on the subclient to full. | readme_PromoteToFullById.txt |
| RenameBackupSet | Qscript to rename backupset name | readme_RenameBackupSet |
| RenameSubclientName | This QScript will rename the Subclient name to a new Subclient name. | readme_RenameSubclientName |
| ResetClientDescription | QScript for clear description set on a client with the given client name. | readme_ResetClientDescription.txt |
| scalereport_backups_restores_errors_perdrive | This QScript 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. | readme_scalereport_backups_restores_errors_perdrive.txt |
| scalereport_commcell_status | This QScript outputs the status of a commcell reporting various parameters like jobs completed, bytes transferred, jobs in the queue etc. | readme_scalereport_commcell_status.txt |
| scalereport_drive_usage_throughput_perdrive | This QScript outputs the library and the drive name along with the drive usage and throughput of the drive in GB/h. | readme_scalereport_drive_usage_throughput_perdrive |
| scalereport_jobs_completed_bytes_transferred_perma | The QScript 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. | readme_scalereport_jobs_completed_bytes_transferred_perma |
| 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. | readme_scalereport_mounts_streams_reservations_perma.txt |
| SetAuxCopyJobPriority | This QScript enables to set or remove the combined priority value for Aux Copy Jobs. | readme_SetAuxCopyJobPriority.txt |
| SetClientDescription | This QScript enables to set description on a client with given client name. | readme_SetClientDescription.txt |
| SetClientGroup | This QScript allows to associate a client with a client group. | readme_SetClientGroup.txt |
| SetCommcellActivity | This QScript enables 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 |
readme_SetCommcellActivity.txt |
| setConfigParam | This QScript sets a particular configuration parameter. | readme_setConfigParam.txt |
| SetDataReaders | This QScript sets description on a client with given client name. | readme_SetDataReaders.txt |
| SetDeconfClientName | This QScript renames a deconfigured client. | readme_SetDeconfClientName.txt |
| SetDefaultSCContent | This QScript sets contents of default subclient of a given backupset. | readme_SetDefaultSCContent.txt |
| SetGlobalFilterState | This QScript sets subclient include global filter option to ON/OFF/USE CELL LEVEL POLICY. | readme_SetGlobalFilterState.txt |
| SetHoliday | Qscript to Add new holiday and change the description of any old holiday. | readme_SetHoliday.txt |
| SetIDAVersion | QScript to set the IDA version for a given client and agent type. | readme_SetIDAVersion |
| SetJobConfiguration | Qscript to Globally set job configuration. | readme_SetJobConfiguration.txt |
| SetJobDescription | QScript to set the job description of running job and historical job. | readme_SetJobDescription.txt |
| SetKeyIntoGlobalparamTbl | QScript to set or remove the data base key and value from the gxglobalparam table. | readme_SetKeyIntoGlobalparamTbl.txt |
| SetMediaAgentProperty | QScript to update the properties of a Specific Media Agent. | readme_setMediaAgentProperty.txt |
| SetMSSQLCredentials | Qscript to Globally set application usernames/password for MS SQL iDataAgents. | readme_SetMSSQLCredentials.txt |
| SetNetHostName | QScript to set netHostName on a client with given name. | readme_SetNetHostName.txt |
| SetNetHostNameByID | QScript to set netHostName on a client with given client ID. | readme_SetNetHostNameByID.txt |
| SetOracleCredentials | QScript to globally set passwords and optionally usernames for Oracle iDataAgents. | readme_SetOracleCredentials.txt |
| SetRefTimeForIncrJobs | Qscript to set the ref time for job with a particular client so that next incr job will not be converted into full. | readme_SetRefTimeForIncrJobs |
| SetSchedulePolicy | QScript to add or remove subclient association from a schedule policy. | readme_SetSchedulePolicy.txt |
| SetStoragePolicy | This QScript will change data/log storage policy of a subclient. | readme_SetStoragePolicy.txt |
| SetStoragePolicyById | This QScript will change data/log storage policy of a subclient. | readme_SetStoragePolicyById.txt |
| SetSubclientFilter | QScript to set content / filters /exception to filter in a file system subclient. | readme_SetSubclientFilter.txt |
| SetSubClientPrePostProcess | Qscript to set Pre/Post Process Batch files and modify user account info user name and password. password is accepted in encrypted format. there is no validation for encrypted password. | readme_SetSubClientPrePostProcess.txt |
| SetUseGlobalFilters | Qscript to set or clear "use global filter" setting per User input (w/aging). Setting will be changed for all FS like SubClients in all backupSets. | readme_SetUseGlobalFilters.txt |
| UpdateNextEvent | QScript to change the next event in a schedule policy | readme_UpdateNextEvent |