6 Installing Oracle Management Agents
Oracle Management Agent (Management Agent) is one of the core components of Enterprise Manager that enables you to convert an unmanaged host to a managed host in the Enterprise Manager system. The Management Agent works in conjunction with the plug-ins to monitor the targets running on that managed host.
Management Agents Types
- Standalone agent: Agent installed on a local target. Also, known as local agent.
- Remote agent: Agent installed on host to monitor remote targets such as Host and Database.
- Central agent: Agent installed with the Enterprise Manager middleware. The OMS home and agent home reside on it.
Note:
For information about installing Remote Management Agents (remote agents), see Installing Oracle Remote Management Agents.
This chapter covers the following:
Overview of Installing Management Agents Using Agent Gold Images
At any point in time, if you want to monitor a target running on a host, you must first convert that unmanaged host to a managed host by installing a Management Agent, and then you must discover and promote the targets running on that managed host so that they are added to the Enterprise Manager Console.
Oracle recommends installing standalone Management Agents using Agent Gold Images
This section introduces you to Agent Gold Images and familiarizes you with important concepts that you must know before you begin installing Management Agents. In particular, this section covers the following:
Note:
The Management Agent software for the platform on which the OMS is deployed, is available by default on the OMS host. For example, if the platform on which the OMS is deployed is Linux x86-64, then the Management Agent software for the Linux x86-64 platform is available by default on the OMS host. You don't need to manually download the Management Agent software for that platform. However, if you plan to install a Management Agent on a platform that is different from the platform on which the OMS is deployed, then you must manually download the Management Agent software for the intended platform using Self Update. For instructions, see Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
Overview of Agent Gold Images
You can install Oracle Management Agents using Agent Gold Images. An Agent Gold Image represents the ideal state of a Management Agent in a data center managed by Enterprise Manager, having a customized configuration of the desired versions of the Management Agent software, the desired versions of the monitoring plug-ins, and the desired patches.
An Agent Gold Image version is created by an Enterprise Manager user, using a live reference Management Agent that is thoroughly tested and tuned. An Agent Gold Image version can be used to provision new Management Agents or update existing Management Agents on a large number of hosts.
Note:
You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Overview of Installing Shared Agents in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
In addition, you cannot use an unsecure Management Agent to create an Agent Gold Image version. Therefore, always use only a secure Management Agent as the source for creating an Agent Gold Image version.
Components of an Agent Gold Image Version
An Agent Gold Image version consists of the following software components that are stored in Oracle Software Library (Software Library):
-
Management Agent software
-
Oracle Home monitoring plug-in
-
Discovery plug-ins
-
Monitoring plug-ins
-
Management Agent and plug-in patches
-
Configuration information
-
Deploy scripts for performing the install or update
Advantages of Provisioning, Upgrading, and Updating Management Agents Using a Gold Image Version
The following are the advantages of provisioning, upgrading, and updating Management Agents using a gold image version:
-
Since an Agent Gold Image version consists of the desired Management Agent software, plug-ins, and patches, provisioning and updating Management Agents using a gold image version is a single point solution to managing the Management Agent lifecycle of a data center, that is, a user need not upgrade Management Agents using the Agent Upgrade Console, apply patches using patch plans, manage plug-ins using the plug-in lifecycle application, and so on.
-
Using an Agent Gold Image version, you can provision a large number of Management Agents, all of which have the same versions of Management Agent software, plug-ins, and patches, and also have the same set of configuration properties.
-
Using an Agent Gold Image version to provision, upgrade, and update Management Agents is a highly scalable approach.
-
Management Agents that are provisioned or updated using a gold image version are stable, well tested, and have a standardized configuration.
-
Management Agents that are provisioned or updated using a gold image version can be tracked easily, based on a recommended configuration.
Installing Management Agents Using Agent Gold Images
At any point in time, if you want to monitor a target running on a host, you must first convert that unmanaged host to a managed host by installing a Management Agent. This section describes how you can install Management Agents using Agent Gold Images.
Note:
Before proceeding, ensure you have reviewed Overview of Installing Management Agents Using Agent Gold Images.This section covers the following:
Getting Started with Installing Management Agents Using an Agent Gold Image Version
To get started with installing Management Agents using Agent Gold Images, follow these steps:
-
Ensure that you have a standalone Oracle Management Agent 24ai Release 1 installed in your environment.
If you do not have a standalone Oracle Management Agent 24ai Release 1 installed, then install one now. See Installing a Standalone Oracle Management Agent Using Add Host Targets Wizard or EM CLI. If you have a Management Agent of any earlier release, then upgrade it to version 24ai Release 1. See Upgrading Oracle Management Agents in the Oracle Enterprise Manager Upgrade Guide.
Note:
An Agent Gold Image can be created only using a standalone Management Agent of 24ai release, and not using a central agent of 24ai release or a standalone Management Agent of any other release. A central agent is a Management Agent that is deployed by default with the first OMS on the OMS host; you cannot use this central agent to create an Agent Gold Image.
-
Create an Agent Gold Image. See Creating an Agent Gold Image.
-
Create an Agent Gold Image version. See Creating an Agent Gold Image Version.
-
Set a particular Agent Gold Image version as the current version that can be used for deployment. See Setting a Particular Agent Gold Image Version as the Current Version.
-
Install the standalone Management Agent on the destination host using the Agent Gold Image. See Installing Management Agents Using an Agent Gold Image.
Note:
You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Overview of Installing Shared Agents in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
In addition, you cannot use an unsecure Management Agent to create an Agent Gold Image version. Therefore, always use only a secure Management Agent as the source for creating an Agent Gold Image version.
Installing a Standalone Oracle Management Agent Using Add Host Targets Wizard or EM CLI
An Agent Gold Image can be created only using a standalone Management Agent of 24ai release, and not using a central agent or a standalone Management Agent of any other release. This section describes how you can install such a standalone Management Agent of 24ai release. In particular, this section covers the following:
-
Overview of Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
-
Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
-
Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
-
After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
Overview of Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
To install a standalone Management Agent, use the Add Host Targets Wizard that is accessible from within the Enterprise Manager console, or use EM CLI. The Add Host Targets Wizard is an application that offers GUI-rich, interactive screens. Oracle recommends that you use this wizard, or EM CLI, for the mass-deployment of Management Agents. For more information about the Add Host Targets Wizard, see What Is an Add Host Target Wizard? in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
Note:
This section only describes how you can deploy a fresh Management Agent using the Add Host Targets Wizard. For information on cloning an existing instance and deploying a Management Agent using a shared instance, see Installing Oracle Management Agent in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
When you install a standalone Management Agent on a host, you will see the following default contents in the agent base directory:
<agent_base_directory>
|_____agent_24.1.0.0.0
|_____sbin
|_____OPatch
|_____agent.rsp
|_____bin
|_____cfgtoollogs
|_____config
|_____install
|_____instalclient
|_____.
|_____.
|_____agent_inst
|_____.
|_____agentInstall.rsp
|_____agentimage.properties
Note:
You can repoint your existing Management Agents to a new Oracle Management Service (OMS). For information on how to do this, see Redirecting Oracle Management Agent to Another Oracle Management Service in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
When you repoint your existing Management Agents to a new OMS, you cannot move the targets monitored by the Management Agents, the target history, and the Management Agent history. The monitored targets and the history data is lost.
Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
Before you begin installing a Management Agent using the Add Host Targets Wizard, or EM CLI, keep these points in mind:
-
The Add Host Targets Wizard and EM CLI convert an unmanaged host to a managed host in the Enterprise Manager system by installing a Management Agent.
-
Oracle recommends you to use the Add Host Targets Wizard or EM CLI to mass-deploy Management Agents in your environment.
-
To install a Management Agent on a host, you must download and apply the required version of the Management Agent software for the host platform, using Self Update. Only the Management Agent software for the OMS host platform is downloaded and applied by default.
To access Self Update, from the Setup menu, select Extensibility, then select Self Update.
For information on how to download and apply the Management Agent software for a platform, see Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
-
Oracle Management Agent 24ai communicates only with Oracle Management Service 24ai and not with any earlier release of Enterprise Manager.
When you use the Add Host Targets Wizard, or EM CLI, you can install only the latest Management Agent version on a platform, for which the Management Agent software is downloaded and applied. For example, if the 24ai Management Agent software for a particular platform is downloaded and applied, then you can install only a 24ai Management Agent on that platform, and not a 13c Management Agent.
For information about the compatibility between Management Agents and the OMS, see Table 5-2.
-
If you have multiple hosts, sharing a common mounted drive, then install the Management Agents in two different phases:
-
In the Add Host Targets Wizard, select the deployment type Fresh Agent Install, and install a Management Agent on the host where the drive is shared. Alternatively, you can select the deployment type Clone Existing Agent, and clone the Management Agent to the host where the drive is shared.
For more information on cloning a Management Agent, see Cloning Oracle Management Agents in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
-
In the Add Host Targets Wizard, select the deployment type Add Host to Shared Agent, and install a Management Agent on all other hosts that access the shared, mounted drive. (Here, you will select the Management Agent you installed in the previous step as the master agent or shared agent.)
For more information on shared agents, see Installing Shared Agents in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
-
-
If you have an Oracle RAC Cluster with multiple nodes, then you must install a Management Agent on each of the nodes separately. In other words, in the Add Host Targets Wizard, you must add each node explicitly as a destination host.
-
In Enterprise Manager 24ai , you can save the Management Agent one-off patches that you want to apply on a particular version of the Management Agent software, such that these patches are automatically applied on the software whenever a new Management Agent of the same version is deployed, or an old Management Agent is upgraded to that version.
For information on how to do this, see Applying Patches to Oracle Management Agents While Deploying or Upgrading Them in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
Also, you can apply one-off patches on a plug-in and create a custom patched plug-in, such that this custom patched plug-in is deployed on all the new Management Agents that you deploy, and all the old Management Agents that you upgrade.
For information on how to do this, see Managing Plug-Ins in the Oracle Enterprise Manager Administrator's Guide.
-
The Add Host Targets Wizard supports the
permissive
andenforcing
options for Security-Enhanced Linux (SELinux). -
The Add Host Targets Wizard uses SSH to establish connectivity between Oracle Management Service (OMS) and the remote hosts where you want to install the Management Agents.
-
Only SSH1 (SSH version 1) and SSH2 (SSH version 2) protocols offered by OpenSSH are supported for deploying a Management Agent.
-
The Add Host Targets Wizard supports Named Credentials that enable you to use a set of credentials registered with a particular name specifically for this operation, by your administrator. This ensures an additional layer of security for your passwords because as an operator, you can only select the named credential, which is saved and stored by an administrator, and not know the actual user name and password associated with it.
In case the named credential you select does not have the privileges to perform the installation, then you can set the named credential to run as another user (locked user account). In this case, the wizard logs in to the hosts using the named credential you select, but performs the installation using the locked user account you set.
For example, you can create a named credential titled User_A (the user account that has remote login access), and set it to run as User_X (the Management Agent install user account for which
no direct login
is set) that has the required privileges. In this case, the wizard logs in to the hosts as User_A, but installs as User_X, using the privilege delegation setting (sudo or PowerBroker) specified in the named credential.The sudo, pbrun, sesu, and su privilege delegation tools are supported in Enterprise Manager.
-
Named credentials support SSH public key authentication and password based authentication. So you can use an existing SSH public key authentication without exposing your passwords.
Note:
If the target host runs on Microsoft Windows, SSH Credentials are not supported. You must use Host Preferred Credentials using password based authentication. To set SSH credentials as preferred credential, see Setting Up Host Preferred Credentials Using SSH Key Credentials in the Oracle® Enterprise Manager Security Guide.To set up SSH public key authentication for a named credential, follow these steps:
Note:
-
If you have already set up SSH public key authentication for a named credential and the SSH keys are already created, then upload the SSH keys to Enterprise Manager, as mentioned in Step (4) of the following procedure.
-
Enterprise Manager does not support the format of the SSH key that is generated using the Tectia SSH client. However, if you are generating the SSH key using the Tectia SSH client, then as a prerequisite, convert the format of that key to OpenSSH format. To do so, run the following command.
ssh-keygen --import-private-key <input_private_key_filename> <output_filename> --key-format openssh2
After converting the format, use the content of the output_filename and upload it as a private key while registering it as a Named Credential in Enterprise Manager.
-
Navigate to the following location in the Oracle home:
$<ORACLE_HOME>/oui/prov/resources/scripts
For example,
/u01/software/em24/oms_home/oui/prov/resources/scripts
-
If the OMS host runs on Oracle Solaris, edit the
sshUserSetup.sh
script to change the following:"SunOS") SSH="/usr/local/bin/ssh" SSH_KEYGEN="/usr/local/bin/ssh-keygen"
to
"SunOS") SSH="/usr/bin/ssh" SSH_KEYGEN="/usr/bin/ssh-keygen"
-
If the OMS host runs on any Unix based operating system, run the
sshUserSetup.sh
script on the OMS host as the OMS install user, and pass the Management Agent install user name and the fully qualified name of the target hosts:sshUserSetup.sh -setup -user <agent_install_user_name> -hosts "<target_hosts>"
For example,
sshUserSetup.sh -setup -user oracle -hosts "abc1.example.com abc2.example.com abc3.example.com".
Ensure that you use a space to separate the target host names.The following SSH keys are created:
$HOME/.ssh/id_rsa $HOME/.ssh/id_rsa_pub
Here,
$HOME
refers to the home directory of the OMS install user.If the OMS host runs on Microsoft Windows, install Cygwin on the OMS host (described in Installing Cygwin and Starting the SSH Daemon), then run the
sshUserSetupNT.sh
script on the OMS host as the OMS user, and pass the Management Agent install user name and the fully qualified name of the target hosts:sshUserSetupNT.sh -setup -user <agent_install_user_name> -hosts <target_hosts>
-
Upload the SSH keys to Enterprise Manager.
From the Setup menu, select Security, then select Named Credentials. Click Create. For Credential Name, specify the name of the credential, for Credential Type, select SSH Key Credentials, and for Scope, select Global. If you do not select the Global option, you cannot use the SSH named credential to install Management Agents using the Add Host Targets Wizard.
To upload one of the private SSH keys created in Step 3, in the Credential Properties section, specify the location of the private SSH key as a value for the Upload Private Key field. Click Save.
To upload one of the public SSH keys created in Step 3, in the Credential Properties section, specify the location of the public SSH key as a value for the Upload Public Key field. Click Save.
Figure 6-1 describes how to upload SSH keys to Enterprise Manager.
Figure 6-1 Uploading SSH Keys to Enterprise Manager
If you have already set up SSH public key authentication for a named credential, you can use the named credential while installing Management Agents using the Add Host Targets Wizard.
-
-
You can mass deploy Management Agents on a number of hosts in a rolling manner, using the Add Host Targets Wizard or EM CLI. In this method, the deployment proceeds continuously from one deployment phase to another, after ignoring the failed hosts in each deployment phase. The deployment process does not stop when a host fails a deployment phase.
To deploy Management Agents in a rolling manner, ensure that you set the
oracle.sysman.prov.agentpush.continueIgnoringFailedHost
property totrue
in the$<ORACLE_HOME>/sysman/prov/agentpush/agentpush.properties
file, then use the Add Host Targets Wizard, or EM CLI to deploy the Management Agents. -
By default, the Add Host Targets Wizard configures only the following types of plug-ins:
-
All discovery plug-ins that were configured with the OMS from where the Management Agent software is being deployed.
-
Oracle Home discovery plug-in
-
Oracle Home monitoring plug-in
-
-
You must have read privileges on the Oracle WebLogic Server's alert log directories for the Support Workbench (Incident) metrics to work properly. You must also ensure that the Management Agent that is monitoring this Oracle WebLogic Server target is running on the same host as the Oracle WebLogic Server.
-
If you have a common mount point in your organization, then ensure that it is generic and ensure that you install the Management Agent in this generic mount point. This guideline helps when you upgrade your Management Agents to higher releases in the future within the same mount point, and not acquire new mount points each time.
For example, have a mount point such as
/oracle/product/agent
and install the Management Agent in there so that it appears as/oracle/product/agent/agent24.
Do not install the Management Agent directly in the mount point because it breaks the upgrade path and causes problems with cleanup operations.
Note:
Instead of installing a Management Agent using the Add Host Targets Wizard, or EM CLI, you can choose to install the Management Agent manually, in silent mode. For information on installing a Management Agent in silent mode, seeInstalling Oracle Management Agent in Silent Mode in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
Meeting the Generic Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
Table 6-1 lists the generic prerequisites you must meet before installing standalone Management Agents using the Add Host Targets Wizard or EM CLI.
Table 6-1 General Prerequisites for Installing Standalone Oracle Management Agent
Requirement | Description |
---|---|
Ensure that you meet the hard disk space, swap space, temp directory space, stage directory space, and physical memory requirements as described in Hardware Requirements for Enterprise Manager. |
|
Ensure that you meet the Oracle Cloud Infrastructure (OCI) requirements when deploying agents to OCI as described in Meeting the Generic Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EMCLI on Oracle Cloud Infrastructure. |
|
(For Microsoft Windows) Ensure that you have installed Cygwin 1.7 on the destination host as described in Installing Cygwin and Starting the SSH Daemon. Note: While running If you do not want to install Cygwin to deploy Management Agents on Microsoft Windows hosts using the Add Host Targets Wizard or EM CLI, you can choose to deploy Management Agents on these hosts using the PsExec process utility. For information on how to deploy Management Agents on Microsoft Windows hosts using PsExec, see Installing Management Agents on Microsoft Windows Target Hosts Without Using Cygwin. |
|
Ensure that you install the Management Agent only on certified operating systems as mentioned in the Enterprise Manager certification matrix available on My Oracle Support. To access the Enterprise Manager certification matrix, follow the steps outlined in Accessing the Enterprise Manager Certification Matrix. For information about platforms receiving future support, refer to My Oracle Support note 793512.1. |
|
File System Requirements |
Ensure that the file system mounted on the destination host does not permit buffered writes. |
File Descriptor Requirements |
|
Package Requirements |
Ensure that you install all the operating system-specific packages as described in Package, Kernel Parameter and Library Requirements for Enterprise Manager. |
User and Operating System Group Requirement |
Ensure that you create the required operating system groups and users as described in Creating Operating System Groups and Users for Enterprise Manager. |
Privilege Requirements |
Ensure that the Enterprise Manager user has the Super administrators, such as the |
etc/hosts File Requirements |
(Only for Microsoft Windows) Ensure that the entry for local host in the |
Destination Host Requirements |
Ensure that the destination hosts are accessible from the host where the OMS is running. If the destination host and the host on which OMS is running belong to different network domains, then ensure that you update the For example, if the fully-qualified host name is
|
Destination Host Credential Requirements |
If all the destination hosts are of the same platform, then they must have the same set of credentials. For example, all the destination hosts running on Linux operating system must have the same set of credentials. The wizard installs the Management Agent using the same user account. If you have hosts running on the same operating system but with different credentials, then have two different deployment sessions. |
Destination Host Time Zone Requirements |
Ensure that the time zones of the destination hosts have been set correctly. To verify the time zone of a destination host, sign in to the OMS host, and run the following command:
Note: If you had ignored a prerequisite check warning about wrong time zone settings during the Management Agent install, you must set the correct time zone on the destination hosts after installing the Management Agents. For information on setting time zones post install, refer After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI. |
Time Zone Requirements |
If the time zone displayed is incorrect, sign in to the destination host, and follow these steps:
|
sudo/pbrun/sesu/su SSH Requirements |
(Only for UNIX) Ensure that you set the Alternatively, you can use the Note: If you are using sudo as your privilege delegation tool, and you do not want to set the
|
sudo/pbrun/sesu/su Requirements (for executing commands as the root user) |
(Only for UNIX)
|
sudo/pbrun/sesu/su Requirements (for executing commands as the locked account user) |
(Only for UNIX) Ensure that the installing user has the privileges to invoke For example, if you are using sudo as your privilege delegation tool, include the following in the
Here, If you do not want to grant privileges to the installing user to invoke For example, if you are using sudo as your privilege delegation tool, include the following in the
Here, |
Locked Account Requirements |
Ensure that the locked account user (oracle) has read permission on the home directory of the login user. |
Ensure that the SSH daemon is running on the default port (that is, 22) on all the destination hosts. To verify the SSH port on a Unix host, run the following command:
For example, the output of this command may be the following:
The above output indicates that the SSH daemon is running on port 22. Also, on a Unix host, you can run the following command to verify the SSH port:
For a Microsoft Windows host, the SSH port value is mentioned in the If the SSH port is a non-default port, that is, any port other than 22, then update the
|
|
On the destination host, ensure the following:
|
|
|
Unset the |
Ensure that the software of the Management Agent you want to install is downloaded and applied using Self Update.
|
|
Validate the path to all command locations as described in Validating Command Locations. |
|
|
|
|
|
Installing User Requirements |
|
Agent User Account Permissions and Rights (For Microsoft Windows) |
(For Microsoft Windows) If you are installing the Management Agent on a Microsoft Windows-based operating system, then ensure that the agent user account has permissions and rights to perform the following:
To verify whether the agent user has these rights, follow these steps:
|
Permissions for cmd.exe (For Microsoft Windows) |
(For Microsoft Windows) If you are installing the Management Agent on a Microsoft Windows-based operating system, then ensure that you grant the For more information on this restriction and to understand how you can grant these permissions, access the following URL to Microsoft Web site: |
Runtime Library File Requirements (For Microsoft Windows) |
(For Microsoft Windows) If you are installing the Management Agent on a Microsoft Windows-based operating system, then ensure that the |
Ensure that the preinstallation and postinstallation scripts that you want to run along with the installation are available either on the OMS host, destination hosts, or on a shared location accessible to the destination hosts. |
|
Ensure that you use a certified browser as mentioned in the Enterprise Manager certification matrix available on My Oracle Support. To access the Enterprise Manager certification matrix, follow the steps in Accessing the Enterprise Manager Certification Matrix. |
|
IPv6 Host Requirements |
To support the deployment of an IPv6-enabled host, set the following property to
|
Meeting the Generic Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EMCLI on Oracle Cloud Infrastructure
You need to ensure your Oracle Cloud Infrastructure (OCI) environment is setup correctly before you install Management Agents on OCI.
Prerequisites to Install Management Agents on Oracle Cloud Infrastructure
If you are installing an agent on Oracle Cloud Infrastructure (OCI), perform the following prerequisites:
- Provision a Compute Virtual Machine or Database System from OCI for agent deployment.
If the Enterprise Manager instance is running on OCI then it should be on the same virtual cloud network (VCN) and subnet as the Enterprise Manager instance to allow target discovery and monitoring. The agent should have the same SSH key as the Enterprise Manager instance for login.
- Allow Enterprise Manager agent port traffic to OCI.
Open port 3872 on the VCN security list to permit connection.
Note:
3872 is the default Management Agent port. If you want to use another port, you can use any available port within 1830-1849 range.
- Open the firewall port in the agent node.
Log in to the node where the agent will be installed and open the firewall port 3872.
- Use the following firewall rules for database systems:
sudo iptables -I INPUT -p tcp -m state --state NEW -m tcp -s 10.0.1.0/25 --dport 3872 -m comment --comment "Required foraccess to Agent Listener" -j ACCEPT sudo iptables -I INPUT -p tcp -m tcp --dport 3872 -j ACCEPT sudo service iptables save sudo service iptables reload
- Use the following commands for Red Hat Enterprise Linux 7.7 and above:
firewall-cmd --zone=public --add-port=3872/tcp --permanent firewall-cmd --reload iptables-save | grep 3872
- Use the following firewall rules for database systems:
- Create named credentials on Enterprise Manager for the agent user.
If the Enterprise Manager instance is running on OCI then you need to create named credentials on the Enterprise Manager instance with the SSH key provided during the Enterprise Manager instance provisioning (either via Compute VM or Database system provisioning).
To create the named credentials, do the following:
Open Enterprise Manager and navigate to Setup > Security and click on Named Credentials.- Credential Name:
OCI_SSH_Key
- Credential Type:
SSH Key Credentials
- Scope:
Global
- Username:
opc
- Run Privilege:
sudo
- Run as:
oracle
- Credential Name:
- Add the agent hosts IP and hostname to the Enterprise Manager host file, and add the Enterprise Manager details to the Agent node host file.
- Example of OMS node host file
$ cat /etc/hosts 10.0.1.3 oms1 10.0.1.4 oms2 10.0.1.6 dbhost1 #agent_node1 10.0.1.7 dbhost2 #agent_node2
- Example of Agent node host file
[opc@dbhostt1 ~]$ cat /etc/hosts 10.0.1.6 dbhost1.emdb.emcc.oraclevcn.com dbhostt1 192.168.16.18 dbhost1-priv.emdb.emcc.oraclevcn.com dbhostt1-priv 10.0.1.8 dbhost1-vip.emdb.emcc.oraclevcn.com dbhostt1-vip 10.0.1.7 dbhost2.emdb.emcc.oraclevcn.com dbhostt2 192.168.16.19 dbhost2-priv.emdb.emcc.oraclevcn.com dbhostt2-priv 10.0.1.9 dbhost2-vip.emdb.emcc.oraclevcn.com dbhostt2-vip 10.0.1.3 oms1 10.0.1.4 oms2
- Example of OMS node host file
Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
To install a standalone Management Agent on a host, the Management Agent software for the host platform must be downloaded and applied using Self Update.
This section describes how to download and apply the Management Agent software for different platforms using Self Update. In particular, it contains the following:
Note:
The Management Agent software for the OMS host platform is downloaded and applied by default, so if the host on which you want to install a Management Agent runs on the same platform as that of the OMS host, you do not need to download and apply the Management Agent software for this platform.
Acquiring the Management Agent Software in Online Mode
If Enterprise Manager has access to My Oracle Support via the Internet, it is said to run in Online Mode.
To verify that Enterprise Manager is running in Online Mode, access the Offline Patching page. To access this page, from the Setup menu, select Provisioning and Patching, then select Offline Patching.
To download and apply the Management Agent software using Self Update when Enterprise Manager is running in Online Mode, follow these steps:
Acquiring the Management Agent Software in Offline Mode
If Enterprise Manager is not connected to My Oracle Support via the Internet, it is said to run in Offline Mode.
To verify that Enterprise Manager is running in Offline Mode, access the Offline Patching page. To access this page, from the Setup menu, select Provisioning and Patching, then select Offline Patching.
https://updates.oracle.com/download/em_catalog.zip
Note:
Upload the file using the options displayed in the Offline Patching page.To download and apply the Management Agent software using Self Update when Enterprise Manager is running in Offline Mode, follow these steps:
Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
This section describes the actions involved in installing standalone Management Agents. It consists of the following:
Note:
If the OMS host is running on Microsoft Windows, and the OMS software was installed in a drive other than C:\,
then update the SCRATCH_PATH
variable in $ORACLE_HOME\oui\prov\resources\ssPaths_msplats.properties.
For example, if the OMS software was installed in D:\,
ensure that you update the SCRATCH_PATH
variable to D:\tmpada
Installing Standalone Management Agents Using Add Host Targets Wizard
This section describes how to install 24ai Management Agents using the Add Host Targets Wizard.
To install fresh Management Agents using the Add Host Targets Wizard, follow these steps:
-
Ensure that you have downloaded and applied the Management Agent software for the platforms of the hosts on which you want to install Management Agents.
For information on how to download and apply the Management Agent software for a platform, see Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
-
In Enterprise Manager, do one of the following:
-
From the Setup menu, select Add Target, then select Auto Discovery Results. On the Auto Discovery Results page, under the Servers, Storage and Network tab, select a host that you want to monitor from the displayed list, then click Promote.
-
From the Setup menu, select Add Target, then select Add Targets Manually. On the Add Targets Manually page, select Install Agent on Host.
-
-
On the Host and Platform page, do the following:
-
Accept the default name assigned for this session or enter a unique name of your choice. The custom name you enter can be any intuitive name, and need not necessarily be in the same format as the default name. For example,
add_host_operation_1
.A unique deployment activity name enables you to save the installation details specified in this deployment session and reuse them in the future without having to enter all the details all over again in the new session.
-
From the Add menu, select Manually to enter the fully qualified name and select the platform of the host on which you want to install the Management Agent.
The host names that are retrieved from the system for the installation may include IP addresses and short names. However, it is recommended that you provide fully qualified host names, such as
foo.example.com,
which persist over the life of the host targets. This is recommended for ease of maintenance and overall security.Note:
-
Oracle recommends you to enter the fully qualified domain name of the host. For monitoring purpose, Enterprise Manager adds that host and the Management Agent with the exact name you enter here.
-
You must enter only one host name per row. Entering multiple host names separated by a comma is not supported.
-
You must ensure that the host name does not contain underscores('_').
-
If the platform name is appended with Agent Software Unavailable, then it indicates that the software for that platform is not available on the OMS host, and that you must download and apply it using Self Update. To access Self Update, from the Setup menu, select Extensibility, then click Self Update.
For more information on using Self Update to download and apply the latest software, see Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
Alternatively, from the Add menu, you can select either From File to add the host names stored in a file, or Discovered Hosts to add the host names from a list of hosts discovered by Enterprise Manager. For information on how the host name entries must appear in the host file, see Format of the Host List File.
Note:
When you select Discovered Hosts from the Add menu, and add hosts from a list of discovered hosts, the host's platform is automatically detected and displayed. The platform name is detected using a combination of factors, including hints received from automated discovery and the platform of the OMS host. This default platform name is a suggestion, so Oracle strongly recommends you to verify the platform details before proceeding to the next step.
If you are correcting the platform names, and if all the hosts run on the same platform, then set the platform for the first host in the table and from the Platform list, select Same for All Hosts. This will ensure that the platform name you selected for the first host is also set for the rest of the hosts in the table.
If you are correcting the platform names, and all the hosts run on different platforms, from the Platform list, select Different for Each Host. Select the correct platform for each host.
Note:
-
If you reach this page (Host and Platform page) from the Auto Discovery Results page, then the hosts you selected on that page automatically appear in the table. In this case, you need to only validate the host names and their platforms.
-
If you are installing a Management Agent on a platform that is different from the platform on which the OMS is running, then ensure that you have the software for that platform. If you do not have that software, then go to the Self Update console within Enterprise Manager, download the software, then apply it. For more information, see Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
-
-
Click Next.
-
-
On the Installation Details page, do the following:
-
In the Deployment Type section, select Fresh Agent Install.
Note:
If you have multiple hosts sharing a common mounted drive, then install the Management Agents in two different phases:
-
In the Add Host Targets Wizard, select the deployment type Fresh Agent Install, and install a Management Agent on the host where the drive is shared.
-
In the Add Host Targets Wizard, select the deployment type Add Host to Shared Agent, and install a Management Agent on all other hosts that access the shared, mounted drive. (Here, you will select the Management Agent you installed in the previous step as the master agent or shared agent.)
-
-
From the table, select the first row that indicates the hosts grouped by their common platform name.
-
In the Installation Details section, provide the installation details common to the hosts selected in Step 3 (b). For Installation Base Directory, enter the absolute path to the agent base directory where you want the software binaries, security files, and inventory files of the Management Agent to be copied.
For example,
/u01/software/em24/agentbasedir/
If the path you enter does not exist, the application creates a directory at the specified path, and copies the Management Agent software binaries, security files, and inventory files there.
Note:
The Installation Base Directory is essentially the agent base directory. Ensure that the directory you provide is empty. If a previously run deployment session had failed for some reason, then you might see an ADATMP_<timestamp> subdirectory in the agent base directory. In this case, either delete the subdirectory and start a new deployment session, or retry the failed session from the Add Host Status page.
-
For Instance Directory, accept the default instance directory location or enter the absolute path to a directory of your choice where all Management Agent-related configuration files can be stored.
For example,
/u01/software/em24/agentbasedir/agent_inst
If you are entering a custom location, then ensure that the directory has write permission. Oracle recommends you to maintain the instance directory inside the agent base directory.
If the path you enter does not exist, the application creates a directory at the specified path, and stores all the Management Agent-related configuration files there.
-
From Named Credential list, select an appropriate profile whose credentials can be used for setting up the SSH connectivity between the OMS and the remote hosts, and for installing a Management Agent on each of the remote hosts.
Note:
-
If you do not have a credential profile, or if you have one but do not see it in the Named Credential list, then click the plus icon against this list. In the Create New Named Credential window, enter the credentials and store them with an appropriate profile name so that it can be selected and used for installing the Management Agents. Also set the run privilege if you want to switch over from the Named Credential you are creating, to another user who has the privileges to perform the installation.
-
If the plus icon is disabled against this list, then you do not have the privileges to create a profile with credentials. In this case, contact your administrator and either request him/her to grant you the privileges to create a new profile or request him/her to create a profile and grant you the access to view it in the Named Credential list.
-
If you have manually set up SSH public key authentication between the OMS and the remote hosts for a named credential, as described in Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI, you can select this credential from the Named Credential list.
-
-
From the Root Credential list, select an appropriate root credential to obtain privileges of a root user. This is an optional field. You may use this option only when your credentials do not have certain privileges as that of a root user. Use this along with your credentials.
-
For Privileged Delegation Setting, validate the Privilege Delegation setting to be used for running the root scripts. By default, it is set to the Privilege Delegation setting configured in Enterprise Manager.
For example, you can specify one of the following for the Privileged Delegation Setting field:
/usr/bin/sudo -u %RUNAS% %COMMAND% /usr/bin/sudo -u -S %RUNAS% %COMMAND% (if a pseudo terminal is required for remote command execution via SSH) /usr/bin/sesu - %RUNAS% -c "%COMMAND%" /usr/bin/pbrun %PROFILE% -u %RUNAS% %COMMAND% /usr/bin/su - %RUNAS% -c "%COMMAND%"
If you leave the Privileged Delegation Setting field blank, the root scripts will not be run by the wizard; you will have to run them manually after the installation. For information about running them manually, see After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
This setting will also be used for performing the installation as the user set in the Run As attribute of the selected Named Credential if you had set the user while creating that Named Credential.
Note:
In the Privilege Delegation setting, the
%RUNAS%
is honored as the root user for running the root scripts and as the user set in the Run As attribute of the Named Credential for performing the installation. -
For Port, accept the default port (3872) that is assigned for the Management Agent to communicate, or enter a port of your choice.
The custom port you enter must not be busy. If you are not sure, you can leave this field blank. Enterprise Manager automatically assigns the first available free port within the range of 1830 - 1849.
-
(Optional) In the Optional Details section, enter the absolute path to an accessible location where the preinstallation and postinstallation scripts you want to run are available. Note that only shell scripts are supported, and only one preinstallation or one postinstallation script can be specified.
If you want to run the script as
root
, then select Run as Root. If the script is on the host where OMS is running and is not on the host where you want to install the Management Agent, then select Script on OMS. In this case, the script will be copied from the OMS host to the destination hosts, and then run on the destination hosts. -
(Optional) For Additional Parameters, enter a whitespace-separate list of additional parameters that you want to pass during the installation. For a complete list of supported additional parameters, see Table 6-2.
For example, if you want to provide the inventory pointer location file, then enter
-invPtrLoc
followed by the absolute path to the file location. However, note that this parameter is supported only on UNIX platforms, and not on Microsoft Windows platforms. -
Repeat Step 3 (b) to Step 3 (i) for every other row you have in the table.
-
Click Next.
-
-
If you want to deploy Management Agents on the selected hosts in a rolling manner, such that the deployment proceeds continuously from one deployment phase to another, ignoring the failed hosts in each deployment phase, specify the following in the
$ORACLE_HOME/sysman/prov/agentpush/agentpush.properties
file:oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true
For more information about this deployment method, see Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
-
On the Review page, review the details you have provided for the installation and do one of the following:
-
If you want to modify the details, then click Back repeatedly to reach the page where you want to make the changes.
-
If you want to cancel the deployment session for some reason, click Cancel. You are automatically taken to the Add Targets Manually page.
-
If you are satisfied with the details, then click Deploy Agent to install the Management Agent. You are automatically taken to the Add Host Status page that enables you to monitor the progress of the deployment session.
If you want to cancel a running deployment session, then on the Add Host Targets page, click Cancel. Note that once you cancel the session, you cannot track or resume the session in any way. However, the currently launched commands on the remote hosts will continue to run until they are completed.
To view the details or track the progress of all the Add Host sessions using the Add Host Targets Wizard, from the Setup menu, select Add Target, then click Add Targets Manually. On the Add Targets Manually page, click Install Agent Results.
-
-
If a particular installation phase has failed or has a warning, review the details provided for each phase in the Agent Deployment Details section of the Add Host Status page, and do one of the following:
Note:
To find the cause of a failure, review the log files. One log file is generated per host, so if you installed Management Agents on multiple hosts, then review all the log files. For information on how to access the log files, refer to Overview of the Installation and Configuration Log Files in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
-
Fix the problem by reviewing the error description carefully, understanding its cause, and taking action as recommended by Oracle.
-
You can retry the deployment of Management Agents with the same installation details.
To do so, on the Add Host Status page, click Retry and select Retry Using Same Inputs.
-
You can retry the deployment of Management Agents with modified installation details.
To do so, on the Add Host Status page, click Retry and select Update Inputs and Retry.
-
-
Ignore the warning or failure, and continue with the session if you prefer.
-
You can choose to proceed with the deployment of Management Agents only on those remote hosts that have successfully cleared the checks, and you can ignore the ones that have Warning or Failed status.
To do so, on the Add Host Status page, click Continue and select Continue, Ignoring Failed Hosts.
-
You can choose to proceed with the deployment of Management Agents on all the hosts, including the ones that have Warning or Failed status.
Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.
To do so, on the Add Host Status page, click Continue and select Continue, All Hosts.
-
-
Installing Standalone Management Agents Using Add Host Targets Wizard on Oracle Cloud Infrastructure
The steps described above also apply to installing Management Agents using Add Host Targets Wizard on Oracle Cloud Infrastructure (OCI).
See below a screenshot of the Add Hosts Targets Wizard after you click on Install Agent on Host and enter the agent installation details.
Format of the Host List File
In the Add Host Targets Wizard, you can click Load from File to add the hosts listed in a file. However, ensure that the file you select has one of the following formats:
-
Only the host name.
For Example,
host1.example.com
host2.example.com
Note:
If the host list file is in this format, ensure that you select the platform for each added host from the drop down list.
-
The host name followed by the platform name.
For Example,
host1.example.com linux_x64
host2.example.com aix
The supported platform names are linux_x64, linux, solaris, hpunix, hpi, linux64_zseries, aix, linux_ppc64, windows_x64, solaris_x64, and win32.
Installing Standalone Management Agents Using EM CLI
Note:
-
Using EM CLI, you can install fresh Management Agents, install Shared Agents, and clone existing Management Agents.
-
Using EM CLI, you can install fresh Management Agents only on a single platform in a single Add Host session. If you want to use EM CLI to install fresh Management Agents on different platforms, then you must create a separate Add Host session for each platform.
Note:
If the output of the EM CLI verbs mentioned in this section is misaligned or is difficult to read, adjust your screen width by specifying an appropriate value for the oracle.sysman.prov.agentpush.emcliScreenWidth
property in the <ORACLE_HOME>/sysman/prov/agentpush/agentpush.properties
file.
To create an Add Host session and install fresh Management Agents using EM CLI, follow these steps:
Note:
For more information on how to use the EM CLI verbs mentioned in this section, refer EMCLI Overview and Concepts in the Oracle Enterprise Manager Command Line Interface.
Supported Additional Parameters for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
Table 6-2 lists the additional parameters supported for installing a new Management Agent using the Add Host Targets Wizard or EM CLI.
Note that all the parameters mentioned in this section are case sensitive.
Table 6-2 Supported Additional Parameters
Parameter | Description |
---|---|
INVENTORY_LOCATION |
Enter the absolute path to the Central Inventory (oraInventory). For example, Important:
|
-invPtrLoc |
Enter the absolute path to the inventory file that has the location of the Central Inventory (oraInventory). For example, Important:
|
-enablePty |
Specify this parameter if the privilege delegation tool you are using requires a pseudo terminal for remote command execution via SSH. Most privilege delegation tools such as pbrun, sesu, and su require a pseudo terminal for remote command execution, by default. You do not need to specify this parameter if you have set the Ensure that you do not pass this parameter if the Central Inventory exists. |
START_PRIORITY_LEVEL (For Unix based hosts only) |
Use this parameter to specify the priority level of the Management Agent service when the host is started. This parameter accepts values between 0 and 99. However, Oracle recommends that you provide a value between 91 and 99 for this parameter.
For example, If you do not include this parameter, it defaults to |
SHUT_PRIORITY_LEVEL (For Unix based hosts only) |
Use this parameter to specify the priority level of the Management Agent service when the host is shut down. This parameter accepts values between 0 and 99 .
For example, If you do not include this parameter, it defaults to |
s_agentSrvcName |
(Only for Microsoft Windows) Enter a custom name for the Management Agent service. Every Management Agent appears as a service in Microsoft Windows, and every Management Agent has a default service name. If you want to assign a custom name to identify it, then use this parameter. For example, Note: (For Microsoft Windows hosts) If you upgrade a 24.1.0.x Management Agent and you want to install another Management Agent on the same host, which points to a different OMS, ensure that you specify the |
START_AGENT=false |
Specify this parameter if you do not want the Management Agent to start automatically once it is installed and configured. If you do not specify this parameter, the Management Agent starts automatically once it is installed and configured. |
SCRATCHPATH |
Specify this parameter if you do not have write permission on /tmp or enough space on /tmp to use a custom path for the software extraction other than /tmp. Perform the following steps to override the /tmp location:
|
b_secureAgent=false |
Specify this parameter if you do not want the Management Agent to be secured after the install. If you do not specify this parameter, the Management Agent is secured automatically after the install. To secure the Management Agent manually after the install, run the following command:
If you specify this parameter, ensure that you also specify the OMS HTTP port, using the For example, |
After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI
After you install a standalone Management Agent using the Add Host Targets Wizard or EM CLI, follow these steps:
Note:
-
To know the location where a Management Agent is deployed on a Microsoft Windows host, that is, the Management Agent Oracle home, access
<INVENTORY_LOCATION>\inventory.xml,
then search forHOME NAME="agent241".
The value of theLOC
parameter denotes the Management Agent Oracle home.For example, in the following line of
C:\Program Files\Oracle\inventory.xml,
D:\agent24\agent_24.1.0.0.0
denotes the Management Agent Oracle home:<HOME NAME="agent241" LOC="D:\agent24\agent_24.1.0.0.0" TYPE="O" IDX="10">
-
You can repoint your existing Management Agents to a new Oracle Management Service (OMS). For information on how to do this, see Redirecting Oracle Management Agent to Another Oracle Management Service in the Oracle Enterprise Manager Advanced Installation Guide.
When you repoint your existing Management Agents to a new OMS, you cannot move the targets monitored by the Management Agents, the target history, and the Management Agent history. The monitored targets and the history data is lost.
Creating an Agent Gold Image
An Agent Gold Image represents the ideal state of a Management Agent in a data center, having customized configurations of the desired versions of the Management Agent software, the desired versions of the monitoring plug-ins, and the desired patches.
You can create an Agent Gold Image, using either of the following methods:
Creating an Agent Gold Image Using Gold Agent Images Home Page
To create an Agent Gold Image, follow these steps:
- From the Setup menu, select Manage the Manager, then select Gold Agent Images.
- Click Manage All Images.
- Click Create.
- Specify the gold image name, a description (optional), and the platform of the source Management Agent that you want to use to create the Agent Gold Image versions. Ensure that you use only a standalone Management Agent as the source, and not a central agent.
- Click Submit.
Creating an Agent Gold Image Using EM CLI
When you create an Agent Gold Image version using EM CLI, the Agent Gold Image gets automatically created.
To create an Agent Gold Image by creating an Agent Gold Image version using EM CLI, see Creating an Agent Gold Image Version Using EM CLI.
Creating an Agent Gold Image Version
An Agent Gold Image is expected to undergo revisions whenever you plan to upgrade your Management Agents, upgrade the plug-ins deployed on your Management Agents, deploy new plug-ins on your Management Agents, or deploy new patches on your Management Agents or plug-ins. Each of these sequential revisions of an Agent Gold Image is termed as a Agent Gold Image version.
You can create an Agent Gold Image version, using either of the following methods:
Creating an Agent Gold Image Version Using Gold Agent Images Home Page
To create an Agent Gold Image version, follow these steps:
Note:
If the configuration properties of the source Management Agent were changed for some reason in the emd.properties file, then before creating an agent gold image version using that source Management Agent, reload the configuration properties of that Management Agent. To do so, run the following command:
emctl reload agent
Creating an Agent Gold Image Version Using EM CLI
To create an Agent Gold Image version using EM CLI, follow these steps:
Note:
If the configuration properties of the source Management Agent were changed for some reason in the emd.properties file, then before creating an agent gold image version using that source Management Agent, reload the configuration properties of that Management Agent. To do so, run the following command:
emctl reload agent
Setting a Particular Agent Gold Image Version as the Current Version
The up-to-date version of an Agent Gold Image that you want to use to standardize the Management Agents in your enterprise is termed as the current version of the Agent Gold Image.
When an Agent Gold Image version is created, it is marked as a draft version. Setting a draft version of an Agent Gold Image as the current version indicates that the gold image version is ready to be used to mass deploy or mass update Management Agents. Once an image is set to Active (Current), you cannot revert it to a draft or a restricted version.
You can set a particular Agent Gold Image version as the current version, using either of the following methods:
Setting a Particular Agent Gold Image Version as the Current Version Using Gold Agent Images Home Page
To set a draft version of an Agent Gold Image as the current version, follow these steps:
Installing Management Agents Using an Agent Gold Image
You can install new Management Agents using Agent gold images, by using either of the following methods:
-
Installing Management Agents Using an Agent Gold Image Using Add Host Targets Wizard
-
Installing Management Agents Using an Agent Gold Image Using EM CLI
Note:
You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Overview of Installing Shared Agents in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
Installing Management Agents Using an Agent Gold Image Using Add Host Targets Wizard
Note:
To view a visual demonstration of how to deploy Oracle Management Agents using Agent Gold Images, access the following URL and click Begin Video.
https://apexapps.oracle.com/pls/apex/f?p=44785:24:0:::24:P24_CONTENT_ID,P24_PREV_PAGE:12754,1
To install new Management Agents using an Agent Gold Image, follow these steps:
-
Access the Add Host Targets Wizard in one of the following ways:
-
Option 1: From the Add Targets Manually Page
From the Setup menu, select Add Target, then select Add Targets Manually.
-
Option 2: From the Gold Agent Images Console
From the Setup menu, select Manage the Manager, then select Gold Agent Images.
On the Gold Agent Images page, in the table that lists all the Agent Gold Images, click the gold image you want to use for deploying new Management Agents.
On the gold image page, click Manage Image Versions and Subscriptions. Then, on the Manage Image: <gold image> page, click the Subscriptions tab. Finally, in the Subscriptions tab, click Add Host.
-
-
On the Add Host Targets: Host and Platform page, do the following:
-
Accept the default name assigned for this session or enter a unique name of your choice. The custom name you enter can be any intuitive name, and need not necessarily be in the same format as the default name. For example,
add_host_operation_1
.A unique deployment activity name enables you to save the installation details specified in this deployment session and reuse them in the future without having to enter all the details all over again in the new session.
-
If you followed Option 1 in Step (1) to reach the Add Host Targets: Host and Platform page, then from the Options drop-down list, select With Gold Image. Then, from the Image Name drop-down list, select the gold image you want to use, and from the Image Version drop-down list, select the version of the gold image you want to use.
If you followed Option 2 in Step (2) to reach the Add Host Targets: Host and Platform page, then you do not have to select anything from the Options, Image Name, and Image Version drop-down lists.
-
From the Add menu, select Manually to enter the fully qualified name and select the platform of the host on which you want to install the Management Agent.
The host names that are retrieved from the system for the installation may include IP addresses and short names. However, it is recommended that you provide fully qualified host names, such as
foo.example.com,
which persist over the life of the host targets. This is recommended for ease of maintenance and overall security.Note:
-
Oracle recommends you to enter the fully qualified domain name of the host. For monitoring purpose, Enterprise Manager adds that host and the Management Agent with the exact name you enter here.
-
You must enter only one host name per row. Entering multiple host names separated by a comma is not supported.
-
You must ensure that the host name does not contain underscores('_').
-
If you reach this page (Host and Platform page) from the Auto Discovery Results page, then the hosts you selected on that page automatically appear in the table. In this case, you need to only validate the host names and their platforms.
Alternatively, from the Add menu, you can select either From File to add the host names stored in a file, or Discovered Hosts to add the host names from a list of hosts discovered by Enterprise Manager. For information on how the host name entries must appear in the host file, see Format of the Host List File.
Note:
When you select Discovered Hosts from the Add menu, and add hosts from a list of discovered hosts, the host's platform is automatically detected and displayed. The platform name is detected using a combination of factors, including hints received from automated discovery and the platform of the OMS host. This default platform name is a suggestion, so Oracle strongly recommends you to verify the platform details before proceeding to the next step.
If you are correcting the platform names, and if all the hosts run on the same platform, then set the platform for the first host in the table and from the Platform list, select Same for All Hosts. This will ensure that the platform name you selected for the first host is also set for the rest of the hosts in the table.
If you are correcting the platform names, and all the hosts run on different platforms, from the Platform list, select Different for Each Host. Select the correct platform for each host.
-
-
Click Next.
-
-
On the Installation Details page, do the following:
-
In the Deployment Type section, select Fresh Agent Install.
-
From the table, select the first row that indicates the hosts grouped by their common platform name.
-
In the Installation Details section, provide the installation details common to the hosts selected in Step 3 (b). For Installation Base Directory, enter the absolute path to the agent base directory where you want the software binaries, security files, and inventory files of the Management Agent to be copied.
For example,
/u01/software/em24/agentbasedir/
If the path you enter does not exist, the application creates a directory at the specified path, and copies the Management Agent software binaries, security files, and inventory files there.
Note:
The Installation Base Directory is essentially the agent base directory. Ensure that the directory you provide is empty.
The directory name you enter here is appended with the name of the Agent Gold Image you have selected for deployment. For example, if you enter
abd
as the directory name, and if you used the gold image namedGI_V2,
then the installation base directory is namedGI_V2_abd.
If a previously run deployment session had failed for some reason, then you might see an ADATMP_<timestamp> subdirectory in the agent base directory. In this case, either delete the subdirectory and start a new deployment session, or retry the failed session from the Add Host Status page.
-
For Instance Directory, accept the default instance directory location or enter the absolute path to a directory of your choice where all Management Agent-related configuration files can be stored.
For example,
/u01/software/em24/agentbasedir/agent_inst
If you are entering a custom location, then ensure that the directory has write permission. Oracle recommends you to maintain the instance directory inside the agent base directory.
If the path you enter does not exist, the application creates a directory at the specified path, and stores all the Management Agent-related configuration files there.
-
From Named Credential list, select an appropriate profile whose credentials can be used for setting up the SSH connectivity between the OMS and the remote hosts, and for installing a Management Agent on each of the remote hosts.
Note:
-
If you do not have a credential profile, or if you have one but do not see it in the Named Credential list, then click the plus icon against this list. In the Create New Named Credential window, enter the credentials and store them with an appropriate profile name so that it can be selected and used for installing the Management Agents. Also set the run privilege if you want to switch over from the Named Credential you are creating, to another user who has the privileges to perform the installation.
-
If the plus icon is disabled against this list, then you do not have the privileges to create a profile with credentials. In this case, contact your administrator and either request him/her to grant you the privileges to create a new profile or request him/her to create a profile and grant you the access to view it in the Named Credential list.
-
If you have manually set up SSH public key authentication between the OMS and the remote hosts for a named credential, as described in Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI, you can select this credential from the Named Credential list.
-
-
For Privileged Delegation Setting, validate the Privilege Delegation setting to be used for running the root scripts. By default, it is set to the Privilege Delegation setting configured in Enterprise Manager.
For example, you can specify one of the following for the Privileged Delegation Setting field:
/usr/bin/sudo -u %RUNAS% %COMMAND% /usr/bin/sudo -u -S %RUNAS% %COMMAND% (if a pseudo terminal is required for remote command execution via SSH) /usr/bin/sesu - %RUNAS% -c "%COMMAND%" /usr/bin/pbrun %PROFILE% -u %RUNAS% %COMMAND% /usr/bin/su - %RUNAS% -c "%COMMAND%"
If you leave the Privileged Delegation Setting field blank, the root scripts will not be run by the wizard; you will have to run them manually after the installation. For information about running them manually, see After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
This setting will also be used for performing the installation as the user set in the Run As attribute of the selected Named Credential if you had set the user while creating that Named Credential.
Note:
In the Privilege Delegation setting, the
%RUNAS%
is honored as the root user for running the root scripts and as the user set in the Run As attribute of the Named Credential for performing the installation. -
For Port, accept the default port (3872) that is assigned for the Management Agent to communicate, or enter a port of your choice.
The custom port you enter must not be busy. If you are not sure, you can leave this field blank. Enterprise Manager automatically assigns the first available free port within the range of 1830 - 1849.
-
(Optional) In the Optional Details section, enter the absolute path to an accessible location where the preinstallation and postinstallation scripts you want to run are available. Note that only shell scripts are supported, and only one preinstallation or one postinstallation script can be specified.
If you want to run the script as
root
, then select Run as Root. If the script is on the host where OMS is running and is not on the host where you want to install the Management Agent, then select Script on OMS. In this case, the script will be copied from the OMS host to the destination hosts, and then run on the destination hosts.Note:
Since you are using a gold image that already carries the patches and the configuration of a stable Management Agent, make sure you do not add any postinstallation scripts that will reapply or reconfigure the Management Agent you are deploying.
-
(Optional) For Additional Parameters, enter a whitespace-separate list of additional parameters that you want to pass during the installation. For a complete list of supported additional parameters, see Table 6-2.
For example, if you want to provide the inventory pointer location file, then enter
-invPtrLoc
followed by the absolute path to the file location. However, note that this parameter is supported only on UNIX platforms, and not on Microsoft Windows platforms. -
Repeat Step 3 (b) to Step 3 (i) for every other row you have in the table.
-
Click Next.
-
-
If you want to deploy Management Agents on the selected hosts in a rolling manner, such that the deployment proceeds continuously from one deployment phase to another, ignoring the failed hosts in each deployment phase, specify the following in the
<ORACL_HOME>/sysman/prov/agentpush/agentpush.properties
file:oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true
For more information about this deployment method, see Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
-
On the Review page, review the details you have provided for the installation and do one of the following:
-
If you want to modify the details, then click Back repeatedly to reach the page where you want to make the changes.
-
If you want to cancel the deployment session for some reason, click Cancel. You are automatically taken to the Add Targets Manually page.
-
If you are satisfied with the details, then click Deploy Agent to install the Management Agent. You are automatically taken to the Add Host Status page that enables you to monitor the progress of the deployment session.
If you want to cancel a running deployment session, then on the Add Host Targets page, click Cancel. Note that once you cancel the session, you cannot track or resume the session in any way. However, the currently launched commands on the remote hosts will continue to run until they are completed.
To view the details or track the progress of all the Add Host sessions using the Add Host Targets Wizard, from the Setup menu, select Add Target, then click Add Targets Manually. On the Add Targets Manually page, click Install Agent Results.
-
-
If a particular installation phase has failed or has a warning, review the details provided for each phase in the Agent Deployment Details section of the Add Host Status page, and do one of the following:
Note:
To find the cause of a failure, review the log files. One log file is generated per host, so if you installed Management Agents on multiple hosts, then review all the log files. For information on how to access the log files, refer to Overview of the Installation and Configuration Log Files in the Oracle Enterprise Manager Advanced Installation and Configuration Guide.
-
Fix the problem by reviewing the error description carefully, understanding its cause, and taking action as recommended by Oracle.
-
You can retry the deployment of Management Agents with the same installation details.
To do so, on the Add Host Status page, click Retry and select Retry Using Same Inputs.
-
You can retry the deployment of Management Agents with modified installation details.
To do so, on the Add Host Status page, click Retry and select Update Inputs and Retry.
-
-
Ignore the warning or failure, and continue with the session if you prefer.
-
You can choose to proceed with the deployment of Management Agents only on those remote hosts that have successfully cleared the checks, and you can ignore the ones that have Warning or Failed status.
To do so, on the Add Host Status page, click Continue and select Continue, Ignoring Failed Hosts.
-
You can choose to proceed with the deployment of Management Agents on all the hosts, including the ones that have Warning or Failed status.
Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.
To do so, on the Add Host Status page, click Continue and select Continue, All Hosts.
-
-
Installing Management Agents Using an Agent Gold Image Using EM CLI
Note:
-
Using EM CLI, you can install fresh Management Agents, install Shared Agents, and clone existing Management Agents.
-
Using EM CLI, you can install fresh Management Agents only on a single platform in a single Add Host session. If you want to use EM CLI to install fresh Management Agents on different platforms, then you must create a separate Add Host session for each platform.
To create an Add Host session and install Management Agents using an Agent Gold Image using EM CLI, follow these steps:
Note:
For more information on how to use the EM CLI verbs mentioned in this section, refer EMCLI Overview and Concepts in the Oracle Enterprise Manager Command Line Interface.
Troubleshooting Management Agents
This section provides tips to issues that you may encounter when installing or working with management agents. In particular, this section covers the following:
Troubleshooting Management Agent Crashes That Occur Due to java.lang.OutOfMemoryError Errors
There is a chance that agents may crash due to an eventual increase in the number of targets per agent. Therefore, if there is a likelihood of future additional targets in the agent infrastructure, it is advisable to increase the Java heap size manually soon after the agent installation.