Applicable to Entuity v23.0 P03. If you are using an earlier version of Entuity, see version 01 of this article.
Agent Summary Dashboard
The Agent Summary dashboard lists the Entuity Agents that are registered with the Entuity server, and includes status information about the Entuity Agents.
Information about an agent can be accessed on the Summary dashboard for a path by clicking its name.
The Agent Summary dashboard is a system dashboard. This means you cannot edit the settings of the dashboard. However, you can create a copy of a system dashboard and edit the settings of that copy.
The dashboard consists of a Table dashlet displaying the following information about each Entuity Agent:
- Agent StormWorks ID
- Agent ID
- Display Name
- IP Address
- OS
- OS User
- Public Key
- Updater Version
- Last Seen Time
Agent management
You can manage Entuity Agents from the Entuity Agents page, which has two tabs: Agents and Applications. This page is only accessible to users with Inventory Administration permissions. For information about granting and managing user permissions, see this article.
Agents tab
The Agents tab of the Entuity Agents page lists all currently allowed registrations, registered agents, and failed agent registrations. Additionally, this page is where you can create an agent pre-registration request to add (register), remove, edit, or re-register an agent.
Register an Entuity Agent
- From the Main Menu, click Administration and navigate to the Entuity Agent Administration section of the Entuity Administration page.
- Click Entuity Agents to access the Entuity Agents page.
-
Click Add Agent, and on the Register form that opens, enter a unique name for the Entuity Agent.
Note, the Entuity URL field on the Register form is automatically populated with a custom URL to which the agent can connect, but you can optionally edit the field to create a custom endpoint. - Click Done on the Register form to save your changes. Otherwise, click Cancel.
Once the form is submitted, a new agent ID is generated and a registration token is displayed that you will need to enter later during agent installation.
The agent ID is also added to the pre-registration list. The pre-registration list contains the agent ID and the agent name that you entered in Step 3.
For information about installing an Entuity Agent, see this article for Windows or this article for Linux.
Remove an Entuity Agent
- From the Main Menu, click Administration and navigate to the Entuity Agent Administration section of the Entuity Administration page.
- Click Entuity Agents to access the Entuity Agents page.
- To remove one or more Entuity Agents, you can multi-select entries in the table on the Agents tab and click Delete Agent.
- At the confirmation window that is displayed, click Yes to confirm the deletion. Otherwise, click No.
Clicking Yes removes each selected agent and all its corresponding data from the server.
Note, you must perform additional steps if you want to fully uninstall an Entuity Agent. For more information about uninstalling an agent, see this article for agents on Windows servers or this article for agents on Linux servers.
Edit an Entuity Agent
Agents might be displayed as pending if there is a pre-registration request from creating an agent, but the agent is not yet fully registered. Also, agents might be listed that couldn't register due to not having a pre-registration entry, or due to being on the forbidden list.
- From the Main Menu, click Administration and navigate to the Entuity Agent Administration section of the Entuity Administration page.
- Click Entuity Agents to access the Entuity Agents page.
- To update the forbidden list if an agent attempts to register and fails, click Add Forbidden Agent from the Overflow Menu.
The Forbidden Agents form is displayed. - To add an agent to the forbidden list:
- Click Add Agent to open the Register form.
- Enter the agent ID and hostname in the Agent ID and Host Name fields.
- Click Done to save your changes and return to the Forbidden Agents form. Otherwise, click Cancel.
- To remove an agent from the forbidden list, select the agent from the list, and click Remove.
- Click Done on the Forbidden Agents form to save your changes. Otherwise, click Cancel.
A banner is displayed, stating the changes have been applied to the access list.
Re-Register an Entuity Agent
Agents can be re-registered if they are redeployed, or if, for any reason, the agent.cfg file and token for the agent no longer match what is registered with the Entuity Server.
- To re-register an already registered agent, select the agent on the Agents tab of the Entuity Agents page.
- Right-click the agent, and select Re-Register from the Context Menu.
- From the confirmation window that is displayed, click Yes to open the Re-Register form.
- Change the Re-Register toggle to Yes and click Done to save your changes. Otherwise, click Cancel.
Applications tab
The Applications tab of the Entuity Agents page displays a list of Entuity Agents, an overview of what applications are assigned to each agent, and whether there are any application updates available. This page also lets you manage applications, on a per agent basis, to easily update and/or roll back applications, as necessary.
Information about an agent can be accessed on the Summary dashboard for an agent by clicking its name.
The dashboard consists of a Table dashlet displaying the following information about each agent:
- Agent Name
- Agent ID (hidden by default)
- Operating System
- Overrides (hidden by default)
- This would be displayed if an agent has an override, meaning if the agent is using an entitlement set that overrides the default entitlement.
- Applications Columns
- These columns show the application name and version of the application to which the agent is entitled, as well as one of these statuses:
Up-to-date
Pending update
Not installed
- These columns show the application name and version of the application to which the agent is entitled, as well as one of these statuses:
Action buttons
The Applications tab has three action buttons for managing the applications assigned to Entuity Agents: Modify Defaults, Modify Overrides, and Show Overrides Only
Modify Defaults
This action button opens the Modifying Defaults form. The Modifying Defaults form lets you edit the default application entitlements for Entuity Agents. Entitlements are organized by platform, Linux (linux section) and Windows (win section), with the application name and versions that are in the default entitlement for each platform listed underneath. The application names and versions are pre-populated, based on the values in the local default.entitle file, located in entuity_home/agentrepos/entitlements.
If the default.entitle file does not exist, the fields are blank upon first opening the Modifying Defaults form. The default.entitle file is then created after you submit any changes.
To modify/delete an application:
- On the Modifying Defaults form, click the drill-down arrow to the right of the application you want to modify or delete.
The Modify Application form is opened, showing the application name, its version and a Remove Application button.
- To modify the application version, select the version that you want from the Version drop-down menu.
- To delete the application, click Remove Application.
- To save your changes, click Done.
Before any changes to the default application are made, a warning message is displayed, stating this action will override the default application(s) for all the agents connected to the server. - Click Yes to confirm the changes, or No to discard the changes.
Modify Overrides
This action button opens the Modifying Overrides form. The Modifying Overrides form lets you override the default application entitlements for the selected Entuity Agent(s). At least one agent must be selected for this action to be enabled. The form shows only the overrides and platforms that exist in the entitlement file that differ from the default.
- Select an agent, or agents, and click Modify Overrides.
The Modifying Overrides form is displayed.
- Click Add Application under the corresponding platform section (linux or win).
The Add Application form is displayed.
- Select an application by clicking the drill-down arrow on the right.
- Select the override version from the Version drop-down menu, and click Done.
You are returned to the Modifying Overrides form.
- To save your changes, click Done on the Modifying Overrides form. Otherwise, click Cancel.
A banner is displayed, stating that x number of overrides successfully deployed to the agents whose IDs are shown within the brackets.
- Select an agent, or agents, and click Modify Overrides.
The Modify Overrides form is displayed, showing the platforms with the override, as well as the application and version that are defined in the override.
Note, if there are varying application versions within a platform across selected agents, the version is shown as Mixed. Any changes to the override take effect on all selected agents.
-
To modify the version, select the version you want from the Version drop-down menu.
-
To delete an application, click Remove Application.
Show Overrides Only
This toggle selection applies a filter with Override equal to Yes to quickly view only agents with override entitlements configured.
Comments
0 comments
Please sign in to leave a comment.