Unsupported content


This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Setting up data collection for Command Usage reports

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 Built-in 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 BMC 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.


When a Network Shell user has the same user ID as a BMC Server Automation user, the Command Usage reports merge activity associated with those IDs. If you want to view the BMC Server Automation activity of a user separately from that Network Shell activity, you must set up different user IDs for that user on BMC Server Automation and the servers where the user accesses Network Shell.

The script is included in the content_installer.zip file, which is located in the BDSSAInstallationDirectory/bsa/content_installer directory.


Some earlier versions of BMC Server Automation use a different content download file. 

Before you create the Network Shell Script Job, you need to install the collect_agent_logs.nsh script. For more information, see Installing Inventory templates and other 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 Creating Network Shell Script Jobs in the BMC Server Automation documentation.




    This parameter is the reports server name on which the agent logs are stored after they are collected from the agents/servers.
    This reports 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.
    For details and default installation locations, see Installation worksheet.


    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 BDSSAInstallationDirectory/AgentLogs.

    For example, on Microsoft Windows, if the BMC Decision Support for Server Automation is installed in C:\Program Files\BMC Software\BDSSA, you would enter the following path in NSH format: /C/Program Files/BMC Software/BDSSA/AgentLogs.
    For details and default installation locations, see Installation worksheet.


    This parameter is the site ID for the BMC Server Automation site from which the collect_agents_logs script is being run.

    If you have multiple BMC Server Automation sites in your BMC Decision Support for Server Automation installation, use the site ID that you used during the BMC Decision Support for Server Automation installation.

    The site ID must be a valid ID from the BL_SITE table. You can determine the site ID using the BMC Decision Support for Server Automation 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

Built-in Command Usage reports

Was this page helpful? Yes No Submitting... Thank you