Oracle® Enterprise Manager Cloud Control Advanced Installation and Configuration Guide 12c Release 1 (12.1.0.1) Part Number E24089-01 |
|
|
PDF · Mobi · ePub |
This chapter describes how you can install Oracle Management Agent (Management Agent) in silent mode. In particular, this section covers the following:
Installing a Management Agent in silent mode is only an alternative to installing it using the Add Host Target Wizard. While the Add Host Target Wizard requires you to use its GUI-rich interview screens for providing all the installation details, the silent mode requires you to use a response file for providing the installation details and a deployment script (agentDeploy.sh
) for silently installing the Management Agent using the information supplied in the response file.
The response file and the deployment script are available as part of the Management Agent software. Instead of creating a response file, you can also choose to pass the values as separate arguments while invoking the deployment script.
Installing in silent mode is best suited when you want to install an additional Management Agent on a destination host, from the destination host itself, and without using the Add Host Target Wizard in the Enterprise Manager Cloud Control console.
Once the installation is complete, you will see the following default contents in the installation base directory:
<installation_base_directory> |_____core |_____12.1.0.1.0 |_____plugins |_____plugins.txt |_____plugins.txt.status |_____agent_inst |_____sbin |_____agentimage.properties
Before you begin installing a Management Agent, keep these points in mind:
Before installing the Management Agent, you must procure the Management Agent software from the OMS host and transfer it to the destination host for installation. The Management Agent software you procure contains the core binaries required for installation, the response file to be edited and passed, and the agentDeploy.sh
script.
By default, the OMS host contains the Management Agent software for the platform on which the OMS is running. For example, if the OMS host is Linux x86, then the Management Agent software available by default is only for Linux x86.
If you want to install the Management Agent on a platform that is different from the one on which the OMS is running, then download the software for the desired platform using the Self Update console.
For information on Self Update and how you can use it to download the software, see the chapter on Self Update in the Oracle Enterprise Manager Cloud Control Administrator's Guide.
You can run the agentDeploy.sh
script only from the destination host.
You can install only on one host at a time using the agentDeploy.sh
script, therefore use this approach when you want to install only on a few hosts.
You can provide the installation details either in a response file or as values for individual arguments that can be passed while invoking the agentDeploy.sh
script. However, Oracle recommends that you create a response file and capture the information there.
You can install even if the OMS is unreachable. In this case, you must pass the special option -forceConfigure
while invoking the agentDeploy.sh
script. For more information, see Table 5-3.
Typically, you will use this option only when you are installing the Management Agent before installing the OMS, and you know for sure that you will install the OMS later on the host and port mentioned in the response file.
However, do not pass the option -forceConfigure
when installing the Management Agent using software-only method as described in Chapter 9.
You cannot run any preinstallation or postinstallation scripts as part of the installation process. Of course, you can run manually them after the installation ends.
By default, the agentDeploy.sh
script 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 not install two Management Agents on the same host. This disrupts the communication with the OMS.
Before installing the Management Agent, ensure that you meet the following prerequisites.
Table 5-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. |
Software Requirements |
(For Microsoft Windows) Ensure that you have installed Cygwin on the destination host. For more information, see the chapter on installing Cygwin 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 this matrix, follow these steps:
|
|
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. |
|
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. |
|
Ensure that the
|
|
(Only for UNIX) Ensure that you have SUDO privileges to invoke |
|
(For Microsoft Windows) On the destination host, ensure that the cygwin software location appears before other software locations in the |
|
Path Validation Requirements |
Validate the path to all command locations. For more information, see the appendix on validating command locations in the Oracle Enterprise Manager Cloud Control Basic Installation Guide. |
Port Requirements |
Ensure that the default ports described in What Default Ports Are Used? 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 |
|
Installation Base Directory Requirements |
Ensure that the installation base directory is empty. Ensure that the installing user owns the installation base directory. Ensure that the installer user or the root user owns all the parent directories. Ensure that the root user owns the root directory. For example, if the installation base directory is |
Agent Instance Home Requirements |
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. Also ensure that the inventory owner and the group to which the owner belongs 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 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:
|
(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: |
To install a Management Agent in silent mode, follow these steps:
On the OMS host, from the OMS home, log in to the EMCLI client. EMCLI Client is available by default with every OMS installation, so you need not install the client separately.
$<OMS_HOME>/bin/emcli login -username=sysman -password=<password>
For example,
$<OMS_HOME>/bin/emcli login -username=sysman -password=2benot2be
Note:
The user name must always besysman
. Do not enter any other user name.$<OMS_HOME>/bin/emcli sync
Identify the platforms for which the Management Agent software is available on the OMS host:
$<OMS_HOME>/bin/emcli get_supported_platforms
This command lists all the platforms for which the Management Agent software is available on the OMS host. Example 5-1 shows a sample output of the command.
Example 5-1 Output Showing Software Availability for Different Platforms
--------------------------------------------------- Version = 12.1.0.1.0 Platform Name = Linux x86 --------------------------------------------------- Version = 12.1.0.1.0 Platform Name = Oracle Solaris on x86-64 (64-bit) --------------------------------------------------- Version = 12.1.0.1.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, download the software for the required platform using the Self Update console.
For information on Self Update and how you can use it to download the software, see the chapter on Self Update in the Oracle Enterprise Manager Cloud Control Administrator's Guide.
Download the Management Agent software from Oracle 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" -version=12.1.0.1.0
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 on the OMS host.
-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, you will see the file 12.1.0.1.0_AgentCore_46.zip
. For information on the contents of this core software, see Understanding the Contents of the Downloaded Management Agent Software.
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 FTP software to transfer the file. For example, FileZilla.
On the destination host, extract the contents of the ZIP file using the unzip utility:
unzip /tmp/<software_zip_file> -d <software_extract_location>
For example,
unzip /tmp/12.1.0.1.0_AgentCore_46.zip -d /tmp/agtImg
Edit the response file agent.rsp
as described in Table 5-2.
<software_extract_location>/agent.rsp
Invoke the deployment script and pass the response file:
<software_extract_location>/agentDeploy.sh AGENT_BASE_DIR=<absolute_path_to_agentbasedir> RESPONSE_FILE=<absolute_path_to_responsefile>
Note:
Instead of creating a response file, if you choose to pass all the arguments explicitly while invoking the deployment script.
However, the mandatory ones are OMS_HOST
, EM_UPLOAD_PORT
, and AGENT_REGISTRATION_PASSWORD
.
For example,
/tmp/agtImg/agentDeploy.sh AGENT_BASE_DIR=/scratch/agent12c OMS_HOST=my.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 Understanding the Options Supported by agentDeploy.sh Script.
Run the root scripts when you are prompted. For more information, see After You Install.
Table 5-2 describes the various parameters you must include in the response file.
Table 5-2 Creating a Response File for Installing Oracle Management Agent in Silent Mode
Parameter | Description |
---|---|
OMS_HOST |
Enter the OMS host name. For example, |
EM_UPLOAD_PORT |
Enter the upload port (HTTP or HTTPS) for communicating with the OMS. For example, |
AGENT_REGISTRATION_PASSWORD |
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 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 |
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 |
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 |
Enter For example, |
ORACLE_HOSTNAME |
Enter the fully qualified domain name of the host where you want to install the agent. For example, |
s_agentHomeName |
Enter the name of the Oracle home you want to see created for the Management Agent. For example, |
s_agentServiceName |
Enter the customized Management Agent service name. If you leave this field blank, then it gets defaulted to Oracle+<oracle_home_name>+Agent. |
Table 5-3 lists the options supported by the agentDeploy.sh
script.
Table 5-3 Understanding the Options Supported by agentDeploy.sh Script
Options | 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 |
-invPtrLoc |
Considers the Oracle Inventory directory for storing inventory details. Enter the absolute path to the Important: If you enter a value for this option, do NOT use the |
INVENTORY_LOCATION |
Considers the Oracle Inventory directory for storing inventory details. Enter the absolute path to the 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 5-4 describes the contents of the core Management Agent software you download before installing the Management Agent.
Table 5-4 Contents of the Downloaded Management Agent Software
Files | Description |
---|---|
12.1.0.1.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 |
Shell 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. |
After you install the Management Agent, follow these steps:
(Only for UNIX Operating Systems) When prompted, manually run the following scripts as a root user. If you do not have SUDO privileges, then request your Administrator who has the privileges to run these scripts.
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.
For example, if the inventory location specified in the oraInst.loc
file is $HOME/oraInventory
, then run the following command:
$HOME/oraInventory/oraInstRoot.sh
Note:
If you are not a root user, then use SUDO to change to a root user. For example, run the following command:/usr/local/bin/sudo $HOME/oraInventory/oraInstRoot.sh
Run the root.sh
script from the Management Agent home:
$<AGENT_HOME>/root.sh
Note:
If you are not a root user, then use SUDO to change to a root user. For example, run the following command:/usr/local/bin/sudo $<AGENT_HOME>/root.sh
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:
$<INSTANCE_HOME>/bin/emctl status agent
Note:
If the status of the Management Agent is down for some reason, then manually start the Management Agent by running the following command from its Oracle home:$<INSTANCE_HOME>/bin/emctl start agent
Navigate to the Management Agent home and run the following command to see a message that confirms that EMD upload completed successfully:
$<INSTANCE_HOME>/bin/emctl upload agent
Verify if all the plug-ins were installed successfully. To do so, access the following log file from the Management Agent home, and search for the sentence WARN:Plugin configuration has failed.
$<AGENT_HOME>/cfgtoollogs/cfgfw/CfmLogger-<timestamp>.log
If you find the sentence, resolve the issue by running the AgentPluginDeploy.pl
script from the Management Agent home. In this command, all <AGENT_HOME>
references refer to the Management Agent home.
$<AGENT_HOME>/perl/bin/perl <AGENT_HOME>/bin/AgentPluginDeploy.pl -oracleHome <AGENT_HOME> -agentDir <AGENT_BASE_DIR> -pluginIdsInfoFile <AGENT_BASE_DIR>/plugins.txt -action configure -emStateDir <AGENT_INSTANCE_HOME>
For example,
/home/john/programs/oracle/EMGC_Main_20SH/agent/core/12.1.0.1.0/perl/bin/perl /home/john/programs/oracle/EMGC_Main_20SH/agent/core/12.1.0.1.0/bin/AgentPluginDeploy.pl -oracleHome /home/john/programs/oracle/EMGC_Main_20SH/agent/core/12.1.0.1.0 -agentDir /home/john/programs/oracle/EMGC_Main_20SH/agent -pluginIdsInfoFile /home/john/programs/oracle/EMGC_Main_20SH/agent/core/12.1.0.1.0/sysman/install/plugins.txt -action configure -emStateDir /home/john/programs/oracle/EMGC_Main_20SH/agent/agent_inst
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 need to 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.