Skip Headers
Oracle® Enterprise Manager Installation and Basic Configuration
10g Release 2 (10.2) for Linux x86

Part Number B16228-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

5 Deploying the Management Agent

The Oracle Management Agent, a process that is deployed on each monitored host, is responsible for monitoring all targets on the host, for communicating that information to the middle-tier Management Service, and for managing and maintaining the host and its targets.This chapter contains the following sections:

Installing the Management Agent Using Agent Deploy

You can perform a mass deployment of the Management Agent through the Web-based Agent Deploy application. This application is particularly useful when you want to perform remote installations.


Note:

You can use the Agent Deploy application to mass-deploy the Management Agent from a remote site.

When you are required to perform a standalone installation of the Agent on a local machine, you can choose to either perform the installation using the Agent Deploy application, or use the agentDownload script. See the section Chapter5, "About agentDownload Script", for more information.



IMPORTANT:

Oracle recommends that you view the installation status output (emctl status) to ensure the installation was successful. You can view this log by executing the following command:
<AGENT_HOME>/bin/emctl status agent

See AppendixA, "Management Agent Installation Fails" to view a sample of the emctl status log and to troubleshoot possible errors that may occur during installation.


Agent Deploy Installation Prerequisites

Ensure the following prerequisites are met before proceeding with the agent installation.

Before you start using Agent Deploy to perform agent installations, ensure the following prerequisites are met:

  • Set up SSH (Secure Shell) User Equivalence.

  • Validate all command locations.

  • Modify response file for Big IP host and port.

  • Verify oraInventory permissions on remote hosts.

  • User installing the agent is part of the same OS group that installed the Oracle Application Server and/or Oracle Collaboration Suite.

See Appendix E, "Agent Deploy Application - Installation Prerequisites" for more information.

Accessing the Agent Deploy Application

To access Agent Deploy:

  1. Log in to the Grid Control console and go to the Deployments page.

  2. Click Install Agent under the Agent Installation section.

  3. In the Agent Deploy home page that appears, select the appropriate installation option that you want to perform.


Note:

If you want to view the status of an earlier installation/upgrade session, click Agent Installation Status in the Deployments page.

Agent Deploy Installation Types

Agent Deploy provides the following two options for deploying the Management Agent:

Fresh Installation of the Management Agent

This option helps you perform a fresh installation of the Management Agent. The Agent Deploy application runs a prerequisite checker to ensure the environment meets the requirements for this installation type. See AppendixE, "Prerequisite Checks Executed by Agent Deploy" for more information.

To perform a fresh Management Agent installation:

  1. Select Fresh Install on the Agent Deploy application home page. The Installation Details page appears.

  2. In the Source Software section, select an installation source directory. This directory can either be the default directory that exists within the Oracle Management Service (OMS), for example <OMS_HOME>/sysman/agent_download/10.2.0.1.0/<platform>, or any other location where the software is available.

    See Chapter5, "Uploading Agent Installation Software for Different Platforms" for more information on obtaining agent installables for different platforms.

    To choose a location other than the default location from the OMS, select Another Location, and specify the full path to the software location that you want to use.


    Note:

    Ensure that the path of the software location that you specify is accessible from all remote hosts.

    The application does not copy the software to the remote hosts, but will only access the software from the specified location.



    IMPORTANT:

    The additional parameters that you specify later in the installation process depend on the source software location that you select here.

    if you select the default software location, you must specify additional parameters that are supported by the agentDownload script. See Table F-1 for a list of parameters supported by this script.

    If you select an alternative location, you must specify additional parameters that are supported by Oracle Universal Installer (OUI). See Table F-2 for a list of parameters supported by OUI.


    Figure 5-1 Source Software Section of the Installation Details Page

    The Source Software Location section.
  3. Select the appropriate platform on which you want to perform this installation.

  4. In the Provide Host List text box, specify all the hosts (host names or IP addresses) on which you want to perform the Agent installation. Alternatively, click Get Host Names From File to browse and select the file that contains a list of all the required host names.


    WARNING:

    Ensure you do not specify duplicate entries of the host list. If there are duplicate host entries in this list, the application hangs.

    Also ensure that you use the same host names for which the SSH has been set.



    Note:

    You can use either a comma (,), white space, or a new line as a separator when specifying multiple hosts.


    IMPORTANT:

    The Agent Deploy application picks up only the values in the first column of the Host List file that you specify/select.

    Ensure the host list format is appropriate, since the Agent Deploy application does not validate this format on the selected file.

    A sample host list format is provided in Table 5-1.


    Table 5-1 Sample Host List Format

    FullyQualified Host Name Host Name Host IP Address

    host1.foo.com

    host1

    154.87.3.229

    host2.foo.com

    host2

    154.87.3.109

    host3.foo.com

    host3

    154.80.5.218


    Figure 5-2 Hosts Section of the Installation Details Page

    The Hosts section.
    1. Select Cluster Install if you want to install the Agent on a cluster.

    2. In the Cluster Node List text box, specify the cluster nodes. Alternatively, click Populate Defaults to populate this text box with all the host names that you had selected in step 3.

    3. In the Cluster Node List text box, specify the cluster nodes. Alternatively, click Populate Defaults to populate this text box with all the host names that you had selected in step 3.


      Note:

      The node names that you specify here are the machine short names.

      If you have set up the cluster over a vendor clusterware, the node names can be different from the machine names.

      You can confirm the node names by executing olsnodes from the <Oracle Clusterware home> on one of the cluster nodes. If you are using a 9.2 Oracle Cluster version, confirm the node names by executing lsnodes from the cluster Oracle home.

      See Chapter5, "Installing a Cluster Agent on Oracle Clusterware" for more information.


    4. In the Cluster Name text box, specify a unique cluster name. If you are extending a cluster, ensure you specify the existing cluster name here. The cluster name that you specify here identifies that cluster in the Grid Control console.


      Note:

      When you select the cluster install option, Agent Deploy performs the agent installation on all the cluster nodes irrespective of the number of hosts you have selected. For example, if you choose to perform a cluster install on a cluster having 10 nodes, but specified only 5 nodes, Agent Deploy installs the agent on all 10 nodes that form that cluster.

      If you are extending an existing cluster, ensure that the cluster name you specify is the same as the existing cluster. You must also ensure that you specify all the nodes of the existing cluster along with the new node on which you are installing the cluster agent.


  5. In the OS Credentials section, specify the appropriate operating system user credentials. Select Run root.sh if you want Agent Deploy to execute this script.

    Figure 5-3 OS Credential Section of the Installation Details Page

    The OS Credentials section.

    Note:

    The root.sh script executes after the configuration assistants are run, and before executing post-install scripts (if any).

    If you do not select this option here, you must manually run root.sh on each node.


    Agent Deploy uses sudo to run this script. You must specify the invoking user's password here. You must also ensure that the targetpw is not set in the /etc/sudoers file.


    Note:

    The OS credentials that you specify here must be the same for all the selected hosts.

  6. In the Destination section, specify the absolute path for the Installation Base Directory. This directory is created on all the specified hosts, and the Agent Oracle home directory is created as a sub-directory under this directory.

    Figure 5-4 Destination Section of the Installation Details Page

    The Destination section.

    Note:

    Ensure you have write permissions on the installation Base Directory that you specify.

  7. Specify the port on which the Agent will communicate. The default port value is 3872.

    Figure 5-5 Port Section of the Installation Details Page

    The Port section.

    Note:

    If the port that you specify is not available, you are prompted to specify an alternative port. If you do not specify a port here, the Agent Deploy application automatically picks up a free port (3872 or in the range of 1830 - 1849).

  8. In the Additional Parameters text box, specify any additional parameters that you want to pass during installation.

    Figure 5-6 Additional Parameters Section of the Installation Details Page

    The additional Parameters section .

    IMPORTANT:

    The additional parameters that you specify here depend on the software source location that you have selected.
    • Default Management Service Location: If you have selected the default software source directory, the additional parameters that you specify must be supported by the agentDownload script, as the Agent Deploy application uses the agentDownload.<platform> script to perform the installation. See Table F-0 for a list of all the parameters supported by the agentDownload script.

    • Another Location: If you have selected an alternative software location, the additional parameters that you specify must be supported by Oracle Universal Installer (OUI), as Agent Deploy then uses OUI to perform the installation. See Table F-1 for a list of parameters supported by OUI.



    Note:

    If the same parameters that you specify here are also specified independently (from the command-line option), the value of the parameters that you specify here take precedence over the other.

    For example, if the installation base directory is specified independently, and -b option is specified here, the latter value (-b) is used in the installation.


    The important parameters for Agent Installation are -b, -c, -n and optionally -i, -p, -t, -d, and -z.

  9. In the Management Service Security section, specify the Management Service Registration Password if you want to secure communications between the Agent and OMS. Alternatively, the super administrator can approve the addition of new agents to Enterprise Manager after the installation is complete.

    Figure 5-7 Management Server Security Section of the Installation Details Page

    The Management Server Security section.

    Note:

    An unsecure agent cannot upload data to the secure OMS. Oracle also recommends for security reasons that you change the OMS password specified here after the installation is complete.

  10. In the Additional Scripts section, specify any pre-install and/or post-install scripts that you want to execute.

    Figure 5-8 Additional Scripts Section of the Installation Details Page

    The Additional Scripts section.

    Select Run as Superuser if you want to run these scripts as root.


    Note:

    The pre/post installation scripts that you specify must be available on all the hosts. These files are not copied onto the hosts from the source software location during installation.

  11. Click Continue to start the installation process. As part of this process, Agent Deploy performs some prerequisite checks before proceeding with the installation. When all the prerequisite checks are complete, the application displays the results. You can choose to either retry the prerequisite check on all those failed hosts, or ignore the result and proceed to install the Agent.


    Note:

    After the installation and configuration phase, the Agent Deploy application checks for the existence of the Central Inventory (located at /etc/oraInst.loc). If this is the first Oracle product installation, Agent Deploy executes the following scripts:
    1. orainstRoot.sh - This creates oraInst.loc that contains the central inventory.

    2. root.sh - This runs all the scripts that must be executed as root.

    If this is not the first Oracle product installation, Agent Deploy executes only root.sh.


Scenarios to Consider While Performing a Cluster Agent Install

Consider the following scenarios while performing cluster installation:

You are performing a fresh Agent installation on a cluster that does not have an Agent.

This is a scenario where you have an existing cluster (cr1 with three nodes n1, n2, and n3) but without an Agent installation on any of the nodes. Here, if you specify only two nodes (n1 and n2) for an agent install, Agent Deploy updates the inventory for these two nodes and the Agent is installed and running.

Now, you want to install the Agent on the third node (n3) and specify the cluster name as cr1 and all three hosts and nodes (n1, n2, and n3) this time. Agent Deploy updates the n1 and n2 inventory to include n3 and the Agent is installed.


IMPORTANT:

In a scenario such as the one above, you must specify the same cluster name and include all the existing nodes of that cluster.

You are extending a cluster, but do not include all the existing nodes.

This is a scenario where you want to install an Agent on the node (n4) that is an extension of the existing cluster (cr1 with nodes n1, n2, and n3.) But during the Agent installation, you specify only the new node (n4) in the Cluster Node List text box. Agent Deploy installs the Agent on n4, but does not update the inventory of the other three nodes (n1, n2, and n3) to include n4.

To ensure that the inventory of all the nodes of an existing cluster are updated, you must specify all the hosts and nodes of that cluster along with the new node (n4 in this example.)

If you have specified just the one node and the existing cluster name (cr1), Agent Deploy still creates a new cluster with the same name.

If you have specified just the one node and did not specify a cluster name, Agent Deploy computes a default cluster name and create a new cluster.

You are installing the Agent on two clusters of the same name but with different nodes.

You have two clusters with the same name but with different nodes, for example crs (with n1, and n2) and crs (with n3 and n4), and you want both clusters to be managed by the same OMS. To distinguish the two clusters in the Grid Control console, you must do the following:

When you are installing the Agent on the first crs cluster (with nodes n1 and n2), enter a unique cluster name and perform the installation. Now, enter a different cluster name for the other crs cluster (with nodes n3 and n4) and perform the Agent installation.

Now, you can view these clusters in the Grid Control console under unique cluster names that you specified during agent installation.

Installation Using a Shared Agent Home

To deploy and install an Agent on multiple hosts using an existing Shared Agent Installation, you must have already performed a complete Enterprise Manager product installation (including the Agent). Another prerequisite when using this option is that the directory where the Agent is installed should be NFS-mounted, meaning the directory must be a shared location on all remote hosts.

The Agent Deploy application runs a prerequisite checker to ensure the environment meets the requirements for this installation type. See AppendixE, "Prerequisite Checks Executed by Agent Deploy" for more information.


ATTENTION:

NFS agent deployment is not supported on a Cluster. If you want the agent to monitor a cluster and RAC, you must use the agent deployment with the cluster option, and not the NFS deployment method


Note:

You can also perform a Shared Agent Oracle home installation using the nfsagentinstall script. See Chapter5, "Sharing the Agent Oracle Home Using the nfsagentinstall Script" for more information.

Concepts and Prerequisites

The following sections briefly discuss the Shared Agent Home concepts, and also list the prerequisites that should be met before starting the installation.

EMSTATE Directory:

This is a directory for storing configuration files such as emd.properties, targets.xml, log files, and so on, on each host. Every host that shares the Agent bits has its own STATE directory.

EMSTATE Directory Location:
  • The EMSTATE directories of agents on different hosts should be local to the host instead of on the mounted drive for security reasons.

  • Since the EMSTATE directory contains the targets pertaining to each host, it is highly recommended to have it on a local host.

EMSTATE Directory Space Requirements:

The initial space required for EMSTATE directories is 1MB. Since all the upload files, collection files, and log files are stored in this directory, the size of the directory is bound to increase. Consequently, Oracle recommends that you allocate sufficient space for the STATE directories after taking these factors into account.

Packages and OS Patches Requirement:

Currently, no packages are required by the agent to run on the shared hosts.

Operating System Credentials:

When you are performing an agent installation using a shared Oracle home, ensure all the specified hosts have the same operating system credentials and file system structure.

Performing the Installation

To perform a fresh Management Agent installation:

  1. Select Shared Agent Home on the Agent Deploy application home page. The Installation Details page appears.

  2. In the Hosts section:

    Figure 5-9 Hosts Section of the Installation Details Page

    The Hosts section.
    1. Select the appropriate Platform on which you want to perform this installation.

    2. In the Provide Host List text box, specify all the hosts (host names or IP addresses) on which you want to perform the Agent installation. Alternatively, click Get Host Names From File to select the file that contains a list of all the required host names.


      WARNING:

      Ensure you do not specify duplicate entries of the host list. If there are duplicate host entries in this list, the application hangs.

      Also ensure that you use the same host names for which the SSH has been set.



      Note:

      You can use comma (,) or just white space as a separator when specifying multiple host names.


      ATTENTION:

      If the Installation Base Directory is shared among the hosts that you have specified in the host list, the installer is invoked from one of these hosts (typically, the first host in that list).

      While the installation is performed on only one host, the application executes the configurations on all nodes in the list. That is, the pre-install, post-install, and collect logs are executed on all the nodes.

      After the installation is complete, the Installation Status page displays the status of only this host (from which the installer was invoked). It may not necessarily list the status of all the hosts specified in the host list.


  3. In the OS Credentials section:

    Figure 5-10 OS Credentials Section of the Installation Details Page

    The OS Credentials section.
    1. Specify the appropriate operating system user credentials.

    2. Select Run root.sh if you want Agent Deploy to execute this script. Agent Deploy uses sudo to run this script. You must specify the invoking user's password here. You must also ensure that the targetpw is not set in the /etc/sudoers file.


    IMPORTANT:

    If you do not want to execute the scripts as root during the installation, ensure you run these scripts manually before performing any other installation on that machine.


    Note:

    The OS credentials that you specify here must be the same for all the selected hosts.

  4. In the Destination section:

    Figure 5-11 Destination Section of the Installation Details Page

    The destination section.
    1. Specify the complete path to the NFS Agent Location. This is the shared directory location on the source host that must be visible (NFS-Mounted) from all remote hosts.

    2. Specify an appropriate State Directory Location. This is a directory for storing configuration files such as emd.properties, targets.xml, log files, and so on, on each host. Every host that shares the Agent has its own STATE directory.

  5. In the Port section:

    Figure 5-12 Port Section of the Installation Details Page

    The Port section in the Installation Details page.

    This is a mandatory field. Specify the appropriate Port on which the Agent will communicate.


    Note:

    If the Port that you specify is busy (not available), you are prompted to specify an alternative port. If you do not specify a Port value here, the installation will fail.

  6. In the Management Service Security section:

    Figure 5-13 Management Service Security Section of the Installation Details Page

    The Management Server Security section.

    Specify the Management Service Registration Password if you want to secure communications between the Agent and OMS. Alternatively, the super administrator can approve the addition of new agents to Enterprise Manager after the installation is complete.


    Note:

    An insecure agent cannot upload data to the OMS. Oracle also recommends for security reasons that you change the OMS password specified here after the installation is complete.

  7. In the Additional Scripts section:

    Figure 5-14 Additional Scripts Section of the Installation Details Page

    The Additional Scripts section.
    1. Specify any pre and/or post-installation scripts that you want to execute. These scripts are optional. If you do not want to customize your installation, leave these fields blank and continue.

    2. Click Continue to start the installation process.


      IMPORTANT:

      If the shared agent is the first Oracle product that is installed on the host, you must execute the following command from the EMSTATE directory after completing the installation:
      <EMSTATE Dir>/bin 
      ./emctl control agent runCollection <Host name>:host Inventory
      

      As part of this process, Agent Deploy performs some prerequisite checks before proceeding with the installation. When all the prerequisite checks are complete, the application displays the results. The results include the name, type, and status for all prerequisite checks designed for the installation.

    Besides the successfully run prerequisite checks, the prerequisite checks can have one of the following two statuses:

    • Warning: If there are warnings against certain prerequisite checks, you may choose to ignore these and continue with the installation (though this is not recommended).

    • Failed: If there are failed prerequisite checks, you may still choose to ignore and continue with the installation. A recommended course of action is to fix the failed prerequisites before proceeding with the installation.

    To fix the failed prerequisites, you can either click Retry, or go to the Fixup page of the application. The Fixup page displays the prerequisites that can be automatically fixed, and those that require manual fixes.


Note:

You can view the status of all previous installation instances from the Status page in the Agent Deploy application. This page lists all agent installations that were performed using Agent Deploy. You can click on the corresponding Status link for each record to view the selected installation details, including user inputs provided during installation and the final status of that installation.

You can access the Status page either before starting the installation process, or after the installation is complete. You cannot access the Status page during an installation.


Sharing the Agent Oracle Home Using the nfsagentinstall Script

The Enterprise Manager 10.2 installer supports NFS-mounted agent installations where the agent bits are shared on a Net App Filer disk, and the other hosts share these bits to run the agent processes on each of the hosts. In this method of Agent deployment, the configuration files for each host are stored in the STATE directory.


IMPORTANT:

Note that the agent Oracle home cannot be installed in an Oracle Cluster Shared File System (OCFS) drive, but is supported on an NAS (Network Attached Storage) drive.


Caution:

You can perform only one nfsagent installation per host. Multiple nfsagent installations on the same host will fail.

Pre-Installation Considerations

Consider the following before starting the agent installation using the nfsagentinstall script.

User Credentials

The shared agent (nfsagent) can only be installed with the same user credentials that were used to perform the master agent installation.

If Agent is not the First Oracle Product Installation

If this shared agent installation is not the first Oracle product installation and your (user that has performed the master agent installation) home directory is shared, you must verify the oraInst.loc location under the /etc directory. If oraInst.loc and inventory_loc are located in the your home directory, you must change this entry point to a non-shared location.

The oraInst.loc entry should look like this:

inventory_loc=/<any location other than the home directory>/oraInventory
inst_group=<group to which the user belongs>

Performing an NFS Agent Installation

To perform an agent installation using nsfagentinstall script:

  1. Configure the shared drive on the host in such a way that only one host has read/write access to this shared location, while all the other hosts have only read access.

  2. Stop the Agent from the Oracle home.


    Note:

    You must not start the master agent from the installed Oracle home.

  3. Now, execute the OH/sysman/install/nfsagentinstall script on all the hosts that should share the agent bits, including the host on which you performed the master agent installation.

  4. If this agent installation is the first Oracle product installation on the host, the nfsagentinstall script prompts you to execute the following script. You must execute this script manually.

    <homedir>/oraInventory/orainstRoot.sh
    
    

    The nfsagentinstall script also prompts you to execute the <STATEDIR>/root.sh. You must manually execute this command.

Usage of the nfsagentinstall Script

./nfsagentinstall  -s <EMSTATE Directory location> -p <port number>

where,

  • <EMSTATE directory location> is the full path where you want the state directory to be created by the script.

  • <port number> is the port on which the agent runs.


IMPORTANT:

If the nfsagent is the first Oracle product that is installed on the host, you must execute the following command from the EMSTATE directory after completing the installation:
<EMSTATE Dir>/bin 
./emctl control agent runCollection <Host name>:host Inventory


ATTENTION:

Deployment of agent through the nfsagent install script is not supported on Clusters. If you want the agent to monitor a Cluster and/or RAC, you must use the agent deployment with cluster options.

Deinstalling the NFSAgent

If the nfsagent you want to deinstall is the first Oracle product installed on the host, you must check the/etc/oraInst.loc for the inventory location andperform the following steps to deinstall the agent.

  1. Stop the agent using the following command:

    <EMSTATE DIR>/bin/emctl stop agent
    
    
  2. Execute rm -rf <inventory_location>

  3. Execute rm -rf <EMSTATE Dir>

If the nfsagent you want to deinstall is not the first Oracle product installed on the host, then go to the master agent Oracle home (via the mounted path) and perform the following steps to deinstall the agent.

  1. Stop the agent using the following command:

    <EMSTATE DIR>/bin/emctl stop agent
    
    
  2. Execute the following command from the master agent Oracle home:

    <master agent home>/oui/bin/runInstaller -detachHome ORACLE_HOME=<master agent home>
    
    
  3. Execute rm -rf <EMSTATE Dir>

Installing the Agent Using the agentDownload Script

The downloadable Agent software contains a sample script called agentDownload. This script provides a means for installing Management Agents that can be customized for specific environments using a silent, scripted installation. The agentDownload script is fully functional and self-documenting so it can be customized easily for specific environments.

About agentDownload Script

The agentDownload script uses pull technology. That is, even though the script does not have to exist on a local file system, it must always be executed from the target host computer. You must be logged into the target host to run the script. Files are not pushed from a central location to a list of target hosts. Instead, files are pulled to the local $ORACLE_HOME from the staged product installation location.

This means that the agentDownload needs to be launched from each target host where you want to install the Management Agent. Because the installation is scripted, it is possible to use a wrapper script, Linux cron job, rdist, or a combination of operating system features to fully automate this process for mass deployments.


Note:

Use the agentDownload script to perform an Agent Installation on a Cluster environment.

Benefits of the agentDownload Script

The download script deploys the standard Management Agent installation with some additional benefits:

  • Can be modified for specific user environments.

  • Non-interactive, silent, installations.

  • Output is text-only (non-graphical).

  • Management Agents installed using the script are identical to Management Agents installed with the Oracle Universal Installer graphical installation.

  • Simplifies deploying Management Agents in secure Web environments that are configured to provide HTTP access.

Obtaining the agentDownload Script

The downloadable Agent software is available on the platform-specific CD from which the Oracle Management Service was installed, and from the following Oracle Technology Network Web site under Mass Agent Deployment:

http://otn.oracle.com/software/products/oem/index.html

To initiate a silent Oracle Universal Installer session using HTTP to install Management Agents, download and execute the agentDownload script to perform the installation. (Note that proxy servers are not supported.)

See Chapter5, "Uploading Agent Installation Software for Different Platforms" for more information on obtaining agent installables for different platforms.

Using the agentDownload Script

To deploy multiple Management Agents using the agentDownload script, you must do the following:

  1. Install the Oracle Management Service.

    Install the Management Service using the Oracle Universal Installer. See Chapter3, "Installing an Additional Management Service" for more information. The Management Service is installed and deployed into its own Oracle Application Server home directory.


    See Also:

    For more information about the directory structure of a typical Management Service installation, see Oracle Enterprise Manager Advanced Configuration.

  2. The download stage for the Management Service platform is installed with the Management Service. For example, for Linux operating systems, the download stage can be found in:

    OMS_HOME/sysman/agent_download/<version>/linux
    
    
    • The agentDownload script is located at OMS_HOME/sysman/agent_download/<version>/linux

    • The response file is located at OMS_HOME/sysman/agent_download/<version>


      IMPORTANT:

      If the Management Service is using a load balancer, you must modify the s_omsHost and s_omsPort values in the <OMS_HOME>/sysman/agent_download/<version>/agentdownload.rsp file to reflect the load balancer host and port before using the agentDownload script.


      Note:

      For Enterprise Manager 10g R2, the <version> value in the above syntax will be 10.2.0.1.0.

    • The readme file is available at OMS_HOME/sysman/agent_download.

  3. Download the agentDownload script to the target host from the Management Service URL.

    The Management Service installation creates a Web sever alias called agent_download that maps to a physical directory in the Oracle Application Server home directory where the Management Service is installed and deployed. For example, if you installed the Management Service on a host named mgmthost27.acme.com, you could access the following URL from a browser:

    http://mgmthost27.acme.com:4889/agent_download/10.2.0.1.0/<platform>
    
    

    Note:

    Port 4889 is the default port for Grid Control. This should be available after you install the Management Service.

    Using this Web server alias, you can download the script to the target host computer using the following URL. Save the script locally as agentDownload.

    http://mgmthost27.acme.com:4889/agent_download/10.2.0.1.0/<platform>/agentDownload.OS
    
    

    Where OS represents the operating system platform. For example, for Linux operating systems, the script is named agentDownload.linux.

    Any method of retrieving the file is acceptable: cp, rcp, scp, FTP, and so on. The script can also be retrieved by launching a browser on the target machine and saving the link to a local file.


    Note:

    If you opt to download using a file-based protocol rather than HTTP, you need to modify the $AgentDownload URL variable to access the file system on the Management Server host instead of a URL.The URL:
    http://${OMShost}:${httpPort}/agent_download/
    
    

    is a Web alias for:

    $OMS_HOME/sysman/agent_download/
    

  4. Execute the agentDownload script on the target host.

    Before launching the script, ensure that:

    • The execute bit is set and the script file has the proper file protection settings (use chmod to ensure the file has the correct privileges).

    • The parent directory is specified at the command line. This will be the location of the Management Agent home on the target host. If the directory does not exist, it is created during the installation. If it exists, ensure it is empty. If the variable is not set, the script exits with an error.


      Note:

      The parent directory for the agent installation must be specified using the -b option. For example, if you specified the parent directory to be agent_download (scratch/agent_download), then the command to be specified is:
      -b scratch/agent_download
      
      

      The agent Oracle home (agent10g) is created as a sub-directory under this parent directory.


    • The jar executable file is in the PATH environment variable. If the file is not found, the script exits with an error.

    • The wget (or other file transfer mechanism) has been defined in the script. The script default is to call /usr/local/bin/wget. If the referenced file is not found, the script exits with an error.

    • The $AGENT_INSTALL_PASSWORD environment variable is set in the environment if the Management Agent is uploading to a secure Management Service.


      ATTENTION:

      The agent that you are installing is not secure by default. If you want to secure the agent, you must specify the password using the AGENT_INSTALL_PASSWORD environment variable, or by executing the following command after the installation is complete:
      <Agent_Home>/bin/emctl secure agent <password>
      


      See Also:

      For more information about enabling Security for Enterprise Manager components, see Oracle Enterprise Manager Advanced Configuration.

    • The script user has the necessary file access permissions for the Management Agent home directory

  5. After the Management Agent installation is complete, change the directory to the Agent home directory and run the root.sh script as the root user.

    For example:

    $PROMPT>su root
    Password: root_password
    #./root.sh
    #exit
    $PROMPT>
    
    

    The root.sh script must be run as root; otherwise, it exits and the Enterprise Manager job system will not be available. The job system is required for some Enterprise Manager features, such as hardware and software configuration tasks and configuring managed database targets.

Script Details

The agentDownload script performs the following actions:

  • Creates home directories for the Management Agent and Oracle Universal Installer if they do not exist, based on the $ORACLE_HOME path specified through the command line.

  • Downloads the agent_download.rsp response file from the Management Service Web server.

    The Management Service instantiates the response file with the name and port number of the Management Service. As a result, the Management Agent you install is configured to use the Management Service from which the response file was downloaded.

  • Downloads an Oracle Universal Installer JAR file for the target operating system from the Management Service Web server (for Linux only).

  • Unjars the Oracle Universal Installer and points the Oracle Universal Installer to the product definition file (products.xml) hosted by the Management Service Web server.

  • Launches the Oracle Universal Installer in silent mode from the local machine; the Universal Installer pulls files from the Web server to the target machine via HTTP.


    Note:

    This script uses the -ignoresysPrereqs flag to bypass prerequisite check messages for operating system-specific patches during installation; prerequisite checks are still performed and saved to the installer logs. While this makes the Management Agent easier to deploy, check the logs to make sure the target machines on which you are installing Management Agents are properly configured for successful installation.

  • The resulting installation and configuration, including the automatic discovery of managed targets on the Management Agent host, is identical to that provided by the Management Agent install on the Enterprise Manager DVD set.

  • The agentDownload script creates a log file in $ORACLE HOME.

  • At the end of a successful installation, the Agent starts and should begin successfully uploading to the OMS, presuming automatic discovery and automatic start were not disabled at the command line.

To run the script, use the following command:

./agentDownload.<platform> [-bcdhilmnoprstux]

Descriptions of the script options follow:

Table 5-2 AgentDownload Script Options

Option Description

-b

Base directory of the Agent Oracle home.

-c

CLUSTER_NODES (to specify the cluster nodes)

Note that there should not be any spaces between the comma-separated nodes list.

-d

Do not automatically discover targets during installation.

-h

Displays and describes the options that can be used with this script.

-i

Inventory pointer location file: Can be used to point the installer to a non-default inventory. (For advanced users only.)

-l

local (pass -local to runInstaller)

-n

Specify the cluster name.

-o

OLD_ORACLE_HOME during upgrade

-s

Installer stage directory: Points to an installer previously downloaded by the script. If defined, the local installer is launched and the jarred installer is not downloaded.

-t

Do not automatically start the agent at the end of the installation.

-u

Upgrade

-x

Debug output: Turns on shell debugging.


Customizing the agentDownload Script

You can edit the contents of the agentDownload script so it uses a specific tool for transferring files from the Management Service Web server. The contents of the file contain instructions for doing so, as shown in the following example:

WGET="/usr/local/bin/wget --dot-style=mega --verbose --tries=5"
InstallerDownloadCmd=$WGET
# Define the command to be used to download the jarred installer from
# the web server hosting the OMS.
# Other download possibilities: ftp; cp/scp; use local browser to save the
# link to a file on the target machine. 
# This example uses wget, a GNU tool for http and ftp file transfers. 
# If the products.xml referenced by the Oracle Installer is a URL, then the
# Installer will download its files via http. This greatly facilitates
# performing installs in a secure environment that may include firewalls 
# and servers with limited access (no ftp server, NFS mounts not available,
# etc.).
# Enterprise Manager version number. This is used to construct the
# home name used by the installer

GNU wget is available for most platforms and can be downloaded from the following location:

http://www.gnu.org/software/wget/wget.html

Uploading Agent Installation Software for Different Platforms

To obtain the agent download for other platforms, you must complete the following steps to make the Management Agent installable from the Management Service Oracle home:

  1. Download the appropriate files from OTN; there is one compressed cpio file for each platform.

  2. For each file, run gunzip. For example:

    gunzip <filename>.gz
    
    
  3. Run cpio to extract the archive. For example:

    cpio -idcmv <filename>.cpio
    
    
  4. Recursively copy the agentDownload for each operating system platform to the Management Service Oracle home. For example:

    cp -r linux $ORACLE_HOME/sysman/agent_download/<version>
    

Installing the Agent on a Cluster

In Enterprise Manager Grid Control 10g R2 (10.2), the agent installation is supported both on Oracle Clusterware as well as 9.2 clusters. The Management Agent can be installed as a standalone agent on each node of a cluster individually, or can be installed on multiple nodes in one single installation by choosing the cluster option.


IMPORTANT:

The agent Oracle home cannot be installed in an Oracle Cluster Shared File System (OCFS) drive, but is supported on a NAS (Network Attached Storage) drive.

Installing the Agent on a 9.2 Cluster

You can choose to either install a standalone agent on each node individually, or perform a cluster installation of the agent. The following sections discuss the various deployment methods for both options.

Installing a Standalone Agent on a 9.2 Cluster Node

You can perform a standalone agent installation using the following deployment methods:

Standalone Agent Install Using the agentDownload Script

The agent can be installed by executing the agentDownload script on one node at a time using the correct arguments. If you want to discover the cluster targets, then you must set the CLUSTER_NAME environment variable prior to executing the agentDownload script, or pass the cluster name to the agentDownload script as agentDownload -n <clustername>.

agentDownload -n <clustername>


Note:

If the CLUSTER_NAME environment variable is not set, the agent cannot discover any Cluster targets.

Standalone Agent Install Using the Agent Deploy Application

To perform a standalone agent install on a cluster node, you must select the appropriate node of that cluster. If you want to discover the cluster targets, you must specify the correct cluster name in the Cluster Name text box. See Chapter5, "Fresh Installation of the Management Agent" for detailed instructions.


Note:

Ensure the nodes that you select for the agent installation are part of the cluster that you have specified in the Cluster Name text box. Otherwise, the targets are not discovered.

Standalone Agent Install Using the Oracle Universal Installer

You can perform this installation by invoking the Enterprise Manager Installer using Oracle Universal Installer (OUI). The Interactive type is typically a one-node installation.

If the agent is installed as a standalone agent on a 9.2 cluster, then you can set the CLUSTER_NAME environment variable to the name of the cluster that you want to use for the cluster targets before invoking the runInstaller. If this variable is not set, the agent cannot discover any Cluster targets.

Installing a Cluster Agent on a 9.2 Cluster

You can perform a cluster agent installation using the following deployment methods:

Cluster Agent Install Using the agentDownload Script

You can perform a cluster agent installation through this script by using the -c option (for example, -c "node1,node2,..."). This option helps install the cluster agent on all the nodes that you specify here.

If you want to override the Cluster name that appears in targets.xml, then you must set the CLUSTER_NAME environment variable prior to executing the agentDownload script, or pass the cluster name to the agentDownload script as agentDownload -n <clustername>.

Cluster Agent Install Using the Agent Deploy Application

To perform a cluster agent installation using the Agent Deploy application, you must select the Cluster Install option and specify all the nodes of that cluster. If you want to discover the cluster targets, you must specify the correct cluster name in the Cluster Name text box. See Chapter5, "Fresh Installation of the Management Agent" for detailed instructions.

Cluster Agent Install Using the Interactive Installer

To install an agent on a 9.2 cluster that is on multiple nodes at a time, you must pass the CLUSTER_NODES variable to the run installer as:

./runInstaller "CLUSTER_NODES={node1,node2, ...}"

If the CLUSTER_NODES is not passed, the installer cannot detect the nodes and cannot perform the cluster install.

If you want to set the cluster name that appears in the targets.xml, you must set the CLUSTER_NAME environment variable before invoking the runInstaller. If this variable is not set, the agent uses the first node as the cluster name.

Installing the Agent on Oracle Clusterware

You can choose to either install a standalone agent on each Oracle Clusterware node individually, or perform a cluster installation of the agent. The following sections discuss the various deployment methods for both options.

Installing a Standalone Agent on Oracle Clusterware

You can perform a standalone agent installation on Oracle Clusterware using the following deployment methods:

Standalone Agent Install Using agentDownload Script

The agent can be installed by executing the agentDownload script on one node at a time using the correct arguments. If you want to override the cluster name to be used in targets.xml, you must set the CLUSTER_NAME environment variable prior to executing the agentDownload script, or pass the cluster name to the agentDownload script as agentDownload -n <clustername>.

agentDownload -n <clustername>


Note:

If the CLUSTER_NAME environment variable is not set or passed, the agent uses the cluster name that was specified during the Oracle Clusterware installation.

Standalone Agent Install Using the Agent Deploy Application

To perform a standalone agent installation on a cluster node, you must select the Cluster Install option, and specify the appropriate cluster node names. The cluster name that you specify here overrides the corresponding value in the targets.xml file. See Chapter5, "Fresh Installation of the Management Agent" for detailed instructions.

Standalone Agent Install Using the Interactive Installer

You can perform this installation by invoking the Enterprise Manager Installer using Oracle Universal Installer (OUI).

If you want to set the Cluster name that will appear in targets.xml, then you must set the CLUSTER_NAME environment variable before invoking the runInstaller. If this variable is not set, the agent uses the cluster name that was specified during the Oracle Clusterware installation.

Installing a Cluster Agent on Oracle Clusterware

You can perform a cluster agent installation using the following deployment methods:

Cluster Agent Install Using the agentDownload Script

You can perform a cluster agent installation through this script by using the -c option (for example, -c node1,node2,...). This option helps install the cluster agent on all the nodes that you specify here.

If you want to override the Cluster name that appears in targets.xml, then you must set the CLUSTER_NAME environment variable prior to executing the agentDownload script, or pass the cluster name to the agentDownload script as agentDownload -n <clustername>.


Note:

If the CLUSTER_NAME variable is not set or passed, the agent uses the cluster name that was specified during the Oracle CLusterware installation.

Cluster Agent Install Using the Agent Deploy Application

To perform a cluster agent installation using the Agent Deploy application, you must select the Cluster Install option and specify all the nodes of that cluster. If you want to override the Cluster name that appears in targets.xml, you must specify the appropriate cluster name in the application. See Chapter5, "Fresh Installation of the Management Agent" for detailed instructions.

Cluster Agent Install Using the Interactive Installer

When you execute the runInstaller script, it automatically detects all the cluster nodes. You can then choose the nodes on which you want to perform the cluster agent installation.

If you want to override the Cluster name that appears in targets.xml, you must set the CLUSTER_NAME environment variable before invoking the runInstaller. If this variable is not set, the agent uses the cluster name that was specified during the Oracle Clusterware installation.

Cloning the Management Agent

If you have a master agent installation, you can use this installed agent and clone it on multiple destination Oracle homes.

To clone a Management Agent:

  1. Install the Agent on a host using any of the deployment methods discussed in this chapter.

  2. Zip the agent Oracle home that you want to clone (for example, agent.zip).

  3. Perform a file transfer (FTP) of this zipped Oracle home onto the destination host (for example, ftp agent.zip).

  4. In the destination host, unzip the agent Oracle home.

  5. Go to $ORACLE_HOME/oui/bin/ and execute the following command:

    ./runInstaller  -clone -forceClone ORACLE_HOME=<full path of Oracle home> ORACLE_HOME_NAME=<Oracle home name> -noconfig -silent
    
    

    Note:

    The cloned agent is not in the secure mode by default. You must manually secure the agent by executing <Oracle_Home>/bin/emctl secure agent.

  6. Execute the following script to run the Agent Configuration Assistant (agentca):

    $ORACLE_HOME/bin/agentca -f
    
    

IMPORTANT:

After the cloning process is complete, you must execute the root.sh script from the destination agent Oracle homes.