The Command Usage reports allow you to monitor the execution of various commands on servers. This topic provides an overview of how data is collected for these reports and how to create a Network Shell Script job to collect data.

These reports derive information from logs recorded by Remote System Call Daemon (RSCD) agents. The Command Usage reports can also help you troubleshoot issues with particular servers. For the Command Usage built-in reports, see Command Usage reports.

You collect data for the Command Usage reports by using the collect_agent_logs.nsh script, which copies data from agent logs on specified target servers to files on the reports server. Use the script to create a TrueSight Server Automation Network Shell Script Job that you can run on a regular basis. You can execute the job for a one-time run or you can create a schedule for the job.

The script is included in the content_installer.zip file, which is located in the <TSSA-DWInstallationDirectory>/bsa/content_installer directory.

Before you create the Network Shell Script Job, you need to install the collect_agent_logs.nsh script. For more information, see Installing scripts.

To create a Network Shell Script Job for the collect_agent_logs.nsh script

1. Create the Network Shell Script Job with the target for which you want to collect the agent logs. 

   The following table lists the required parameters that you must provide while creating the job. For information about how to create a Network Shell Script Job, see  Adding a Network Shell script  in the TrueSight Server Automation documentation.
   
   

   Using existing jobs

   If you want use the existing TrueSight Server Automation jobs, the following fields need to be modified:

   Script name	Field/Parameter
   COLLECT_AGENT_LOG_SERVER	Host name of the server where TrueSight Server Automation - Data Warehouse is installed.
   COLLECT_AGENT_LOG_LOCATION	<TSSA-DWInstallationDirectory>/AgentLogs

   Parameter	Description/Value
   COLLECT_AGENT_LOG_SERVER	This parameter is the TrueSight Server Automation - Data Warehouseserver name on which the agent logs are stored after they are collected from the agents/servers. This server name must be the same as the server on which the agent log destination folder is located. You provide that location during the product installation.
   COLLECT_AGENT_LOG_LOCATION	This parameter is the directory in which the agent logs are stored. This location should be the same as the agent log destination folder that you provided during the product installation. The default location is <TSSA-DWInstallationDirectory>/AgentLogs.
   BL_SITE_ID	This parameter is the site ID for the TrueSight Server Automation site from which the collect_agents_logs script is being run. If you have multiple TrueSight Server Automation sites in your TrueSight Server Automation - Data Warehouse installation, use the site ID that you used during the TrueSight Server Automation - Data Warehouse installation. The site ID must be a valid ID from the BL_SITE table. You can determine the site ID using the TrueSight Server Automation - Data Warehouse console.

2. (Optional) Create a schedule for the job. 

After you run the job and the logs are present on the server, you run ETL by using an NSH script to transfer the data to the reports data warehouse and make it available for the Command Usage reports. While running ETL, provide the agentlogs.properties file as the value for the -f argument. See Running ETL using an NSH script and agentlogs.properties file in Property files for more information.

Related topic

Command Usage reports