How do I install the Entuity Oracle Enterprise Manager plug-in?

To configure the Entuity plug-in for Oracle Enterprise Manager

Oracle Enterprise Manager integration files

Checklist before deploying the plug-in

To upload the Entuity management plug-in archives to the Oracle EM

To deploy the Entuity plug-ins

To add Entuity instances for monitoring

To remove Entuity management plug-ins

 

 

To configure the Entuity plug-in for Oracle Enterprise Manager:

Entuity recommends you configure the plug-in in the following order:

1. Set up your Oracle EM and ensure it is running.
2. Set up your Entuity server.
3. Configure the integration by adding Entuity as a target to the Oracle EM server.
4. When required, set up Entuity to forward events to Oracle EM.

 

 

Oracle Enterprise Manager integration files:

Filename	Description
12.1.0.1.0_entuity.eye.xsvc_2000_0.opar, 12.1.0.1.0_entuity.eye.xsvr_2000_0.opar	management plug-in archives for Entuity which you should have ready in a location that Oracle EM can import from. These files are located in entuity_home\integ\OracleEM.
deploy.readme	includes the latest Oracle EM integration notes. This readme is located in entuity_home\integ\OracleEM.
license.dat	Entuity license file must include the Oracle EM key.
snmpforward_oem.cfg	snmpForward is the utility for forwarding Entuity events. This sample configuration file defines the events forwarded to Oracle Enterprise Manager.
startup_O/ S_site_specific.cfg	includes a section that configures snmpforward, ensuring it always runs when Entuity runs. A sample configuration section can be copied from snmpforward_oem.cfg.

 

 

Checklist before deploying the plug-in:

• ensure Entuity is installed and licensed for Oracle Enterprise Manager.
• if you are running the Entuity webserver using the https protocol, with a certificate from an unrecognized authority, register the certificate.
• in Entuity, set up the user accounts that Oracle EM requires to access Entuity.
• ensure you are installing the integration to Oracle Enterprise Manager 12c version. This integration requires that you set up the Oracle Enterprise Manager Command Line Interface (emcli) and a repository for management plug-in archives (see the Oracle EM documentation).

 

To use HTTPS with self-certified certificates:

You can configure Entuity to run under HTTPS using certificates from recognized certification authorities, or self-certified certificates. When using Entuity with a certificate that is not from a recognized certification authority, you must register a certificate trust with the agent that is monitoring the Entuity components.

For example, to register a certificate in a Linux environment:

1. Change directory to the AGENT_HOME/bin directory, where AGENT_HOME is the agent directory containing all files required to configure and run the Oracle Management Agent on this host, e.g. /opt/oracle/Middleware/agent/agent_inst/.
2. Register the certificate:
   ./emctl secure add_trust_cert_to_jks -password welcome -trust_certs_loc <MyCACert.txt> -alias privateAuth
   where:
   • -trust_certs_loc parameter must contain the path and filename of the trusted_certs.txt file. This file must only contain certificates in base64 format and no special characters
     or empty lines.
3. When the certificate is registered, stop and then restart the agent. From the AGENT_HOME/bin directory, enter:
   

   emctl stop agent
   emctl start agent

 

 

To upload the Entuity management plug-in archives to the Oracle EM:

1. Copy the management plug-in archives from the Entuity server to a temporary folder on the Oracle Enterprise Manager.
   • Specifically, copy the following files:
     12.1.0.1.0_entuity.eye.xsvc_2000_0.opar
     12.1.0.1.0_entuity.eye.xsvr_2000_0.opar
     from:
     entuity_home/integ/OracleEM
     to:
     /tmp
2. Import the plug-ins from the command line. These instructions setup an alias to emcli, jdk and import the plug-in archives from a tmp folder:
   

   alias emcli=/home/oracle/gcmiddleware/oms/bin/emcli
   export JAVA_HOME=/home/oracle/gcmiddleware/oms/jdk
   emcli import_update -file=/tmp/12.1.0.1.0_entuity.eye.xsvr_2000_0.opar -omslocal
   emcli import_update -file=/tmp/12.1.0.1.0_entuity.eye.xsvc_2000_0.opar -omslocal

 

 

To deploy the Entuity plug-ins:

After uploading the management plug-ins, you must first deploy them to the management server before you can deploy them to management agents.

 

To deploy a plug-in to the Oracle Enterprise Manager Management Server:

1. Log in to the Oracle Enterprise Manager Cloud Control as a super administrator.
2. Click Setup > Extensibility > Plug-ins. Oracle EM will then display the list of available plug-ins.
3. Highlight the required plug-in. From the context menu, cluck Deploy-on > Management Servers. EM will then display the Deploy Plug-in on Management Servers page.
4. Confirm the plug-in Name and Version, and enter the Repository SYS Password.
5. Click Continue. Oracle EM will report on the progress of the prerequisite checks for plug-in deployment.
6. When the checks are successful, click Next. Oracle EM will display details of the plug-in and available management servers.
7. Click Deploy.  Oracle EM will start to deploy the plug-in. Select Show status to follow its progress, or Close to close the Deploy Plug-in on Management Servers page.

 

To deploy a plug-in to the Oracle Enterprise Manager Management Agent:

Once a plug-in has been deployed to a management server, it can then be deployed to management agents.

1. From the Oracle Enterprise Manager, click Setup > Extensibility > Plug-ins. Oracle Enterprise Manager will then display the list of available plug-ins.
2. Highlight the required plug-in, and from the context menu click Deploy on > Management Agent. The Deploy Plug-in on Management Agent page will then be displayed.
3. From Selected Management Agent, select Add. The Search and Select dialog will display.
4. Highlight the agents to which you want to deploy the agent, and then choose Select.
5. Specify other required details on teh Deploy Plug-in on Agents dialog box.
6. Click Continue. Oracle Enterprise Manager will then report on the progress of the prerequisite checks for plug-in deployment.
7. Once the checks are successful, click Next. Oracle Enterprise Manager will then display details of the plug-in and available management servers.
8. Click Deploy. Deployment occurs in parallel on all selected agents. You can click Show status to follow its progress, or Close to close the Deploy Plug-in on Management Agents page.

 

 

To add Entuity instances for monitoring:

1. After successfully deploying the Entuity Network Manager and Entuity Network Service plug-ins, you can add them to Cloud Control for central monitoring and management.
2. For each Entuity server that you want to include to Oracle EM, first add it as a server plug-in target. It is through its Services metrics page that you can identify the service identifiers you require when adding instances of the service plug-in.

 

To add Entuity Network Manager instances:

When adding an instance of Entuity Network Manager, you must specify the Entuity server and enter details of the user account that Oracle EM uses to access it. It is the permissions of this Entuity user account that determine the potential network objects visible to Oracle EM.

The below table displays the attributes for the Entuity Network Manager agent configuration:

 

Attributes	Description
Name	name of the Entuity server in Oracle EM.
Type	set by the management plug-in to Entuity Network Manager, Entuity Network Service. This is not user-definable.
Hostname	hostname of the Entuity webserver. By default, the webserver uses port 80 for http, and port 443 for https. When the Entuity webserver is running on a different port to these, you must specify the port by adding a colon after the hostname and then the port number, e.g. century:82.
Protocol (http/https)	protocol used by the Entuity webserver.
User	user account that Oracle EM uses to access the Entuity server.
Password	Entuity user account password.
SNMP Trap Source	IP address used by Entuity's SNMP trap forwarding process, snmpforward. Entuity can use multiple IP addresses. This should be set to allow Oracle EM to correctly associate the trap sender with the Entuity server. This IP address must be the same as the IP address set in snmpforward_oem.cfg through agent_addr. It is only required when configuring the Entuity Network Manager plug-in.

 

To add an Entuity Network Manager instance:

1. Log in to Oracle Enterprise Manager Cloud Control as a super administrator. Oracle EM will display its home page.
2. Click Setup > Add Target > Add Targets Manually. Oracle EM will then display the Overview of Setup page.
3. Select Add Non-Host Targets by Specifying Target Monitoring Properties. Oracle EM will then display Import Management Plug-in fields.
4. For Target Type, select Entuity Network Manager. For Monitoring Agent, select the magnifying Search icon. A Search and Select dialog will then display, from which you can select the target agent.
5. Highlight the target agent and click Select. Oracle EM will update the Add Targets Manually page.
6. Click Add Manually....
7. Complete the Entuity Network Manager properties.
8. Click Test Connection, to test the connection details for the Entuity Network Manager. If the connection fails, check the Entuity properties - for example, when the Entuity webserver is running on a non-standard port, ensure that you have specified that port. If running on port 90 on the host century, the hostname is century:90.
9. Click OK, to confirm and save the connection details. Oracle EM will then display the Agent status and details page, and a confirmation message that the target server has been successfully added.

After waiting a few minutes for the plug-in to start collecting data, you can verify and validate that Oracle Enterprise Manager is properly monitoring the plug-in target. You can also view the service details that you require when adding Entuity Network Service instances.

To verify and validate the plug-in:

1. Click Targets > All Targets.
2. From the list of monitored targets, select the new Entuity target. Oracle EM displays the home page for this Entuity server, from which you can see:
   • current status of the Entuity server.
   • a bar chart showing up to ten views on the Entuity server, along with the percentage of reachability to the network infrastructure components within those views.
   • a chart showing the overall status of the network services on the Entuity server, and the list of services currently down.
   • a list of active alerts that have been forwarded from the Entuity server, and which have not been cleared or deleted.
   • a selection of hyperlinks to quickly launch various parts of Entuity.

You should also check the two reports, Device Inventory and Device by Manufacturer.

 

To add Entuity Network Service instances:

When adding an Entuity Network Service instance, you must specify the Entuity server, enter details of the user account Oracle Enterprise Manager uses to access it and the service identifier. It is the permissions of this Entuity user account that allow Oracle EM access to the state of the specified service.

The below table displays the attributes for the Entuity Network Manager agent configuration:

Attributes	Description
Name	name of the Entuity service in Oracle EM.
Type	set by the management plug-in to Entuity Network Service. This is not user-definable.
Hostname	hostname of the Entuity webserver. By default, the webserver uses port 80 for http, and port 443 for https. When the Entuity webserver is running on a different port to these, you must specify the port by adding a colon after the hostname and then the port number, e.g. century:82.
Protocol (http/https)	protocol used by the Entuity webserver.
User	user account that Oracle EM uses to access the Entuity server.
Password	Entuity user account password.
Service Id	unique identifier of the Entuity service. You can identify available services and their identifiers through the Entuity Network Manager instance's Service metrics page.

When you want Oracle EM to monitor one or more Entuity services, you will need to know their service identifier. You can find the service identifier through the Entuity web UI via its URL, for instance:

http://century/webUI/serviceDetails.do?view=CIO%20London%20Office&serverId=aa2287e3-19ac-4d2c-876a-b1e7b6-fa059e&serviceId=17417

where serviceId is the unique identifier of the service.

The service identifier is also available when the Entuity server is managed through the Entuity Network Manager. To find an Entuity Network Service identifier:

1. Navigate to the summary page of the Entuity Network Manager target.
2. From the Target dropdown, select Monitoring > All Metrics.
3. From the metric types listed under the Entuity server, select Network Services.
4. Oracle Enterprise Manager displays details of the Entuity network services, including Service ID.

 

To add Entuity Network Services:

1. Log in to Oracle Enterprise Manager Cloud Control as a super administrator. Oracle Enterprise Manager will then display its home page.
2. Click Setup > Add Target > Add Targets Manually. The Overview of Setup page will display.
3. Click Add Non-Host Targets by Specifying Target Monitoring Properties. The Import Management Plug-in fields will display.
4. For Target Type, click Entuity Network Service. Then for Monitoring Agent, select the Search icon. The Search and Select dialog will then display, from which you can select the target agent.
5. Highlight the target agent and click Select. The Add Targets Manually page will update.
6. Select Add Manually and then complete the Entuity Network Manager properties.
7. Select Test Connection to test the connection details for the Entuity Network Manager. If the connection fails, check the Entuity properties, e.g. when the Entuity webserver is running on a non-standard port, ensure you have specified that port. For example, if running on port 90 on the host century, the hostname is century:90.
8. Click OK to confirm and save the connection details. The Agent status and Details page will display, and a confirmation message that the target server has been successfully added will appear.

 

To verify and validate the Entuity Network Service Plug-in:

After waiting a few minutes for the plug-in to start collecting data, you can verify and validate that Oracle Enterprise Manager is properly monitoring the plug-in target. To verify and validate the plug-in:

1. Select Targets > All Targets.
2. From the list of monitored targets, select the new Entuity Target Name. Oracle Enterprise Manager will display the home page for this Entuity network service, from which you can view:
   • the current status of the Entuity service.
   • a list of active alerts that Oracle Enterprise Manager has raised against the service.
   • a selection of hyperlinks to quickly launch the Entuity home and Service Details page.

 

 

To remove Entuity management plug-ins:

When you want to remove the Entuity management plug-ins, you must ensure that any associated Entuity Network Service instances are first deleted. You must then:

1. remove all Entuity Network Manager and Entuity Network Service instances from the agent monitoring configuration.
2. undeploy the plug-in from all agents, and then undeploy from the management server.
3. remove the plug-in.

 

To remove an Entuity target from an agent:

1. Log in to Enterprise Manager Cloud Control as a super administrator.
2. Select Targets > All Targets.
3. Highlight the Entuity Network Manager or Entuity Network Service target that you want to remove.
4. From the context menu, select Target Set-up > Remove Target, and then select Yes in the Confirmation dialog.

 

To remove a plug-in from an agent:

1. From the Oracle Enterprise Manager, select Setup > Extensibility > Plug-ins. The list of available plug-ins will be displayed.
2. Highlight the Entuity Network Manager and Entuity Network Service plug-in you want to remove, and from the context menu select Undeploy From and Management Agent. The Undeploy Management Plug-in page will then display. You must confirm your credentials to remove an agent.
3. Check all the agents that are currently deployed with the Entuity Network Manager and Entuity Network Service plug-ins, and click OK.
4. You must undeploy the plug-in from every agent in the system to completely remove it from the enterprise.

 

To remove a plug-in from a management server:

1. From the Oracle Enterprise Manager, select Setup >Extensibility >Plug-ins. The list of available plug-ins will display.
2. Highlight the Entuity Network Manager and Entuity Network Service plug-in you want to remove, and from the context menu select Undeploy From and Management Servers. The Undeploy Management Plug-in page will then display. You must confirm your credentials to remove a plug-in.
3. Check all the servers that are currently deployed with the Entuity Network Manager and
   Entuity Network Service plug-ins, and click OK.

 

To remove a plug-in from Oracle Enterprise Manager:

After undeploying a plug-in from management agents and management servers, you can remove it from Oracle Enterprise Manager:

1. From the Oracle Enterprise Manager, select Setup > Extensibility > Self Update.
2. Select the plug-in folder.
3. Highlight the plug-in, and from the Actions menu click Delete.