Perform these tasks to install the Oracle Enterprise Manager Agent and deploy the plug-in.
The following is an overview of the tasks that you need to perform to begin monitoring Oracle Database Appliance systems.
Install the Oracle Enterprise Manager Agent
Deploy the plug-in
Discover Oracle Database Appliance systems to add the targets for monitoring
(Optional) Configure the monitoring metrics and notifications
After Oracle Enterprise Manager Cloud Control discovers the targets, the software begins monitoring the supported hardware and software components.
Before deploying Oracle Database Appliance plug-in, ensure that you complete the prerequisites.
Complete the following prerequisites:
Create a special user for the Oracle ILOM service processor.
For the Oracle Enterprise Manager agent to communicate with an Oracle Integrated Lights Out Manager (Oracle ILOM) service processor, you must have a specific user ID configured for the Oracle ILOM service processor.
Adding the specific user ID requires administrator level privilege on the Oracle ILOM service processor.
The specific Oracle ILOM user ID can be added in the Oracle ILOM service processor web interface, Oracle ILOM CLI, or with the
ipmitool command. This example uses the Oracle ILOM CLI.
For security reasons, the
root user password to the Oracle ILOM service processor is not shown in the Oracle ILOM CLI commands in this example.
Log in to the Oracle ILOM Service Processor as root:
# ssh root@[Service Processor IP] Password:
Change to the
-> cd /SP/users
oemuser user and password:
-> create oemuser Creating user... Enter new password: ******** Enter new password again: ******** Created /SP/users/oemuser
Change to the new user's directory and set the role:
-> cd oemuser /SP/users/oemuser -> set role='cro' -> Set 'role' to 'cro'
Test the Oracle ILOM user ID created in step 3 by listing the last 10 system events:
-> ipmitool -I lanplus -H -U oemuser -P welcome1 -L USER sel list last 10
Repeat steps 1 through 5 for the rest of the server node Oracle ILOM service processors in Oracle Database Appliance.
(Optional) Create a special user for monitoring instead of using the root user.
The root user can perform monitoring on Oracle Database Appliance agents. However, if the root user is not accessible for security reasons, an alternative method is to create a monitoring OS user as the monitoring user, and set the privilege delegation appropriately. If you run a virtualized ODA, please perform the following steps from ODA_BASE.
The following is an example that creates user for the purpose of monitoring Oracle Database Appliance.
Run the following commands:
#useradd username #passwd password
Add SUDO privilege for the user.
/etc/sudoers file on the host using the
Add the following commands to the
Cmnd_Alias plugin_agent_script=$perl_home/bin/perl $agent_home/plugins/$plugin_opar_version /scripts/*.pl* , \ $agent_home/sbin/nmosudo default_plugin default_functionality default_subaction default_action perl -e exit 0 monitor_user ALL=(ALL) plugin_agent_script
agent_home is the absolute path to the installed agent home. The agent home directory is created during agent deployments to the hosts. For example,
perl_home is the absolute path to the installed executable Perl. For example,
plugin_opar_version is the complete Oracle Database Appliance Plug-in OPAR file that is deployed to the Oracle Management System (OMS) and the agents. It is in the format:
version is the Oracle Database Appliance plug-in version, for example, 188.8.131.52.0.
Set privilege delegation to the host targets.
Log in to Oracle Enterprise Manager.
In the Setup menu select Security, then Privilege Delegation.
In the Type box, select Sudo.
/usr/bin/sudo -u %RUNAS% %COMMAND% in the Sudo Command box.
Verify that you have a supported version of Oracle Appliance Manager software installed.
To verify the software version on Oracle Database Appliance X7-2S, X7-2M, X6-2S, X6-2M, and X6-2L, run the command:
# odacli describe-component
To verify the software version on Oracle Database Appliance X7-2-HA (bare metal platform) run the command:
# odacli describe-component
Verify the version on both nodes. The command provides details across all nodes.
To verify the software version on Oracle Database Appliance X7-2-HA (virtualized platform), run the command:
# oakcli show version
To verify the software version on Oracle Database Appliance X6-2-HA, X5-2, X4-2, X3-2, and V1 (bare metal or virtualized platform), run the command:
# oakcli show version
Verify the version on both nodes.
Validate the Oracle Database Appliance storage topology and external JBOD connectivity before deploying Oracle Database Appliance. You should also validate the connections after changing the cabling.
For Oracle Database Appliance X7-2-HA (bare metal platform), X7-2S, X7-2M, X6-2S, X6-2M, and X6-2L, run the command
# odacli validate-storagetopology
For Oracle Database Appliance X7-2-HA (virtualized platform), run the command
odacli validate-storagetopology .
# oakcli validate -c storagetopology
For Oracle Database Appliance X6-2-HA, X5-2, X4-2, X3-2, and V1 (bare metal and virtualized platforms), run the command
oakcli validate storagetopology.
# oakcli validate -c storagetopology
# oakcli validate -c storagetopology It may take a while. Please wait... INFO : ODA Topology Verification INFO : Running on Node0 INFO : Check hardware type SUCCESS : Type of hardware found : X5-2 INFO : Check for Environment(Bare Metal or Virtual Machine) SUCCESS : Type of environment found : Virtual Machine(ODA BASE) SUCCESS : Number of External LSI SAS controller found : 2 INFO : Check for Controllers correct PCIe slot address SUCCESS : External LSI SAS controller 0 : 00:15.0 SUCCESS : External LSI SAS controller 1 : 00:16.0 INFO : Check if powered on SUCCESS : 1 : Powered-on INFO : Check for correct number of EBODS(2 or 4) SUCCESS : EBOD found : 2 INFO : Check for External Controller 0 SUCCESS : Controller connected to correct ebod number SUCCESS : Controller port connected to correct ebod port SUCCESS : Overall Cable check for controller 0 INFO : Check for External Controller 1 SUCCESS : Controller connected to correct ebod number SUCCESS : Controller port connected to correct ebod port SUCCESS : Overall Cable check for controller 1 INFO : Check for overall status of cable validation on Node0 SUCCESS : Overall Cable Validation on Node0 INFO : Check Node Identification status SUCCESS : Node Identification SUCCESS : Node name based on cable configuration found : NODE0 INFO : Check Nickname SUCCESS : Nickname set correctly : Oracle Database Appliance - E0 INFO : The details for Storage Topology Validation can also be found in log file=/opt/oracle/oak/log/<hostname>/storagetopology/StorageTopology-2018-01-03-08:57:31_7661_15914.log
Verify that each server node is able to resolve the host names of the Oracle ILOM servers.
If the names of those components are not registered in DNS, then entries can be added to the
/etc/hosts file of each server node.
Verify the firewall configuration for Oracle Database Appliance.
System administrators typically disable the
ping service in secure network environment. Oracle Enterprise Manager uses
ping to establish the basic availability and status of Oracle Database Appliance.
Ensure that the server nodes have the
ping service and port enabled from the Oracle Management System (OMS).
All other Oracle Database Appliance components (such as Oracle ILOM servers) must have the
ping service and port enabled from the server nodes where the agents are running.
ping traffic overhead is minimal. The agent pings the targets every five minutes.
The database listener ports must be opened for the Oracle Enterprise Manager OMS server(s). Oracle Database Appliance databases use SCAN listeners; therefore, ports must be opened for the base server node, the node virtual IP, and the scan listeners addresses.
The Oracle Enterprise Manager Cloud Control agents require access to the Oracle Enterprise Manager server's upload service. This is usually configured on port 4889 for HTTP uploads and 4900 for HTTPS. To verify the ports assigned, run the following command on the OMS server command line.
$ emctl status oms -details
Open these ports for each of the server nodes.
The OMS servers must be able to connect to the Oracle Enterprise Manager Cloud Control Agent HTTP/HTTPS port on each server node. The agent port defaults to 3872. If port 3872 is not available, the next available port starting from port 1830 is used.
To identify the port used:
Run the following command on the server node command line:
$ emctl status agent
Alternatively, you can look for the value of the
EMD_URL property in the
emd.properties file the following directory:
$agent_home is the absolute path to the installed agent home. The agent home directory is created during agent deployments to the hosts. For example,
The Oracle Enterprise Manager Cloud Control agents require
ssh access to the Oracle Database Appliance components they monitor. Because the agents will run on the server nodes, the
ssh ports on each of the Oracle ILOMs (port 22) must be opened for each of the server nodes.
ssh access, but still requires the ports to be opened first.
All Oracle Database Appliance components must be able to send SNMP traps to the agents running on the server nodes. SNMP uses the UDP protocol so the agent port and port 162 need to be opened for UDP traffic between the Oracle ILOMs and the agent.
Use one of two methods to install the Oracle Enterprise Manager Agent for Oracle Database Appliance.
Deploy the Oracle Enterprise Manager agent on ODA_BASE for Oracle Database Appliance Virtualized Platform deployments, and in Linux Hosts for Oracle Database Appliance Bare Metal deployments.
Oracle Enterprise Manager target discovery supports the use of either the management network host name or the client network host name for the server nodes. When you install the Oracle Enterprise Manager agent on the server nodes, use the same host name you used in Oracle Clusterware.
You can identify the host name of the nodes in the cluster by running the
olsnodes command on one of the server nodes. It is recommended that a fully qualified host name, including the domain name, be used when specifying an Oracle Enterprise Manager agent host name.
Before deploying the agent, review the following requirements:
The Oracle Enterprise Manager agent must be deployed to all server nodes of Oracle Database Appliance. The host target name of the server node must be the fully qualified host name, for example,
A non-fully qualified host name (for example,
dbm1db01) or IP address must not be used for the host target name of the server node.
The same version of the Oracle Enterprise Manager agent and the same version of the plug-ins should be deployed on all server nodes within the same Oracle Database Appliance.
Use this procedure to install Oracle Enterprise Manager Agent using the Push method.
To install the Oracle Enterprise Manager agent using the push method, add the Oracle Database Appliance server nodes as host targets to Oracle Enterprise Manager Cloud Control 13c, and then start the agent deployment process.
Click Add and select Manually from the drop-down menu.
If the Oracle Enterprise Manager agent software is not available for your platform, go to the Extensibility page and download it first.
Installation Base Directory
For Port, leave this field blank. As part of the installation process, an available port will be selected automatically.
root.sh was not executed during deployment, then make sure to execute it on all server nodes.
Use this procedure to install Oracle Enterprise Manager Agent using a response file.
You can install Oracle Management Agent in non-interactive (“silent”) mode, as an alternative to installing Oracle Management Agent by using the Add Host Target wizard. You configure a response file with the information required for the installation, and then run a deployment script to install the management agent using the information supplied in the response file.
See Also:Installing a Management Agent in Silent Mode in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
Import and deploy the Oracle Enterprise Manager Plug-in for Oracle Database Appliance.
The Oracle Enterprise Manager Plug-in for Oracle Database Appliance is delivered as an Oracle plug-in archive file (
The plug-ins belong to a specific Oracle Enterprise Manager category called
Add-on. If you are using Oracle Enterprise Manager 12c to monitor Oracle Database Appliance, download the latest 13c compatible version of the plug-in and follow the instructions to invoke the Enterprise Manager Cloud Control Installer in GUI Mode before starting the Enterprise Manager 13.2 upgrade process.
The Enterprise Manager for Oracle Database Appliance plug-in archive file (
*.opar) is named
oda_plug_in_version number is the Oracle Database Appliance plug-in version, the plug-in version is not the same as the Oracle Database Appliance version. The latest Oracle Database Appliance plug-in version for Enterprise Manager 13.2 is named
Assuming you plan to use an existing Oracle Enterprise Manager installation, and that you have installed an Oracle Enterprise Manager agent, you are ready to deploy the Oracle Database Appliance plug-in.
Note:Before deploying the plug-in, you must have already completed the Oracle Database Appliance deployment, and the Oracle Grid Infrastructure cluster should be up and running.
The following is a high-level overview of the steps to deploy the plug-in:
Download the Enterprise Manager for Oracle Database Appliance plug-in archive file from http://www.oracle.com/technetwork/oem/enterprise-manager/downloads/oem-plugins-3237574.html.
Either import the Oracle Database Appliance plug-in archive locally, or import the Oracle Database Appliance plug-in archive file remotely.
Deploy the Oracle Database Appliance plug-in on Oracle Enterprise Manager Cloud Control (Oracle Management System Servers).
Deploy the Oracle Database Appliance plug-in to the management agents on both Oracle Database Appliance server nodes (hosts).
Use this procedure to import the Oracle Database Appliance plug-in archive file locally.
$ /u01/OracleHomes/Middleware/oms/bin/emcli login -username=user_name -password=password
Importing ensures the content that you have created and packaged in the plug-in is available to Oracle Enterprise Manager Cloud Control.
$ /u01/OracleHomes/Middleware/oms/bin/emcli import_update -file=OPAR_FILE_LOCATION -omslocal
/u01/OracleHomes/Middleware/oms/bin/emcli import_update -file=/tmp/oda_plug-in_version number_oracle.dba.odba_2000_0.opar -omslocal
oda_plug-in_version number is the Oracle Database Appliance plug-in version number, for example, 184.108.40.206.0.
As shown in the example, you must append the
-omslocal flag because the plug-in archive is on the same system where you are running this command (copied in step 4 above). Specify the absolute path name that exists on the system.
Use this procedure if you are running
EMCLI on a different system than the system where you created the plug-in archive (
Run the following command to import the plug-in archive file (OPAR) remotely:
emcli import_update -file="path to the .opar file" -host="host name of plug-in host" -credential_name="credential for plug-in host" -credential_owner="credential owner on the plug-in host"
path to the .opar file is the absolute path to the
*.opar file on the system where you created the archive.
host name of plug-in host is the host name for the host target where the file is available.
credential for plug-in host is the name of the credentials on the remote system you are connecting to.
credential owner on the plug-in host is the owner of the credentials on the host system you are connecting to.
Example 2-1 Example of How to Import the OPAR File Remotely
emcli import_update -file=/tmp/sample_plugin.opar -host=host1.example.com -credential_name= -credential_owner=
Use this task to deploy Oracle Database Appliance Plug-in on Oracle Enterprise Manager Cloud Control (Oracle Management System Servers).
To deploy the Oracle Database Appliance plug-in on Oracle Management System (OMS) servers:
This step takes approximately 3 to 5 minutes, including stopping and restarting the OMS server. During the deployment use
/u01/OracleHomes/Middleware/oms/bin/emctl status oms -details to check OMS status.
Use this task to deploy Oracle Database Appliance Plug-in to the management agents on both Oracle Database Appliance server nodes (hosts).
To deploy plug-ins on Management Agents, you must select only plug-ins that are deployed on the management server.
Deployment takes approximately 2 minutes, depending on how many agents are deployed at the same time. The deployment does not restart Oracle Management System (OMS).