Skip Headers
Oracle® Enterprise Manager Grid Control agentDownload Install Readme
10g Release 2 (10.2)
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

  Mobi · ePub

Oracle® Enterprise Manager

Grid Control agentDownload Install Readme

10g Release 2 (10.2)

B28832-01

May 2006

This document describes how to add additional Host targets to the Enterprise Manager Central Console by installing the Oracle Management Agent. There are a number of strategies for installing the Oracle Management Agent. This document specifically describes how to install agents using the download method: Agent installation files are staged in the OMS home; the agentDownload script is executed on the target host(s) and the files are copied to the destination host(s) over the network using HTTP.

In order to add a host target to your Grid Control console, you must first install the Oracle Management Agent on the computer (host) that you want to manage. When the Management Agent on that host begins communicating with the Oracle Management Service, the agent target and the host target will appear in the list of targets. Refer to the information in this document for instructions on installing the Oracle Management Agent.

This document is installed with the OMS, and is accessible through a web browser at:

http://<OMS_host>:<OMS_port>/agent_download/agent_install_readme.html

It is also accessible through the file system on the host on which the OMS is installed; the web alias maps to this file location:

OMS_HOME/sysman/agent_download/agent_install_readme.html

The OMS_HOME is the home directory of the Management Service. For more information about the directories and files installed by the Enterprise Manager installation, see Oracle Enterprise Manager Advanced Configuration.

The latest version is also available on the Oracle Technology Network website inside the Mass Agent Deployment download:

http://www.oracle.com/technology/software/products/oem/htdocs/agentsoft.html

Note:

Information on Adding Host Targets is also available in the Grid Control console online help. Click Help, and use the search tab to find "Adding Host Targets", or use the Adding Host Targets link on the Hosts page of the Targets tab (Click Add in the Targets page. In the Information page that appears, click Adding Host Targets.)

1 Management Agent Deployment Options

You can deploy the Management Agent on remote hosts using any of the following installation mechanisms:

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

2.1 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, 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. See the Section 2.4.1, "Cluster Installation" section for more information on deploying Management Agents onto clusters.

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

  • Provides useful install options via the command line (including the ability to control target auto-discovery, auto-starting of the agent, and so on).

  • Allows installation onto clustered environments. See the Section 2.4.1, "Cluster Installation" section for more information.

2.3 Obtaining the agentDownload Script

The downloadable Agent software for the operating system of the OMS platform is available from inside an installed Oracle Management Service Oracle home, and from the following Oracle Technology Network Web site under Mass Agent Deployment:

http://www.oracle.com/technology/software/products/oem/htdocs/agentsoft.html

There is a separate downloadable agent for each operating system platform. See Section 2.5, "Downloading Agent Installation Software for Different Platforms" for more information on obtaining agent installables for different platforms.

2.4 Using the agentDownload Script

In use, the agentDownload script is downloaded to a target node and executed to initiate a silent Oracle Universal Install session. The agent files are copied from the staging area in the OMS home to the target node via HTTP.

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. 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>/<platform>
    
    
    • The agentDownload script is located at OMS_HOME/sysman/agent_download/<version>/<platform>

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

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

    Important:

    If the Management Service is using a load balancer, you must modify the s_omsHost and s_omsPort values in the download script file to reflect the load balancer host and port before using the agentDownload script.
  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.2.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.2.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 perform the installation using a file-based protocol rather than HTTP, you need to modify the $AgentDownload URL variable in the script 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 base 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 base 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 wget (or other file transfer mechanism) has been defined in the script. The script checks for the existence of wget in /usr/local/bin/wget, followed by /usr/bin/wget. If wget is not found in either of those locations, then it must be included in the $PATH or the script will exit 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.

      On all UNIX platforms, if the $AGENT_INSTALL_PASSWORD environment variable is not set, the agentDownload script when executed, will prompt you to specify the Registration Password. If the password that you specify is correct, the agent gets secured autmatically.

      ATTENTION:

      If the agent that you are installing is not secure, you must execute 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 or with sudo privileges; 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.

2.4.1 Cluster Installation

The agentDownload script can be used to install Management Agents onto clustered environments. In order to perform this type of installation, the following command-line switches are used:

Table 1 Command-line Switches to be Used

Command-line Switches Description

-c

This option is followed by a comma-separated list of the nodes in the cluster. It is possible to install a standalone agent that will still discover cluster targets by not specifying this option while still specifying the cluster name with the -n option.

-n

This option is followed by the name of the cluster. This option is required for 9i clusters; for 10g clusters, if this option is not specified, the default cluster name from the targets.xml file will be used.

-l

This option specifies that the install should be done just on the local node of the cluster.


For example, to use the agentDownload script to install a Management Agent on just the local node of a cluster that consists of nodes host1, host2, and host3, with cluster name myCRS, you must execute the following:

./agentDownload.<platform> -b /scratch/agentInstall -c "host1,host2,host3" -n myCRS -l

2.4.2 Script Details

The agentDownload script performs the following actions:

  • Creates a home directory for the Management Agent and Oracle Universal Installer if they do not exist, based on the parent directory 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/cfgtoollogs/cfgfw.

  • 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> [-bcdhilmnoprtux]

Descriptions of the script options follow:

Table 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

-t

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

-u

Upgrade

-x

Debug output: Turns on shell debugging.


For example, to use the agentDownload script to install a Management Agent on just the local node of a cluster that consists of nodes host1, host2, and host3, with cluster name myCRS, you must execute the following:

./agentDownload.<platform> -b /scratch/agentInstall -c "host1,host2,host3" -n myCRS -l

2.4.3 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

2.5 Downloading 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.

Note:

The agentDownload kit for all UNIX platforms in this release (10.2.0.2) will be in the ZIP (.zip) format, and not in the cpio format as was in the 10.2.0.1 release.

2.5.1 Downloading the 10.2.0.1 Agent Installation Software

To Obtain agentDownload for Unix

Follow the instructions below, to download the agent installation software for Unix:

  1. Download the <platform>_Grid_Control_agent_download_10_2_0_1.cpio.gz (or .zip) file from OTN:

    http://www.oracle.com/technology/software/products/oem/htdocs/agentsoft.html

  2. Copy the downloaded file to the <OMS_HOME>/sysman/agent_download/10.2.0.1.0 directory.

    Note:

    Create the <OMS_HOME>/sysman/agent_download/10.2.0.1.0 directory, if it does not exist.
  3. Go to this directory by executing the following:

    cd <OMS_HOME>/sysman/agent_download/10.2.0.1.0
    
    

    When you are here, confirm that the size and checksum calculation of the downloaded file match the information specified on the OTN download page.

  4. Run gunzip by executing the following:

    gunzip <platform>_Grid_Control_agent_download_10_2_0_1.cpio.gz
    
    

    Note:

    For the agentDownloads that are of the .zip format, execute the following command:
    unzip <platform>_Grid_Control_agent_download_10_2_0_1.zip
    
  5. To extract archives that are in the cpio format, execute the following command:

    cpio -idcmv < <platform>_Grid_Control_agent_download_10_2_0_1.cpio
    
    
  6. If the agent_download.rsp file does not exist in the <OMS_HOME>/sysman/agent_download/10.2.0.1.0 directory, do the following:

    1. Execute mv agent_download.rsp.bak agent_download.rsp

    2. Edit agent_download.rsp and modify s_OMSHost="REPLACE_WITH_OMS_HOST" and s_OMSPort="REPLACE_WITH_OMS_PORT" variables with the correct OMSHost and OMSPort values. For example:

      s_OMSHost="stadv26.us.oracle.com"
      s_OMSPort="4889"
      

      Note:

      Even if you are specifying a secure Management Service, you must still enter the non-secure port number here.
  7. Edit the <OMS_HOME>/sysman/agent_download/10.2.0.1.0/<platform>/agentDownload.linux file and modify OMShost=REPLACE_WITH_OMS_HOST and httpPort=REPLACE_WITH_OMS_PORT with the correct OMSHost and OMSPort.(Even if you are specifying a secure Management Service, you must still enter the non-secure port number here.) For example:

    OMShost=stadv26.us.oracle.com
    httpPort=4889
    

To obtain agentdownload for Windows:

Follow the instructions below, to download the agent installation software for Windows:

  1. Download the Win32_Grid_Control_agent_download_10_2_0_1.zip file from OTN:

    http://www.oracle.com/technology/software/products/oem/htdocs/agentsoft.html
    
    
  2. Copy the downloaded file to the <OMS_HOME>/sysman/agent_download/10.2.0.1.0 directory.

    Note:

    Create the <OMS_HOME>/sysman/agent_download/10.2.0.1.0 directory, if it does not exist.
  3. Go to this directory by executing the following:

    cd <OMS_HOME>/sysman/agent_download/10.2.0.1.0
    
    

    When you are here, confirm that the size and checksum calculation of the downloaded file match the information specified on the OTN download page.

  4. Unzip this file by executing the following:

    unzip Win32_Grid_Control_agent_download_10_2_0_1.zip
    
    
  5. After unzipping, the agentdownload.vbs will be available at <OMSHOME>/sysman/agent_download/10.2.0.1.0/win32/agentdownload.vbs.

  6. Download the agentDownload.vbs on the machine where you want to install the Management Agent.

  7. Run agentDownload.vbs by executing the following:

    cscript.exe agentDownload.vbs (followed by the appropriate options to specify the OMS Oracle home and port)
    

2.5.2 Downloading (10.2.0.2.0 and Higher) Agent Installation Software

To Obtain agentDownload for Linux

Follow the instructions below to download the agent installation software for Linux:

  1. Download the Linux_Grid_Control_agent_download_10_2_0_2_0.zip file from OTN:

    http://www.oracle.com/technology/software/products/oem/htdocs/agentsoft.html

  2. Copy the downloaded file to the <OMS_HOME>/sysman/agent_download/10.2.0.2.0 directory.

    Note:

    Create the <OMS_HOME>/sysman/agent_download/10.2.0.2.0 directory, if it does not exist.
  3. Go to this directory by executing the following:

    cd <OMS_HOME>/sysman/agent_download/10.2.0.2.0
    
    

    When you are here, confirm that the size and checksum calculation of the downloaded file match the information specified on the OTN download page.

  4. Unzip the file by executing the following:

    <OMS_HOME>/bin/unzip Linux_Grid_Control_agent_download_10_2_0_2_0.zip
    
    
  5. If the agent_download.rsp file does not exist in the <OMS_HOME>/sysman/agent_download/10.2.0.2.0 directory, do the following:

    1. Execute mv agent_download.rsp.bak agent_download.rsp

    2. Edit agent_download.rsp and modify s_OMSHost="%s_hostname%" and s_OMSPort="%s_OMSPort%" variables with the correct OMSHost and OMSPort values. For example:

      s_OMSHost="stadv26.us.oracle.com"
      s_OMSPort="4889"
      

      Note:

      Even if you are specifying a secure Management Service, you must still enter the non-secure port number here.
  6. Edit the <OMS_HOME>/sysman/agent_download/10.2.0.2.0/linux/agentDownload.linux and modify OMShost=%s_OMSHost% and httpPort=%s_OMSPort% with the correct OMSHost and OMSPort. For example:

    OMShost=stadv26.us.oracle.com
    httpPort=4889
    

    Note:

    Even if you are specifying a secure Management Service, you must still enter the non-secure port number here.

To Obtain agentDownload for Windows

Follow the instructions below, to download the agent installation software for Windows:

  1. Download the Win32_Grid_Control_agent_download_10_2_0_2_0.zip file from OTN:

    http://www.oracle.com/technology/software/products/oem/htdocs/agentsoft.html
    
    
  2. Copy the downloaded file to the <OMS_HOME>/sysman/agent_download/10.2.0.2.0 directory.

    Note:

    Create the <OMS_HOME>/sysman/agent_download/10.2.0.2.0 directory, if it does not exist.
  3. Go to this directory by executing the following:

    cd <OMS_HOME>/sysman/agent_download/10.2.0.2.0
    
    

    When you are here, confirm that the size and checksum calculation of the downloaded file match the information specified on the OTN download page.

  4. Unzip this file by executing the following:

    <OMS_HOME>/bin/unzip Win32_Grid_Control_agent_download_10_2_0_2_0.zip
    
    
  5. After unzipping, the agentdownload.vbs will be available at <OMSHOME>/sysman/agent_download/10.2.0.2/win32/agentdownload.vbs.

  6. Download the agentDownload.vbs on the machine where you want to install the Management Agent.

    Note:

    Before executing the agentDownload.vbs script, ensure Windows Script Host version 5.6 is installed on the target agent host. This is required for the script to be executed successfully.
  7. Run agentDownload.vbs by executing the following:

    CScript.exe agentDownload.vbs b <ORACLE_HOME> m <OMS_HOST> r <HTTPport>
    
    

    For example,

    CScript.exe agent_download.vbs  b  C:\foo  m foo.us.abc.com  r   4889
    

3 Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.


Management Agent Download Installation Readme, 10g Release 2 (10.2)

Copyright © 2003, 2006, Oracle. All rights reserved.

The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software—Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.

Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.