Agent Management User Interface

You can view all the installed agents on the Agent Management tab in the Controller UI. You can navigate using any of the following ways on the Controller UI to view the Agent Management tab:

• Home > Agent Management > Manage Agents
• <user profile> >  Agent Management 

Permissions

To access the Agent Management UI, you require to be an administrator or a user with Agent Management role-based access control. The administrators can provide access to the application owners to view or manage App Server Agent inventory from the Agent Management UI. See Role-Based Access Control.

Currently, an administrator can manage only App Server Agents, and Machine Agents by using Smart Agents. An administrator can also view the tasks in progress, history of tasks, and import configuration to the Controller. 

The application owners with role-based access control (RBAC) can manage the app server agents based on their roles.

Role-Based Access Control

The ITOps administrator (with the administrator role) can now use the role-based access control to provide permissions to application owners. These permissions allow the application owners to perform the following for a specific application (View Agent, Edit Agent or both) or for a specific account (Install Agent):

• View Agent: to allow users in a specific role view the App Server Agent inventory in the Agent Management UI for the specific applications.
• Edit Agent: to allow users in a specific role to manage (except install) one or more App Server Agents for the specific applications. 
• Install Agent: to allow users to install the agents based on all the Smart Agents that are associated with the account. The users with this permission will have the same permission as the administrator. The users can manage the agents from the App Server Agent inventory on the Agent management UI.

• These permissions apply to AppServer Agent, Machine Agent, and Smart Agent.
• Tabs other than App Server Agents will be disabled for non-admin users.

Application-Based Access Control

An ITOps administrator can create a role for an application owner and assign any specific application to it. When you assign the View or Edit permissions to the application, the user can view or modify AppServer Agents, Machine Agents, and Smart Agents.

If you select the Edit Agent permission the user with the specific role can manage (except install) only the agent associated with the application.

Perform the following to provide access based on the application:

1. Create a role by navigating to Settings>Administration>Roles>Create, then associate the role with a user.
   You must associate the role to the username of the application owner. See Manage Controller Tenant Users and Groups.
   If you have already created the role, select the role name under Name on the left pane.
2. Click Applications.
3. Under Custom Permissions for Applications / Tiers, click Add.
4. Select the applications on which you require to allow the application owners to view or manage the Agents, and then click Done.
5. Select Custom under Permissions. 
6. Select View to enable the Edit checkbox, and then select Edit.
7. Click Edit (All) 
   1. Select View Agent if you require the users in the specified role to view the application-specific agent inventory in the Agent Management UI.
   2. Select Edit Agent if you require the users in the specified role to view and manage the agents through the Agent Management UI. 

Account-Based Access Control

An ITOps administrator can create a role for any user. Administrator can specify the Install Agent permission for a role within a specific account. If you select the Install Agent permission, the user of the specified role can view, and manage all the agents connected to that account. The users can install the agents on all the Smart Agent hosts connected to that account. 

Perform the following to provide access to install agents at the account level:

1. Create a role by navigating to Settings>Administration>Roles>Create, then associate the role with a user.
   You must associate the role to the username of the application owner. See Manage Controller Tenant Users and Groups.
   If you have already created the role, select the role name under Name on the left pane.
2. Click Account>Add.
3. Select Install Agent.
4. Click Done.

Hence, the application owner can log in using their credentials and access Agent Management to manage the app server agents.

View and Manage Agent Details

When you click Manage Agents, you can view the following Agent details:

• App Server Agents
• Machine Agents
• Smart Agents 
• Database Agents
• Analytics Agents
• Network Visibility Agents
• Cluster Agents
  
  

  You cannot manage Analytics Agents, Network Visibility Agents, and Cluster Agents using Smart Agent or Smart Agent CLI. Therefore, you cannot install, upgrade, or rollback these agents from the Agent Management UI.

On the right pane you can view details of the agents that require an upgrade. The right pane is collapsible using the toggle arrow on the pane.

The Agent Management page provides the following details:

• Agents
• Tasks in Progress
• History
• Config Management
• Processes
• Deployment Groups

Agents

This displays all agents with the inventory details. The following sections include the agent details and actions that you can perform on the respective agents:

• App Server Agents
• Machine Agents
• Smart Agents
• Database Agents
• Analytic Agents
• Network Visibility Agents
• Cluster Agents

If you have not installed Smart Agent, the Smart Agent ID and Managed columns will not display any value. 

App Server Agents

Inventory:

Actions:

Machine Agents

Inventory:

Actions:

Smart Agents

Inventory:

Tags 

The tags feature is supported when you install supported agents using Smart Agent. You can use tags to filter the list on Machine Agents, App Server Agents, Smart Agents, and Database Agents. For more information about custom tags, see Tags.

You require to perform the following to enable and view tags under View Options or Filters > Add Criteria for the supported agents in the Agent Management UI:

1. Enable tags.
   To use the tags feature, you can ask your customer support to set the entity.tagging.enabled account level property to true in the Administration Console.
   By default, this property is disabled. For details, see Enable Custom Tagging.
2. Update the Smart Agent config.ini.
   Add the tags under the common config section in the config.ini file. This is a sample configuration where we have added tags owner and location:
   

   [CommonConfig]
   ServiceName           =
   ServiceNamespace      =
   RequestTimeoutSeconds = 0
   AgentName             =
   PollingIntervalInSec  =
   Tags				  = "owner=abc;location=blr"

   CODE
3. Start Smart Agent.
   To restart the Smart Agent run the following command:
   

   sudo systemctl restart smartagent

   CODE
4. View tags.
   Navigate to View options to view the tags as a column or or use the tag within the filter.

Actions:

Database Agents

Inventory:

Actions:

Analytics Agents

You cannot install, upgrade, or rollback Analytics Agents from the Agent Management UI because Smart Agent does not support this agent.

Inventory:

To view the Analytics Agent summary, you can double click the required Analytics Agent or select the agent, then click Details.

You can filter the details based on name and health of the pipelines.

Network Visibility Agents

You cannot install, upgrade, or rollback Network Visibility Agents from the Agent Management UI because Smart Agent does not support this agent.

Inventory:

Actions:

You can select the required Network Visibility Agent and perform the following actions:

Cluster Agents

You cannot install, upgrade, or rollback Cluster Agents from the Agent Management UI because Smart Agent does not support this agent.

Inventory:

Actions:

You can select the required Cluster Agent and perform the following actions:

Tasks In Progress

This displays details of all the tasks such as install, upgrade, or rollback that are in progress. You can click and download the log file for the required agent to view the log details.

History

This displays the details of what all tasks such as install, upgrade, or rollback were performed. You can click and download the log file for the required agent to view the log details.

Config Management

The Import Config dialog enables you to upload a config.xml file to the Controller, and specify a unique name for the configuration.

• Use a naming convention that helps you identify the type of machine for the configuration.
• Consider using a date or version scheme for the configuration name.
• Click a configuration, then click Edit Config to modify the configuration name.
• Double-click a config to display the XML. You can copy the XML, but you cannot modify it.

Processes

The Processes tab in the Agent Management UI displays all the processes that are running on the hosts. To view the tab, you must install Smart Agent on the host machine. You can view both monitored and unmonitored processes.

For details about processes, see Auto-discovery of Application Process.

Deployment groups

This displays all the Deployment groups that you have created. You can view the details such as the following from Deployment groups: 

• group name
• number of hosts in the group
• who created the group
• when was it last modified
• when was the group created

For details about Deployment groups, see Deployment Groups.