Agents Page (Magic xpi 4.13)

« Go Back


Created ByKnowledge Migration User
Approval Process StatusPublished

Agents Page (Magic xpi 4.13)

Agent acts as a container and hosts multiple Agent Connectors within the same.

The Agents page lists the details of the agents available. The page also allows the user to deploy the connectors on the given agent. Each agent can have multiple Agent Connectors.

The Restart button at the top right corner of this page, provides the user a functionality to restart multiple agents. On clicking the button, the list of available Agents will be shown, and the user can select one or more Agents from the list and restart the same.

The page provides a filter to search the Agents based on the pre-defined criteria. The filters available are for Name, ID, Host, OS, Version, and Status.

Working with Multiple Management IDs

The Agents, Agent Connectors, and Connectors in the Local Agent are associated with a specific Management ID. The local Agent installation can be configured with more than one Management ID. These IDs are managed as part of the management-ids.xml file which is part of the Local Agent installation. This file should be copied to the <Tomcat Installation>/lib folder. Refer to Management Server and Management Console Installation page for further details.

The Agent View will show the list of Agents for a selected Management ID or for All Management IDs. This can be configured by the drop-down menu of All Management IDs which is available on the left hand pane of the Management Console. Here the user can choose a particular management ID or show the list for all management IDs.

The same functionality of displaying the data as per Management ID is available for Agent Connectors and Connectors pages as well.

The following details about each agent are displayed on the Agent page:




The name of the Agent.

Click the button beside the name, to see the list of Available Connectors.

Management ID

The Management ID for the Agent. This value is shared between all Local Agent components belonging to a specific Management Console.

This column is displayed only when the All Management IDs option is selected.


The ID is the unique identifier of the agent service and can be used in the log files to identify the Agent Service instance.


The Host on which the Agent is deployed. Each host contains only one Agent.


The operating system of the Host.


The version of the software running on the Agent.


This is the status of the Agent. The status can have one of the following values:

· Enabled

The enabled status is displayed when the Agent service is running on the given host. The user can disable the Agent by clicking the Disable button next to the status.

When the user clicks the Disable button, and there are Agent Connectors running on that Agent, then a confirmation message, to terminate the Agent Connectors, is provided to the user. On confirming, the disable request will be sent to the Management server.

· Disabled

The Disabled status is displayed when the Agent Service is disabled. In this status, the Agent Service will not run any Agent Connectors and will not accept requests to insert, update, or delete a connector.

The user can enable the Agent service by clicking the Enable button.

o In the disabled state, the user can update the Version of distributable by clicking the Update button. On clicking the Update button, the user will be provided with a dialog box to select the Distributive. On clicking the Deploy button, the new version of the Distributive will be deployed.

· Restart

o In the disabled state, the user can also restart the Agent by clicking the Restart button. On clicking the Restart button, the user will be provided with a confirmation dialog. On confirming the Agent restart process will be triggered.

While updating the distributive, all the existing binary files will be replaced with the files from the distributive. The configuration files, namely for AgentService and AgentConnector, will be merged. The old properties will be retained as in the existing installation and the new properties will be added.

Available Connectors

An Agent can have one or more connectors deployed in it. To deploy the connector, click the button. As you click the button, the Select Connector window will open which will display all the Connectors available to be deployed on the given Agent. Select the connector to deploy and click the Deploy button. To deploy the connector to the Agent, click OK in the confirmation box.

Before deploying the connectors to the Agent , the connector has to be first uploaded from the Connectors Page.

The Agent page will display the following details of the connectors already deployed on the Agent.



Connector Name

The name of the connector.


The version of the connector.

Runtime Technology

The Runtime technology of the deployed Connector. It can be either Java or .NET.

The Runtime Technology Magic xpa is not supported by the Local Agent.

Has Step

This column displays whether the connector has a Step.

Has Trigger

This column displays whether the connector has a Trigger.


This status of the connector that is deployed to the Agent. The status can have one of the following values:

· Available

· Running

· Suspend


The following actions can be taken upon the Available Connector.

· Update

· Delete

An Agent Connector can be deleted only when the status is changed to Suspended.

If the connection between the Management server and the Management Console is lost, then a Management Server is offline message will be shown at the top of the page.