File Level Analytics

Overview Getting Started Advanced FAQ

Table of Contents

Running File Level Analytics

Windows Usage

Unix Usage

Mandatory parameters for subclient based query

Mandatory parameters for Job ID based query

Available Command Parameters

Running File Level Analytics

File Level Analytics is performed from the Command Line by directly querying the index cache. It is supported by all Agents.

Windows Usage

You can run the File Level Analytics on Windows MediaAgents using the following steps:

  1. From the Command prompt Navigate to <Software_Installation_Directory>/Base folder.
  2. Run one of the following commands:

    Subclient Based Command

    Job ID Based Command

Unix Usage

You can run the File Level Analytics on Unix MediaAgents using the following steps:

  1. From the Command prompt navigate to any folder except the root folder /<folder name>
  2. Run the following command:

    Subclient Based Command

    Job ID Based Command

Mandatory parameters for subclient based query

The following parameters are a must for the subclient based query:

Example

Notes

  1. If no backupset is provided default backupset is considered.
  2. If there are two subclients with the same name on the client, then you must specify a backupset.
  3. If you run a query on a virtual machine, then you must specify the instance name with the -vm parameter.
  4. If format is not specified then full file name, file size and modified date of the file is provided in the CSV format in the output file.
  5. If unixtime stamp is not specified, human readable time will be printed in the output.
  6. If a MediaAgent is specified, the index will be downloaded to that MediaAgent and then the query will be processed on this MediaAgent.

    If not specified, the media agent where the backup job ran would be used for processing the query.

  7. If no pattern file is specified everything is considered.

Mandatory parameters for Job ID based query

The following parameters are a must for the Job ID based query:

Example

Available Command Parameters

Parameter Description of Parameter Values
-client Name of the client on which the data protection job is run.
-appType Application type of the corresponding subclient. All Agents are supported.
-instance Name of the instance in the client computer on which the data protection job is run. Note that this parameter is optional as not all Agents have instances. If your Agent does not support instances, then do not list the parameter in the command.
For all Exchange Agents, make sure to include the instance parameter and specify defaultInstance as the value. Exchange Agents will always use the default instance.
-backupset Name of the backupset in the client computer on which the data protection job is run.
-subclient Subclient name of the subclient which contains the backup data.
-jobId Job id of the job whose file level information needs to be established.
-outfile File name and location of the output file in which the output will be displayed.
-ma Fully qualified domain name of the MediaAgent computer. This needs to be the host name as specified in the CommCell Console.
-where Clause used to run the query.

The following arguments can be used with the where clause.

file_size Size of files in backup presented in Bytes.
mod_time The time at which the file was modified. This time needs to be in unix time format. Use any third party converting tool to convert windows time to unix time.
access_time The time at which the file was last accessed. This time needs to be in unix time format. Use any third party converting tool to convert windows time to unix time.
basename File name (without the full path) of the file for which file level information is retrieved.

The following operators can be used:

  • AND -  can be used when more than two arguments are used in the where clause.
  • <
  • >
  • ==
-format Format in which the information will be presented in the output.

The following arguments can be used to specify the format for output file.

file_size Size of files in backup presented in Bytes.
mod_time The time at which the file was modified.
access_time The time at which the file was last accessed.
basename File name (without the full path) of the file for which file level information is retrieved.
-patternfile This is an input file. Specify the location of the pattern file with file name. If - pattern file is not specified, then “\**\*” (everything) is used. If more than one pattern needs to be matched, multiple patterns need to be provided within the patternfile.

Pattern file can contain patterns based on the wild card support. See Wildcards for detailed information.
-vm Name of the instance.
-unixtime If used, time in output file will be displayed in unix time format.
-commcellid This parameter is used with queries based on job id.
-commcell CommCell name which holds the client. This parameter works with subclient based queries.
–dbjob Used to get the backup list for databases (Oracle, Sybase, Informix,DB2, SAP for Oracle). This works along with -jobId parameter.