Skip Headers
Oracle® Enterprise Manager Cloud Control Basic Installation Guide
12c Release 4 (12.1.0.4)

E22624-32
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

7 Installing Oracle Management Agents

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

7.1 Overview

Oracle Management Agent (Management Agent) is one of the core components of Enterprise Manager Cloud Control that enables you to convert an unmanaged host to a managed host in the Enterprise Manager system. The Management Agent works in conjunction with the plug-ins to monitor the targets running on that managed host.

Therefore, at any point in time, if you want to monitor a target running on a host, ensure that you first convert that unmanaged host to a managed host by installing a Management Agent, and then manually discover the targets running on it to start monitoring them.

To install a Management Agent, use the Add Host Targets Wizard that is accessible from within the Enterprise Manager Cloud Control console, or use EM CLI. Oracle recommends that you use this wizard, or EM CLI, for the mass-deployment of Management Agents.

Figure 7-1 describes a method to access the Add Host Targets Wizard.

Figure 7-1 Add Host Targets Wizard

Surrounding text describes Figure 7-1 .

The Add Host Targets Wizard is an application that offers GUI-rich, interactive screens. To access it, do one of the following:

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

  • From the Setup menu, select Add Target, then select Auto Discovery Results. On the Auto Discovery Results page, under the Servers, Storage and Network tab, select a host that you want to monitor from the displayed list, then click Promote.

The wizard enables you to do the following on multiple hosts across platforms with options to run preinstall and postinstall scripts:

  • Deploy a fresh Management Agent

    Surrounding text describes fresh_agent.jpg.
  • Clone an existing well-tested and patched Management Agent

    Surrounding text describes clone_agent.jpg.
  • Install a Management Agent (called Shared Agent) using an existing, centrally shared Management Agent (called Master Agent)

    Surrounding text describes shared_agent.jpg.

Note:

This chapter only describes how you can deploy a fresh Management Agent using the Add Host Targets Wizard. For information on cloning an existing instance and deploying a Management Agent using a shared instance, refer to Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

To monitor a target, you need to add the target 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.

When you install a standalone Management Agent on a host, you will see the following default contents in the agent base directory:

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

Note:

You can repoint your existing Management Agents to a new Oracle Management Service (OMS). For information on how to do this, see the Redirecting Oracle Management Agent to Another Oracle Management Service Appendix present in Oracle Enterprise Manager Cloud Control Advanced Installation Guide.

When you repoint your existing Management Agents to a new OMS, you cannot move the targets monitored by the Management Agents, the target history, and the Management Agent history. The monitored targets and the history data is lost.

7.2 Before You Begin

Before you begin installing a Management Agent using the Add Host Targets Wizard, or EM CLI, keep these points in mind:

  • The Add Host Targets Wizard and EM CLI convert an unmanaged host to a managed host in the Enterprise Manager system by installing a 12.1.0.4.0 Management Agent.

  • Oracle recommends you to use the Add Host Targets Wizard or EM CLI to mass-deploy Management Agents in your environment.

  • To install a Management Agent on a host, you must download and apply the required version of the Management Agent software for the host platform, using Self Update. Only the Management Agent software for the OMS host platform is downloaded and applied by default.

    To access Self Update, from the Setup menu, select Extensibility, then select Self Update.

    For information on how to download and apply the Management Agent software for a platform, see Section 7.3.2.

  • Oracle Management Agent 12c communicates only with Oracle Management Service 12c and not with any earlier release of Enterprise Manager.

    When you use the Add Host Targets Wizard of a 12.1.0.4.0 OMS, or EM CLI, you can install only the latest Management Agent version on a platform, for which the Management Agent software is downloaded and applied. For example, if the 12.1.0.4.0 Management Agent software for a particular platform is downloaded and applied, you can install only a 12.1.0.4.0 Management Agent on that platform, and not a 12.1.0.3.0 or a 12.1.0.2.0 Management Agent.

    For information about the compatibility between 12c releases of Management Agents and the OMS, see Table 6-2.

  • If you have multiple hosts, sharing a common mounted drive, then install the Management Agents in two different phases:

    1. In the Add Host Targets Wizard, select the deployment type Fresh Agent Install, and install a Management Agent on the host where the drive is shared. Alternatively, you can select the deployment type Clone Existing Agent, and clone the Management Agent to the host where the drive is shared.

      For more information, refer to the chapter on cloning a Management Agent in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

    2. In the Add Host Targets Wizard, select the deployment type Add Host to Shared Agent, and install a Management Agent on all other hosts that access the shared, mounted drive. (Here, you will select the Management Agent you installed in the previous step as the master agent or shared agent.)

      For more information, refer to the chapter on installing a Shared Agent in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

  • If you have an Oracle RAC Cluster with multiple nodes, then you must install a Management Agent on each of the nodes separately. In other words, in the Add Host Targets Wizard, you must add each node explicitly as a destination host.

  • In Enterprise Manager Cloud Control 12c Release 4 (12.1.0.4.0), you can save the Management Agent one-off patches that you want to apply on a particular version of the Management Agent software, such that these patches are automatically applied on the software whenever a new Management Agent of the same version is deployed, or an old Management Agent is upgraded to that version.

    For information on how to do this, see Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

    Also, you can apply one-off patches on a plug-in and create a custom patched plug-in, such that this custom patched plug-in is deployed on all the new Management Agents that you deploy, and all the old Management Agents that you upgrade.

    For information on how to do this, see Oracle Enterprise Manager Cloud Control Administration Guide.

  • The Add Host Targets Wizard supports the permissive and enforcing options for Security-Enhanced Linux (SELinux).

  • The Add Host Targets Wizard uses SSH to establish connectivity between Oracle Management Service (OMS) and the remote hosts where you want to install the Management Agents.

  • Only SSH1 (SSH version 1) and SSH2 (SSH version 2) protocols offered by OpenSSH are supported for deploying a Management Agent.

  • The Add Host Targets Wizard supports Named Credentials that enable you to use a set of credentials registered with a particular name specifically for this operation, by your administrator. This ensures an additional layer of security for your passwords because as an operator, you can only select the named credential, which is saved and stored by an administrator, and not know the actual user name and password associated with it.

    In case the named credential you select does not have the privileges to perform the installation, then you can set the named credential to run as another user (locked user account). In this case, the wizard logs in to the hosts using the named credential you select, but performs the installation using the locked user account you set.

    For example, you can create a named credential titled User_A (the user account that has remote login access), and set it to run as User_X (the Management Agent install user account for which no direct login is set) that has the required privileges. In this case, the wizard logs in to the hosts as User_A, but installs as User_X, using the privilege delegation setting (sudo or PowerBroker) specified in the named credential.

    The sudo, pbrun, sesu, and su privilege delegation tools are supported in Cloud Control.

  • Named credentials support SSH public key authentication and password based authentication. So you can use an existing SSH public key authentication without exposing your passwords.

    To set up SSH public key authentication for a named credential, follow these steps:

    Note:

    If you have already set up SSH public key authentication for a named credential and the SSH keys are already created, upload the SSH keys to Enterprise Manager, as mentioned in Step 3 of the following procedure.
    1. Navigate to the following location in the OMS home:

      $<OMS_HOME>/oui/prov/resources/scripts

      For example,

      /home/software/em/middleware/oms/oui/prov/resources/scripts

    2. If the OMS host runs on Oracle Solaris, edit the sshUserSetup.sh script to change the following:

      "SunOS") SSH="/usr/local/bin/ssh" SSH_KEYGEN="/usr/local/bin/ssh-keygen"

      to

      "SunOS") SSH="/usr/bin/ssh" SSH_KEYGEN="/usr/bin/ssh-keygen"

    3. If the OMS host runs on any Unix based operating system, run the sshUserSetup.sh script on the OMS host as the OMS user, and pass the Management Agent install user name and the fully qualified name of the target hosts:

      sshUserSetup.sh -setup -user <agent_install_user_name> -hosts <target_hosts>

      The following SSH keys are created:

      $HOME/.ssh/id_rsa
      $HOME/.ssh/id_rsa_pub
      

      Here, $HOME refers to the home directory of the OMS install user.

      If the OMS host runs on Microsoft Windows, install Cygwin on the OMS host (described in Chapter 5), then run the sshUserSetupNT.sh script on the OMS host as the OMS user, and pass the Management Agent install user name and the fully qualified name of the target hosts:

      sshUserSetupNT.sh -setup -user <agent_install_user_name> -hosts <target_hosts>

    4. Upload the SSH keys to Enterprise Manager.

      From the Setup menu, select Security, then select Named Credentials. Click Create. For Credential Name, specify the name of the credential, for Credential Type, select SSH Key Credentials, and for Scope, select Global. If you do not select the Global option, you cannot use the SSH named credential to install Management Agents using the Add Host Targets Wizard.

      To upload one of the private SSH keys created in Step 3, in the Credential Properties section, specify the location of the private SSH key as a value for the Upload Private Key field. Click Save.

      To upload one of the public SSH keys created in Step 3, in the Credential Properties section, specify the location of the public SSH key as a value for the Upload Public Key field. Click Save.

      Figure 7-2 describes how to upload SSH keys to Enterprise Manager.

      Figure 7-2 Uploading SSH Keys to Enterprise Manager

      Surrounding text describes Figure 7-2 .

    If you have already set up SSH public key authentication for a named credential, you can use the named credential while installing Management Agents using the Add Host Targets Wizard.

  • You can mass deploy Management Agents on a number of hosts in a rolling manner, using the Add Host Targets Wizard or EM CLI. In this method, the deployment proceeds continuously from one deployment phase to another, after ignoring the failed hosts in each deployment phase. The deployment process does not stop when a host fails a deployment phase.

    To deploy Management Agents in a rolling manner, ensure that you set the oracle.sysman.prov.agentpush.continueIgnoringFailedHost property to true in the $<OMS_HOME>/sysman/prov/agentpush/agentpush.properties file, then use the Add Host Targets Wizard, or EM CLI to deploy the Management Agents.

  • By default, the Add Host Targets Wizard configures only the following types of plug-ins:

    • All discovery plug-ins that were configured with the OMS from where the Management Agent software is being deployed.

    • Oracle Home discovery plug-in

    • Oracle Home monitoring plug-in

  • You must have read privileges on the Oracle WebLogic Server's alert log directories for the Support Workbench (Incident) metrics to work properly. You must also ensure that the Management Agent that is monitoring this Oracle WebLogic Server target is running on the same host as the Oracle WebLogic Server.

  • If you have a common mount point in your organization, then ensure that it is generic and ensure that you install the Management Agent in this generic mount point. This guideline helps when you upgrade your Management Agents to higher releases in the future within the same mount point, and not acquire new mount points each time.

    For example, have a mount point such as /oracle/product/agent and install the Management Agent in there so that it appears as /oracle/product/agent/agent12c.Do not install the Management Agent directly in the mount point because it breaks the upgrade path and causes problems with cleanup operations.

Note:

Instead of installing a Management Agent using the Add Host Targets Wizard, or EM CLI, you can choose to install the Management Agent manually, in silent mode. For information on installing a Management Agent in silent mode, refer to Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

7.3 Prerequisites

This section describes the prerequisites you must meet before installing Management Agents using the Add Host Targets Wizard or EM CLI. In particular, it contains the following:

7.3.1 Meeting the Generic Prerequisites

Table 7-1 lists the generic prerequisites you must meet before installing Management Agents using the Add Host Targets Wizard or EM CLI.

Table 7-1 Prerequisites for Installing Oracle Management Agent

Requirement Description

Hardware Requirements

Ensure that you meet the hard disk space and physical memory requirements as described in Chapter 2.

Software Requirements

(For Microsoft Windows) Ensure that you have installed Cygwin 1.7 on the destination host as described in Chapter 5.

Note: While running cygwin.bat in Microsoft Windows Server 2008 and Microsoft Windows Vista, ensure that you invoke it in administrator mode. To do this, right-click the cygwin.bat file and select Run as administrator.

If you do not want to install Cygwin to deploy Management Agents on Microsoft Windows hosts using the Add Host Targets Wizard or EM CLI, you can choose to deploy Management Agents on these hosts using the PsExec process utility. For information on how to deploy Management Agents on Microsoft Windows hosts using PsExec, see Appendix F.

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 the Enterprise Manager certification matrix, follow the steps outlined in Appendix E.

For information about platforms receiving future support, refer to My Oracle Support note 793512.1.

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, which is not a supported update level for installation, is installed.

Solaris 10 10/08 s10s_u6wos_07b SPARC

File System Requirements

Ensure that the file system mounted on the destination host does not permit buffered writes.

File Descriptor Requirements

  • Ensure that the maximum user process limit is set to 13312 or greater.

    To verify the current value set, run the following command:

    ulimit -u

    If the current value is not 13312 or greater, then contact your system administrator to set it to at least 13312.

  • Ensure that you set the soft limit of file descriptor to a minimum of 4096 and hard limit less then or equal to 16384.

    To verify the current value set, run the following commands:

    For Soft Limit:

    /bin/sh -c "ulimit -n"

    For Hard Limit:

    /bin/sh -c "ulimit -Hn"

    If the current value is not 4096 or greater, then as a root user, update the /etc/security/limits.conf file with the following entries:

    <UID> soft nofile 4096

    <UID> hard nofile 16384

Package Requirements

Ensure that you install all the operating system-specific packages as described in Chapter 3.

User and Operating System Group Requirement

Ensure that you create the required operating system groups and users as described in Chapter 4.

Note: If your enterprise has a policy against installing Management Agents using the OMS install operating system user account, you can use a different operating system user account to install Management Agents. However, ensure that the user account you use and the OMS install user account belong to the same primary group.

Privilege Requirements

Ensure that the Enterprise Manager user has the CREATE_TARGET privilege. If the Enterprise Manager user does not have this privilege, ensure that this privilege is granted to the user.

Super administrators, such as the sysman user, have the CREATE_TARGET privilege by default.

Destination Host Requirements

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 example.com and the short name is mypc, then add the following line in the /etc/hosts file:

172.16.0.0 example.com mypc

Destination Host Credential Requirements

If all the destination hosts are of the same platform, then they must 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.

Permission Requirements

  • Ensure that the agent base directory you specify is empty and has the write permission for the install user.

  • Ensure that the instance directory is empty and has the write permission for the install user.

Destination Host Time Zone Requirements

Ensure that the time zones of the destination hosts have been set correctly. To verify the time zone of a destination host, log in to the OMS host, and run the following command:

ssh -l <install_user> <destination_host_name> /bin/sh -c 'echo $TZ'

If the time zone displayed is incorrect, log in to the destination host, and follow these steps:

  1. Run the following commands to set the time zone on the destination host:

    • For Korn shell:

      TZ=<value>

      export TZ

    • For Bourne shell or Bash shell:

      export TZ=<value>

    • For C shell:

      setenv TZ <value>

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

    export TZ='America/New_York'

    To set the time zone on a destination host that runs on Microsoft Windows, from the Start menu, select Control Panel. Click Date and Time, then select the Time Zone tab. Select your time zone from the displayed drop down list.

    To view a list of the time zones you can use, access the supportedtzs.lst file present in the <AGENT_HOME>/sysman/admin directory of the central agent (that is, the Management Agent installed on the OMS host).

  2. Restart the SSH daemon.

    If the destination host runs on a UNIX based operating system, run the following command:

    sudo /etc/init.d/sshd restart

    If the destination host runs on a Microsoft Windows operating system, run the following commands:

    cygrunsrv -E sshd

    cygrunsrv -S sshd

  3. Verify whether the SSH server can access the TZ environment variable by logging in to the OMS host, and running the following command:

    ssh -l <install_user> <destination_host_name> /bin/sh -c 'echo $TZ'

Note: If you had ignored a prerequisite check warning about wrong time zone settings during the Management Agent install, you must set the correct time zone on the destination hosts after installing the Management Agents. For information on setting time zones post install, refer Section 7.5.

sudo/pbrun/sesu/su SSH Requirements

(Only for UNIX)

Ensure that you set the oracle.sysman.prov.agentpush.enablePty property to true in the $<OMS_HOME>/sysman/prov/agentpush/agentpush.properties file, if the privilege delegation tool you are using requires a pseudo terminal for remote command execution via SSH. Most privilege delegation tools such as pbrun, sesu, and su require a pseudo terminal for remote command execution, by default.

Alternatively, you can use the -enablePty additional parameter while installing Management Agents using the Add Host Targets Wizard (as described in Section 7.4.1), or EM CLI (as described in Section 7.4.2). For more information about this parameter, see Section 7.4.3.

Note: If you are using sudo as your privilege delegation tool, and you do not want to set the oracle.sysman.prov.agentpush.enablePty property to true, do one of the following:

  • Include Defaults visiblepw in the /etc/sudoers file, or enter the sudo command with the -S option for Privileged Delegation Setting on the Installation Details page.

    For information on how to access the Installation Details page, see Section 7.4.

  • Comment out Defaults requiretty in the /etc/sudoers file.

sudo/pbrun/sesu/su Requirements (for executing commands as the root user)

(Only for UNIX)

  • Ensure that the installing user has the privileges to invoke the id command and the agentdeployroot.sh script as root. Grant the privileges in the configuration file of your privilege delegation tool.

    For example, if you are using sudo as your privilege delegation tool, include the following in the /etc/sudoers file to grant the required privileges:

    <install_user> ALL=(root) /usr/bin/id, <agent_home>/*/agentdeployroot.sh

    For example, oracle ALL=(root) /usr/bin/id, /home/oracle/agentibd/*/agentdeployroot.sh

    Here, oracle is the installing user, and /home/oracle/agentibd is the Management Agent home, that is, the agent base directory.

  • You do not require the following entry in the /etc/sudoers file for installing a Management Agent. However, the entry is required for performing provisioning and patching operations in Enterprise Manager. Therefore, if you are removing this entry before installing a Management Agent, then ensure that you bring back the entry after installing the Management Agent.

    In Enterprise Manager Cloud Control 12c Release 2 (12.1.0.2), Release 3 (12.1.0.3), and Release 4 (12.1.0.4):

    (root) /<AGENT_BASE_DIRECTORY>/sbin/nmosudo

    In Enterprise Manager Cloud Control 12c Release 1 (12.1.0.1) [with Bundle Patch 1]:

    (root) /<AGENT_INSTANCE_DIRECTORY>/bin/nmosudo

sudo/pbrun/sesu/su Requirements (for executing commands as the locked account user)

(Only for UNIX)

Ensure that the installing user has the privileges to invoke /bin/sh as the locked account user. Grant the privileges in the configuration file of your privilege delegation tool.

For example, if you are using sudo as your privilege delegation tool, include the following in the /etc/sudoers file to grant the required privileges:

login_user1 ALL=(oracle) /bin/sh

Here, login_user1 is the SSH log in user, and oracle is the locked account and install user.

If you do not want to grant privileges to the installing user to invoke /bin/sh as the locked account user, set the oracle.sysman.prov.agentpush.pdpShellOutEnabled property to false, and ensure that the installing user has the privileges to invoke id, chmod, cp, mkdir, rm, tar, emctl, agentDeploy.sh, runInstaller, and unzip as the locked account user. Grant the privileges in the configuration file of your privilege delegation tool.

For example, if you are using sudo as your privilege delegation tool, include the following in the /etc/sudoers file to grant the required privileges:

login_user1 ALL=(oracle) /usr/bin/id, /bin/chmod, /bin/cp, /bin/mkdir, /bin/rm, /bin/tar, /home/oracle/agentibd/agent_inst/bin/emctl, /home/oracle/agentibd/*/agentDeploy.sh, /home/oracle/agentibd/*/prereq_stage/core/12.1.0.4.0/oui/bin/runInstaller, /home/oracle/agentibd/*/unzip, /home/oracle/agentibd/*/unzipTmp/unzip

Here, login_user1 is the SSH log in user, oracle is the locked account and install user, and /home/oracle/agentibd is the agent base directory.

Locked Account Requirements

Ensure that the locked account user (oracle) has read permission on the home directory of the login user.

Default SSH Port Requirements

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

netstat -anp | grep -i sshd

For example, the output of this command may be the following:

tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN 3188/sshd

The above output indicates that the SSH daemon is running on port 22.

Also, on a Unix host, you can run the following command to verify the SSH port:

cat /etc/ssh/sshd_config

For a Microsoft Windows host, the SSH port value is mentioned in the C:\cygwin\etc\sshd_config file.

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

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

PATH Environment Variable Requirements

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

    Also, ensure that the PATH environment variable does not exceed 1024 characters.

  • (For UNIX) On the destination host, ensure that the SCP binaries (for example, /usr/bin/scp) are in the PATH environment variable.

CLASSPATH Environment Variable Requirements

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

Software Availability Requirements

Ensure that the software of the Management Agent you want to install is downloaded and applied using Self Update.

  • If you want to install Oracle Management Agent 12c on a host that runs on the same platform as the one on which Oracle Management Service 12c is running, then the Management Agent software for that release and platform is downloaded and applied by default. Therefore, no action is required from your end.

  • If you want to install Oracle Management Agent 12c on a host that does not run on the same platform as the one on which Oracle Management Service 12c is running, then ensure that the Management Agent software for the intended platform is downloaded and applied using Self Update.

    For information about how to download and apply Management Agent software using Self Update, see Section 7.3.2.

Path Validation Requirements

Validate the path to all command locations as described in Appendix B.

Temporary Directory Space Requirements

Ensure that you allocate 400 MB of space for a temporary directory where the executables can be copied.

By default, the temporary directory location set to the environment variable TMP or TEMP is honored. If both are set, then TEMP is honored. If none of them are set, then the following default values are honored: /tmp on UNIX hosts and c:\Temp on Microsoft Windows hosts.

Agent Base Directory Requirements

  • Ensure that the agent base directory you provide is empty and has at least 1 GB of free space.

    If a previously run deployment session had failed for some reason, then you might see an ADATMP_<timestamp> subdirectory in the agent base directory. In this case, either delete the subdirectory and start a new deployment session, or retry the failed session from the Add Host Status page.

  • Ensure that the directory name does not contain any spaces.

  • The install user owns the agent base directory. The agent base directory and the parent directories of the agent base directory have read, write, and execute permissions for the install user. Ensure that the install user or the root user owns all the parent directories of the agent base directory, and that the parent directories have read and execute permissions for the install user group and all the other users. Also, ensure that the root user owns the root directory.

    For example, if the agent base directory is /scratch/OracleHomes/agent, and oracle is the install user, then the /scratch/OracleHomes/agent directory must be owned by oracle, directories scratch and OracleHomes must be owned by either oracle or the root user, and the root directory (/) must be owned by the root user.

  • (For Microsoft Windows hosts) Ensure that the agent base directory name does not exceed 68 characters.

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

Central Inventory (oraInventory) Requirements

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

  • The central inventory can be in a shared location, but the shared location must be unique to each host. Therefore, make sure that the shared location you use for the central inventory of a host is not used as a central inventory for another host. If you have configured a common central inventory for two or more hosts, then switch over to a non-shared location following the instructions outlined in My Oracle Support note 1092645.1.

  • Ensure that you have read, write, and execute permissions on oraInventory on all remote hosts. If you do not have these permissions on the default inventory (typically specified by /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. However, note that these parameters are supported only on UNIX platforms, and not on Microsoft Windows platforms.

    INVENTORY_LOCATION=<absolute_path_to_inventory_directory>

    -invPtrLoc <absolute_path_to_oraInst.loc>

    Ensure that you use INVENTORY_LOCATION only when the target host does not already have a central inventory.

Installing User Requirements

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

  • Also ensure that the inventory owner and the group to which the owner belongs have read and write permissions on the inventory directory.

    For example, if the inventory owner is abc and the user installing the Management Agent is xyz, then ensure that abc and xyz belong to the same group, and they have read and write access to the inventory.

Agent User Account Permissions and Rights (For Microsoft Windows)

(For Microsoft Windows) If you are installing the Management Agent on a Microsoft Windows-based operating system, then ensure that the agent user account has permissions and rights to perform the following:

  • Act as part of the operating system.

  • Adjust memory quotas for a process.

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

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

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

Permissions for cmd.exe (For Microsoft Windows)

(For Microsoft Windows) If you are installing the Management Agent on a Microsoft Windows-based operating system, then ensure that you grant the cmd.exe program Read and Execute permissions for the user account that the batch job runs under. This is a restriction from Microsoft.

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

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

Runtime Library File Requirements (For Microsoft Windows)

(For Microsoft Windows) If you are installing the Management Agent on a Microsoft Windows-based operating system, then ensure that the Msvcp71.dll and Msvcr71.dll runtime library files are present in c:\windows\system32.

Preinstallation/Postinstallation Scripts Requirements

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

  • Ensure that you use a certified browser as mentioned in the Enterprise Manager certification matrix available on My Oracle Support.

    To access the Enterprise Manager certification matrix, follow the steps in Appendix E.

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


7.3.2 Meeting the Management Agent Software Prerequisites

To install a Management Agent on a host, the Management Agent software for the host platform must be downloaded and applied using Self Update.

This section describes how to download and apply the Management Agent software for different platforms using Self Update. In particular, it contains the following:

Important:

The Management Agent software for the OMS host platform is downloaded and applied by default, so if the host on which you want to install a Management Agent runs on the same platform as that of the OMS host, you do not need to download and apply the Management Agent software for this platform.

7.3.2.1 Acquiring the Management Agent Software in Online Mode

If Enterprise Manager has access to My Oracle Support via the Internet, it is said to run in Online Mode.

To verify that Enterprise Manager is running in Online Mode, access the Offline Patching page. To access this page, from the Setup menu, select Provisioning and Patching, then select Offline Patching.

To download and apply the Management Agent software using Self Update when Enterprise Manager is running in Online Mode, follow these steps:

  1. Ensure that you have set up Self Update.

    For information on setting up Self Update, see Oracle Enterprise Manager Cloud Control Administration Guide.

  2. From the Setup menu, select Extensibility, then select Self Update.

  3. For Type, select Agent Software, then select Open from the Actions menu. The Agent Software Updates page appears to show the Management Agent software available for different platforms.

  4. Select an update from the list of available updates. All entries other than the one that matches the platform of the OMS host should show their status as Available.

  5. Click Download. The Schedule Download dialog opens.

  6. Select when to download the update. The following options are available:

    • Immediately

    • Later (specified time)

    • Whether or not to send a notification when the download is complete

  7. Click Select. An Enterprise Manager job is created to download the Management Agent software to Software Library.

    Enterprise Manager starts downloading the archive from the Oracle Enterprise Manager store. Wait for the download to complete (when in offline mode, the system starts reading from the specified location).

    When the download is complete, Enterprise Manager displays the Confirmation page.

  8. Once the download is complete, select the Management Agent, then click Apply. This step will stage the Management Agent software in Software Library and make it available to the Add Host Targets wizard, which you will use to install Management Agents on hosts.

7.3.2.2 Acquiring the Management Agent Software in Offline Mode

If Enterprise Manager is not connected to My Oracle Support via the Internet, it is said to run in Offline Mode.

To verify that Enterprise Manager is running in Offline Mode, access the Offline Patching page. To access this page, from the Setup menu, select Provisioning and Patching, then select Offline Patching.

To download and apply the Management Agent software using Self Update when Enterprise Manager is running in Offline Mode, follow these steps:

  1. Ensure that you have set up Self Update.

    For information on setting up Self Update, see Oracle Enterprise Manager Cloud Control Administration Guide.

  2. From the Setup menu, select Extensibility, then select Self Update.

  3. On the Self Update home page, click Check Updates. A message is displayed that contains the URL to be accessed to download a catalog of all updates.

  4. From an Internet-enabled computer, download the catalog file using the aforementioned URL.

    Note:

    Do not unzip the file.
  5. Copy the downloaded file to either of the following:

    • To any host that has a Management Agent and EM CLI installed

    • To the Oracle Management Service (OMS) host (EM CLI is configured out of box on the OMS host machine, so no setup is required)

  6. Navigate to <OMS_HOME> and log in to EM CLI, running the command as the install user, for example:

    ./emcli login -username=sysman

  7. Synchronize EM CLI:

    ./emcli sync

  8. Run the emcli import_update_catalog command to import the archive into the Oracle Management Service instance or the Management Agent you want to update. For example:

    ./emcli import_update_catalog -omslocal  -file=zip file absolute path
    

    Before running this command, ensure that you have set up Software Library in Cloud Control. For information on how to do this, see Oracle Enterprise Manager Lifecycle Management Administrator's Guide.

    Tip:

    For a multi-OMS setup, run emcli help import_update_catalog for more options.
  9. Return to the Self Update home page and do a refresh to see a count of new updates in the Available Updates column.

  10. For Type, select Agent Software, then select Open from the Actions menu. The Agent Software Updates page appears to show the Management Agent software available for different platforms.

  11. Select an update from the list of available updates. All entries other than the one that matches the platform of the OMS host should show their status as Available.

  12. Click Download. A message displays with a URL and instructions.

  13. From an Internet-enabled computer, download the file from the URL displayed in Step 12. Do one of the following:

    • Copy the file to a Management Agent host and follow the instructions displayed in Step 12.

    • Copy the file to Oracle Management Service host and follow the instructions displayed in Step 12.

    At this stage, the update will show up in a downloaded state in the Self Update home page.

  14. Once the download is complete, select the Management Agent, then click Apply. This step will stage the Management Agent software in Software Library and make it available to the Add Host Targets wizard, which you will use to install Management Agents on hosts.

7.4 Installation Procedure

This section describes the actions involved in installing Management Agents. It consists of the following:

Important:

If the OMS host is running on Microsoft Windows, and the OMS software was installed in a drive other than C:\, then update the SCRATCH_PATH variable in $OMS_HOME\oui\prov\resources\ssPaths_msplats.properties.

For example, if the OMS software was installed in D:\, ensure that you update the SCRATCH_PATH variable to D:\tmpada

7.4.1 Installing Management Agents Using Add Host Targets Wizard

This section describes how to install 12c Management Agents using the Add Host Targets Wizard.

To install fresh Management Agents using the Add Host Targets Wizard, follow these steps:

  1. Ensure that you have downloaded and applied the Management Agent software for the platforms of the hosts on which you want to install Management Agents.

    For information on how to download and apply the Management Agent software for a platform, see Section 7.3.2.

    Note:

    If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is downloaded and applied using Self Update.
  2. In Cloud Control, do one of the following:

    • From the Setup menu, select Add Target, then select Auto Discovery Results. On the Auto Discovery Results page, under the Servers, Storage and Network tab, select a host that you want to monitor from the displayed list, then click Promote.

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

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

      Session Name

      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. From the Add menu, select Manually to enter the fully qualified name and select the platform of the host on which you want to install the Management Agent.

      The host names that are retrieved from the system for the installation may include IP addresses and short names. However, it is recommended that you provide fully qualified host names, such as foo.mydomain.com, which persist over the life of the host targets. This is recommended for ease of maintenance and overall security.

      Surrounding text describes add_host_wiz_add_hosts_new.jpg.

      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 does not contain underscores('_').

      • If the platform name is appended with Agent Software Unavailable, then it indicates that the software for that platform is not available on the OMS host, and that you must download and apply it using Self Update. To access Self Update, from the Setup menu, select Extensibility, then click Self Update.

        For more information on using Self Update to download and apply the latest software, see Section 7.3.2.

      Alternatively, from the Add menu, you can select either From File to add the host names stored in a file, or Discovered Hosts to add the 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 Section 7.4.1.1.

      Surrounding text describes add_host_wiz_ldfile_adddisc_new.jpg.

      Note:

      When you select Discovered Hosts from the Add menu, 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.

      If you are correcting the platform names, and if all the hosts run on the same platform, then set the platform for the first host in 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.

      If you are correcting the platform names, and all the hosts run on different platforms, from the Platform list, select Different for Each Host. Select the correct platform for each host.

      Note:

      • If you reach this page (Host and Platform page) from the Auto Discovery Results page, then the hosts you selected on that page automatically appear in the table. In this case, you need to only validate the host names and their platforms.

      • 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 console within Enterprise Manager Cloud Control, download the software, then apply it. For more information, see Section 7.3.2.

    3. Click Next.

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

    1. In the Deployment Type section, select Fresh Agent Install.

      Install Type

      Note:

      If you have multiple hosts sharing a common mounted drive, then install the Management Agents in two different phases:
      1. In the Add Host Targets Wizard, select the deployment type Fresh Agent Install, and install a Management Agent on the host where the drive is shared.

      2. In the Add Host Targets Wizard, select the deployment type Add Host to Shared Agent, and install a Management Agent on all other hosts that access the shared, mounted drive. (Here, you will select the Management Agent you installed in the previous step as the master agent or shared agent.)

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

      Surrounding text describes add_host_wiz_inst_details.jpg.
    3. In the Installation Details section, provide the installation details common to the hosts selected in Step 3 (b). For Installation Base Directory, enter the absolute path to the agent base directory where you want the software binaries, security files, and inventory files of the Management Agent to be copied.

      For example, /u01/app/Oracle/

      If the path you enter does not exist, the application creates a directory at the specified path, and copies the Management Agent software binaries, security files, and inventory files there.

      Note:

      The Installation Base Directory is essentially the agent base directory. Ensure that the directory you provide is empty. If a previously run deployment session had failed for some reason, then you might see an ADATMP_<timestamp> subdirectory in the agent base directory. In this case, either delete the subdirectory and start a new deployment session, or retry the failed session from the Add Host Status page.
    4. For Instance Directory, accept the default instance directory location or enter the absolute path to a directory of your choice where all Management Agent-related configuration files can be stored.

      For example, /u01/app/Oracle/agent_inst

      If you are entering a custom location, then ensure that the directory has write permission. Oracle recommends you to maintain the instance directory inside the agent base directory.

      If the path you enter does not exist, the application creates a directory at the specified path, and stores all the Management Agent-related configuration files there.

    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.

      Named Credentials

      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 SSH public key authentication between the OMS and the remote hosts for a named credential, as described in Section 7.2, you can select this credential from the Named Credential list.

    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.

      For example, you can specify one of the following for the Privileged Delegation Setting field:

      /usr/bin/sudo -u %RUNAS% %COMMAND%
      /usr/bin/sudo -u -S %RUNAS% %COMMAND% (if a pseudo terminal is required for remote command execution via SSH)
      /usr/bin/sesu - %RUNAS% -c "%COMMAND%"
      /usr/bin/pbrun %PROFILE% -u %RUNAS% %COMMAND%
      /usr/bin/su - %RUNAS% -c "%COMMAND%"
      

      If you leave the Privileged Delegation Setting 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 Section 7.5.

      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 this field 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 shell scripts are supported, and 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. However, note that this parameter is supported only on UNIX platforms, and not on Microsoft Windows platforms.

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

    11. Click Next.

  5. If you want to deploy Management Agents on the selected hosts in a rolling manner, such that the deployment proceeds continuously from one deployment phase to another, ignoring the failed hosts in each deployment phase, specify the following in the $OMS_HOME/sysman/prov/agentpush/agentpush.properties file:

    oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true

    For more information about this deployment method, see Section 7.2.

  6. On the Review page, review the details you have provided for the installation and do one of the following:

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

    • If you want to cancel the deployment session for some reason, click Cancel. You are automatically taken to the Add Targets Manually page.

    • If you are satisfied with the details, then click Deploy Agent to install the Management Agent. You are automatically taken to the Add Host Status page that enables you to monitor the progress of the deployment session.

      If you want to cancel a running deployment session, then on the Add Host Targets page, click Cancel. Note that once you cancel the session, you cannot track or resume the session in any way. However, the currently launched commands on the remote hosts will continue to run until they are completed.

      To view the details or track the progress of all the Add Host sessions using the Add Host Targets Wizard, from the Setup menu, select Add Target, then click Add Targets Manually. On the Add Targets Manually page, select Add Host Targets, then click Add Host Results.

  7. If a particular installation phase has failed or has a warning, review the details provided for each phase in the Agent Deployment Details section of the Add Host Status page, and do one of the following:

    Note:

    To find the cause of a failure, review the log files. One log file is generated per host, so if you installed Management Agents on multiple hosts, then review all the log files. For information on how to access the log files, refer to Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
    • Fix the problem by reviewing the error description carefully, understanding its cause, and taking action as recommended by Oracle.

      • You can retry the deployment of Management Agents with the same installation details.

        To do so, on the Add Host Status page, click Retry and select Retry Using Same Inputs.

      • You can retry the deployment of Management Agents with modified installation details.

        To do so, on the Add Host Status page, click Retry and select Update Inputs and Retry.

    • 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, on the Add Host Status page, 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.

        Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.

        To do so, on the Add Host Status page, click Continue and select Continue, All Hosts.

7.4.1.1 Format of Host List File

In the Add Host Targets Wizard, you can click Load from File to add the hosts listed in a file. However, ensure that the file you select has one of the following formats:

  • Only the host name.

    For Example,

    host1.example.com

    host2.example.com

    Note:

    If the host list file is in this format, ensure that you select the platform for each added host from the drop down list.
  • The host name followed by the platform name.

    For Example,

    host1.example.com linux_x64

    host2.example.com aix

    The supported platform names are linux_x64, linux, solaris, hpunix, hpi, linux64_zseries, aix, linux_ppc64, windows_x64, solaris_x64, win32.

7.4.2 Installing Management Agents Using EM CLI

Important:

  • Using EM CLI, you can install fresh Management Agents, install Shared Agents, and clone existing Management Agents.

  • Using EM CLI, you can install fresh Management Agents only on a single platform in a single Add Host session. If you want to use EM CLI to install fresh Management Agents on different platforms, then you must create a separate Add Host session for each platform.

Note:

If the output of the EM CLI verbs mentioned in this section is misaligned or is difficult to read, adjust your screen width by specifying an appropriate value for the oracle.sysman.prov.agentpush.emcliScreenWidth property in the <OMS_HOME>/sysman/prov/agentpush/agentpush.properties file.

To create an Add Host session and install fresh Management Agents using EM CLI, follow these steps:

  1. Log in to EM CLI from the /bin directory present within the OMS home:

    $<OMS_HOME>/bin/emcli login -username=<user_name>
    

    Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.

  2. Synchronize EM CLI:

    $<OMS_HOME>/bin/emcli sync
    
  3. Run the get_targets verb to obtain the list of unmanaged hosts:

    emcli get_targets -unmanaged -targets="%:host" -format=name:script
    

    Make a note of the unmanaged hosts on which you want to install a Management Agent.

    To view more information on the syntax and the usage of the get_targets verb, run the following command:

    $<OMS_HOME>/bin/emcli help get_targets
    
  4. Run the list_add_host_platforms verb to obtain a list of the platforms for which the Management Agent software is available in Software Library:

    $<OMS_HOME>/bin/emcli list_add_host_platforms 
                          [-all] 
                          [-noheader] 
                          [-script | -format]
    

    Note that the parameters mentioned in [ ] are optional.

    For example, $<OMS_HOME>/bin/emcli list_add_host_platforms -all

    Figure 7-3 displays the output of this command.

    Figure 7-3 Output of list_add_host_platforms -all

    Surrounding text describes Figure 7-3 .

    If the Management Agent software for a platform on which you want to install a Management Agent is not available, download and apply it using Self Update. For information on how to download and apply the Management Agent software for a platform, see Section 7.3.2.

    Note:

    If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is downloaded and applied using Self Update.

    To view more information on the syntax and the usage of the list_add_host_platforms verb, run the following command:

    $<OMS_HOME>/bin/emcli help list_add_host_platforms
    
  5. If you want to deploy Management Agents on the selected hosts in a rolling manner, such that the deployment proceeds continuously from one deployment phase to another, ignoring the failed hosts in each deployment phase, specify the following in the $OMS_HOME/sysman/prov/agentpush/agentpush.properties file:

    oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true

    For more information about this deployment method, see Section 7.2.

  6. Run the submit_add_host verb to submit the Add Host session and install Management Agents:

    $<OMS_HOME>/bin/emcli submit_add_host 
                          -host_names=<list_of_hosts>
                          -platform=<platform_ID>
                          -installation_base_directory=<install_directory_of_agent>
                          -credential_name=<named_credential_for_agent_install> 
                          [-credential_owner=<named_credential_owner>]
                          [-instance_directory=<agent_instance_directory>] 
                          [-port=<agent_port>] 
                          [-session_name=<add_host_session_name>] 
                          [-deployment_type=<type_of_agent_deployment>] 
                          [-privilege_delegation_setting=<privilege_delegation>] 
                          [-additional_parameters=<additional_params_for_install>]
                          [-source_agent=<source_agent_for_cloned_agent_install>]
                          [-master_agent=<master_agent_for_shared_agent_install>] 
                          [-properties_file=<properties_file_having_inputs>] 
                          [-preinstallation_script=<pre_install_script>] 
                          [-preinstallation_script_on_oms] 
                          [-preinstallation_script_run_as_root] 
                          [-postinstallation_script=<post_install_script>] 
                          [-postinstallation_script_on_oms] 
                          [-postinstallation_script_run_as_root] 
                          [-wait_for_completion]
    

    Note that the parameters mentioned in [ ] are optional.

    Important:

    You can install a Shared Agent and clone a Management Agent by specifying the -deployment_type option with the submit_add_host verb. To install a Shared Agent, specify -deployment_type=SHARED. To clone a Management Agent, specify -deployment_type=CLONE. By default, the -deployment_type option is set to FRESH, so if this option is not specified, a fresh Management Agent is installed on the selected host.

    For example, $<OMS_HOME>/bin/emcli submit_add_host -host_names=example.com -platform=226 -installation_base_directory=/opt/agent -credential_name=oracle -privilege_delegation_setting=sudo

    This example installs a fresh Management Agent on the host example.com, having the platform ID 226, in the directory /opt/agent, using the named credential oracle.

    The -platform parameter specifies the platform ID. Every platform has a unique platform ID associated with it. This association for various platforms is displayed in the output of the list_add_host_platforms verb, as shown in Figure 7-3.

    The -credential_name parameter specifies the named credential that must be used to install Management Agents on the specified hosts. If you have not created a named credential, you can create one using the create_named_credential verb. For information on how to use this verb, refer Oracle Enterprise Manager Command Line Interface.

    To view more information on the syntax and the usage of the submit_add_host verb, run the following command:

    $<OMS_HOME>/bin/emcli help submit_add_host
    
  7. Run the get_add_host_status verb to view the status of the created Add Host session:

    $<OMS_HOME>/bin/emcli get_add_host_status 
                          -session_name 
                          [-details] 
                          [-show_only_failed_hosts] 
                          [-host_name] 
                          [-noheader] 
                          [-script | -format]
    

    Note that the parameters mentioned in [ ] are optional.

    For example, $<OMS_HOME>/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_27_2012_3:02:28_AM_PST

    This example displays the status of the ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST Add Host session.

    To view the detailed Management Agent deployment status of a particular host, run the get_add_host_status verb with the -host_name parameter. For example:

    $<OMS_HOME>/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_27_2012_3:02:28_AM_PST -host_name=example.com

    This command also displays the location of the log file for the deployment of a Management Agent on the specified host. If the deployment failed, you can investigate the failure by reviewing the log files. One log file is generated per host.

    Figure 7-4 displays a sample output of the command.

    Figure 7-4 Output of emcli get_add_host_status

    Surrounding text describes Figure 7-4 .

    Alternatively, to know where the Management Agent log files are located, see Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

    Run the list_add_host_sessions verb to view the details or track the progress of all the Add Host sessions:

    $<OMS_HOME>/bin/emcli list_add_host_sessions 
                          [-host_name]
                          [-session_name]
                          [-match_all]
                          [-noheader] 
                          [-script | -format]
    

    For example, $<OMS_HOME>/bin/emcli list_add_host_sessions -host_name=example.com

    This example displays all the Add Host sessions that the host example.com was a part of.

    To view more information on the syntax and the usage of the get_add_host_status and the list_add_host_sessions verb, run the following commands:

    $<OMS_HOME>/bin/emcli help get_add_host_status
    $<OMS_HOME>/bin/emcli help list_add_host_sessions
    
  8. If the output of the get_add_host_status EM CLI verb mentions that a particular installation phase has failed or has a warning, do one of the following:

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

      • You can retry the deployment of Management Agents with the same installation details.

        To do so using EM CLI, use the retry_add_host verb, with the -retry_using_same_inputs option:

        $<OMS_HOME>/bin/emcli retry_add_host 
                              -session_name 
                              -retry_using_same_inputs 
                              [-wait_for_completion]
        

        Note that the parameters mentioned in [ ] are optional.

        For example, $<OMS_HOME>/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST' -retry_using_same_inputs

      • You can retry the deployment of Management Agents with modified installation details.

        To do so using EM CLI, use the retry_add_host verb, with the -update_inputs_and_retry option:

        $<OMS_HOME>/bin/emcli retry_add_host 
                        -session_name 
                        -update_inputs_and_retry 
                        [-host_names]
                        [-platform]
                        [-installation_base_directory]
                        [-credential_name]
                        [-credential_owner]
                        [-instance_directory]
                        [-port]
                        [-deployment_type]
                        [-privilege_delegation_setting]
                        [-additional_parameters]
                        [-source_agent]
                        [-master_agent]
                        [-preinstallation_script]
                        [-preinstallation_script_on_oms]
                        [-preinstallation_script_run_as_root]
                        [-postinstallation_script]
                        [-postinstallation_script_on_oms]
                        [-postinstallation_script_run_as_root]
                        [-wait_for_completion]
        

        Note that the parameters mentioned in [ ] are optional.

        For example, $<OMS_HOME>/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST' -update_inputs_and_retry -credential_name=oracle2

        This example retries the deployment of Management Agents for the ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST Add Host session, using the oracle2 named credential.

      To view more information on the syntax and the usage of the retry_add_host verb, run the following command:

      $<OMS_HOME>/bin/emcli help retry_add_host
      
    • 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 using EM CLI, use the continue_add_host verb, with the -continue_ignoring_failed_hosts option:

        $<OMS_HOME>/bin/emcli continue_add_host 
                              -session_name
                              -continue_ignoring_failed_hosts
                              [-wait_for_completion]
        

        Note that the parameters mentioned in [ ] are optional.

        For example, $<OMS_HOME>/bin/emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST' -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.

        Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.

        To do so using EM CLI, use the continue_add_host verb, with the -continue_all_hosts option:

        $<OMS_HOME>/bin/emcli continue_add_host 
                              -session_name
                              -continue_all_hosts
                              [-wait_for_completion]
        

        Note that the parameters mentioned in [ ] are optional.

        For example, $<OMS_HOME>/bin/emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST' -continue_all_hosts

      To view more information on the syntax and the usage of the continue_add_host verb, run the following command:

      $<OMS_HOME>/bin/emcli help continue_add_host
      

Note:

For more information on how to use the EM CLI verbs mentioned in this section, refer Oracle Enterprise Manager Command Line Interface.

7.4.3 Supported Additional Parameters

Table 7-2 lists the additional parameters supported for installing a new Management Agent using the Add Host Targets Wizard or EM CLI.

Note that all the parameters mentioned in this section are case sensitive.

Table 7-2 Supported Additional Parameters

Parameter Description

INVENTORY_LOCATION

Enter the absolute path to the Central Inventory (oraInventory).

For example, INVENTORY_LOCATION=$HOME/oraInventory

Important:

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

  • Ensure that you use this parameter only when no other Oracle product is installed on the remote host, and the Central Inventory pointer /var/opt/oracle/oraInst.loc (for Solaris and HP-UX platforms) or /etc/oraInst.loc (for other Unix platforms) does not exist.

  • If you use this parameter, ensure that you do not use the -invPtrLoc parameter.

-invPtrLoc

Enter the absolute path to the inventory file that has the location of the Central Inventory (oraInventory).

For example, -invPtrLoc /tmp/oraInst.loc

Important:

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

  • You can use this parameter even when another Oracle product is already installed on the remote host, and the Central Inventory pointer /var/opt/oracle/oraInst.loc (for Solaris and HP-UX platforms) or /etc/oraInst.loc (for other Unix platforms) exists.

  • If you use this parameter, ensure that you do not use the INVENTORY_LOCATION parameter.

-enablePty

Specify this parameter if the privilege delegation tool you are using requires a pseudo terminal for remote command execution via SSH. Most privilege delegation tools such as pbrun, sesu, and su require a pseudo terminal for remote command execution, by default.

You do not need to specify this parameter if you have set the oracle.sysman.prov.agentpush.enablePty property to true in the $<OMS_HOME>/sysman/prov/agentpush/agentpush.properties file.

Ensure that you do not pass this parameter if the Central Inventory exists.

START_PRIORITY_LEVEL

(For Unix based hosts only)

Use this parameter to specify the priority level of the Management Agent service when the host is started. This parameter accepts values between 0 and 99. However, Oracle recommends that you provide a value between 91 and 99 for this parameter.

For example, START_PRIORITY_LEVEL=95

If you do not include this parameter, it defaults to 98.

SHUT_PRIORITY_LEVEL

(For Unix based hosts only)

Use this parameter to specify the priority level of the Management Agent service when the host is shut down. This parameter accepts values between 0 and 99.

For example, SHUT_PRIORITY_LEVEL=25

If you do not include this parameter, it defaults to 19.

s_agentSrvcName

(Only for Microsoft Windows) Enter a custom name for the Management Agent service.

Every Management Agent appears as a service in Microsoft Windows, and every Management Agent has a default service name. If you want to assign a custom name to identify it, then use this parameter.

For example, s_agentSrvcName=agentsrvc1

Note: (For Microsoft Windows hosts) If you upgrade a 12.1.0.x Management Agent and you want to install another Management Agent on the same host, which points to a different OMS, ensure that you specify the s_agentSrvcName parameter while installing the Management Agent, as described in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

b_startAgent=false

Specify this parameter if you do not want the Management Agent to start automatically once it is installed and configured.

If you do not specify this parameter, the Management Agent starts automatically once it is installed and configured.

b_secureAgent=false

Specify this parameter if you do not want the Management Agent to be secured after the install. If you do not specify this parameter, the Management Agent is secured automatically after the install.

To secure the Management Agent manually after the install, run the following command:

<AGENT_BASE_DIRECTORY>/agent_inst/bin/emctl/ secure agent

If you specify this parameter, ensure that you also specify the OMS HTTP port, using the EM_UPLOAD_PORT parameter.

For example, b_secureAgent=false EM_UPLOAD_PORT=4899


7.5 After You Install

After you install a Management Agent using the Add Host Targets Wizard or EM CLI, follow these steps:

  1. Verify the installation on the Add Host Status page, or using the get_add_host_status EM CLI verb. Review the progress made on each of the phases of the deployment operation — Initialization, Remote Prerequisite Check, and Agent Deployment.

    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.

    For information on using the get_add_host_status EM CLI verb, see Section 7.4.2.

  2. If required, manually verify the installation:

    1. Navigate to the Management Agent home and run the following command to see a message that confirms that the Management Agent is up and running:

      $<AGENT_INSTANCE_HOME>/bin/emctl status agent

    2. Navigate to the Management Agent home and run the following command to see a message that confirms that EMD upload completed successfully:

      $<AGENT_INSTANCE_HOME>/bin/emctl upload agent

    3. From the Setup menu, select Manage Cloud Control, then select Agents. Verify that the Management Agent you installed is up and running.

  3. Verify whether all the plug-ins listed in $<AGENT_BASE_DIRECTORY>/plugins.txt were installed successfully. To do so, run the following command:

    $<AGENT_INSTANCE_HOME>/bin/emctl listplugins agent -type all

  4. If you have restrictive Privilege Delegation Provider (PDP) configuration settings, enter the location of nmosudo in your PDP configuration file.

    Enterprise Manager supports PDPs such as SUDO and PowerBroker that enable administrators to restrict certain users from running certain commands.

    In Enterprise Manager Cloud Control 12c Release 2 (12.1.0.2), Release 3 (12.1.0.3), and Release 4 (12.1.0.4), nmosudo is located in the sbin directory, which is in the agent base directory. For example, <AGENT_BASE_DIRECTORY>/sbin/nmosudo. In Enterprise Manager Cloud Control 12c Release 1 (12.1.0.1) [with or without Bundle Patch 1], nmosudo is located in the agent instance directory. For example, <AGENT_INSTANCE_DIRECTORY>/bin/nmosudo.

    Therefore, when you install a 12.1.0.4 Management Agent, you must modify your PDP configuration file to update the new location of nmosudo.

    For example, if you use SUDO as your PDP, the configuration file for SUDO is typically /etc/sudoers. In this file, update the following entry with the new location to nmosudo.

    sudouser ALL : oracle /eminstall/basedir/sbin/nmosudo * 
    
  5. (Only for UNIX Operating Systems) If you had ignored the prerequisite check warning about not having root privileges, SUDO/PBRUN binaries, or SUDO/PBRUN privileges, then manually run the following scripts as a root user from each of the hosts where the installation was done. If you do not have SUDO/PBRUN privileges, then request your Administrator who has the privileges to run these scripts.

    • If this is the first Oracle product you just installed on the host, then run the orainstRoot.sh script from the inventory location specified in the oraInst.loc file that is available in the Management Agent home.

      For example, if the inventory location specified in the oraInst.loc file is $HOME/oraInventory, then run the following command:

      $HOME/oraInventory/orainstRoot.sh

    • Run the root.sh script from the Management Agent home:

      $<AGENT_HOME>/root.sh

  6. If you had ignored a prerequisite check warning about wrong time zone settings, run the following command and follow the steps it displays:

    $<AGENT_INSTANCE_HOME>/bin/emctl resetTZ agent

  7. By default, the host and the Management Agent get automatically added to the Enterprise Manager Cloud Control console for monitoring. None of the targets running on that host get automatically discovered and monitored.

    To monitor the other targets, you need to add them to Enterprise Manager Cloud Control either using the Auto Discovery Results page, the Add Targets Manually page, or the discovery wizards offered for the targets you want to monitor.

    For information about discovering targets in Enterprise Manager Cloud Control, refer to Oracle Enterprise Manager Cloud Control Administrator's Guide.

  8. If you installed a Management Agent on a host that has Oracle Fusion Applications deployed on it, the Management Agent must have access to a set of configuration files for the business metrics feature to function properly. If the Management Agent user is in the same group as the Oracle Fusion Applications install user, ensure that the following files have 640 access:

    <DOMAIN_HOME>/config/fmwconfig/jps-config-jse.xml
    <DOMAIN_HOME>/config/fmwconfig/policy-accessor-config.xml
    <DOMAIN_HOME>/config/fmwconfig/bootstrap/cwallet.sso 
    

Note:

  • If Oracle Management Agents 12c (12.1.0.x) hang frequently or do not respond on Solaris 9ux and 10ux operating systems, then refer to document ID 1427773.1 on My Oracle Support.

  • You can repoint your existing Management Agents to a new Oracle Management Service (OMS). For information on how to do this, see the Redirecting Oracle Management Agent to Another Oracle Management Service Appendix present in Oracle Enterprise Manager Cloud Control Advanced Installation Guide.

    When you repoint your existing Management Agents to a new OMS, you cannot move the targets monitored by the Management Agents, the target history, and the Management Agent history. The monitored targets and the history data is lost.