6 Installing Oracle Management Agents

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.

This chapter describes how you can install Management Agent on unmanaged hosts and convert them to managed hosts. In particular, this chapter covers the following:

• Overview of Installing Management Agents Using Agent Gold Images

• Installing Management Agents Using Agent Gold Images

• Troubleshooting Management Agents

Note:

The Management Agent software for the platform on which the OMS is deployed, is available by default on the OMS host. For example, if the platform on which the OMS is deployed is Linux x86-64, then the Management Agent software for the Linux x86-64 platform is available by default on the OMS host. You need not manually download the Management Agent software for that platform. However, if you plan to install a Management Agent on a platform that is different from the platform on which the OMS is deployed, then you must manually download the Management Agent software for the intended platform using Self Update. For instructions, see Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

Overview of Installing Management Agents Using Agent Gold Images

At any point in time, if you want to monitor a target running on a host, you must first convert that unmanaged host to a managed host by installing a Management Agent, and then you must discover and promote the targets running on that managed host so that they are added to the Enterprise Manager Cloud Control Console.

Oracle recommends that you install Management Agents using Agent Gold Images. This section introduces you to Agent Gold Images and familiarizes you with important concepts that you must know before you begin installing Management Agents. In particular, this section covers the following:

• Overview of Agent Gold Images

• Components of an Agent Gold Image Version

• Advantages of Provisioning, Upgrading, and Updating Management Agents Using a Gold Image Version

Overview of Agent Gold Images

You can install Oracle Management Agents using Agent Gold Images. An Agent Gold Image represents the ideal state of a Management Agent in a data center managed by Enterprise Manager, having a customized configuration of the desired versions of the Management Agent software, the desired versions of the monitoring plug-ins, and the desired patches.

An Agent Gold Image version is created by an Enterprise Manager user, using a live reference Management Agent that is thoroughly tested and tuned. An Agent Gold Image version can be used to provision new Management Agents or update existing Management Agents on a large number of hosts.

Note:

You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Overview of Installing Shared Agents in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

In addition, you cannot use an unsecure Management Agent to create an Agent Gold Image version. Therefore, always use only a secure Management Agent as the source for creating an Agent Gold Image version.

Components of an Agent Gold Image Version

An Agent Gold Image version consists of the following software components that are stored in Oracle Software Library (Software Library):

• Management Agent software

• Oracle Home monitoring plug-in

• Discovery plug-ins

• Monitoring plug-ins

• Management Agent and plug-in patches

• Configuration information

• Deploy scripts for performing the install or update

Advantages of Provisioning, Upgrading, and Updating Management Agents Using a Gold Image Version

The following are the advantages of provisioning, upgrading, and updating Management Agents using a gold image version:

• Since an Agent Gold Image version consists of the desired Management Agent software, plug-ins, and patches, provisioning and updating Management Agents using a gold image version is a single point solution to managing the Management Agent lifecycle of a data center, that is, a user need not upgrade Management Agents using the Agent Upgrade Console, apply patches using patch plans, manage plug-ins using the plug-in lifecycle application, and so on.

• Using an Agent Gold Image version, you can provision a large number of Management Agents, all of which have the same versions of Management Agent software, plug-ins, and patches, and also have the same set of configuration properties.

• Using an Agent Gold Image version to provision, upgrade, and update Management Agents is a highly scalable approach.

• Management Agents that are provisioned or updated using a gold image version are stable, well tested, and have a standardized configuration.

• Management Agents that are provisioned or updated using a gold image version can be tracked easily, based on a recommended configuration.

Installing Management Agents Using Agent Gold Images

At any point in time, if you want to monitor a target running on a host, you must first convert that unmanaged host to a managed host by installing a Management Agent. This section describes how you can install Management Agents using Agent Gold Images. In particular, this section covers the following:

• Getting Started with Installing Management Agents Using an Agent Gold Image Version

• Installing a Standalone Oracle Management Agent Using Add Host Targets Wizard or EM CLI

• Creating an Agent Gold Image

• Creating an Agent Gold Image Version

• Setting a Particular Agent Gold Image Version as the Current Version

• Installing Management Agents Using an Agent Gold Image

Getting Started with Installing Management Agents Using an Agent Gold Image Version

To get started with installing Management Agents using Agent Gold Images, follow these steps:

1. Ensure that you have a standalone Oracle Management Agent 13c Release 4 installed in your environment.

   If you do not have a standalone Oracle Management Agent 13c Release 4 installed, then install one now. See Installing a Standalone Oracle Management Agent Using Add Host Targets Wizard or EM CLI. If you have a Management Agent of any earlier release, then upgrade it to 13c Release 2. See Upgrading Oracle Management Agents in the Oracle Enterprise Manager Cloud Control Upgrade Guide.

   Note:

   An Agent Gold Image can be created only using a standalone Management Agent of 13c release, and not using a central agent of 13c release or a standalone Management Agent of any other release. A central agent is a Management Agent that is deployed by default with the first OMS on the OMS host; you cannot use this central agent to create an Agent Gold Image.

2. Create an Agent Gold Image. See Creating an Agent Gold Image.

3. Create an Agent Gold Image version. See Creating an Agent Gold Image Version.

4. Set a particular Agent Gold Image version as the current version that can be used for deployment. See Setting a Particular Agent Gold Image Version as the Current Version.

5. Install the standalone Management Agent on the destination host using the Agent Gold Image. See Installing Management Agents Using an Agent Gold Image.

Note:

You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Overview of Installing Shared Agents in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

In addition, you cannot use an unsecure Management Agent to create an Agent Gold Image version. Therefore, always use only a secure Management Agent as the source for creating an Agent Gold Image version.

Installing a Standalone Oracle Management Agent Using Add Host Targets Wizard or EM CLI

An Agent Gold Image can be created only using a standalone Management Agent of 13c release, and not using a central agent of 13c release or a standalone Management Agent of any other release. This section describes how you can install such a standalone Management Agent of 13c release. In particular, this section covers the following:

• Overview of Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

• Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

• Meeting the Generic Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

• Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

• Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

• After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

Overview of Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

To install a standalone Management Agent, use the Add Host Targets Wizard that is accessible from within the Enterprise Manager Cloud Control console, or use EM CLI. The Add Host Targets Wizard is an application that offers GUI-rich, interactive screens. Oracle recommends that you use this wizard, or EM CLI, for the mass-deployment of Management Agents. For more information about the Add Host Targets Wizard, see What Is an Add Host Target Wizard? in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

Note:

This section 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, see Installing Oracle Management Agent in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration 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>
    |_____agent_13.4.0.0.0
          |_____sbin
          |_____OPatch
          |_____agent.rsp
          |_____bin
          |_____cfgtoollogs
          |_____config
          |_____install
          |_____instalclient
          |_____.
          |_____.
    |_____agent_inst
          |_____.
    |_____agentInstall.rsp
    |_____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 Redirecting Oracle Management Agent to Another Oracle Management Service in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration 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.

Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

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 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 Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

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

  When you use the Add Host Targets Wizard, 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 13c Management Agent software for a particular platform is downloaded and applied, then you can install only a 13c Management Agent on that platform, and not a 12c Management Agent.

  For information about the compatibility between 12c and 13c releases of Management Agents and the OMS, see Table 5-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 on cloning a Management Agent, see Cloning Oracle Management Agents 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 on shared agents, see Installing Shared Agents 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 13c, 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 Applying Patches to Oracle Management Agents While Deploying or Upgrading Them in the 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 Managing Plug-Ins in the Oracle Enterprise Manager Cloud Control Administrator's 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.

  Note:

  If the target host runs on Microsoft Windows, SSH Credentials are not supported. You must use Host Preferred Credentials using password based authentication. To set SSH credentials as preferred credential, see Setting Up Host Preferred Credentials Using SSH Key Credentials in the Oracle® Enterprise Manager Cloud Control Security Guide.

  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, then upload the SSH keys to Enterprise Manager, as mentioned in Step (4) of the following procedure.

  • Enterprise Manager Cloud Control does not support the format of the SSH key that is generated using the Tectia SSH client. However, if you are generating the SSH key using the Tectia SSH client, then as a prerequisite, convert the format of that key to OpenSSH format. To do so, run the following command.

    ssh-keygen --import-private-key <input_private_key_filename> <output_filename> --key-format openssh2

    After converting the format, use the content of the output_filename and upload it as a private key while registering it as a Named Credential in Enterprise Manager.

  1. Navigate to the following location in the Oracle home:

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

     For example,

     /u01/software/em13c/oraclehome/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 install 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>"

     For example, sshUserSetup.sh -setup -user oracle -hosts "abc1.example.com abc2.example.com abc3.example.com". Ensure that you use a space to separate the target host names.

     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 Installing Cygwin and Starting the SSH Daemon), 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 6-1 describes how to upload SSH keys to Enterprise Manager.

     Figure 6-1 Uploading SSH Keys to Enterprise Manager

     
     

     

     
     

  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 $<ORACLE_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/agent13c.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, seeInstalling Oracle Management Agent in Silent Mode in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

Meeting the Generic Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

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

Table 6-1 General Prerequisites for Installing Standalone Oracle Management Agent

Requirement	Description
Hardware Requirements	Ensure that you meet the hard disk space, swap space, temp directory space, stage directory space, and physical memory requirements as described in Hardware Requirements for Enterprise Manager Cloud Control.
Oracle Cloud Infrastructure (OCI) Requirements	Ensure that you meet the Oracle Cloud Infrastructure (OCI) requirements when deploying agents to OCI as described in Meeting the Generic Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EMCLI on Oracle Cloud Infrastructure.
Software Requirements	(For Microsoft Windows) Ensure that you have installed Cygwin 1.7 on the destination host as described in Installing Cygwin and Starting the SSH Daemon. Note: While running cygwin.bat, 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 Installing Management Agents on Microsoft Windows Target Hosts Without Using Cygwin.
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 Accessing the Enterprise Manager Certification Matrix. For information about platforms receiving future support, refer to My Oracle Support note 793512.1.
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 Package, Kernel Parameter, and Library Requirements for Enterprise Manager Cloud Control.
User and Operating System Group Requirement	Ensure that you create the required operating system groups and users as described in Creating Operating System Groups and Users for Enterprise Manager Cloud Control.
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.
etc/hosts File Requirements	(Only for Microsoft Windows) Ensure that the entry for local host in the etc/hosts file is always against 127.0.0.1 and against any other address.
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, sign in to the OMS host, and run 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 After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
Time Zone Requirements	If the time zone displayed is incorrect, sign in to the destination host, and follow these steps: 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). 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 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'
sudo/pbrun/sesu/su SSH Requirements	(Only for UNIX) Ensure that you set the oracle.sysman.prov.agentpush.enablePty property to true in the $<ORACLE_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 Installing Standalone Management Agents Using Add Host Targets Wizard), or EM CLI (as described in Installing Standalone Management Agents Using EM CLI). For more information about this parameter, see Supported Additional Parameters for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI. 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 Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI. Comment out Defaults requiretty in the /etc/sudoers file.
sudo/pbrun/sesu/su Requirements (for executing commands as the root user)	(Only for UNIX) The installing user must have the privileges to invoke the id command. As part of agent deployment process the agent should be able to run the agentdeployroot.sh script as root. To ensure this, 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 13c Release 4: (root) /<AGENT_HOME>/sbin/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/agent_13.4.0.0.0/oui/bin/runInstaller, /home/oracle/agentibd/*/unzip, /home/oracle/agentibd/*/unzipTmp/unzip, /home/oracle/agentibd/*/agentcore.bin 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: $<ORACLE_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 13c on a host that runs on the same platform as the one on which Oracle Management Service 13c 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 13c on a host that does not run on the same platform as the one on which Oracle Management Service 13c 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 Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.
Path Validation Requirements	Validate the path to all command locations as described in Validating Command Locations.
Agent Base Directory Requirements	Ensure that the agent base 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. 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 number of characters in the agent base directory path does not exceed 25 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. 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 on as a batch job. To verify whether the agent user has these rights, follow these steps: 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. 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 Accessing the Enterprise Manager Certification Matrix.
IPv6 Host Requirements	To support the deployment of an IPv6-enabled host, set the following property to true in the $<ORACLE_HOME>/sysman/prov/agentpush/agentpush.properties file: oracle.sysman.prov.agentpush.IPv6

Meeting the Generic Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EMCLI on Oracle Cloud Infrastructure

You need to ensure your Oracle Cloud Infrastructure (OCI) environment is setup correctly before you install Management Agents on OCI.

Prerequisites to Install Management Agents on Oracle Cloud Infrastructure

If you are installing an agent on Oracle Cloud Infrastructure (OCI), perform the following prerequisites:

1. Provision a Compute Virtual Machine or Database System from OCI for agent deployment.

   If the Enterprise Manager instance is running on OCI then it should be on the same virtual cloud network (VCN) and subnet as the Enterprise Manager instance to allow target discovery and monitoring. The agent should have the same SSH key as the Enterprise Manager instance for login.

2. Allow Enterprise Manager agent port traffic to OCI.

   Open port 3872 on the VCN security list to permit connection.

   

   Note:

   3872 is the default Management Agent port. If you want to use another port, you can use any available port within 1830-1849 range.

3. Open the firewall port in the agent node.
   Log in to the node where the agent will be installed and open the firewall port 3872.

   1. Use the following firewall rules for database systems:

      sudo iptables -I INPUT -p tcp -m state --state NEW -m tcp -s 10.0.1.0/25 --dport 3872 -m comment --comment "Required foraccess to Agent Listener" -j ACCEPT
      sudo iptables -I INPUT -p tcp -m tcp --dport 3872 -j ACCEPT
      sudo service iptables save
      sudo service iptables reload

   2. Use the following commands for Red Hat Enterprise Linux 7.7 and above:

      firewall-cmd --zone=public --add-port=3872/tcp --permanent
      firewall-cmd --reload
      iptables-save | grep 3872

4. Create named credentials on Enterprise Manager for the agent user.

   If the Enterprise Manager instance is running on OCI then you need to create named credentials on the Enterprise Manager instance with the SSH key provided during the Enterprise Manager instance provisioning (either via Compute VM or Database system provisioning).

   To create the named credentials, do the following:

   Open Enterprise Manager and navigate to Setup > Security and click on Named Credentials.

   1. Credential Name: OCI_SSH_Key
   2. Credential Type: SSH Key Credentials
   3. Scope: Global
   4. Username: opc
   5. Run Privilege: sudo
   6. Run as: oracle
5. Add the agent hosts IP and hostname to the Enterprise Manager host file, and add the Enterprise Manager details to the Agent node host file.
   1. Example of OMS node host file

      $ cat /etc/hosts
      10.0.1.3 oms1  
      10.0.1.4 oms2  
      10.0.1.6 dbhost1 #agent_node1
      10.0.1.7 dbhost2 #agent_node2

   2. Example of Agent node host file

      [opc@dbhostt1 ~]$ cat /etc/hosts
      10.0.1.6 dbhost1.emdb.emcc.oraclevcn.com dbhostt1
      192.168.16.18 dbhost1-priv.emdb.emcc.oraclevcn.com dbhostt1-priv
      10.0.1.8 dbhost1-vip.emdb.emcc.oraclevcn.com dbhostt1-vip
      10.0.1.7 dbhost2.emdb.emcc.oraclevcn.com  dbhostt2
      192.168.16.19 dbhost2-priv.emdb.emcc.oraclevcn.com  dbhostt2-priv
      10.0.1.9 dbhost2-vip.emdb.emcc.oraclevcn.com  dbhostt2-vip
      10.0.1.3 oms1
      10.0.1.4 oms2

Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

To install a standalone 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:

• Acquiring the Management Agent Software in Online Mode

• Acquiring the Management Agent Software in Offline Mode

Note:

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.

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 Using Self Update in the 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.

   Note:

   The Download button is enabled only in the following cases:

   • You must have the privilege to download and apply in Self Update Console.

   • You must have selected at least one Management Agent software row in the table, and the Management Agent software must be in Available or Download Failed status.

   • You must have configured the Software Library.

   • You must have configured the Self Update staging area.

   • You must have enabled the online mode for Self Update and set the My Oracle Support credentials.

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.

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.

From an Internet-enabled computer, download the catalog file using the following URL: https://updates.oracle.com/download/em_catalog.zip

Note:

Upload the file using the options displayed in the Offline Patching page.

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 Using Self Update in the 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. 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)

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

   ./emcli login -username=sysman

6. Synchronize EM CLI:

   ./emcli sync

7. 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 Setting Up Oracle Software Library in the Oracle Enterprise Manager Lifecycle Management Administrator's Guide.

   Tip:

   For a multi-OMS setup, run emcli help import_update_catalog for more options.

8. Return to the Self Update home page and do a refresh to see a count of new updates in the Available Updates column.
9. 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.
10. 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.
11. Click Download. A message displays with a URL and instructions.
12. 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.

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

Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

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

• Installing Standalone Management Agents Using Add Host Targets Wizard

• Format of the Host List File

• Installing Standalone Management Agents Using EM CLI

• Supported Additional Parameters for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

Note:

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 $ORACLE_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

Installing Standalone Management Agents Using Add Host Targets Wizard

This section describes how to install 13c 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 Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

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 Install Agent on 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.

      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.example.com, which persist over the life of the host targets. This is recommended for ease of maintenance and overall security.

      
      

      

      
      

      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 Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

      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 Format of the Host List File.

      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 Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

   3. Click Next.

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

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

      
      

      

      
      

      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.

   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/software/em13c/agentbasedir/

      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/software/em13c/agentbasedir/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.

      
      

      

      
      

      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 Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI, you can select this credential from the Named Credential list.

   6. From the Root Credential list, select an appropriate root credential to obtain privileges of a root user. This is an optional field. You may use this option only when your credentials do not have certain privileges as that of a root user. Use this along with your credentials.

   7. 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 After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

      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.

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

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

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

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

   12. 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 $ORACLE_HOME/sysman/prov/agentpush/agentpush.properties file:

   oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true

   For more information about this deployment method, see Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

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, click Install Agent 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 Overview of the Installation and Configuration Log Files in the 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.

Installing Standalone Management Agents Using Add Host Targets Wizard on Oracle Cloud Infrastructure

The steps described above also apply to installing Management Agents using Add Host Targets Wizard on Oracle Cloud Infrastructure (OCI).

See below a screenshot of the Add Hosts Targets Wizard after you click on Install Agent on Host and enter the agent installation details.

Format of the 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, and win32.

Installing Standalone Management Agents Using EM CLI

Note:

• 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 <ORACLE_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. Sign in to EM CLI from the /bin directory present within the Oracle home:

   $<ORACLE_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:

   $<ORACLE_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:

   $<ORACLE_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:

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

   Note that the parameters mentioned in [ ] are optional.

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

   Figure 6-2 displays the output of this command.

   Figure 6-2 Output of list_add_host_platforms -all

   
   

   

   
   

   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 Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

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

   $<ORACLE_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 $<ORACLE_HOME>/sysman/prov/agentpush/agentpush.properties file:

   oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true

   For more information about this deployment method, see Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

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

   $<ORACLE_HOME>/bin/emcli submit_add_host 
           -host_names="List of host names."
           -platform="Platform id"
           -installation_base_directory="Installation base directory."
           -credential_name="Credential Name"
           [-credential_owner="Credential Owner"]
           [-instance_directory="Instance directory"]
           [-port="Agent port"]
           [-version_name="Gold Image Version Name"]
           [-image_name="Gold Image Name"]
           [-session_name="Deployment session name"]
           [-deployment_type="Type of agent deployment"]
           [-privilege_delegation_setting="Privilege delegation setting"]
           [-additional_parameters="parameter1 parameter2 ..."]
           [-source_agent="Source agent"]
           [-master_agent="Master agent"]
           [-input_file=properties_file:"Properties file"]
           [-predeploy_script="Predeploy script"]
           [-predeploy_script_on_oms]
           [-predeploy_script_run_as_root]
           [-preinstallation_script="Preinstallation script"]
           [-preinstallation_script_on_oms]
           [-preinstallation_script_run_as_root]
           [-postinstallation_script="Postinstallation script"]
           [-postinstallation_script_on_oms]
           [-postinstallation_script_run_as_root]
           [-configure_hybrid_cloud_agent]
           [-hybrid_cloud_gateway_agent="Hybrid Cloud Gateway Agent"]
           [-hybrid_cloud_gateway_proxy_port="Hybrid Cloud Gateway Proxy Port"]
           [-wait_for_completion]

   Note that the parameters mentioned in [ ] are optional.

   Note:

   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, $<ORACLE_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 defines 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 6-2.

   The -credential_name parameter defines 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, see create_named_credential in the 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:

   $<ORACLE_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:

   $<ORACLE_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, /u01/software/em13c/oraclehome/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_operation

   This example displays the status of the ADD_HOST_SYSMAN_operation 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:

   /u01/software/em13c/oraclehome/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_operation -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 6-3 displays a sample output of the command.

   Figure 6-3 Output of emcli get_add_host_status

   
   

   

   
   

   Alternatively, to know where the Management Agent log files are located, see Overview of the Installation and Configuration Log Files in the 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:

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

   For example, $<ORACLE_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:

   $<ORACLE_HOME>/bin/emcli help get_add_host_status
   $<ORACLE_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:

       $<ORACLE_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, /u01/software/em13c/oraclehome/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_operation2' -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:

       $<ORACLE_HOME>/bin/emcli retry_add_host 
               -session_name="session_name"
               -retry_using_same_inputs | -update_inputs_and_retry"
               [-host_names="Host names"]
               [-platform="Platform id"]
               [-installation_base_directory="Installation base directory"]
               [-credential_name="Credential Name"]
               [-credential_owner="Credential Owner"]
               [-instance_directory="Instance directory"]
               [-port="Agent port"]
               [-deployment_type="Type of agent deployment"]
               [-privilege_delegation_setting="Privilege delegation setting"]
               [-additional_parameters="parameter1 parameter2 ..."]
               [-source_agent="Source agent"]
               [-master_agent="Master agent"]
               [-preinstallation_script="Preinstallation script"]
               [-preinstallation_script_on_oms]
               [-preinstallation_script_run_as_root]
               [-postinstallation_script="Postinstallation script"]
               [-postinstallation_script_on_oms]
               [-postinstallation_script_run_as_root]
               [-configure_hybrid_cloud_agent]
               [-hybrid_cloud_gateway_agent="Hybrid Cloud Gateway Agent"]
               [-hybrid_cloud_gateway_proxy_port="Hybrid Cloud Gateway Proxy Port"]
               [-wait_for_completion]
       

       Note that the parameters mentioned in [ ] are optional.

       For example, /u01/software/em13c/oraclehome/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_operation2' -update_inputs_and_retry -credential_name=oracle2

       This example retries the deployment of Management Agents for the ADD_HOST_SYSMAN_operation2 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:

     $<ORACLE_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:

       $<ORACLE_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, /u01/software/em13c/oraclehome/bin/emcli continue_add_host -session_name='ADD_HOST_SYSMAN_operation2' -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:

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

       Note that the parameters mentioned in [ ] are optional.

       For example, /u01/software/em13c/oraclehome/bin/emcli continue_add_host -session_name='ADD_HOST_SYSMAN_operation2' -continue_all_hosts

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

     $<ORACLE_HOME>/bin/emcli help continue_add_host

Note:

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

Supported Additional Parameters for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

Table 6-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 6-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 $<ORACLE_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, START_PRIORITY_LEVEL=95 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 13.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 Installing Oracle Management Agent in Silent Mode in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
START_AGENT=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.
SCRATCHPATH	Specify this parameter if you do not have write permission on /tmp or enough space on /tmp to use a custom path for the software extraction other than /tmp. Perform the following steps to override the /tmp location: Update $OMS_HOME/oui/prov/resources/ssPaths_<platform>.properties for SCRATCHPATH property. For example, if you are deploying 13.2 or greater agents on Linux x64 platform, then you must update the property file -ssPaths_linuxx64.properties with the value SCRATCHPATH=/u01/app/stage In the agent push console, pass SCARTCHPATH=/u01/app/stage in additional parameter
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

After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI

After you install a standalone 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 Installing Standalone Management Agents Using EM CLI.

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_HOME>/sysman/install/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 13c, nmosudo is located in the sbin directory that is in the agent home. For example, <AGENT_HOME>/sbin/nmosudo.

   Therefore, when you install a 13c 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 Overview of Discovering and Adding Targetsin the 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 

9. If you install a Management Agent on a host that resides in Oracle Cloud Infrastructure (OCI), the steps described above also apply to it.

   • Make sure the agent shows as up on the Enterprise Manager All Targets page.

   • Confirm Privilege Delegation is set for the agent on Enterprise Manager: Open Enterprise Manager and navigate to Setup > Security and click on Privilege Delegation.

     

   Once the Management Agent installation is completed, you can proceed with discovering targets. For information about discovering targets in Enterprise Manager Cloud Control, refer to Overview of Discovering and Adding Targets in the Oracle Enterprise Manager Cloud Control Administrator's Guide.

Note:

• To know the location where a Management Agent is deployed on a Microsoft Windows host, that is, the Management Agent Oracle home, access <INVENTORY_LOCATION>\inventory.xml, then search for HOME NAME="agent13c1". The value of the LOC parameter denotes the Management Agent Oracle home.

  For example, in the following line of C:\Program Files\Oracle\inventory.xml, D:\agent13cr3\agent_13.4.0.0.0 denotes the Management Agent Oracle home:

  <HOME NAME="agent13c1" LOC="D:\agent13cr2\agent_13.4.0.0.0" TYPE="O" IDX="10">

• You can repoint your existing Management Agents to a new Oracle Management Service (OMS). For information on how to do this, see Redirecting Oracle Management Agent to Another Oracle Management Service in the 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.

Creating an Agent Gold Image

An Agent Gold Image represents the ideal state of a Management Agent in a data center, having customized configurations of the desired versions of the Management Agent software, the desired versions of the monitoring plug-ins, and the desired patches.

You can create an Agent Gold Image, using either of the following methods:

• Creating an Agent Gold Image Using Gold Agent Images Home Page

• Creating an Agent Gold Image Using EM CLI

Creating an Agent Gold Image Using Gold Agent Images Home Page

To create an Agent Gold Image, follow these steps:

1. From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
2. Click Manage All Images.
3. Click Create.
4. Specify the gold image name, a description (optional), and the platform of the source Management Agent that you want to use to create the Agent Gold Image versions. Ensure that you use only a standalone Management Agent as the source, and not a central agent.
5. Click Submit.

Creating an Agent Gold Image Using EM CLI

When you create an Agent Gold Image version using EM CLI, the Agent Gold Image gets automatically created.

To create an Agent Gold Image by creating an Agent Gold Image version using EM CLI, see Creating an Agent Gold Image Version Using EM CLI.

Creating an Agent Gold Image Version

An Agent Gold Image is expected to undergo revisions whenever you plan to upgrade your Management Agents, upgrade the plug-ins deployed on your Management Agents, deploy new plug-ins on your Management Agents, or deploy new patches on your Management Agents or plug-ins. Each of these sequential revisions of an Agent Gold Image is termed as a Agent Gold Image version.

You can create an Agent Gold Image version, using either of the following methods:

• Creating an Agent Gold Image Version Using Gold Agent Images Home Page

• Creating an Agent Gold Image Version Using EM CLI

Creating an Agent Gold Image Version Using Gold Agent Images Home Page

To create an Agent Gold Image version, follow these steps:

Note:

If the configuration properties of the source Management Agent were changed for some reason in the emd.properties file, then before creating an agent gold image version using that source Management Agent, reload the configuration properties of that Management Agent. To do so, run the following command:

emctl reload agent

1. From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
2. Click the name of the required Agent Gold Image.
3. Click Manage Image Versions and Subscriptions.
4. Select the Versions and Drafts tab, then from the Actions menu, select Create.
5. Specify an image version name, and a description for the image version, if required.

   When you create an image version and update a Management Agent with it, Enterprise Manager Cloud Control uses the image version name you provide here to create a subdirectory in the agent base directory for the Management Agent being updated.

   For example, if the agent base directory of the Management Agent being updated is /u01/software/em13c/agentbasedir, and the agent home is /u01/software/em13c/agentbasedir/agent_13.4.0.0.0, and if you provide OPB_BP1 as the image version name, then when you update the Management Agent with the image version, a new subdirectory /u01/software/em13c/agentbasedir/GoldImage_OPB_BP1/agent_13.4.0.0.0 is created. The word limit for the image version name is 20 characters.

6. If you want to create the gold image version using a source Management Agent, for Create image by, select Selecting a source agent, then specify the source Management Agent that you want to use. In this case, you can also specify the following:

   • Work Directory: The working directory that must be used to create the Agent Gold Image. The default working directory is $AGENT_INSTANCE_HOME/install. Ensure that you have minimum 750MB space in this location.

   • Configuration Properties: The Management Agent configuration properties separated by ";" that must be captured while creating the Agent Gold Image. The names of these properties can be found in the $AGENT_INSTANCE_HOME/sysman/config/emd.properties file.

   • Exclude Files: The list of files that you want to exclude from the Agent Base Directory of the source agent while creating the Agent Gold Image. Ensure that you provide the complete file path. If there are two or more files, then separated them by a semicolon (;).

   However, if you want to create the gold image version by importing an existing gold image version, for Create image by, select Importing an image, then specify the location of the gold image version that you want to import. In order to be able to import an image, the image should already be staged. If you have not already staged the image for this purpose, see Managing the Lifecycle of an Agent Gold Image in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

7. Click OK.

   A job that creates the Agent Gold Image version is submitted to the Enterprise Manager job system. You can view the status of this job on the Gold Agent Image Activities page, in the Image Activities tab.

Creating an Agent Gold Image Version Using EM CLI

To create an Agent Gold Image version using EM CLI, follow these steps:

Note:

If the configuration properties of the source Management Agent were changed for some reason in the emd.properties file, then before creating an agent gold image version using that source Management Agent, reload the configuration properties of that Management Agent. To do so, run the following command:

emctl reload agent

1. Sign in to EM CLI from the /bin directory present within the Oracle home:

   $<ORACLE_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:

   $<ORACLE_HOME>/bin/emcli sync

3. Run the create_gold_agent_image verb to create an Agent Gold Image using the specified source Management Agent or by importing an already created image from another Enterprise Management System:

   <ORACLE_HOME>/bin/emcli create_gold_agent_image
           -image_name="gold_image_name"
           -version_name="gold_image_version_name"
           -source_agent|-import_location="source_agent|import_location"
           [-gold_image_description="gold_image_description"]
           [-working_directory="working_directory_location"]
           [-config_properties= "agent_configuration_properties"]
           [-exclude_files= "list_of_files_directories_to_exclude"]

   Note that the parameters mentioned in [ ] are optional.

   Table 6-3 lists and describes the parameters supported for creating an Agent Gold Image version using EM CLI.

   Table 6-3 Supported Parameters for Creating an Agent Gold Image Version

   Parameter	Description
   -image_name	Agent Gold Image name to which the created Agent Gold Image must be added.
   -version_name	Version name of the Agent Gold Image. When you create an image version and update a Management Agent with it, Enterprise Manager Cloud Control uses the image version name you provide here to create a subdirectory in the agent base directory for the Management Agent being updated. For example, if the agent base directory of the Management Agent being updated is /u01/software/em13c/agentbasedir, and the agent home is /u01/software/em13c/agentbasedir/agent_13.4.0.0.0, and if you provide OPB_BP1 as the image version name, then when you update the Management Agent with the image version, a new subdirectory /u01/software/em13c/agentbasedir/GoldImage_OPB_BP1/agent_13.4.0.0.0 is created. The word limit for the image version name is 20 characters.
   -source_agent	Management Agent to be used as the source to create the Agent Gold Image. To view a list of the Management Agents that can be used as a source to create a gold image, run emcli get_targets -target="oracle_emd".
   -import_location	Location where the Agent Gold Image is staged for creating the gold agent image version. This location is accessible from all the OMS instances.
   -gold_image_description	Description of the Agent Gold Image.
   -working_directory	Working directory to be used to create the Agent Gold Image. The default working directory is $AGENT_INSTANCE_HOME/install. Minimum free space required is 1 GB.
   -config_properties	Management Agent configuration properties separated by \";\" that must be captured while creating the Agent Gold Image. For example, MaxThread;GracefulShutdown.
   -exclude_files	List of files or directories separated by \";\" that must be excluded from the gold agent image version. For example, agent_13.4.0.0.0/cfgtoollogs/agentDeploy;agent_13.4.0.0.0/oui. Ensure that you provide only the relative path to the files and directories and not the absolute path.

   Examples:

   • The following example creates an Agent Gold Image OPC_AGI_DB_JUL_13, using example.com:3872 as the source Management Agent, and adds the gold image version to the gold image OPC_DB_MONITORING:

     <ORACLE_HOME>/bin/emcli create_gold_agent_image -source_agent=example.com:3872 -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING

   • The following example creates an Agent Gold Image OPC_AGI_DB_JUL_13, using example.com:3872 as the source Management Agent, /tmp as the working directory, and adds the gold image version to the gold image OPC_DB_MONITORING:

     <ORACLE_HOME>/bin/emcli create_gold_agent_image -source_agent=example.com:3872 -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING -working_directory=/tmp

   • The following example creates an Agent Gold Image OPC_AGI_DB_JUL_13 using gold image software staged at import location /abc/stage:

     <ORACLE_HOME>/bin/emcli create_gold_agent_image -import_location=/abc/stage -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING

Setting a Particular Agent Gold Image Version as the Current Version

The up-to-date version of an Agent Gold Image that you want to use to standardize the Management Agents in your enterprise is termed as the current version of the Agent Gold Image.

When an Agent Gold Image version is created, it is marked as a draft version. Setting a draft version of an Agent Gold Image as the current version indicates that the gold image version is ready to be used to mass deploy or mass update Management Agents. Once an image is set to Active (Current), you cannot revert it to a draft or a restricted version.

You can set a particular Agent Gold Image version as the current version, using either of the following methods:

• Setting a Particular Agent Gold Image Version as the Current Version Using Gold Agent Images Home Page

• Setting a Particular Agent Gold Image Version as the Current Version Using EM CLI

Setting a Particular Agent Gold Image Version as the Current Version Using Gold Agent Images Home Page

To set a draft version of an Agent Gold Image as the current version, follow these steps:

1. From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
2. Click the name of the required Agent Gold Image.
3. Click Manage Image Versions and Subscriptions.
4. Select the Versions and Drafts tab. Select the gold image version that you want to set as the current version, then click Set Current Version.

   A job that promotes the Agent Gold Image draft version to the current version is submitted to the Enterprise Manager job system. You can view the status of this job on the Gold Agent Image Activities page, in the Image Activities tab.

Setting a Particular Agent Gold Image Version as the Current Version Using EM CLI

To set a particular Agent Gold Image version as the current version using EM CLI, follow these steps:

1. Sign in to EM CLI from the /bin directory present within the Oracle home:

   $<ORACLE_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:

   $<ORACLE_HOME>/bin/emcli sync
   

3. Run the promote_gold_agent_image verb to promote the Agent Gold Image version to the Current maturity level:

   <ORACLE_HOME>/bin/emcli promote_gold_agent_image -version_name="gold_image_version_name" -maturity="Current/Restricted/Draft"

   The -version_name parameter defines the Agent Gold Image version name that you want to promote.

   The -maturity parameter defines the gold image maturity level.

   For example, to promote the Agent Gold Image OPC_AGI_DB_JUL_13 to the Current maturity level, run the following:

   <ORACLE_HOME>/bin/emcli promote_gold_agent_image -version_name=OPC_AGI_DB_JUL_13 -maturity=Current

Installing Management Agents Using an Agent Gold Image

You can install new Management Agents using Agent gold images, by using either of the following methods:

• Installing Management Agents Using an Agent Gold Image Using Add Host Targets Wizard

• Installing Management Agents Using an Agent Gold Image Using EM CLI

Note:

You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Overview of Installing Shared Agents in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

Installing Management Agents Using an Agent Gold Image Using Add Host Targets Wizard

Note:

To view a visual demonstration of how to deploy Oracle Management Agents using Agent Gold Images, access the following URL and click Begin Video.

https://apexapps.oracle.com/pls/apex/f?p=44785:24:0:::24:P24_CONTENT_ID,P24_PREV_PAGE:12754,1

To install new Management Agents using an Agent Gold Image, follow these steps:

1. Access the Add Host Targets Wizard in one of the following ways:

   • Option 1: From the Add Targets Manually Page

     From the Setup menu, select Add Target, then select Add Targets Manually.

   • Option 2: From the Gold Agent Images Console

     From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.

     On the Gold Agent Images page, in the table that lists all the Agent Gold Images, click the gold image you want to use for deploying new Management Agents.

     On the gold image page, click Manage Image Versions and Subscriptions. Then, on the Manage Image: <gold image> page, click the Subscriptions tab. Finally, in the Subscriptions tab, click Add Host.

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

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

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

   2. If you followed Option 1 in Step (1) to reach the Add Host Targets: Host and Platform page, then from the Options drop-down list, select With Gold Image. Then, from the Image Name drop-down list, select the gold image you want to use, and from the Image Version drop-down list, select the version of the gold image you want to use.

      If you followed Option 2 in Step (2) to reach the Add Host Targets: Host and Platform page, then you do not have to select anything from the Options, Image Name, and Image Version drop-down lists.

   3. 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.example.com, which persist over the life of the host targets. This is recommended for ease of maintenance and overall security.

      
      

      

      
      

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

      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 Format of the Host List File.

      
      

      

      
      

      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.

   4. Click Next.

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

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

      
      
      

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

   3. In the Installation Details section, provide the installation details common to the hosts selected in Step 3 (b). For 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/software/em13c/agentbasedir/

      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.

      The directory name you enter here is appended with the name of the Agent Gold Image you have selected for deployment. For example, if you enter abd as the directory name, and if you used the gold image named GI_V2, then the installation base directory is named GI_V2_abd.

      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/software/em13c/agentbasedir/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.

      

      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 Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI, 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 After Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

      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.

      Note:

      Since you are using a gold image that already carries the patches and the configuration of a stable Management Agent, make sure you do not add any postinstallation scripts that will reapply or reconfigure the Management Agent you are deploying.

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

4. 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 <ORACL_HOME>/sysman/prov/agentpush/agentpush.properties file:

   oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true

   For more information about this deployment method, see Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

5. 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, click Install Agent Results.

6. 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 Overview of the Installation and Configuration Log Files in the 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.

Installing Management Agents Using an Agent Gold Image Using EM CLI

Note:

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

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

1. Sign in to EM CLI from the /bin directory present within the Oracle home:

   $<ORACLE_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:

   $<ORACLE_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:

   $<ORACLE_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:

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

   Note that the parameters mentioned in [ ] are optional.

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

   Figure 6-2 displays the output of this command.

   Figure 6-4 Output of list_add_host_platforms -all

   
   

   

   
   

   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 Meeting the Management Agent Software Prerequisites for Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

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

   $<ORACLE_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 <ORACLE_HOME>/sysman/prov/agentpush/agentpush.properties file:

   oracle.sysman.prov.agentpush.continueIgnoringFailedHost=true

   For more information about this deployment method, see Before You Begin Installing Standalone Management Agents Using Add Host Targets Wizard or EM CLI.

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

   $<ORACLE_HOME>/bin/emcli submit_add_host
           -host_names="List of host names."
           -platform="Platform id"
           -installation_base_directory="Installation base directory."
           -credential_name="Credential Name"
           [-credential_owner="Credential Owner"]
           [-instance_directory="Instance directory"]
           [-port="Agent port"]
           [-version_name="Gold Image Version Name"]
           [-image_name="Gold Image Name"]
           [-session_name="Deployment session name"]
           [-deployment_type="Type of agent deployment"]
           [-privilege_delegation_setting="Privilege delegation setting"]
           [-additional_parameters="parameter1 parameter2 ..."]
           [-source_agent="Source agent"]
           [-master_agent="Master agent"]
           [-input_file=properties_file:"Properties file"]
           [-predeploy_script="Predeploy script"]
           [-predeploy_script_on_oms]
           [-predeploy_script_run_as_root]
           [-preinstallation_script="Preinstallation script"]
           [-preinstallation_script_on_oms]
           [-preinstallation_script_run_as_root]
           [-postinstallation_script="Postinstallation script"]
           [-postinstallation_script_on_oms]
           [-postinstallation_script_run_as_root]
           [-configure_hybrid_cloud_agent]
           [-hybrid_cloud_gateway_agent="Hybrid Cloud Gateway Agent"]
           [-hybrid_cloud_gateway_proxy_port="Hybrid Cloud Gateway Proxy Port"]
           [-wait_for_completion]        

   Note that the parameters mentioned in [ ] are optional.

   Table 6-4 lists and describes the parameters supported for submitting an Add Host session which installs Management Agents on unmanaged hosts, thereby converting them to managed hosts.

   Table 6-4 Supported Parameters for Submitting an Add Host Session

   Parameter	Description
   -host_names	The names of the hosts where the agents need to be installed, separated by a semi colon.
   -platform	The ARU platform ID of the hosts where the agent need to be installed.
   -installation_base_directory	The directory where the Management Agent will be installed. Provide this parameter in double quotes if it is a MS-DOS/Windows style path.
   -credential_name	The named credential to be used for installing the Management Agent.
   -credential_owner	The owner of the named credential.
   -instance_directory	The instance directory of the Management Agent. Provide this parameter in double quotes if it is a MS-DOS/Windows style path.
   -port	The port through which the Management Agent should communicate with the OMS.
   -version_name	The Agent Gold Image name to be used for deployment. Run emcli list_gold_agent_images to view a list of Agent Gold Images.
   -session_name	The session name which uniquely identifies the Add Host session.
   -deployment_type	The type of Management Agent deployment. 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.
   -privilege_delegation_setting	The privilege delegation setting for installing an Management Agent and running the root script.
   -additional_parameters	Additional parameters for installing a Management Agent.
   -source_agent	The source Management Agent for installing a cloned Management Agent.
   -master_agent	The master Management Agent for installing a shared Management Agent.
   -input_file	The properties file containing the Management Agent installation inputs.
   -preinstallation_script	The script that you want to run before installing the Management Agent. Provide this parameter in double quotes if it is a MS-DOS/Windows style path.
   -preinstallation_script_on_oms	Indicates that the preinstallation script resides on the OMS host.
   -preinstallation_script_run_as_root	Runs the preinstallation script as the root user.
   -postinstallation_script	The script you want to run after installing the Management Agent. Provide this parameter in double quotes if it is a MS-DOS/Windows style path.
   -postinstallation_script_on_oms	Indicates that the postinstallation script resides on the OMS host.
   -postinstallation_script_run_as_root	Runs the postinstallation script as the root user.
   -configure_hybrid_cloud_agent	Enables you to deploy a management agent on a hybrid cloud.
   -hybrid_cloud_gateway_agent	The Management Agent that provides a communication channel between the Oracle Public Cloud virtual hosts and the OMS deployed in your private network.
   -hybrid_cloud_gateway_proxy_port	The port on which the Hybrid Cloud Agent can communicate with the Hybrid Cloud Gateway Proxy.
   -wait_for_completion	Runs the Add Host operation synchronously.

   Examples:

   • To submit an Add Host session on the host example.com, having platform ID 226, with /opt/agent as the installation base directory, using the named credential oracle and privilege delegation setting /usr/bin/sudo -u %RUNAS% %COMMAND%, run the following command:

     $<ORACLE_HOME>/bin/emcli submit_add_host -host_names=example.com -platform=226 -installation_base_directory=/opt/agent -credential_name=oracle -privilege_delegation_setting="/usr/bin/sudo -u %RUNAS% %COMMAND%"

   • To submit an Add Host session on the host example2.com, having platform ID 233, with C:\agent as the installation base directory, using the named credential oracle, run the following command:

     $<ORACLE_HOME>/bin/emcli submit_add_host -host_names=example2.com -platform=233 -installation_base_directory="C:\agent" -credential_name=oracle

   • To submit an Add Host session using the inputs provided in the properties file /opt/inputs.txt, run the following command:

     $<ORACLE_HOME>/bin/emcli submit_add_host -input_file=properties_file:/opt/inputs.txt

   • To submit an Add Host session of type CLONE, on the host example.com, having platform ID 226, with /opt/agent as the installation base directory, example1.com:3872 as the source agent, using the named credential oracle, run the following command:

     $<ORACLE_HOME>/bin/emcli submit_add_host -host_names=example.com -platform=226 -installation_base_directory=/opt/agent -credential_name=oracle -deployment_type=CLONE -source_agent=example1.com:3872

   • To submit an Add Host session of type SHARED, on the host example.com, having platform ID 226, with /opt/agent/agent_inst as the instance directory, example1.com:3872 as the master agent, using the named credential oracle, run the following command:

     $<ORACLE_HOME>/bin/emcli submit_add_host -host_names=example.com -platform=226 -instance_directory=/opt/agent/agent_inst -credential_name=oracle -deployment_type=SHARED -master_agent=example1.com:3872

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

   $<ORACLE_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:

   $<ORACLE_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, $<ORACLE_HOME>/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_operation

   This example displays the status of the ADD_HOST_SYSMAN_operation 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:

   $<ORACLE_HOME>/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_operation -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 6-3 displays a sample output of the command.

   Figure 6-5 Output of emcli get_add_host_status

   
   

   

   
   

   Alternatively, to know where the Management Agent log files are located, see Overview of the Installation and Configuration Log Files in the 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:

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

   For example, $<ORACLE_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:

   $<ORACLE_HOME>/bin/emcli help get_add_host_status
   $<ORACLE_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:

       $<ORACLE_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, $<ORACLE_HOME>/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_operation2' -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:

       $<ORACLE_HOME>/bin/emcli retry_add_host 
               -session_name="session_name"
               -retry_using_same_inputs | -update_inputs_and_retry"
               [-host_names="Host names"]
               [-platform="Platform id"]
               [-installation_base_directory="Installation base directory"]
               [-credential_name="Credential Name"]
               [-credential_owner="Credential Owner"]
               [-instance_directory="Instance directory"]
               [-port="Agent port"]
               [-deployment_type="Type of agent deployment"]
               [-privilege_delegation_setting="Privilege delegation setting"]
               [-additional_parameters="parameter1 parameter2 ..."]
               [-source_agent="Source agent"]
               [-master_agent="Master agent"]
               [-preinstallation_script="Preinstallation script"]
               [-preinstallation_script_on_oms]
               [-preinstallation_script_run_as_root]
               [-postinstallation_script="Postinstallation script"]
               [-postinstallation_script_on_oms]
               [-postinstallation_script_run_as_root]
               [-configure_hybrid_cloud_agent]
               [-hybrid_cloud_gateway_agent="Hybrid Cloud Gateway Agent"]
               [-hybrid_cloud_gateway_proxy_port="Hybrid Cloud Gateway Proxy Port"]
               [-wait_for_completion]

       Note that the parameters mentioned in [ ] are optional.

       For example, $<ORACLE_HOME>/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_operation2' -update_inputs_and_retry -credential_name=oracle2

       This example retries the deployment of Management Agents for the ADD_HOST_SYSMAN_operation2 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:

     $<ORACLE_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:

       $<ORACLE_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, $<ORACLE_HOME>/bin/emcli continue_add_host -session_name='ADD_HOST_SYSMAN_operation2' -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:

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

       Note that the parameters mentioned in [ ] are optional.

       For example, $<ORACLE_HOME>/bin/emcli continue_add_host -session_name='ADD_HOST_SYSMAN_operation2' -continue_all_hosts

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

     $<ORACLE_HOME>/bin/emcli help continue_add_host

Note:

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

Troubleshooting Management Agents

This section provides tips to issues that you may encounter when installing or working with management agents. In particular, this section covers the following:

• Troubleshooting Management Agent Crashes That Occur Due to java.lang.OutOfMemoryError Errors

Troubleshooting Management Agent Crashes That Occur Due to java.lang.OutOfMemoryError Errors

There is a chance that agents may crash due to an eventual increase in the number of targets per agent. Therefore, if there is a likelihood of future additional targets in the agent infrastructure, it is advisable to increase the Java heap size manually soon after the agent installation.

To increase the heap size manually, follow these steps:

1. Stop the agent.
2. Carry out a backup of the following file:

   AGENT_INST_HOME/sysman/config/emd.properties

3. Open the same file and change agentJavaDefines=-Xmx128M -XX:MaxPermSize=96M to agentJavaDefines=-Xmx[New Heap Size]M -XX:MaxPermSize=96M.
4. Start the agent.