Skip Headers
Oracle® Enterprise Manager Cloud Control Advanced Installation and Configuration Guide
12c Release 1 (12.1.0.1)

Part Number E24089-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

8 Installing Shared Agent

This chapter describes how you can install a Shared Agent with the help of a central, shared Oracle home location of an existing Oracle Management Agent (Management Agent) that is installed on an NFS-mounted drive.

Overview

If you want to install additional Management Agents on hosts that share a mounted drive where a Management Agent is already installed, then the best option is to use the software binaries of the shared Oracle home from the mounted drive and configure the remote hosts to be managed by that Management Agent, thus capitalizing on the NFS visibility and saving hard disk space on the remote hosts.

The Management Agent that shares its software binaries, in this context, is called the Master Agent, and the one that is configured with an instance directory on the remote host is called the Shared Agents or NFS Agents.

You can install a Shared Agent in graphical or silent mode. In graphical mode, you use the Add Host Targets Wizard that is accessible from within the Enterprise Manager Cloud Control console. In silent mode, you use the AgentNFS.pl script.

The wizard and the script use the software binaries from the shared Oracle home and configure an instance directory on each of the destination hosts for storing configuration files such as emd.properties, targets.xml, log files, and so on.

Note:

Unlike the Add Host Target Wizard, the AgentNFS.pl script must be run only from a destination host, and at a given time, only one Management Agent can be installed at a given time. Therefore, if you want to install only a few Management Agents, then use the AgentNFS.pl script

Before You Begin

Before you begin, keep these points in mind:

Prerequisites

Before installing a Shared Agent, ensure that you meet the following prerequisites:

Table 8-1 Prerequisites for Installing Shared Agent

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

(Only for Graphical Mode)

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

Software Availability Requirements

Ensure that you already have Oracle Management Agent 12c installed as a Master Agent in a shared, mounted location

/etc/hosts File Requirements

(Only for Silent Mode)

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:

12.123.123.12 mypc.cn.company.com mypc

Destination Host Requirements

(Only for Graphical Mode)

Ensure that the destination hosts are accessible from the host where the OMS is running.

If the destination host and the host on which OMS is running belong to different network domains, then ensure that you update the /etc/hosts file on the destination host to add a line with the IP address of that host, the fully qualified name of that host, and the short name of the host.

For example, if the fully-qualified host name is mypc.cn.company.com and the short name is mypc, then add the following line in the /etc/hosts file:

12.123.123.12 mypc.cn.company.com mypc

Destination Host Credential Requirements

(Only for Graphical Mode)

Ensure that all the destination hosts running on the same operating system have the same set of credentials. For example, all the destination hosts running on Linux operating system must have the same set of credentials.

The wizard installs the Management Agent using the same user account. If you have hosts running on the same operating system but with different credentials, then have two different deployment sessions.

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.

Installation Base Directory Requirements

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.

Instance Directory Requirements

Ensure that the instance directory you enter is empty and has write permission.

Shared Oracle Home Requirements

Ensure that the Master Agent home is accessible from the destination host where you want to install the Shared Agent.

SUDO Requirements

(Only for UNIX) Ensure that the installing user has SUDO privileges to invoke /bin/sh as root.

PATH Environment Variable Requirements

(Only for Graphical Mode)

On the destination host, ensure the following:

  • (For Microsoft Windows) 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).

  • (For UNIX) Ensure that the SCP binaries (for example, /usr/local/bin/scp) are in the PATH environment variable.

Path Validation Requirements

(Only for Graphical Mode)

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.

IPV 6 Requirements

(Only for Graphical Mode)

If you are installing from an ipv6 OMS to a non-ipv6 host, then follow these step:

  1. Navigate to the following location on the OMS home:

    $<OMS_HOME>/oui/prov/resources/

  2. Check the property value of PING_PATH in the following files in this order:

    1. ssPaths_<plat>.properties

    2. sPaths.properties

    3. Paths.properties

  3. Change the property value of PING_PATH from /bin/ping to /bin/ping6

Default SSH Port Requirements

(Only for Graphical Mode)

Ensure that the SSH daemon is running on the default port (that is, 22) on all the destination hosts. To verify the port, run the following command:

netstat -anp | grep <port_no>

If the port is a non-default port, that is, any port other than 22, then update the SSH_PORT property in the following file that is present in the OMS home:

$<OMS_HOME>/oui/prov/resources/Paths.properties

Ping Requirements

(Only for Graphical Mode)

If a firewall configured in your environment does not allow any ping traffic, then ensure that you do the following:

  1. Take a backup of the following file from the OMS home:

    For Linux Platforms:

    $<OMS_HOME>/oui/prov/resources/sPaths.properties

    For Other Platforms:

    $<OMS_HOME>/oui/prov/resources/ssPaths_<platform>.properties

    For example, ssPaths_aix.properties if the OMS is on AIX platform.

  2. Edit the original properties file and change PING_PATH=/bin/ping to PING_PATH=/bin/true.

Port Requirements

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

Installing User Requirements

  • Ensure that the user installing the Shared Agent is the same as the user who installed the Master Agent.

  • If the central inventory owner and the user installing the Management Agent are different, then ensure that they are part of the same group.

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

  • 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 at /etc/oraInst.loc) on any remote host, then ensure that you specify the path to an alternative inventory location by using one of the following options in the Additional Parameters field of the Add Host Targets Wizard:

    INVENTORY_LOCATION=<absolute_path_to_inventory_directory>

    -invPtrLoc <absolute_path_to_oraInst.loc>

Agent User Account Permissions and Rights

(Only 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

(Only 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

Preinstallation/Postinstallation Scripts Requirements

(Only for Graphical Mode)

Ensure that the preinstallation and postinstallation scripts that you want to run along with the installation are available either on the OMS host, destination hosts, or on a shared location accessible to the destination hosts.

Browser Requirements

(Only for Graphical Mode)

  • Ensure that you use a certified browser 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.

  • If you use Microsoft Internet Explorer 8 or 9, do the following:

    • Turn off the compatibility view mode. To do so, in Microsoft Internet Explorer, from the Tools menu, click Compatibility View to disable it if it is enabled. Also, click Compatibility View Settings and deregister the Enterprise Manager Cloud Control console URL.

    • Enable XMLHTTP. To do so, from the Tools menu, click Internet Options. Click the Advanced tab, and under the Security heading, select Enable native XMLHTTP support to enable it.


Installation Procedure

This section describes the following:

Installing in Graphical Mode

To install a Shared Agent in graphical mode, follow these steps:

  1. In Cloud Control, do one of the following:

    • From the Setup menu, select Add Targets, and then, click Auto Discovery Results. On the Auto Discovery Results page, select a host you want to monitor in Enterprise Manager Cloud Control, and click Promote.

    • From the Setup menu, select Add Target, and then, click Add Targets Manually. On the Add Targets Manually page, select Add Host Targets and click Add Host.

  2. On the Host and Platform page, do the following:

    1. Accept the default name assigned for this session or enter a unique name of your choice. The custom name you enter can be any intuitive name, and need not necessarily be in the same format as the default name. For example, add_host_operation_1

      A unique deployment activity name enables you to save the installation details specified in this deployment session and reuse them in the future without having to enter all the details all over again in the new session.

    2. Click Add to enter the fully qualified name and select the platform of the host on which you want to install the Management Agent.

      Note:

      • Oracle recommends you to enter the fully qualified domain name of the host. For monitoring purpose, Enterprise Manager Cloud Control adds that host and the Management Agent with the exact name you enter here.

      • You must enter only one host name per row. Entering multiple host names separated by a comma is not supported.

      • You must ensure that the host name you enter does not have underscores.

      Alternatively, you can click either Load from File to add host names stored in a file, or Add Discovered Hosts to add host names from a list of hosts discovered by Enterprise Manager.For information on how the host name entries must appear in the host file, see Format of Host List File

      Note:

      When you click Add Discovered Hosts and add hosts from a list of discovered hosts, the host's platform is automatically detected and displayed. The platform name is detected using a combination of factors, including hints received from automated discovery and the platform of the OMS host. This default platform name is a suggestion, so Oracle strongly recommends you to verify the platform details before proceeding to the next step.

      As the Shared Agent can be installed only if the source host and the destination host are running on the same platform, set the platform for the first host in the first row of the table and from the Platform list, select Same for All Hosts. This will ensure that the platform name you selected for the first host is also set for the rest of the hosts in the table.

      Note:

      If you are installing a Management Agent on a platform that is different from the platform on which the OMS is running, then ensure that you have the software for that platform. If you do not have that software, then go to the Self-Update page within Enterprise Manager Cloud Control, and download the software.
    3. Click Next.

  3. On the Installation Details page, do the following:

    1. In the Deployment Type section, select Add Host to Shared Agent. Then, for Select Target, click the torch icon and select the Management Agent that is shared and mounted. This location must be visible on all remote hosts.

    2. From the table, select the first row that indicates the hosts grouped by their common platform name.

    3. In the Installation Details section, provide the installation details common to the hosts selected in Step 3 (b). For Oracle Home, validate or enter the location of the shared Management Agent home. Ensure that this location is accessible from all the destination hosts.

    4. For Instance Directory, enter the absolute path to a directory where all Management Agent-related configuration files can be stored. Ensure that the directory has write permission.

      For example, /usr/home/software/oracle/agentHome/agent_inst.

    5. From Named Credential list, select an appropriate profile whose credentials can be used for setting up the SSH connectivity between the OMS and the remote hosts, and for installing a Management Agent on each of the remote hosts.

      Note:

      • If you do not have a credential profile, or if you have one but do not see it in the Named Credential list, then click the plus icon against this list. In the Create New Named Credential window, enter the credentials and store them with an appropriate profile name so that it can be selected and used for installing the Management Agents. Also set the run privilege if you want to switch over from the Named Credential you are creating, to another user who has the privileges to perform the installation.

      • If the plus icon is disabled against this list, then you do not have the privileges to create a profile with credentials. In this case, contact your administrator and either request him/her to grant you the privileges to create a new profile or request him/her to create a profile and grant you the access to view it in the Named Credential list.

      • If you have manually set up the SSH connectivity between the OMS and the remote hosts, then you may not have a password for your user account. In this case, create a named credential with a dummy password. Do NOT leave the password field blank.

    6. For Privileged Delegation Setting, validate the Privilege Delegation setting to be used for running the root scripts. By default, it is set to the Privilege Delegation setting configured in Enterprise Manager Cloud Control.

      If you leave this field blank, the root scripts will not be run by the wizard; you will have to run them manually after the installation. For information about running them manually, see After You Install.

      This setting will also be used for performing the installation as the user set in the Run As attribute of the selected Named Credential if you had set the user while creating that Named Credential.

      Note:

      In the Privilege Delegation setting, the %RUNAS% is honored as the root user for running the root scripts and as the user set in the Run As attribute of the Named Credential for performing the installation.
    7. For Port, accept the default port (3872) that is assigned for the Management Agent to communicate, or enter a port of your choice.

      The custom port you enter must not be busy. If you are not sure, you can leave it blank. Enterprise Manager Cloud Control automatically assigns the first available free port within the range of 1830 - 1849.

    8. (Optional) In the Optional Details section, enter the absolute path to an accessible location where the preinstallation and postinstallation scripts you want to run are available. Note that only one preinstallation or one postinstallation script can be specified.

      If you want to run the script as root, then select Run as Root. If the script is on the host where OMS is running and is not on the host where you want to install the Management Agent, then select Script on OMS. In this case, the script will be copied from the OMS host to the destination hosts, and then run on the destination hosts.

    9. (Optional) For Additional Parameters, enter a whitespace-separate list of additional parameters that you want to pass during the installation. For a complete list of supported additional parameters, see Table 7-2.

      For example, if you want to provide the inventory pointer location file, then enter -invPtrLoc followed by the absolute path to the file location.

    10. Repeat Step 3 (b) to Step 3 (h) for every other row you have in the table.

    11. Click Next.

  4. On the Review page, review the details you have provided and if you are satisfied with the details, then click Deploy Agent to install the Management Agent.

    If you want to modify the details, then click Back repeatedly to reach the page where you want to make the changes.

    When you click Deploy Agent and submit the deployment session, you are automatically taken to the Add Host Status page that enables you to monitor the progress of the deployment session.

Installing in Silent Mode

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

  1. Create a response file titled AgentNFS.rsp as described in Table 8-2.

    Note:

    The response file you create can have any name, and not necessarily AgentNFS.rsp. For easy understanding, this chapter uses the name AgentNFS.rsp. Also, instead of creating a response file, you can choose to pass the arguments explicitly while invoking the script. However, Oracle recommends that you create a response file and capture the information there.
  2. Invoke the script from the Master Agent home, which is visible as a shared location, and pass the response file.

    <AGENT_HOME>/perl/bin/perl <AGENT_HOME>/sysman/install/AgentNFS.pl -responseFile=<absolute_path_to_response_file>

    For example,

    /scratch/agent_base_dir/core/12.1.0.1.0/perl/bin/perl /scratch/agent_base_dir/core/12.1.0.1.0/sysman/install/AgentNFS.pl -responseFile=/home/john/AgentNFS.rsp

    Note:

    • Instead of creating a response file, you can choose to pass all the arguments explicitly while invoking the script. In this case, invoke the script in the following way:

      <AGENT_HOME>/perl/bin/perl <AGENT_HOME>/sysman/install/AgentNFS.pl AGENT_INSTANCE_HOME=<absolute_path_to_instance_dir> ORACLE_HOME=<absolute_path_to_master_agent_oracle_home> <parameter1>=<value1> <parameter2>=<value2> <parameter3>=<value3> . . .

      For example,

      /scratch/agent_base_dir/core/12.1.0.1.0/perl/bin/perl /scratch/agent_base_dir/core/12.1.0.1.0/sysman/install/AgentNFS.pl AGENT_INSTANCE_HOME=/home/john/agent_inst ORACLE_HOME=/scratch/agent_base_dir/core/12.1.0.1.0 AGENT_PORT=1832 AGENT_REGISTRATION_PASSWORD=welcome b_startAgent=TRUE

    • If the Master Agent was installed using the Add Host Targets Wizard, then ensure that you pass the following arguments with these values:

      AGENT_REGISTRATION_PASSWORD=<password>

      b_startAgent=TRUE

    • Do NOT pass the -invPtrLoc argument because, by default, the location <AGENT_HOME>/oraInst.loc is honored, where <AGENT_HOME> is the Master Agent. Also ensure that the Oracle Inventory directory, to which the inventory file points, is not in a shared location.

  3. When prompted to run the root.sh script, run it from the instance directory of the Management Agent:

    <AGENT_INSTANCE_HOME>/root.sh

    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 /scratch/OracleHomes/agent_inst/root.sh

  4. Repeat Step (1) to Step (3) on the remaining hosts where you want to install the Shared Agent.

Creating a Response File

For silently installing a Shared Agent, you must invoke the AgentNFS.pl script and pass a response file that captures all the required information. Table 8-2 describes the various parameters you must include in the response file.

Table 8-2 Creating a Response File for Installing Oracle Management Agent Using the AgentNFS.pl Script

Parameter Description

ORACLE_HOME

Specify the absolute path to the Master Agent home, which is shared and visible on the destination host.

For example, /scratch/agent_base_dir/core/12.1.0.1.0

AGENT_PORT

(Optional) Enter the port on which the Shared Agent process should be started. You can enter any free port between 1830 and 1849. The same port is used for both HTTP and HTTPS.

For example, 1832

AGENT_INSTANCE_HOME

Specify the absolute path to a location on the destination host where you want to store all Management Agent-related configuration files.

For example, /home/john/agent_inst

b_startAgent

Set it to TRUE so that the Shared Agent is started automatically once it is installed and configured.

Note: If the Master Agent was installed using the Add Host Targets Wizard, then you must pass this parameter.

ORACLE_HOSTNAME

(Optional) (Only for Installation on Virtual Hosts) Specify the virtual host name where you are installing the Shared Agent.

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, Wel456come

Note: If the Master Agent was installed using the Add Host Targets Wizard, then you must pass this parameter.


After You Install

After you install a Shared Agent, follow these steps:

  1. (Only for Graphical Mode) Verify the installation on the Add Host Status page. Review the progress made on each of the phases of the deployment operation — Initialization, Remote Prerequisite Check, and Agent Deployment.

    Note:

    In the Add Host Targets Wizard, after you click Deploy Agent to install one or more Management Agents, you are automatically taken to the Add Host Status page.

    If you want to view the details or track the progress of all the deployment sessions, then from the Setup menu, select Add Target, and then, click Add Targets Manually. On the Add Targets Manually page, select Add Host Targets and click Add Host Results.

    If a particular phase fails or ends up with a warning, then review the details provided for each phase in the Agent Deployment Details section, and do one of the following:

    • Ignore the warning or failure, and continue with the session if you prefer.

      • You can choose to proceed with the deployment of Management Agents only on those remote hosts that have successfully cleared the checks, and you can ignore the ones that have Warning or Failed status. To do so, click Continue and select Continue, Ignoring Failed Hosts.

      • You can choose to proceed with the deployment of Management Agents on all the hosts, including the ones that have Warning or Failed status. To do, click Continue and select Continue, All Hosts.

    • Fix the problem by reviewing the error description carefully, understanding its cause, and taking action as recommended by Oracle.

      • You can choose to retry the deployment of Management Agents with the same installation details. To do so, click Retry and select Retry Using Same Inputs.

      • You can retry the deployment of Management Agents with modified installation details. To do so, click Retry and select Update Inputs and Retry.

  2. Verify the installation:

    1. Navigate to the Shared Agent instance 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 Shared 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. (Only for UNIX Operating Systems) If you had ignored the prerequisite check warning about not having root privileges, SUDO binaries, or SUDO privileges, then manually run the following scripts as a root user from each of the hosts where the cloning was done. 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 cloned 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

  4. By default, the host and the Shared 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.