Skip to content
CA Workload Automation AE & Workload Control Center
Documentation powered by DocOps

CA WCC Agent Inventory

Last update February 28, 2019

The Agent Inventory display lets you see and export information about each separately installable component (system agent, plug-ins, and advanced integrations). 

The Agent Inventory tab is available to CA WCC users with permission for Agent Inventory functions. Agents are shown only for CA Workload Automation AE instances that have the CA Workload Automation AE Web Services component enabled.

Note: Agent Inventory requires the CA Workload Automation AE servers to be at version 11.3.6 SP2 or later.


Agent List

The Agent Inventory tab contains the Agent List providing a list of machines for a CA Workload Automation AE server. The list contains the following columns:

  • Machine Name
    Displays the CA Workload Automation AE machine name (as defined to CA Workload Automation AE server) where the agent is installed.
    Hover the cursor over the required Machine Name row, click the button next to the machine name to retrieve the following agent information:
    • Download Logs
    • Download AgentParams
    • View Agent Details
    • Update AgentParams
    • Stop Agent
    • Restart Agent
    • Reset Action Status
    • View Status Details
    • Plugin Details
  • Machine Status
    Indicates the connection status of the machine as reported by the CA Workload Automation AE Scheduler. A machine can have one of following statuses:
    • Online
      Indicates that the machine is available and accepting jobs to run.
    • Offline 
      Indicates that the machine has been manually removed from service and does not accept jobs to run. In this status, the agent is accessible.

      Note: This status is applicable for machines in schedulers from CA Workload Automation AE Release 11.3.6 SP6 or earlier releases. From CA Workload Automation AE Release 11.3.6 SP7, this status is displayed as Offline and OfflineDown.

    • Offline Down
      Indicates that the machine has been manually removed from service and does not accept jobs to run. In this status, the agent is not accessible.
    • Missing
      Indicates that the scheduler has verified that the machine is not responding and has automatically removed it from service. The machine does not accept jobs to run.
    • Unqualified
      Indicates that the scheduler is attempting to qualify the status of an agent before switching the machine from an online to missing status. The machine does not accept jobs to run.
    • Blocked
      Indicates that the agent blocks communication. All jobs that are scheduled to start on the agent are put in a PEND_MACH status.

    Note: For more information about machine status, see the Machine Status section.

    Status changes can be delayed by the specified refresh duration and Agent Status Poll Interval. The check interval can be set on the CA Workload Automation AE Scheduler using AgentStatusPollInterval.

  • Agent Type
    Indicates the agent type.
  • Agent Name
    Indicates the name of the agent.
  • Host
    Indicates the hostname of the agent.
  • Port
    Indicates the port on which the agent is listening.
  • Version
    Indicates the version of the agent. The format is <version_number>-<build_number>. If the version is not available, -- is displayed (that is, two dashes).
  • Platform
    Indicates the platform where agent is being run. If the platform is not available, -- is displayed (that is, two dashes).

    Note: For CA Workload Automation AE Release 11.3.6 SP7, the value of 'opsys' as entered under the Machine Name configuration or the agent detected value is displayed. If 'opsys' value is not entered, -- is displayed for 11.3.6 SP6 and previous releases.

  • Server Name

  • Displays the  CA Workload Automation AE server name (as defined to CA WCC) where the agent is installed.

  • Action Status
    Displays the agent status such as stopping, stopped successfully, failed, or restarted.
  • Action Timestamp
    Displays the time dynamically corresponding to the agent status.

    Note: The Action Timestamp column data cannot be located using the Search.

  • Plugins
    Displays all plugins (internal and external), that are configurable by the user.

    Note: The internal plugins “clearfiles, communicationmanager, config, filebrowser, nop, outbox, refresh, router, setproperty, and status” are not displayed in the Agent Inventory table. When you export data, it contains all the plugin details except the mentioned internal plugins.

  • Description
    Displays the description property value of the machine.

More information:

Security

The following security requirements control how Agent Inventory displays information and what functions a user can perform.

  • Users must have configuration access to use Agent Inventory. Only users with Agent Inventory through EEM access see the Agent Inventory tab.
  • The Monitor ID and Monitor Password must be specified in the configuration tab of CA WCC per server description. The Monitor User must have CA Workload Automation AE web service access enabled. 
  • If the web services URL is empty in CA WCC, Agent Inventory ignores the server.
  • Download logs, download params, view agent details, plugin details, stop agent, restart agent, view status details, and reset status are not supported when local job security is turned on (security.level=on setting in agentparm.txt). In this case, you might receive the following error message:
    Error: E140179 Unexpected error occurred while performing the action. Refused by agent security

The search bar lets you specify multiple search terms (separated by spaces). Rows are displayed if any of the search terms are found anywhere within a row of data. A case-insensitive search is performed. Searches also support the asterisk (*) wildcard character.  

For example, you enter the following items in the search bar:

11.3.0 solaris

In this case, rows are displayed where 11.3.0 or solaris were found in the agent data.  For example, agents with versions like 11.3.06.01-0478, or platforms and host names containing solaris are displayed.

Export Table

You can export the Agent List to CSV (Comma Separated Values) so that you can filter, sort, edit, and create custom reports.

To export the Agent List, click the EXPORT TABLE button on the top of the Agent List table.

The CSV file is filtered with the same criteria, and displays the same columns with one column for each plugin, as the Agent List table, described earlier in this article.

Example:

Machine Name,Status,Agent Type,Agent Name,Host,Port,Version,Platform,Server Name,Action Status,Action Timestamp,Application Services Agent,BigData Agent,DataServices Agent,Database Agent,FTP Agent,File Monitoring Agent,Hadoop Agent,I5OS Agent,ITPAM Agent,Informatica Agent,MSSQL Agent,Management Agent,Microfocus Agent,Object Monitoring Agent,Oracle Applications Agent,PeopleSoft Agent,Remote Agent,Runner Agent,SAP Agent,SNMP Agent,SQL Agent,WebServices Agent,Description
P13res,Online,System Agent,WA_AGENT,user01-I152613,7520,11.4.00.00-1607,Linux for amd64,P13,,,No,No,No,No,Yes,Yes,No,No,No,No,No,No,No,Yes,No,No,No,Yes,No,No,No,No,test
user01-I152613,Online,System Agent,WA_AGENT,user01-I152613,7520,11.4.00.00-1607,Linux for amd64,P13,,,No,No,No,No,Yes,Yes,No,No,No,No,No,No,No,Yes,No,No,No,Yes,No,No,No,No,Created by the installer.
i5agentnw,Online,System Agent,DEMO832,USILIA09,7832,11.3.04.03-0833,OS/400 for PowerPC,P13,,,No,No,No,No,No,Yes,No,No,No,No,No,No,No,Yes,No,No,No,Yes,No,No,No,No,
user01-I152612,Online,System Agent,WA_AGENT,user01-I152612,7520,11.3.07.00-0979,Linux for i386,P13,,,Yes,No,Yes,Yes,Yes,Yes,No,No,Yes,No,No,No,No,Yes,No,No,No,Yes,No,No,No,Yes,
user01-I8901,Online,System Agent,WA_AGENT,user01-I8901,7520,11.3.07.00-0979,Windows Server 2012 R2 for x86,P13,,,No,No,No,No,Yes,Yes,No,No,No,No,No,No,No,Yes,No,No,No,Yes,No,No,No,No,
user01-I8901,Online,System Agent,WA_AGENT1a,user01-I8901,7521,11.3.07.00-0979,Windows Server 2012 R2 for x86,P13,,,No,No,No,No,Yes,Yes,No,No,No,No,No,No,No,Yes,No,No,No,Yes,No,No,No,No,
user01-I8901,Online,System Agent,WA_AGENT2,user01-I8901,7522,11.3.07.00-0979,Windows Server 2012 R2 for x86,P13,,,No,No,No,No,Yes,Yes,No,No,No,No,No,No,No,Yes,No,No,No,Yes,No,No,No,No,

Datasources

The Datasources icon informs the user of the overall state of all CA Workload Automation AE Servers (Datasources) connected to Agent Inventory.

The possible conditions are:

  • Green (Ok)
    Indicates that all enabled CA Workload Automation AE schedulers are connected and providing agent data.
  • Red (Error)
    Indicates one of the following conditions:
    • When no CA Workload Automation AE servers are defined, the overall Datasources status is Error. 
    • When one of the CA Workload Automation AE servers is not connected or providing agent data as expected, the overall Datasources status is Error.

Clicking the Datasources icon takes you to the Datasources page.

More information:

Supported Browsers

Some browsers do not support Agent Inventory inside the CA WCC tab, including IE10 and IE11. In this case, you see the following message:

The application could not be loaded inside WCC tab.

Please click here to open in a new window.

If you click on click here, Agent Inventory opens as a new browser tab where it is fully functional.

Retrieve Information from Agents

Agent Inventory lets authorized users retrieve information from Agents. This information includes agent details, logs, and parameters.

Note: The selected action is performed only on one of the agents in the cluster configuration.

Download Logs

Agent Inventory provides the capability to download the agent log files. The files are collected on the agent, compressed, and downloaded to your browser. All the files in the agent log directory are downloaded.

To download the agent log files, click to select a row in the Agent Inventory table. Select the Download Logs option in the Machine Name button drop-down list. When downloading logs, a warning dialog appears to notify you that the download can take some time. If you click Continue, it downloads the log files; otherwise it does not.  After the logs are downloaded, you can use a standard "unzip" utility of your choice to recover the original log files as they existed on the agent host.

Other considerations:

  • Supported versions are described in the Retrieve Information from Agents topic.
  • The machine (agent) must be accessible by CA Workload Automation AE for the download to be successful. You cannot download logs from an agent that is not running.
  • While not required, we recommend that you take the machines associated with the agent offline. Next, ensure that the agent is not processing any critical jobs that the log download could interfere with.
  • Retrieving the agent logs can be quite time consuming (several minutes). So be patient until the files are available on the browser or an error message is displayed.
  • If the logs cannot be downloaded for some reason, the UI presents an error message. As noted previously, it might be some time before the error message appears.
  • Downloads fail when the log directory is greater than 500 MB (uncompressed) or 250 MB (compressed). The error message reflects this size problem.
  • As part of the process, files are staged in a temporary directory on the agent. For this reason, sufficient agent disk space must exist for the download to succeed. As a rule of thumb, you need about twice the amount of space that the agent log directory consumes.
  • When reviewing agent logs, remember that the log retrieval process itself might appear in the logs. Repeated attempts to download the same logs can cause the logs themselves to grow.
  • Only files in the agent log directory are downloaded. Log files that are archived to other storage areas are not downloaded.
  • Assume a standard agent configuration where agent log folder location is not customized.

Download AgentParams

Agent Inventory provides the capability to download the Agent parameters file (agentparm.txt). The agentparm.txt file is collected from the agent, and a text file is downloaded to your browser.

To download the agent parameters, click a row in the Agent Inventory table. Select Download AgentParams option in the Machine Name button drop-down list. Once downloaded, you can use a standard editor of your choosing to open the Agent parameters.

Other considerations:

  • Supported versions are described in the Retrieve Information from Agents topic.
  • The machine (agent) must be accessible by CA Workload Automation AE for the download to be successful. You cannot download parameters from an agent that is not running.
  • If the parameters cannot be downloaded for some reason, the UI displays an error message.
  • Downloads fail when the agentparm.txt file is greater than 10- MB. The error message reflects this size problem.

View Agent Details

Agent Inventory lets you view various details about an agent like enabled functionality and other integrations and plug-ins. The displayed details vary based on the version of the agent.

To view the Agent details, click a row in the Agent Inventory table. Select the View Agent Details option in the Machine Name button drop-down list.

Other considerations:

  • Supported versions are described in the Retrieve Information from Agents topic.
  • The machine (agent) must be accessible by CA Workload Automation AE for the View Agent Details to succeed. You cannot View Agent Details from an agent that is not running.
  • The displayed details are the same as the details that are displayed with the “cybAgent -v[v]” command of the agent.
  • A modal window in the browser displays the details.

To download the agent details, click a row in the Agent Inventory table. Select the View Agent Details option in the Machine Name button drop-down list. Click the DOWNLOAD button. Once downloaded, you can use a standard editor of your choice to open the agent parameters.

Update AgentParams

Agent Inventory provides the capability to update the parameters in the agentparm.txt file.

Follow these steps:

  1. Click ... against the machine (agent) name for which you want to update the parameters in the Machine Name column of the Agent List table.
  2. Select Update AgentParams.
    The agentparm.txt file is collected from the agent and the Update Agent Parameters dialog displays the agent parameters. 

    Note: A message displays if no content is present in the agentparm.txt file.

  3. Add new content or modify the existing content as appropriate and Click Update.
    The updates are applied and the agent is restarted.

Note:

  • To update the agentparm.txt file, you must have Configure access under the AgentAccess policy.
  • If the updated agentparm.txt file contains any errors, the agent restart fails.

Stop Agent

Agent Inventory lets you stop agents that are running. Stopping the agent stops all the plug-ins of that agent.

Follow these steps:

  1. To stop the agent, select the agent that you want to stop, in the Inventory table. Select the Stop Agent option in the Machine Name button drop-down list.
  2. You can stop more than one agent, by selecting the checkboxes against the agents; to stop more than one agent, select the STOP AGENTS option that is displayed from the ACTIONS button drop-down list.
    After you select Stop Agent, a message displays.
  3. Click CONTINUE to stop the agents.
    The Action Status and Action Timestamp column in the Inventory table are updated.

Note: Legacy agents are not supported. If you select a legacy agent and use the Stop Agent option, a message displays.

Restart Agent

Agent Inventory lets you Stop Agents that are running and restart those agents.

Follow these steps:

  1. To restart the agent, select the agent that you want to restart, in the Inventory table. Select the Restart Agent option in the Machine Name button drop-down list.
  2. You can restart more than one agent, by selecting the checkboxes against the agents; to restart more than one agent, select the RESTART AGENTS option that is displayed from the ACTIONS button drop-down list.
    After you select Restart Agent, a message displays.
  3. Click CONTINUE to restart the agents.
    The Action Status and Action Timestamp column in the Inventory table are updated. 

Note: Legacy agents are not supported. If you select a legacy agent and use the Restart Agent option, a message displays.

Reset Action Status

Agent Inventory lets you reset the status an agent, when the agent failed to stop or restart and the issue was manually resolved.

Follow these steps:

  1. To reset the status of an agent, select the agent which status you want to reset, in the Inventory table. Select the Reset Action Status option in the Machine Name button drop-down list.
  2. You can reset the status of more than one agent, by selecting the checkboxes against the agents; to reset more than one agent, select the RESET ACTION STATUS option that is displayed from the ACTIONS button drop-down list.
    The Action Status field is cleared.

View Status Details

You can view the status of the agent that was stopped, restarted, or the agent parameter was updated.

To view the status details of an agent, select the agent which status you want to reset, in the Inventory table. Select the View Status Details option in the Machine Name button drop-down list.

A message displays the status details of the agent.

Plugin Details

Agent Inventory lets you view various details about an agent like enabled functionality and plug-ins.

To view the Agent and Plugin details, click a row in the Agent Inventory table. Select the Plugin Details option in the Machine Name button drop-down list.

Note: When you select the Plugin Details option, columns not displayed in the Agent List table are also listed under Agent Details.

Was this helpful?

Please log in to post comments.