Skip Headers
Oracle® Enterprise Manager Cloud Control Advanced Installation and Configuration Guide
12c Release 1 (12.1.0.1)
E24089-15
  Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
 

5 Installing Oracle Management Agent in Silent Mode

This chapter describes how you can install Oracle Management Agent (Management Agent) in silent mode. In particular, this section covers the following:

Overview

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 or agentDeploy.bat on Windows) 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 agent base directory:

<agent_base_directory>
    |_____core
         |_____12.1.0.1.0
    |_____plugins
    |_____plugins.txt
    |_____plugins.txt.status
    |_____agent_inst
    |_____sbin
    |_____agentimage.properties

Note:

If you want to move your Management Agents from one Enterprise Manager Cloud Control to another, then you must first deinstall those Management Agents and plug-ins, and then redeploy those Management Agents and plug-ins using the new Oracle Management Service. This is typically done when you want to move from an Enterprise Manager Cloud Control in a test environment to an Enterprise Manager Cloud Control in a production environment.

Before You Begin

Before you begin installing a Management Agent, keep these points in mind:

Prerequisites

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.

Operating System Requirements

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:

  1. Log in to My Oracle Support, and click the Certifications tab.

  2. On the Certifications page, in the Certification Search region, from the Product list, select Enterprise Manager Cloud Control.

  3. From the Release list, select 12.1.0.1.0, and click Search.

    Note: If you use Oracle Solaris 10, then ensure that you have update 9 or higher installed. To verify whether it is installed, run the following command:

    cat /etc/release

    You should see the output similar to the following. Here, s10s_u6 indicates that update 6 is already installed.

    Solaris 10 10/08 s10s_u6wos_07b SPARC

Package 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.

User and Operating System Group Requirement

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.

/etc/hosts File Requirements

Ensure that the /etc/hosts file on the host has the IP address, the fully qualified name, and the short name in the following format:

172.16.0.0 example.com mypc

Time Zone Requirements

Ensure that the host time zone has been set correctly. To verify the host time zone, run the following command:

echo $TZ

If the time zone displayed is incorrect, run the following commands, before running the agentDeploy.sh or agentDeploy.bat scripts, to set the correct time zone:

  • For Korn shell:

    TZ=<value>

    export TZ

  • For Bourne shell or Bash shell:

    export TZ=<value>

  • For C shell:

    setenv TZ <value>

For example, in the Bash shell, run the following command to set the time zone to America/New_York:

export TZ='America/New_York'

The time zones you can use are listed in <AGENT_HOME>/sysman/admin/supportedtzs.lst.

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 After You Install.

SUDO Requirements

(Only for UNIX) Ensure that you have SUDO privileges to invoke /bin/sh as root.

PATH Environment Variable Requirements

(For Microsoft Windows) On the destination host, ensure that the cygwin software location appears before other software locations in the PATH environment variable. After making it the first entry, restart the SSH daemon (sshd) on both the hosts.

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.

CLASSPATH Environment Variable Requirements

Unset the CLASSPATH environment variable. You can always reset the variable to the original value after the installation is complete.

Port Requirements

Ensure that the default ports described in What Default Ports Are Used? are free.

Temporary Directory Space Requirements

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 TMP or TEMP is honored. If both are set, then TEMP is honored. If none of them are set, then the following default values are honored: /tmp on UNIX hosts and c:\Temp on Microsoft Windows hosts.

Agent Base Directory Requirements

Ensure that the agent base directory is empty.

Ensure that the directory name does not contain any spaces.

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 /scratch/OracleHomes/agent, and oracle is the installing user, then the /scratch/OracleHomes/agent directory must be owned by oracle, directories scratch and OracleHomes must be owned by either oracle or root user, and the root directory (/) must be owned by root user.

If the agent base directory is mounted, then ensure that it is mounted with the setuid turned on.

Agent Instance Home Requirements

Ensure that the agent instance home location you specify in the response file is empty.

Permission Requirements

  • Ensure that the agent base directory is empty, and ensure that you (in fact, all users accessing the agent base directory) have read and execute permission on all the directories that lead up to the agent base directory.

    For example, if the agent base directory is /home/john/oracle/software/agent/, then you must have read and execute permissions on all the directories, mainly home, john, oracle, software, and agent.

  • Ensure that you have write permission in the agent instance home.

  • Ensure that you have write permission in the temporary directory.

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.

Central Inventory (oraInventory) Requirements

  • Ensure that you allocate 100 MB of space for the Central Inventory.

  • Ensure that the Oracle Inventory (oraInventory) is not in a shared location. When you use the /etc/oraInst.loc file, ensure that the inventory location specified there is not pointing to a shared location. If it is, change it to a non-shared location by following the instructions outlined in My Oracle Support note 1092645.1.

  • Ensure that you have read, write, and execute permissions on oraInventory on all remote hosts.

    If you do not have these permissions on the default inventory (typically in the location mentioned in the /etc/oraInst.loc file) on any remote host, then ensure that you enter the path to an alternative inventory location using the INVENTORY_LOCATION or -invPtrLoc arguments as described in Table 5-3. Note that these parameters are supported only on UNIX platforms, and not on Microsoft Windows platforms.

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:

  • Act as part of the operating system.

  • Increase quotas.

  • Replace process level token.

  • Log in as a batch job.

To verify whether the agent user has these rights, follow these steps:

  1. Launch the Local Security Settings.

    From the Start menu, click Settings and then select Control Panel. From the Control Panel window, select Administrative Tools, and from the Administrative Tools window, select Local Security Settings.

  2. In the Local Security Settings window, from the tree structure, expand Local Policies, and then expand User Rights Assignment.

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 Cmd.exe program Read and Execute permissions for the user account that the batch job runs under. This is a restriction from Microsoft.

For more information on this restriction and to understand how you can grant these permissions, access the following URL to Microsoft Web site:

http://support.microsoft.com/kb/867466/en-us


Installation Procedure

To install a Management Agent in silent mode, follow these steps:

  1. 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 be sysman. Do not enter any other user name.

  2. Synchronize EMCLI:

    $<OMS_HOME>/bin/emcli sync

  3. 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.

  4. 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.

  5. 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.

  6. 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

  7. Edit the response file agent.rsp as described in Table 5-2.

    <software_extract_location>/agent.rsp

  8. 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=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 (agentDeploy.bat).


  9. Run the root scripts when you are prompted. For more information, see After You Install.


Note:

Despite a successful installation, if you see some exceptions in the prerequisite error file, you can ignore the exception trace. This issue might happen when an operation attempts to retrieve an element from a collection using a key that does not exist in that collection. You can ignore this exception.

Creating a Response File

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, OMS_HOST="example.com"

EM_UPLOAD_PORT

Enter the upload port (HTTP or HTTPS) for communicating with the OMS.

For example, EM_UPLOAD_PORT="14511"

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_REGISTRATION_PASSWORD="Wel456come"

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:

  • Leave it blank.

    In this case, by default, an instance directory titled agent_inst is created in the agent installation base directory.

    For example, if the installation base directory is /john/oracle/, then the instance directory is defaulted to /john/oracle/agent_inst

  • Enter the absolute path to a custom directory.

    Although you can enter any location as a custom location, Oracle recommends you to maintain the instance directory inside the installation base directory.

    For example, AGENT_INSTANCE_HOME="/john/oracle/instance_dir/inst_mydir"

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, AGENT_PORT="1832"

If you do not enter any value, then either 3872 or any free port between 1830 and 1849 is honored.

b_startAgent

Enter TRUE if you want the Management Agent to start automatically once it is installed and configured. Otherwise, enter FALSE.

For example, b_startAgent=TRUE

ORACLE_HOSTNAME

Enter the fully qualified domain name of the host where you want to install the agent.

For example, ORACLE_HOSTNAME="example.com"

s_agentHomeName

Enter the name of the Oracle home you want to see created for the Management Agent.

For example, s_agentHomeName="agent12gR1"

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.


Understanding the Options Supported by agentDeploy.sh (agentDeploy.bat)

Table 5-3 lists the options supported by the agentDeploy.sh script. On Microsoft Windows, these options apply to the agentDeploy.bat file.

Table 5-3 Understanding the Options Supported by agentDeploy.sh/agentDeploy.bat

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 -prereqOnly option and verified the prerequisites, and only want to install the software binaries.

-invPtrLoc

Considers the Oracle Inventory directory for storing inventory details. Enter the absolute path to the oraInst.loc file that contains the location of the OraInventory directory.

Important: If you enter a value for this option, do NOT use the INVENTORY_LOCATION option. Also note that this parameter is supported only on UNIX platforms, and not on Microsoft Windows platforms.

INVENTORY_LOCATION

Considers the Oracle Inventory directory for storing inventory details. Enter the absolute path to the OraInventory directory.

Important:

  • If you enter a value for this option, do NOT use the -invPtrLoc option.

  • Do NOT use this option if you already have the /var/opt/oracle/oraInst.loc on HP and Solaris platforms, and /etc/oraInst.loc file on all other UNIX platforms.

  • This parameter is supported only on UNIX platforms, and not on Microsoft Windows platforms.

-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 -softwareOnly option, so that only the configuration is done to the copied software binaries. For more information, see Chapter 9.

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 OMS_HOST and EM_UPLOAD_PORT, respectively, in the response file you pass.

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.


Understanding the Contents of the Downloaded Management Agent Software

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/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.


After You Install

After you install the Management Agent, follow these steps:

  1. (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 (oraInstroot.bat on Windows) 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 (root.bat on Microsoft Windows) 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


  2. Verify the installation:

    1. 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


    2. 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

  3. 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

    For example,

    /u01/app/Oracle/core/12.1.0.1.0/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,

    /u01/app/Oracle/core/12.1.0.1.0/perl/bin/perl /u01/app/Oracle/core/12.1.0.1.0/bin/AgentPluginDeploy.pl -oracleHome /u01/app/Oracle/core/12.1.0.1.0/ -agentDir /u01/app/Oracle/ -pluginIdsInfoFile /u01/app/Oracle/plugins.txt -action configure -emStateDir /u01/app/Oracle/agent_inst

  4. If you had ignored a prerequisite check warning about wrong time zone settings, follow these steps:

    1. Set the correct time zone on the required host.

      For information on how to set the time zone on a host, refer Time Zone Requirements in Table 5-1.

    2. Deinstall the Management Agent present on the host.

      For information on how to deinstall a Management Agent, refer Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

    3. Install a Management Agent on the host.

  5. 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.


Note:

If you want to move your Management Agents from one Enterprise Manager Cloud Control to another, then you must first deinstall those Management Agents and plug-ins, and then redeploy those Management Agents and plug-ins using the new Oracle Management Service. This is typically done when you want to move from an Enterprise Manager Cloud Control in a test environment to an Enterprise Manager Cloud Control in a production environment.