This chapter describes how you can install Oracle Management Agent (Management Agent) in silent mode. In particular, this chapter covers the following:
Before You Begin Installing a Management Agent in Silent Mode
Prerequisites for Installing a Management Agent in Silent Mode
Installing a Management Agent in silent mode is only an alternative to installing it using the Add Host Targets Wizard. While the Add Host Targets Wizard requires you to use its GUI-rich interview screens for providing all installation details, the silent mode requires you to use a response file for providing installation details and deployment scripts to install Management Agents on hosts.
Installing in silent mode is useful when you want to install an additional Management Agent on a destination host from the destination host itself, without using the Add Host Targets Wizard.
You can install Management Agents in silent mode using the following methods:
In this method, you do not have to use EM CLI to download the Management Agent software onto the remote destination host before executing the script to install the Management Agent. This method supports only a few additional parameters, and is ideal for a basic Management Agent install.
Using the agentDeploy Script
In this method, you must use EM CLI to download the Management Agent software onto the remote destination host before executing the script to install the Management Agent. You can either choose to use EM CLI from the OMS host, or from the remote destination host. If you choose to use EM CLI from the OMS host, you must transfer the downloaded Management Agent software to the remote destination host before executing the script to install the Management Agent. This method supports many additional parameters, and is ideal for a customized Management Agent install.
Using the RPM File
In this method, you obtain the .rpm
file using EM CLI on the OMS host, then transfer the file to the remote destination host before running the file to install the Management Agent. Using the .rpm
file, you can also choose to install a Management Agent while provisioning an operating system on a bare metal host. For more information, see the Oracle Enterprise Manager Administrator's Guide for Software and Server Provisioning and Patching. This guide is available in the Enterprise Manager documentation library at:
http://www.oracle.com/technetwork/indexes/documentation/index.html
Note:
The Management Agent .rpm
file can be obtained using EM CLI only for Linux x86 and Linux x86-64 platforms.
For Enterprise Manager 12c (12.1.0.x), installing a Management Agent by downloading the Management Agent .rpm
file from Oracle Technology Network (OTN) is not supported.
Once the installation is complete, you will see the following default contents in the agent base directory:
<agent_base_directory> |_____core |_____12.1.0.5.0 |_____plugins |_____plugins.txt |_____plugins.txt.status |_____agent_inst |_____sbin |_____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 the Redirecting Oracle Management Agent to Another Oracle Management Service Appendix present in Oracle Enterprise Manager Cloud Control 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.
(For Microsoft Windows hosts) If you upgrade a 12.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 s_agentSrvcName
parameter while installing the Management Agent, as described in Section 6.4.6.
Before you begin installing a Management Agent in silent mode, keep these points in mind:
You can install a Management Agent on only one host at a time by using the silent methods. Therefore, use this approach when you want to install a Management Agent on only a few hosts.
The Management Agent software for the platform of the host on which you want to install a Management Agent must be downloaded and applied, using Self Update. Only the Management Agent software for the OMS host platform is downloaded and applied by default. The Management Agent software contains the core binaries required for installation, the response file to be edited and passed, and the agentDeploy.sh
script (agentDeploy.bat
for Microsoft Windows).
For information on how to download and apply the Management Agent software for a platform using Self Update, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.
In Enterprise Manager Cloud Control 12c Release 5 (12.1.0.5.0), 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 Appendix D.
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 Oracle Enterprise Manager Cloud Control Administration Guide.
From Enterprise Manager Cloud Control 12c Release 5 (12.1.0.5), parallel deployment of Management Agents using the AgentPull.sh
script (AgentPull.bat
for Microsoft Windows) is supported. This enables you to deploy Management Agents on multiple hosts, at the same time (in a parallel manner), using the AgentPull.sh
or AgentPull.bat
script.
If you want to install a Management Agent on a Microsoft Windows host in silent mode, ensure that you execute the AgentPull.bat
or agentDeploy.bat
script from the default command prompt, which is cmd.exe,
and not from any other command prompt.
You cannot run any preinstallation or postinstallation scripts as part of the installation process. You can run them manually before or after the installation.
By default, installing a Management Agent in silent mode 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
Upgrading a lower release of Solaris by applying a kernel patch or a patch bundle is not equivalent to installing the actual Solaris 5.10 Update 9 image. Oracle Management Agent 12c Release 5 (12.1.0.5) was built, tested, and certified on a minimum update version of Solaris 5.10 Update 9, so Oracle recommends that you install Oracle Management Agent only on Solaris 5.10 Update 9, and not on any release that was upgraded using patches.
Before installing a Management Agent in silent mode, ensure that you meet the following prerequisites:
Table 6-1 Prerequisites for Installing Oracle Management Agent in Silent Mode
Requirement | Description |
---|---|
Hardware Requirements |
Ensure that you meet the hard disk space and physical memory requirements. For more information, see the chapter on hardware requirements in the Oracle Enterprise Manager Cloud Control Basic Installation Guide. |
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 Oracle Enterprise Manager Cloud Control Basic Installation Guide. 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 |
|
Ensure that you install all the operating system-specific packages. For more information, see the chapter on package requirements in the Oracle Enterprise Manager Cloud Control Basic Installation Guide. If you choose to install a Management Agent using a
|
|
cURL Utility Requirements (For installing using the |
Ensure that you install the cURL utility on the destination host. You can download the cURL utility from the following URL:
Note: For destination hosts running on Microsoft Windows, Oracle recommends that you install cURL in |
ZIP and UNZIP Utility Requirements |
Ensure that the ZIP and the UNZIP utilities are present on the destination host. The ZIP utility must be of version 3.0 2008 build or higher. The UNZIP utility must be of version 6.0 or higher. |
Ensure that the destination host where you want to install the Management Agent has the appropriate users and operating system groups created. For more information, see the chapter on creating operating system groups and users in the Oracle Enterprise Manager Cloud Control Basic Installation Guide. Note: If your enterprise has a policy against installing Management Agents using the OMS install operating system user account, you can use a different operating system user account to install Management Agents. However, ensure that the user account you use and the OMS install user account belong to the same primary group. |
|
Ensure that the
|
|
Time Zone Requirements |
Ensure that the host time zone has been set correctly. To verify the host time zone, run the following command:
If the time zone displayed is incorrect, run the following commands, before running the
For example, in the Bash shell, run the following command to set the time zone to America/New_York:
To set the time zone on a destination host that runs on Microsoft Windows, from the Start menu, select Control Panel. Click Date and Time, then select the Time Zone tab. Select your time zone from the displayed drop down list. To view a list of the time zones you can use, access the 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 host after installing the Management Agent. For information on setting time zones post install, refer Section 6.5. |
PATH Environment Variable Requirements (For installing using the |
Ensure that the location of For example, if |
Path Validation Requirements |
Validate the path to all command locations. For more information, refer to the appendix on validating command locations in the Oracle Enterprise Manager Cloud Control Basic Installation Guide. |
|
Unset the |
Port Requirements |
Ensure that the default ports described in Section 2.1.10.1 are free. |
Ensure that you allocate 400 MB of space for a temporary directory where the executables can be copied. By default, the temporary directory location set to the environment variable |
|
/var/tmp Requirements (For installing using the |
Ensure that the |
/usr/lib/oracle Requirements (For installing using the |
Ensure that the |
Agent Base Directory Requirements |
Ensure the following:
|
Agent Instance Home Requirements (For installing using the |
Ensure that the agent instance home location you specify in the response file is empty. |
Installing User Requirements |
If the central inventory owner and the user installing the Management Agent are different, then ensure that they are part of the same group, and have read and write permissions on the inventory directory. For example, if the inventory owner is abc and the user installing the Management Agent is xyz, then ensure that abc and xyz belong to the same group, and they have read and write access to the inventory. |
|
|
Agent User Account Permissions and Rights (For installing using the |
(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:
|
(For installing using the |
(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) If you are installing the Management Agent on a Microsoft Windows-based operating system, then ensure that the |
This section describes the actions involved in installing a Management Agent in silent mode. It consists of the following:
Response File Parameters for Installing a Management Agent in Silent Mode Using the AgentPull Script
Response File Parameters for Installing a Management Agent in Silent Mode Using an RPM File
About the Contents of the Downloaded Management Agent Software
Important:
If the OMS host is running on Microsoft Windows, and the OMS software was installed in a drive other thanC:\,
then update the SCRATCH_PATH
variable in $OMS_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
To install a Management Agent using the AgentPull
script, follow these steps:
Important:
To install a Management Agent using the AgentPull script, you do not need to download the Management Agent software onto the destination host. The AgentPull script performs this action automatically.If the destination host runs on UNIX, access the following URL from the host:
https://<OMS_HOST>:<OMS_PORT>/em/install/getAgentImage
If the destination host runs on Microsoft Windows, access the following URL from the host:
https://<OMS_HOST>:<OMS_PORT>/em/install/getAgentImage?script=bat
Save the file as AgentPull.sh
(AgentPull.bat
for Microsoft Windows) to a temporary directory, say /tmp
(c:\temp
for Microsoft Windows).
Note:
You can also use the following command to obtain theAgentPull.sh
script:
curl "https://<OMS_HOST>:<OMS_PORT>/em/install/getAgentImage" --insecure -o AgentPull.sh
To use this command, ensure that you have the cURL utility installed, as described in Table 6-1.
(Only for UNIX Operating Systems) Provide the execute permission to the AgentPull.sh
script by running the following command:
chmod +x <absolute_path_to_AgentPull.sh>
For example, run the command chmod +x /tmp/AgentPull.sh.
Identify the platforms for which the Management Agent software is available on the OMS host. Run the AgentPull.sh
script (AgentPull.bat
for Microsoft Windows) specifying the -showPlatforms
option to display the platforms for which the Management Agent software is available on the OMS host.
<absolute_path_to_AgentPull.sh> -showPlatforms
The following is a sample output of the command.
Platforms Version Linux x86-64 12.1.0.5.0 Microsoft Windows x64 (64-bit) 12.1.0.5.0 IBM AIX on POWER Systems (64-bit) 12.1.0.5.0
If the output lists the platform on which you want to install the Management Agent, then proceed to the next step. Otherwise, acquire and apply the Management Agent software for the required platform using Self Update.
For information on how to acquire and apply the Management Agent software for a platform using Self Update, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.
Note:
If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is available in Software Library.If the destination host runs on UNIX, and the OMS host runs on Microsoft Windows, run the following command:
dos2unix <absolute_path_to_AgentPull.sh>
For example, run the command dos2unix /tmp/AgentPull.sh.
Create a response file (in any location on the destination host) specifying the parameters described in Table 6-2. Ensure that you do not name the response file agent.rsp.
The following are the contents of a sample response file, agent.properties.
LOGIN_USER=sysman LOGIN_PASSWORD=welcome PLATFORM="Linux x86-64" AGENT_REGISTRATION_PASSWORD=wel246come
If you want the script to ignore a particular response file parameter, specify a '#' before the parameter. For example, #VERSION.
Run the AgentPull.sh
script (AgentPull.bat
for Microsoft Windows) specifying the RSPFILE_LOC
and AGENT_BASE_DIR
parameters.
<absolute_path_to_AgentPull.sh> RSPFILE_LOC=<absolute_path_to_responsefile> AGENT_BASE_DIR=<absolute_path_to_agentbasedir>
For example, run the following command:
/tmp/AgentPull.sh RSPFILE_LOC=/tmp/agent.properties AGENT_BASE_DIR=/scratch/agent
The AgentPull.sh
script (and AgentPull.bat)
supports certain options, such as -download_only,
which downloads the Management Agent software, but does not deploy the Management Agent. These supported options are described in Table 6-5.
If you are installing a Management Agent on a Microsoft Windows host using AgentPull.bat,
ensure that you execute AgentPull.bat
from the default command prompt, which is cmd.exe,
and not from any other command prompt.
If the Management Agent install fails, diagnose the problem by viewing the Management Agent install logs. For information on the location of these logs, see Section B.3.
You can install a Management Agent using the agentDeploy.sh
or agentDeploy.bat
script in the following ways:
To install a Management Agent using the agentDeploy
script, and EM CLI from the destination host, follow these steps:
Acquiring the Management Agent Software and Downloading it onto the Destination Host Using EM CLI.
Set up EM CLI on the destination host.
For information on how to set up EM CLI on a host that is not running the OMS, refer the Command Line Interface Concepts and Installation chapter of Oracle Enterprise Manager Command Line Interface.
On the destination host, from the EM CLI install location, log in to EM CLI:
<emcli_install_location>/emcli login -username=<username>
For example,
<emcli_install_location>/emcli login -username=sysman
Specify the password when you are prompted for it.
Note:
Ensure that the EM CLI log in user has theADD_TARGET
privilege.<emcli_install_location>/emcli sync
Identify the platforms for which the Management Agent software is available in Software Library:
<emcli_install_location>/emcli get_supported_platforms
This command lists all the platforms for which the Management Agent software is available in Software Library. The following is the sample output of the command.
--------------------------------------------------- Version = 12.1.0.5.0 Platform Name = Linux x86-64 --------------------------------------------------- Version = 12.1.0.5.0 Platform Name = Oracle Solaris on x86-64 (64-bit) --------------------------------------------------- Version = 12.1.0.5.0 Platform Name = HP-UX PA-RISC (64-bit) ---------------------------------------------------
If the output lists the platform on which you want to install the Management Agent, then proceed to the next step. Otherwise, acquire and apply the Management Agent software for the required platform using Self Update.
For information on how to acquire and apply the Management Agent software for a platform using Self Update, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.
Note:
If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is available in Software Library.Download the Management Agent software from Software Library to a temporary directory on the destination host:
<emcli_install_location>/emcli get_agentimage -destination=<download_directory> -platform="<platform>" -version=<version>
For example,
./emcli get_agentimage -destination=/tmp/agentImage -platform="Linux x86-64" -version=12.1.0.5.0
Important:
If you use theget_agentimage
EM CLI verb to download the Management Agent software for a platform different from the destination host platform, then you must set the ZIP_LOC
environment variable to the location of the ZIP utility. For example, if the ZIP utility is present in /usr/bin/zip,
set ZIP_LOC=usr/bin/zip.
Also, ensure that the ZIP utility is of version 3.0 2008 build or higher.
If you use the get_agentimage
EM CLI verb to download the Management Agent software for a platform different from the OMS host platform, then you must set the ZIP_LOC
environment variable to $OMS_HOME/bin/zip,
that is, the location of the ZIP utility on the OMS host.
Note:
In the command, note the following:-destination
is a directory on the destination host where you want the Management Agent software to be downloaded. Ensure that you have write permission on this location.
-platform
is the platform for which you want to download the software; this must match one of the platforms listed in the previous step for which the software is available in Software Library.
-version
is the version of the Management Agent software that you want to download; this is an optional argument. If you do not pass this argument, then the version is defaulted to the OMS version.
The command downloads the core Management Agent software to the destination directory you entered. For example, for Linux x86-64, you will see the file 12.1.0.5.0_AgentCore_226.zip
. For information on the contents of this core software, see Section 6.4.10.
Installing the Management Agent Using the agentDeploy Script.
On the destination host, extract the contents of the ZIP file using the unzip utility:
unzip <software_zip_file_location> -d <software_extract_location>
For example,
unzip /tmp/agentImage/12.1.0.5.0_AgentCore_226.zip -d /tmp/agtImg
Edit the response file agent.rsp
as described in Table 6-3.
<software_extract_location>/agent.rsp
The following are the contents of a sample response file.
OMS_HOST=example.com EM_UPLOAD_PORT=14511 AGENT_REGISTRATION_PASSWORD=abc123 AGENT_PORT=1832
If you want the script to ignore a particular response file parameter, specify a '#' before the parameter. For example, #AGENT_PORT.
Invoke the deployment script and pass the response file:
<software_extract_location>/agentDeploy.sh AGENT_BASE_DIR=<absolute_path_to_agentbasedir> RESPONSE_FILE=<software_extract_location>/agent.rsp
If a proxy is set up between the destination host and the OMS host, you must specify the REPOSITORY_PROXYHOST
and REPOSITORY_PROXYPORT
parameters in a properties file, then specify the PROPERTIES_FILE
parameter while running agentDeploy.sh
to install a Management Agent on the destination host:
<software_extract_location>/agentDeploy.sh AGENT_BASE_DIR=<absolute_path_to_agentbasedir> RESPONSE_FILE=<absolute_path_to_responsefile> PROPERTIES_FILE=<absolute_path_to_properties_file>
For example, /tmp/agtImg/agentDeploy.sh AGENT_BASE_DIR=/scratch/agent12c RESPONSE_FILE=/tmp/agtImg/agent.rsp PROPERTIES_FILE=/tmp/agent.properties
The properties file you use must have the following format:
REPOSITORY_PROXYHOST=<proxy_host_name> REPOSITORY_PROXYPORT=<proxy_port>
Note:
Instead of passing a response file, you can choose to pass response file parameters explicitly while invoking the deployment script.
The mandatory response file parameters are OMS_HOST
, EM_UPLOAD_PORT
, and AGENT_REGISTRATION_PASSWORD
.
For example,
/tmp/agtImg/agentDeploy.sh AGENT_BASE_DIR=/scratch/agent12c OMS_HOST=example.com EM_UPLOAD_PORT=14511 AGENT_REGISTRATION_PASSWORD=2bornot2b
When you pass the arguments while invoking the deployment script, these values need not be given with double quotes. However, when you provide them in a response file, the values need to be in double quotes (except for the argument b_startAgent
).
In addition to passing the agent base directory and a response file (or individual mandatory arguments with installation details), you can also pass other options that are supported by the deployment script. For more information, see Section 6.4.9.
If you are installing a Management Agent on a Microsoft Windows host using agentDeploy.bat,
ensure that you execute agentDeploy.bat
from the default command prompt, which is cmd.exe,
and not from any other command prompt.
Run the root scripts after the install. For more information, see Section 6.5.
If you want to install a Management Agent on a physical host, and install another Management Agent on a virtual host that is installed on the physical host, ensuring that both the Management Agents use the same port for communication, follow these steps:
Install a Management Agent on the physical host. Stop the Management Agent.
Install a Management Agent on the virtual host. Stop the Management Agent.
Set AgentListenOnAllNICs=false
in the $<AGENT_HOME>/sysman/config/emd.properties
file. Ensure that you perform this step for both the Management Agents.
Start up both the Management Agents.
If the Management Agent install fails, diagnose the problem by viewing the Management Agent install logs. For information on the location of these logs, see Section B.3.
To install a Management Agent using the agentDeploy
script, and EM CLI from the OMS host, follow these steps:
Acquiring the Management Agent Software and Downloading it onto the OMS Host Using EM CLI.
On the OMS host, from the OMS home, log in to EM CLI. EM CLI is available by default with every OMS installation, so you need not install the client separately on the OMS host.
$<OMS_HOME>/bin/emcli login -username=<username>
For example,
$<OMS_HOME>/bin/emcli login -username=sysman
Specify the password when you are prompted for it.
Note:
Ensure that the EM CLI log in user has the ADD_TARGET
privilege.
If you have configured a load balancer for a multiple OMS setup, ensure that you run the EM CLI commands on one of the local OMS hosts, and not on the load balancer hosts.
If you have configured a load balancer for a multiple OMS setup, and you choose to use the EM CLI setup
command, ensure that you pass the OMS host and port as parameters, and not the load balancer host and port.
For example, emcli setup -url=https://<OMS_HOST>:<OMS_PORT>/em -user=sysman -password=sysman
$<OMS_HOME>/bin/emcli sync
Identify the platforms for which the Management Agent software is available in Software Library:
$<OMS_HOME>/bin/emcli get_supported_platforms
This command lists all the platforms for which the Management Agent software is available in Software Library. The following shows the sample output of the command.
--------------------------------------------------- Version = 12.1.0.5.0 Platform Name = Linux x86-64 --------------------------------------------------- Version = 12.1.0.5.0 Platform Name = Oracle Solaris on x86-64 (64-bit) --------------------------------------------------- Version = 12.1.0.5.0 Platform Name = HP-UX PA-RISC (64-bit) ---------------------------------------------------
If the output lists the platform on which you want to install the Management Agent, then proceed to the next step. Otherwise, acquire and apply the Management Agent software for the required platform using Self Update.
For information on how to acquire and apply the Management Agent software for a platform using Self Update, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.
Note:
If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is available in Software Library.Download the Management Agent software from Software Library to a temporary directory on the OMS host:
$<OMS_HOME>/bin/emcli get_agentimage -destination=<download_directory> -platform="<platform>" -version=<version>
For example,
./emcli get_agentimage -destination=/tmp -platform="Linux x86-64" -version=12.1.0.5.0
Important:
If you use theget_agentimage
EM CLI verb to download the Management Agent software for a platform different from the OMS host platform, then you must set the ZIP_LOC
environment variable to $OMS_HOME/bin/zip,
which is the location of the ZIP utility on the OMS host.
If you use the get_agentimage
EM CLI verb to download the Management Agent software for a platform different from the destination host platform, then you must set the ZIP_LOC
environment variable to the location of the ZIP utility. For example, if the ZIP utility is present in /usr/bin/zip,
set ZIP_LOC=usr/bin/zip.
Also, ensure that the ZIP utility is of version 3.0 2008 build or higher.
Note:
In the command, note the following:-destination
is a directory on the OMS host where you want the Management Agent software to be downloaded. Ensure that you have write permission on this location.
If the destination directory is titled with two or more words separated by a space, then enclose the directory name with double quotes.
For example, if the destination directory is titled /tmp/linux agentimage
, then enter the value as -destination="/tmp/linux agentimage"
-platform
is the platform for which you want to download the software; this must match one of the platforms listed in the previous step for which the software is available in Software Library.
-version
is the version of the Management Agent software that you want to download; this is an optional argument. If you do not pass this argument, then the version is defaulted to the OMS version.
The command downloads the core Management Agent software to the destination directory you entered. For example, for Linux x86-64, you will see the file 12.1.0.5.0_AgentCore_226.zip
. For information on the contents of this core software, see Section 6.4.10.
Transferring the Management Agent Software to the Destination Host.
Transfer the downloaded ZIP file to a temporary directory (/tmp
) on the destination host where you want to install the Management Agent. You can use any file transfer utility to transfer the file.
Installing the Management Agent Using the agentDeploy Script.
Follow Step 2 mentioned in Section 6.4.2.1 to install the Management Agent.
To install a Management Agent using a .rpm
file, follow these steps:
On the OMS host, from the OMS home, log in to EM CLI. EM CLI is available by default with every OMS installation, so you need not install the client separately on the OMS host.
$<OMS_HOME>/bin/emcli login -username=<username>
For example,
$<OMS_HOME>/bin/emcli login -username=sysman
Specify the password when you are prompted for it.
Note:
Ensure that the EM CLI log in user has theADD_TARGET
privilege.$<OMS_HOME>/bin/emcli sync
Identify the platforms for which the Management Agent software is available in Software Library:
$<OMS_HOME>/bin/emcli get_supported_platforms
This command lists all the platforms for which the Management Agent software is available in Software Library. The following is the sample output of the command.
--------------------------------------------------- Version = 12.1.0.5.0 Platform Name = Linux x86-64 --------------------------------------------------- Version = 12.1.0.5.0 Platform Name = Oracle Solaris on x86-64 (64-bit) --------------------------------------------------- Version = 12.1.0.5.0 Platform Name = HP-UX PA-RISC (64-bit) ---------------------------------------------------
If the output lists the platform on which you want to install the Management Agent, then proceed to the next step. Otherwise, acquire and apply the Management Agent software for the required platform using Self Update.
For information on how to acquire and apply the Management Agent software for a platform using Self Update, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.
Note:
If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is available in Software Library.Download the .rpm
file of the Management Agent from Software Library to a temporary directory on the OMS host:
$<OMS_HOME>/bin/emcli get_agentimage_rpm -destination=<download_directory> -platform="<platform>" -version=<version>
For example,
./emcli get_agentimage_rpm -destination=/tmp/agentRPM -platform="Linux x86-64" -version=12.1.0.5.0
In the command, note the following:
-destination
is a directory on the OMS host where you want the .rpm
file to be downloaded. Ensure that you have write permission on this location.
-platform
is the platform for which you want to download the .rpm
file; this must match one of the platforms listed in the previous step for which the software is available on the OMS host.
-version
is the version of the Management Agent for which you want to download the .rpm
file; this is an optional argument. If you do not pass this argument, then the version is defaulted to the OMS version.
The command downloads the .rpm
file of the core Management Agent to the destination directory you entered. For example, oracle-agt-12.1.0.5.0-1.0.i386.rpm
Also, this command retrieves the Management Agent software, patches, and plug-ins present in the OMS home. For information on how to save Management Agent patches to the OMS home such that they are applied whenever a Management Agent is deployed, see Section D.1.
Transfer the downloaded .rpm
file to a temporary directory (/tmp)
on the destination host where you want to install the Management Agent. You can use any file transfer utility to transfer the file.
On the destination host, install the .rpm
file as a root user to install the Management Agent:
rpm -ivh <download_directory>/<rpm_file>
For example,
rpm -ivh /tmp/oracle-agt-12.1.0.5.0-1.0.i386.rpm
Note:
The following is the output of the command:Preparing... ########################################### [100%] Running the prereq 1:oracle-agt ########################################### [100%] Follow the below steps to complete the agent rpm installation: 1. Edit the properties file: /usr/lib/oracle/agent/agent.properties with the correct values 2. Execute the command /etc/init.d/oracle-agt RESPONSE_FILE=<location_to_agent.properties>
When you use a .rpm
file to install a Management Agent, the default agent base directory location is /usr/lib/oracle/agent.
To install the Management Agent using a custom agent base directory location, run the following command as a root user:
rpm -ivh --relocate /usr/lib/oracle/agent=<custom_agent_base_directory_location> <download_directory>/<rpm_file>
For example,
rpm -ivh --relocate /usr/lib/oracle/agent=/scratch/aime/agent tmp/agent_rpm/oracle-agt-12.1.0.5.0-1.0.i386.rpm
When you use a .rpm
file to install a Management Agent, the inventory location is always <agent_base_directory>/oraInventory.
As the default agent base directory location is /usr/lib/oracle/agent,
the default inventory location is /usr/lib/oracle/agent/oraInventory.
If you choose to install the Management Agent in a custom agent base directory location (using the --relocate
option), say in /oem/agent,
then the inventory location is /oem/agent/oraInventory.
Edit the agent.properties
file as described in Table 6-4. The file is available in the following location:
/usr/lib/oracle/agent/agent.properties
Run the following command to complete the installation:
/etc/init.d/oracle-agt RESPONSE_FILE=<location_to_agent.properties>
If the Management Agent install fails, diagnose the problem by viewing the Management Agent install logs. For information on the location of these logs, see Section B.3.
To install a Management Agent on a virtual host, follow these steps:
Follow the steps described in Section 6.4.2.1 or Section 6.4.2.2. While invoking the agentDeploy.sh
or the agentDeploy.bat
script, ensure that you specify the ORACLE_HOSTNAME
parameter.
For example, <software_extract_location>/agentDeploy.sh AGENT_BASE_DIR=<absolute_path_to_agentbasedir> RESPONSE_FILE=<absolute_path_to_response_file> ORACLE_HOSTNAME=<name_of_virtual_host>
For more information about the ORACLE_HOSTNAME
parameter, see Table 6-3.
If the virtual host is associated with a virtual Network Interface Controller (NIC), set AgentListenOnAllNICs=false
in the $<AGENT_HOME>/sysman/config/emd.properties
file, then run the following command:
$<AGENT_HOME>/bin/emctl reload
Table 6-2 describes the mandatory parameters that you must include, and the optional parameters that you can include in the response file, while installing a Management Agent using the AgentPull
script.
Table 6-2 Creating a Response File for Installing Oracle Management Agent Using AgentPull Script
Parameter | Description |
---|---|
LOGIN_USER |
(Mandatory) Enter the Enterprise Manager console login user name. For example, |
LOGIN_PASSWORD |
(Mandatory) Enter the Enterprise Manager console login password. For example, |
PLATFORM |
(Mandatory) Enter the platform for which you want to download the Management Agent software. For example, Note: The value of this parameter must be in " ". |
AGENT_REGISTRATION_PASSWORD |
(Mandatory) Enter a password for registering new Management Agents that join the Enterprise Manager system. By default, the communication between the OMS and the Management Agents is secured and locked. Any new Management Agents that join the Enterprise Manager system must be authenticated before they become part of the system. The password you enter here will be used for authenticating those new Management Agents. For example, |
VERSION |
(Optional) Enter the version of the Management Agent software you want to download. For example, If you do not specify this parameter, it is assigned the OMS version. |
CURL_PATH (For Microsoft Windows hosts only) |
(Optional) Enter the absolute path of the installed cURL utility. For example, If you do not include this parameter, it is assigned the value |
OMS_HOST |
(Optional) Enter the OMS host name. For example, |
EM_UPLOAD_PORT |
(Optional) Enter the upload port (HTTP or HTTPS) for communicating with the OMS. For example, |
AGENT_INSTANCE_HOME |
(Optional) Enter a directory location on the destination host where all Management Agent-related configuration files can be stored. For this parameter, you can do one of the following:
|
AGENT_PORT |
(Optional) Enter a free port on which the Management Agent process should be started. The same port is used for both HTTP and HTTPS. For example, If you do not enter any value, then either 3872 or any free port between 1830 and 1849 is honored. |
b_startAgent |
(Optional) Enter For example, If you do not include this parameter, it defaults to |
ORACLE_HOSTNAME |
(Optional) Enter the fully qualified domain name of the host where you want to install the Management Agent. For example, If you do not include this parameter, it defaults to the physical host name. |
ALLOW_IPADDRESS |
(Optional) Enter For example, If you do not include this parameter, it defaults to |
START_PRIORITY_LEVEL (For Unix based hosts only) |
(Optional) Use this parameter to specify the priority level of the Management Agent service when the host is started. This parameter accepts values between For example, If you do not include this parameter, it defaults to |
SHUT_PRIORITY_LEVEL (For Unix based hosts only) |
(Optional) Use this parameter to specify the priority level of the Management Agent service when the host is shut down. This parameter accepts values between For example, If you do not include this parameter, it defaults to |
PROPERTIES_FILE |
(Optional) Use this parameter to specify the absolute location of the properties file. For example, In the properties file, specify the parameters that you want to use for the Management Agent deployment. The list of parameters that you can specify in the properties file is present in
The properties file does not support parameter values that have spaces. If the value of a particular parameter contains a space, then run the following command after deploying the Management Agent:
|
s_agentHomeName |
(Optional) Enter the name of the Oracle home you want to see created for the Management Agent. For example, If you do not include this parameter, it defaults to Note: Ensure that the name you enter consists of only alphanumeric characters, and is not more than 128 characters long. |
s_agentSrvcName (Only for Microsoft Windows hosts) |
(Optional) Enter the customized Management Agent service name. For example, If you do not include this parameter, it defaults to Oracle+<oracle_home_name>+Agent. Note: (For Microsoft Windows hosts) If you upgrade a 12.1.0.x Management Agent installed on a host and you want to install another Management Agent on the same host, which points to a different OMS, specify the |
Table 6-3 describes the mandatory parameters that you must include, and the optional parameters that you can include in the response file, while installing a Management Agent using the agentDeploy
script.
Table 6-3 Creating a Response File for Installing Oracle Management Agent Using agentDeploy Script
Parameter | Description |
---|---|
OMS_HOST |
(Mandatory) Enter the OMS host name. For example, |
EM_UPLOAD_PORT |
(Mandatory) Enter the upload port (HTTP or HTTPS) for communicating with the OMS. For example, |
AGENT_REGISTRATION_PASSWORD |
(Mandatory) Enter a password for registering new Management Agents that join the Enterprise Manager system. By default, the communication between the OMS and the Management Agents is secured and locked. Any new Management Agents that join the Enterprise Manager system must be authenticated before they become part of the system. The password you enter here will be used for authenticating those new Management Agents. For example, |
AGENT_INSTANCE_HOME |
(Optional) Enter a directory location on the destination host where all Management Agent-related configuration files can be stored. For this parameter, you can do one of the following:
|
AGENT_PORT |
(Optional) Enter a free port on which the Management Agent process should be started. The same port is used for both HTTP and HTTPS. For example, If you do not enter any value, then either 3872 or any free port between 1830 and 1849 is honored. |
b_startAgent |
(Optional) Enter For example, If you do not include this parameter, it defaults to |
ORACLE_HOSTNAME |
(Optional) Enter the fully qualified domain name of the host where you want to install the Management Agent. For example, If you do not include this parameter, it defaults to the physical host name. |
ALLOW_IPADDRESS |
(Optional) Enter For example, If you do not include this parameter, it defaults to |
START_PRIORITY_LEVEL (For Unix based hosts only) |
(Optional) Use this parameter to specify the priority level of the Management Agent service when the host is started. This parameter accepts values between For example, If you do not include this parameter, it defaults to |
SHUT_PRIORITY_LEVEL (For Unix based hosts only) |
(Optional) Use this parameter to specify the priority level of the Management Agent service when the host is shut down. This parameter accepts values between For example, If you do not include this parameter, it defaults to |
PROPERTIES_FILE |
(Optional) Use this parameter to specify the absolute location of the properties file. For example, In the properties file, specify the parameters that you want to use for the Management Agent deployment. The list of parameters that you can specify in the properties file is present in
The properties file does not support parameter values that have spaces. If the value of a particular parameter contains a space, then run the following command after deploying the Management Agent:
|
s_agentHomeName |
(Optional) Enter the name of the Oracle home you want to see created for the Management Agent. For example, If you do not include this parameter, it defaults to Note: Ensure that the name you enter consists of only alphanumeric characters, and is not more than 128 characters long. |
s_agentSrvcName (Only for Microsoft Windows hosts) |
(Optional) Enter the customized Management Agent service name. For example, If you do not include this parameter, it defaults to Oracle+<oracle_home_name>+Agent. Note: (For Microsoft Windows hosts) If you upgrade a 12.1.0.x Management Agent installed on a host and you want to install another Management Agent on the same host, which points to a different OMS, specify the |
Table 6-4 describes the mandatory parameters that you must include, and the optional parameters that you can include in the response file, while installing a Management Agent using a.rpm
file.
Table 6-4 Creating a Response File for Installing Oracle Management Agent Using an RPM File
Parameter | Description |
---|---|
OMS_HOST |
(Mandatory) Enter the host name of the OMS to which you want to connect. For example, |
OMS_PORT |
(Mandatory) Enter the upload port (HTTP or HTTPS) to communicate with the OMS. For example, |
AGENT_REGISTRATION_PASSWORD |
(Mandatory) Enter a password for registering new Management Agents that join the Enterprise Manager system. By default, the communication between the OMS and the Management Agents is secured and locked. Any new Management Agents that join the Enterprise Manager system must be authenticated before they become part of the system. The password you enter here will be used for authenticating those new Management Agents. For example, |
AGENT_USERNAME |
(Mandatory) Enter the user name with which you want to install the Management Agent. For example, |
AGENT_GROUP |
(Mandatory) Enter the group to which the Management Agent user should belong. For example, |
AGENT_PORT |
(Optional) Enter the port used for the Management Agent process. For example, If you do not enter any value, then either 3872 or any free port between 1830 and 1849 is honored. |
ORACLE_HOSTNAME |
(Only for Virtual Hosts) Enter the virtual host name where you want to install the Management Agent. For example, |
Table 6-5 lists the options supported by the AgentPull.sh
script. On Microsoft Windows, these options apply to the AgentPull.bat
file.
Table 6-5 Understanding the Options Supported by AgentPull.sh/AgentPull.bat
Option | Description |
---|---|
-download_only |
Only downloads the Management Agent software. Does not deploy the Management Agent. |
-showPlatforms |
Displays the platforms for which the Management Agent software is available on the OMS host. Does not install the Management Agent. |
-help |
Displays command line help and describes the usage of the |
Table 6-6 lists the options supported by the agentDeploy.sh
script. On Microsoft Windows, these options apply to the agentDeploy.bat
file.
Table 6-6 Understanding the Options Supported by agentDeploy.sh/agentDeploy.bat
Option | Description |
---|---|
-prereqOnly |
Runs only the prerequisite checks. Does NOT actually install the Management Agent. This option is useful when you want to verify whether your environment meets all the prerequisites for a successful Management Agent installation. |
-ignorePrereqs |
Skips running the prerequisite checks. Use this when you have already used the |
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:
|
-help |
Displays command line help and describes the usage of the deployment script. |
-debug |
Logs more debug messages useful for debugging and resolving errors. |
-ignoreUnzip |
Skips extracting the software binaries of the Management Agent software. Use this when you do not want to copy the binaries again, but only want to configure the available binaries. |
-softwareOnly |
Installs only the software binaries, and does NOT configure the installation. Use this when you want to perform a software-only installation of the Management Agent. For more information, see Chapter 9. Note: This option does not apply if you are cloning using a ZIP file. |
-configOnly |
Configures the software binaries, and does not install any software binaries. Use this when you have performed a software-only installation using the Note: This option does not apply if you are cloning using a ZIP file. |
-forceConfigure |
Forcefully configures the Management Agent even when the OMS is unreachable. Use this option only when you are installing the Management Agent before installing the OMS, and when you know for sure that you will install the OMS later on the same host and port mentioned for the parameters If you pass this option, then do not pass -configOnly, -softwareOnly, and -prereqOnly. Note: When you pass this option, the Management Agent is configured to use HTTP (non-secure) communication. To establish a secure HTTPS communication between the Management Agent and the OMS, you must manually secure the Management Agent after the OMS is available. |
Table 6-7 describes the contents of the core Management Agent software you download before installing the Management Agent using the agentDeploy
script.
Table 6-7 Contents of the Downloaded Management Agent Software
Files | Description |
---|---|
12.1.0.5.0_PluginsOneoffs_<platform id>.zip |
Plug-in ZIP file containing all the discovering plug-ins, which were installed with the OMS, Oracle Home discovery plug-in, and Oracle Home monitoring plug-in. |
agentcoreimage.zip |
Archived ZIP file containing the core agent bits and agent set-uid binaries. |
agentDeploy.sh/agentDeploy.bat |
Script used for deploying the Management Agent. |
unzip |
Utility used for unarchiving the ZIP files. |
agentimage.properties |
Properties file used for getting the version, platform ID, and so on. |
agent.rsp |
Response file to be edited and passed for installing the Management Agent. |
If you choose to install a Management Agent using the .rpm
file, the .rpm
file you download contains an agent base directory. Table 6-8 describes the contents of this agent base directory:
Table 6-8 Contents of the Agent Base Directory Present in RPM File
Element | Description |
---|---|
core/12.1.0.5.0 |
Contains the Management Agent software. |
sbin |
Contains the Management Agent binaries. |
plugins.txt |
Response file specifying the plug-ins deployed on the Management Agent. |
plugins |
Contains the plug-in software. |
agentimage.properties |
Properties file used for getting the version, platform ID, and so on. |
agent.properties |
Response file to be edited and passed for installing the Management Agent. |
oracle-agt |
Management Agent configuration script. |
After you install the Management Agent, follow these steps:
(Only for UNIX Operating Systems) Manually run the following scripts as a root user:
If this is the first Oracle product you just installed on the host, then run the orainstRoot.sh
script from the inventory location specified in the oraInst.loc
file that is available in the Management Agent home. This location is also displayed when you run the agentDeploy
script with the -configOnly
option.
For example, if the inventory location specified is $HOME/oraInventory
, then run the following command:
$HOME/oraInventory/orainstRoot.sh
Run the root.sh
script from the Management Agent home:
$<AGENT_HOME>/root.sh
Note:
You do not need to run theorainstRoot.sh
and root.sh
scripts if you are installing a Management Agent using a .rpm
file.Navigate to the Management Agent home and run the following command to see a message that confirms that the Management Agent is up and running:
$<AGENT_INSTANCE_HOME>/bin/emctl status agent
Navigate to the Management Agent home and run the following command to see a message that confirms that EMD upload completed successfully:
$<AGENT_INSTANCE_HOME>/bin/emctl upload agent
Verify whether all the plug-ins listed in $<AGENT_BASE_DIRECTORY>/plugins.txt
were installed successfully. To do so, run the following command:
$<AGENT_INSTANCE_HOME>/bin/emctl listplugins agent -type all
If you had ignored a prerequisite check warning about wrong time zone settings, run the following command and follow the steps it displays:
$<AGENT_INSTANCE_HOME>/bin/emctl resetTZ agent
By default, the host and the Management Agent get automatically added to the Enterprise Manager Cloud Control console for monitoring. None of the targets running on that host get automatically discovered and monitored.
To monitor the other targets, you must add them to Enterprise Manager Cloud Control either using the Auto Discovery Results page, the Add Targets Manually page, or the discovery wizards offered for the targets you want to monitor.
For information about discovering targets in Enterprise Manager Cloud Control, refer to the chapter on adding targets in the Oracle Enterprise Manager Cloud Control Administrator's Guide.
Note:
If 12c (12.1.0.x) Management Agents hang frequently or do not respond on Solaris 9ux and 10ux operating systems, then refer to document ID 1427773.1 on My Oracle Support.
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 for HOME NAME="agent12c2".
The value of the LOC
parameter denotes the Management Agent Oracle home.
For example, in the following line of C:\Program Files\Oracle\inventory.xml,
D:\agent12cr4\core\12.1.0.5.0
denotes the Management Agent Oracle home:
<HOME NAME="agent12c2" LOC="D:\agent12cr4\core\12.1.0.5.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 the Redirecting Oracle Management Agent to Another Oracle Management Service Appendix present in Oracle Enterprise Manager Cloud Control 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.