StorageUsageBySubclients

Scope

Intended Audience
All X
CommVault Internal  
CE/System Test  
Development  

Platform

  • CommServer (Database: CommServ)

Release

  • 10.0.0

Description

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


    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. Eg. '7 days'.


    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'.



    Output:


    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.


    Version

  • 1.1.2.3
     
  • Disclaimer of Warranties

    CommVault provides software tools and utilities on an "as is" basis, as a courtesy and convenience to its users, and they may be changed from time to time without notice. These tools and utilities are provided without express, implied, or statutory warranties of any kind. You assume full risk and responsibility for the selection, possession, performance and proper installation and use of the software tools and utilities, and for verifying the results obtained there from. Your use of CommVault software tools and utilities indicates your unconditional acceptance of the above disclaimer.