2 Install the Enterprise Manager Management Agent
This chapter provides the instructions for installing the Enterprise Manager (EM) Management Agent onto the Audit Vault Server and Database Firewall Appliance.
Prerequisites for Installing Enterprise Manager Agent
There are multiple prerequisites that need to be done in the Audit Vault console before installing the Enterprise Manager agent.
Determining Whether an Oracle Software Owner User Already Exists for Enterprise Manager
To determine whether an Oracle software owner user named oracle
exists, run the following command:
$ id oracle
If the oracle
user exists, then the output from this command looks like this:
uid=440(oracle) gid=200(oinstall) groups=201(dba),202(oper)
If the user exists, then determine whether you want to use the existing user or create another oracle
user.
To use the existing user, ensure that the user's primary group is the Oracle Inventory group.
Note:
If necessary, contact your system administrator before using or modifying an existing user.
Creating the Oracle Software Owner User for Enterprise Manager
If the Oracle software owner user does not exist or if you require a new Oracle software owner user, then follow these steps to create one. In the following procedure, use the user name oracle
unless a user with that name already exists.
-
To create the
oracle
user, enter a command similar to the following:# /usr/sbin/useradd -g oinstall oracle
In this command, the
-g
option defines the primary group, which must be the Oracle Inventory group, for exampleoinstall
. -
Set the password of the
oracle
user:# passwd oracle
Note:
Oracle recommends you to use the same UIDs across all the OMS instances, especially when you use Oracle Software Library. If the UIDs are different, then the files created by one OMS cannot be modified by another OMS.
Determining Whether the Oracle Inventory Group Already Exists for Enterprise Manager
When you install Oracle software on the system for the first time, the oraInst.loc
file is created. This file identifies the name of the Oracle Inventory group and the path to the Oracle Inventory directory.
To determine whether the Oracle Inventory group exists, enter the following command:
$ more /etc/oraInst.loc
Note:
the oraInst.loc file is available in the /etc
directory for Linux and other platforms. On Solaris platforms, it is available at /var/opt/oracle/.
If the oraInst.loc
file exists, then the output from this command looks like:
inventory_loc=/u01/app/oracle/oraInventory
inst_group=oinstall
The inst_group
parameter shows the name of the Oracle Inventory group, oinstall
.
Creating the Oracle Inventory Group for Enterprise Manager
If the oraInst.loc
file does not exist, or if the file exists but the Oracle Inventory group is different, then create the Oracle Inventory group oinstall
using the following command:
# /usr/sbin/groupadd oinstall
Unblock the EM Agent Network Port
- Log in to the operating system of the Audit Vault Server or Database Firewall appliance as the root user.
- Unblock the network port through which the EM Management Agent and the Enterprise Manager server communicate:
- Edit the file
/usr/local/dbfw/templates/template-iptables.
By default, the permissions for this file is read-only. You must change the permissions to allow editing. As root, change the permissions:
Edit the line as described below. There may be similar entries in this file for database listener ports. Make your entry below these. For AVDF Server version earlier than 20.1, add a line as shown:chmod 644 template-iptables
For AVDF Server version 20.1 and above, add a line as shown:-A RH-Firewall-1-INPUT -p tcp -m state --state NEW --dport <EM agent port number> -j ACCEPT
Where:-A INPUT -p tcp -m state --state NEW --dport <EM agent port number> -j ACCEPT
--dport
is the port number for your EM Agent. Typically, the default port number used by the EM agent is 3872.- An optional “-s” option limits the IP range to specific OMS. The best practice is to add the additional optional switch: "-s ip1,ip2" and limit the IP ranges.
template-iptables
file. Any editing mistakes could make the system inoperable. Change the permissions of thetemplate-iptables
file back to read-only:chmod 444 template-iptables
- Run the following command as
root
:/usr/local/dbfw/bin/priv/configure-networking
- Test your change. If your agent port number is the default value 3872, which is officially registered with IANA by Oracle under
oem-agent
, use:
If another port was used, use:iptables -L | grep oem
iptables -L n | grep <EM agent port number>
- Edit the file
Note:
Changes made here to the template-iptables file might be rolled back by a subsequent Oracle Audit Vault and Database Firewall patch or upgrade. If you notice after applying the next patch or upgrade that Enterprise Manager is no longer collecting information about AV Server correctly, then repeat steps a and b above.
The next step is to install and configure an EM Management Agent on each server where an AVDF agent resides. The EM management agents can be installed using the Enterprise Manager graphical user interface (using a “push” method) or by manually ”pulling” the agent software onto the Audit Vault Server or Database Firewall Appliance.
Install the Enterprise Manager Agent Using UI
Installing the Oracle Enterprise Manager agent is done via a push method from the OEM console.
Be sure to perform the prerequisites detailed in Prerequisites to Installing Enterprise Manager Agent.
- From the Setup dropdown select Add Target > Add Target Manually.
- Click Install Agent on Host.
- Click the + Add button, fill in the Host Name and Platform and click Next.
- Fill in the Installation Base Directory as /var/lib/oracle/agent13c.
- Create a Named Credential for user oracle.
- Leave the root credential blank.
- Click Deploy Agent.
Note:
During the installation phase, you may see a message about sudo not being setup with visible password. Click Continue All Hosts. - Open a terminal window in the Audit Vault Server as root and run the following command:
./var/lib/oracle/agent13c/<agent_version>/root.sh
Manually Install the EM Management Agent on an Audit Vault Server or a Database Firewall Appliance
Perform the following steps to install the EM Management Agent manually by pulling the agent files and configuring an agent on a Database Firewall Appliance 12.2.x or Audit Vault Server.
Be sure to perform the prerequisites detailed in Prerequisites for Installing Enterprise Manager Agent.
- Log in as the
root
user on the Audit Vault Server and run the following command to become theoracle
user:su - oracle
- Download the
AgentPull.sh
script as follows:cd /tmp curl "https://<OMS_HOST>:<OMS_PORT>/em/install/getAgentImage" -k -o AgentPull.sh
- Give execute permission to the
AgentPull.sh
script:chmod +x AgentPull.sh
- Run the
AgentPull.sh
script to download and install the Management Agent. TheLOGIN_USER
is the EM repository owner (SYSMAN
) and the password is the repository owner password (SYSMAN
password).:sh AgentPull.sh LOGIN_USER=<username> LOGIN_PASSWORD=password PLATFORM=<PLATFORM> AGENT_BASE_DIR=<EM agent install directory> AGENT_REGISTRATION_PASSWORD=password ORACLE_HOSTNAME=<ORACLE HOSTNAME>
Note:
ORACLE_HOSTNAME
is the fully qualified hostname of the Audit Vault Server or Database Firewall Appliance where the EM Management Agent is being installed.
The installation of the EM Management Agent starts automatically as soon as the download has finished. At the end of the installation, you will be prompted to run a script as root
.
After running that script, continue with Discovering the Oracle AVDF Target.
Manually Install the EM Management Agent on a Database Firewall Appliance 20.x
Perform the following steps to install the EM Management Agent manually by pulling the agent files and configuring an agent on a Database Firewall Appliance 20.x.
Be sure to perform the prerequisites detailed in Prerequisites for Installing Enterprise Manager Agent.
-
As root user, add
oinstall
group, createoracle
user and add it to theoinstall
group:/usr/sbin/groupadd oinstall /usr/sbin/useradd -g oinstall oracle
-
As root user navigate to the
dbfw
directory:cd /var/dbfw
-
Create the
emagent
directory, change the user and group ownership of theemagent
directory:mkdir emagent chown oracle emagent chgrp oinstall emagent
-
Switch to the
oracle
user and navigate to theemagent
directory:su - oracle cd /var/dbfw/emagent
-
Transfer the Agent:
curl https://<OMS Host>:<Port>/em/install/getAgentImage --insecure -o AgentPull.sh chmod +x AgentPull.sh
-
Run the AgentPull.sh script to download and install the Management Agent. The
LOGIN_USER
is the EM repository owner (SYSMAN
) and the password is the repository owner password (SYSMAN
password).sh AgentPull.sh LOGIN_USER=<username> LOGIN_PASSWORD=password PLATFORM=<PLATFORM> AGENT_BASE_DIR=<EM agent install directory> AGENT_REGISTRATION_PASSWORD=password ORACLE_HOSTNAME=<ORACLE HOSTNAME>
Note:
ORACLE_HOSTNAME
is the fully qualified hostname of the Database Firewall Appliance where the EM Management Agent is being installed.
The installation of the EM Management Agent starts automatically as soon as the download has finished. At the end of the installation, you will be prompted to run a script as root
.
After running that script, continue with Discovering the Oracle AVDF Target.
Manually Install the EM Management Agent on an Audit Vault Server
Topics:
Configure the Oracle Software User
- Create the agent home
directory:
mkdir $ORACLE_BASE/emagent
- Edit the
oraenv
command inside.bashrc
:-
vi $HOME/.bashrc
- Add a
-s
tooraenv
../usr/local/bin/oraenv -s
-
Unlock the dbsnmp
account
- Change user to
dvaccountmgr
, usingsu - dvaccountmgr
from root account. - Run the following command, altering user
dbsnmp
identified by <password> account unlock:sqlplus /
- Change user to
grid
fromroot
:su -grid
- Run the following
command:
orapwd file=+SYSTEMDATA password=<password> asm=Y sqlplus create user
asmsnmp
identified by <password>; grant sysdba to asmsnmp;Oracle recommends creating the Oracle Database user
asmsnmp
withsysdba
privileges.
Manually Install the EM Management Agent on the Audit Vault Server
Follow the steps below to set the host name, configure the DNS, and to download and install the EM Management Agent on the Audit Vault Server:
- Log in to the Audit Vault Server console as a user with the
AV_ADMIN
role. - Configure the DNS on each appliance, which are to be monitored, to be the same as that on the OMS server. Click Settings, then Services under the System group header. On the Services page, configure the DNS, and change the host name. By default, SSH access into Audit Vault Server and Database Firewall is disabled. For the following steps, SSH is required. Therefore, on the same Services page, replace disabled inside the SSH box either with the IP address of the machine from which you will connect or with all to allow SSH connections from all machines on the network.
- Log in to the operating system of the Audit Vault Server as the root user.
- Unblock the network port through which the EM Management Agent and
the Enterprise Manager server communicate:
Note:
Changes made here to thetemplate-iptables
file might be rolled back by a subsequent Oracle Audit Vault and Database Firewall patch or upgrade. If you notice after applying the next patch or upgrade that Enterprise Manager is no longer collecting information about AV Server correctly, then repeat steps 2a and 2b below.- Edit the file
/usr/local/dbfw/templates/template-iptables
file with the following entry:Note:
By default, the permissions for this file is read-only. You must change the permissions to allow editing, edit the file, and then change the permissions back to read-only:- As root, change the permissions of the
template-iptables
file:
chmod 644 template-iptables
- Add the following line as described
below:
#OEM -A INPUT -p tcp -m state --state NEW --dport 3872 -j ACCEPT
- Change the permissions of the
template-iptables
file back to read-only:chmod 444 template-iptables
There may be similar entries already for database listener ports. Make your entry below them.
Note:
Take extreme care when modifying thetemplate-iptables
file. Any mistakes here could make the system inoperable. Only make this change and no other. - As root, change the permissions of the
template-iptables
file:
- Run the following command as
root
:/usr/local/dbfw/bin/priv/configure-networking
- Test your change. If port 3872 is used (this port is
officially registered with IANA by Oracle for oem-agent),
use:
iptables -L -n | grep 3872
If another port was used, use:
iptables -L | grep oem
You will see that there is now an ACCEPT rule for the Management Agent.
- Edit the file
- While logged in as the
root
user on the Audit Vault Server, run the following command to become the oracle user:su - oracle
- Download the
AgentPull.sh
script as follows:cd /tmp curl "https://<OMS_HOST>:<OMS_PORT>/em/install/getAgentImage" -k -o AgentPull.sh
OMS_HOST = OEM DNS or IP Address OMS_PORT - OEM Port Number
- Give execute permission to the
AgentPull.sh
script:chmod 755 AgentPull.sh
- Run the
AgentPull.sh
script to download and install the Management Agent:./AgentPull.sh AGENT_BASE_DIR=/var/lib/oracle/emagent ORACLE_HOSTNAME=<Fully Qualified Hostname> AGENT_PORT=3872 LOGIN_USER=sysman PLATFORM="Linux x86-64"
where ORACLE_HOSTNAME is the fully qualified host name of the Audit Vault Server where the EM Management Agent is to be installed.
Note:
a. You will be prompted for two passwords immediately upon executing the above command. The EM SYSMAN password and an Agent Password (which you assign).
b. The installation of the EM Management Agent starts automatically as soon as the download has finished.
c. At the end of the installation, you will be prompted to run a script as root:
/var/lib/oracle/emagent/agent_13.X.0.0.0/root.sh
- Run following agent emctl commands as
oracle
:cd /var/lib/oracle/emagent/agent_13.X.0.0.0/bin ./emctl secure agent ./emctl config agent addinternaltargets
Discover the Oracle AVDF Target
Follow the steps below to add the Oracle Audit Vault Server target:
- Log in to Enterprise Manager.
- Click Setup, then Add Target, and finally Configure Auto Discovery.
- On the Setup Discovery page, select a host on the Targets on Hosts tab and click Discovery Modules.
- On the Discovery Modules page, confirm that Discover Audit Vault and Database Firewall Entities and the Oracle Database, Listener and Automatic. Click OK.
- Returning to the previous page, highlight the host name of the Oracle Audit Vault Server and click Discover Now. A dialog box will appear while the discovery is in progress.
- Rename the Audit Vault Server and Database Firewall instances:
- Click Setup, then Add Target, and finally Auto Discovery Results.
- Click the Targets on the Hosts tab.
- In the Target Type column, look for
Oracle Audit Vault and Database Firewall,
this is your Audit Vault Server. Highlight the row and click
Rename to rename it to any meaningful name,
such as
AVServer_Legal_and_HR
. - Next, highlight the row with Database
Instance as a target type. Click
Rename to rename it to any meaningful name,
such as
AVS_Repository
.
- Promote the Audit Vault Server (AV Server):
- Highlight the row of the Audit Vault Server and click Promote.
- On the next page, provide user name and password of the AV
Server user with
AV_ADMIN
privilege. The Preferred Connect String should be already populated . However, if it is not, go to the AV Server Web administration console and log in as a user with theAV_ADMIN
privilege. Click Settings, then Status, and copy the preferred connect string from there. TheORACLE_HOME
is:/var/lib/oracle/dbfw
- Click Promote.
- Promote AV Repository Database instance:
- Highlight the row with the
AVS_Repository
database instance. Click on Promote. - On the next page, check
AVS_Repository
and click Configure. - Enter the Monitor password (user is
dbsnmp
, unlock the account in the AVS repository database), change the port from1522
to1521
, and change the Listener Machine Name to the fully qualified host name of your AV Server. - Click Test Connection; when successful, click Save.
- Highlight the row with the
- Back on the previous page, click Next. On the following page, click Save.
- To navigate to your new AV Server home page in Enterprise
Manager:
- From the Targets menu, select All Targets.
- Expand the Others list item.
- Select Oracle Audit Vault and Database Firewall. The AV repository database is listed under Targets, Databases.
The AVDF Plug-in Home Page
Once installed and configured, you can monitor Oracle Audit Vault and Database Firewall from Enterprise Manager. Each section and region of this page is described in Primary AVDF Plug-in Monitoring Overview.