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:
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 Section 6.2.2.4.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:
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 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.
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
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.
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
Setting a Particular Agent Gold Image Version as the Current Version
To get started with installing Management Agents using Agent Gold Images, follow these steps:
Ensure that you have a standalone Oracle Management Agent 13c Release 1 installed in your environment.
If you do not have a standalone Oracle Management Agent 13c Release 1 installed, then install one now. See Section 6.2.2. If you have a Management Agent of any earlier release, then upgrade it to 13c Release 1. See 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.Create an Agent Gold Image. See Section 6.2.3.
Create an Agent Gold Image version. See Section 6.2.4.
Set a particular Agent Gold Image version as the current version that can be used for deployment. See Section 6.2.5.
Install the standalone Management Agent on the destination host using the Agent Gold Image. See Section 6.2.6.
Note:
You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see 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.
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
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
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 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, refer to 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.1.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 the Redirecting Oracle Management Agent to Another Oracle Management Service Appendix present in Oracle Enterprise Manager Cloud Control Advanced Installation Guide.When you repoint your existing Management Agents to a new OMS, you cannot move the targets monitored by the Management Agents, the target history, and the Management Agent history. The monitored targets and the history data is lost.
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 Section 6.2.2.4.
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 a12c 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:
In the Add Host Targets Wizard, select the deployment type Fresh Agent Install, and install a Management Agent on the host where the drive is shared. Alternatively, you can select the deployment type Clone Existing Agent, and clone the Management Agent to the host where the drive is shared.
For more information, refer to the chapter on cloning a Management Agent in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
In the Add Host Targets Wizard, select the deployment type Add Host to Shared Agent, and install a Management Agent on all other hosts that access the shared, mounted drive. (Here, you will select the Management Agent you installed in the previous step as the master agent or shared agent.)
For more information, refer to the chapter on installing a Shared Agent in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
If you have an Oracle RAC Cluster with multiple nodes, then you must install a Management Agent on each of the nodes separately. In other words, in the Add Host Targets Wizard, you must add each node explicitly as a destination host.
In Enterprise Manager Cloud Control 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 Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
Also, you can apply one-off patches on a plug-in and create a custom patched plug-in, such that this custom patched plug-in is deployed on all the new Management Agents that you deploy, and all the old Management Agents that you upgrade.
For information on how to do this, see Oracle Enterprise Manager Cloud Control Administration Guide.
The Add Host Targets Wizard supports the permissive
and enforcing
options for Security-Enhanced Linux (SELinux).
The Add Host Targets Wizard uses SSH to establish connectivity between Oracle Management Service (OMS) and the remote hosts where you want to install the Management Agents.
Only SSH1 (SSH version 1) and SSH2 (SSH version 2) protocols offered by OpenSSH are supported for deploying a Management Agent.
The Add Host Targets Wizard supports Named Credentials that enable you to use a set of credentials registered with a particular name specifically for this operation, by your administrator. This ensures an additional layer of security for your passwords because as an operator, you can only select the named credential, which is saved and stored by an administrator, and not know the actual user name and password associated with it.
In case the named credential you select does not have the privileges to perform the installation, then you can set the named credential to run as another user (locked user account). In this case, the wizard logs in to the hosts using the named credential you select, but performs the installation using the locked user account you set.
For example, you can create a named credential titled User_A (the user account that has remote login access), and set it to run as User_X (the Management Agent install user account for which no direct login
is set) that has the required privileges. In this case, the wizard logs in to the hosts as User_A, but installs as User_X, using the privilege delegation setting (sudo or PowerBroker) specified in the named credential.
The sudo, pbrun, sesu, and su privilege delegation tools are supported in Cloud Control.
Named credentials support SSH public key authentication and password based authentication. So you can use an existing SSH public key authentication without exposing your passwords.
To set up SSH public key authentication for a named credential, follow these steps:
Note:
If you have already set up SSH public key authentication for a named credential and the SSH keys are already created, 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.
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
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"
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 Chapter 4), 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>
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.
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.
Upgrading a lower release of Solaris by applying a kernel patch or a patch bundle is not equivalent to installing the actual Solaris 5.10 Update 9 image. Oracle Management Agent 13c was built, tested, and certified on a minimum update version of Solaris 5.10 Update 9, so Oracle recommends that you install Oracle Management Agent only on Solaris 5.10 Update 9, and not on any release that was upgraded using patches.
Note:
Instead of installing a Management Agent using the Add Host Targets Wizard, or EM CLI, you can choose to install the Management Agent manually, in silent mode. For information on installing a Management Agent in silent mode, refer to Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.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 |
---|---|
Ensure that you meet the hard disk space, swap space, temp directory space, stage directory space, and physical memory requirements as described in Chapter 1. |
|
(For Microsoft Windows) Ensure that you have installed Cygwin 1.7 on the destination host as described in Chapter 4. Note: While running If you do not want to install Cygwin to deploy Management Agents on Microsoft Windows hosts using the Add Host Targets Wizard or EM CLI, you can choose to deploy Management Agents on these hosts using the PsExec process utility. For information on how to deploy Management Agents on Microsoft Windows hosts using PsExec, see Appendix E. |
|
Ensure that you install the Management Agent only on certified operating systems as mentioned in the Enterprise Manager certification matrix available on My Oracle Support. To access the Enterprise Manager certification matrix, follow the steps outlined in Appendix D. For information about platforms receiving future support, refer to My Oracle Support note 793512.1. Note: If you use Oracle Solaris 10, then ensure that you have update 3 or higher installed. To verify whether it is installed, run the following command:
|
|
File System Requirements |
Ensure that the file system mounted on the destination host does not permit buffered writes. |
File Descriptor Requirements |
|
Package Requirements |
Ensure that you install all the operating system-specific packages as described in Chapter 2. |
User and Operating System Group Requirement |
Ensure that you create the required operating system groups and users as described in Chapter 3. |
Privilege Requirements |
Ensure that the Enterprise Manager user has the Super administrators, such as the |
etc/hosts File Requirements |
(Only for Microsoft Windows) Ensure that the entry for local host in the |
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 For example, if the fully-qualified host name is
|
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. |
Destination Host Time Zone Requirements |
Ensure that the time zones of the destination hosts have been set correctly. To verify the time zone of a destination host, log in to the OMS host, and run the following command:
If the time zone displayed is incorrect, log in to the destination host, and follow these steps:
Note: If you had ignored a prerequisite check warning about wrong time zone settings during the Management Agent install, you must set the correct time zone on the destination hosts after installing the Management Agents. For information on setting time zones post install, refer Section 6.2.2.6. |
sudo/pbrun/sesu/su SSH Requirements |
(Only for UNIX) Ensure that you set the Alternatively, you can use the Note: If you are using sudo as your privilege delegation tool, and you do not want to set the
|
sudo/pbrun/sesu/su Requirements (for executing commands as the root user) |
(Only for UNIX)
|
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 For example, if you are using sudo as your privilege delegation tool, include the following in the
Here, If you do not want to grant privileges to the installing user to invoke For example, if you are using sudo as your privilege delegation tool, include the following in the
Here, |
Locked Account Requirements |
Ensure that the locked account user (oracle) has read permission on the home directory of the login user. |
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:
For example, the output of this command may be the following:
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:
For a Microsoft Windows host, the SSH port value is mentioned in the If the SSH port is a non-default port, that is, any port other than 22, then update the
|
|
On the destination host, ensure the following:
|
|
|
Unset the |
Ensure that the software of the Management Agent you want to install is downloaded and applied using Self Update.
|
|
Validate the path to all command locations as described in Appendix B. |
|
|
|
|
|
Installing User Requirements |
|
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:
To verify whether the agent user has these rights, follow these steps:
|
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 For more information on this restriction and to understand how you can grant these permissions, access the following URL to Microsoft Web site: |
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 |
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. |
|
Ensure that you use a certified browser as mentioned in the Enterprise Manager certification matrix available on My Oracle Support. To access the Enterprise Manager certification matrix, follow the steps in Appendix D. |
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:
Important:
The Management Agent software for the OMS host platform is downloaded and applied by default, so if the host on which you want to install a Management Agent runs on the same platform as that of the OMS host, you do not need to download and apply the Management Agent software for this platform.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:
Ensure that you have set up Self Update.
For information on setting up Self Update, see Oracle Enterprise Manager Cloud Control Administration Guide.
From the Setup menu, select Extensibility, then select Self Update.
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.
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.
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.
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
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.
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.
If Enterprise Manager is not connected to My Oracle Support via the Internet, it is said to run in Offline Mode.
To verify that Enterprise Manager is running in Offline Mode, access the Offline Patching page. To access this page, from the Setup menu, select Provisioning and Patching, then select Offline Patching.
To download and apply the Management Agent software using Self Update when Enterprise Manager is running in Offline Mode, follow these steps:
Ensure that you have set up Self Update.
For information on setting up Self Update, see Oracle Enterprise Manager Cloud Control Administration Guide.
From the Setup menu, select Extensibility, then select Self Update.
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.
From an Internet-enabled computer, download the catalog file using the aforementioned URL.
Note:
Do not unzip the file.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)
Navigate to <OMS_HOME>
and log in to EM CLI, running the command as the install user, for example:
./emcli login -username=sysman
Synchronize EM CLI:
./emcli sync
Run the emcli import_update_catalog
command to import the archive into the Oracle Management Service instance or the Management Agent you want to update. For example:
./emcli import_update_catalog -omslocal -file=zip file absolute path
Before running this command, ensure that you have set up Software Library in Cloud Control. For information on how to do this, see Oracle Enterprise Manager Lifecycle Management Administrator's Guide.
Tip:
For a multi-OMS setup, runemcli help import_update_catalog
for more options.Return to the Self Update home page and do a refresh to see a count of new updates in the Available Updates column.
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.
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.
Click Download. A message displays with a URL and instructions.
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.
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.
This section describes the actions involved in installing standalone Management Agents. It consists of the following:
Important:
If the OMS host is running on Microsoft Windows, and the OMS software was installed in a drive other thanC:\,
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
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:
Ensure that you have downloaded and applied the Management Agent software for the platforms of the hosts on which you want to install Management Agents.
For information on how to download and apply the Management Agent software for a platform, see Section 6.2.2.4.
Note:
If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is downloaded and applied using Self Update.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.
On the Host and Platform page, do the following:
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.
From the Add menu, select Manually to enter the fully qualified name and select the platform of the host on which you want to install the Management Agent.
The host names that are retrieved from the system for the installation may include IP addresses and short names. However, it is recommended that you provide fully qualified host names, such as foo.mydomain.com,
which persist over the life of the host targets. This is recommended for ease of maintenance and overall security.
Note:
Oracle recommends you to enter the fully qualified domain name of the host. For monitoring purpose, Enterprise Manager Cloud Control adds that host and the Management Agent with the exact name you enter here.
You must enter only one host name per row. Entering multiple host names separated by a comma is not supported.
You must ensure that the host name does not contain underscores('_').
If the platform name is appended with Agent Software Unavailable, then it indicates that the software for that platform is not available on the OMS host, and that you must download and apply it using Self Update. To access Self Update, from the Setup menu, select Extensibility, then click Self Update.
For more information on using Self Update to download and apply the latest software, see Section 6.2.2.4.
Alternatively, from the Add menu, you can select either From File to add the host names stored in a file, or Discovered Hosts to add the host names from a list of hosts discovered by Enterprise Manager. For information on how the host name entries must appear in the host file, see Section 6.2.2.5.2.
Note:
When you select Discovered Hosts from the Add menu, and add hosts from a list of discovered hosts, the host's platform is automatically detected and displayed. The platform name is detected using a combination of factors, including hints received from automated discovery and the platform of the OMS host. This default platform name is a suggestion, so Oracle strongly recommends you to verify the platform details before proceeding to the next step.If you are correcting the platform names, and if all the hosts run on the same platform, then set the platform for the first host in the table and from the Platform list, select Same for All Hosts. This will ensure that the platform name you selected for the first host is also set for the rest of the hosts in the table.
If you are correcting the platform names, and all the hosts run on different platforms, from the Platform list, select Different for Each Host. Select the correct platform for each host.
Note:
If you reach this page (Host and Platform page) from the Auto Discovery Results page, then the hosts you selected on that page automatically appear in the table. In this case, you need to only validate the host names and their platforms.
If you are installing a Management Agent on a platform that is different from the platform on which the OMS is running, then ensure that you have the software for that platform. If you do not have that software, then go to the Self Update console within Enterprise Manager Cloud Control, download the software, then apply it. For more information, see Section 6.2.2.4.
Click Next.
On the Installation Details page, do the following:
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: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.
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.)
From the table, select the first row that indicates the hosts grouped by their common platform name.
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.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.
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 Section 6.2.2.2, you can select this credential from the Named Credential list.
For Privileged Delegation Setting, validate the Privilege Delegation setting to be used for running the root scripts. By default, it is set to the Privilege Delegation setting configured in Enterprise Manager Cloud Control.
For example, you can specify one of the following for the Privileged Delegation Setting field:
/usr/bin/sudo -u %RUNAS% %COMMAND% /usr/bin/sudo -u -S %RUNAS% %COMMAND% (if a pseudo terminal is required for remote command execution via SSH) /usr/bin/sesu - %RUNAS% -c "%COMMAND%" /usr/bin/pbrun %PROFILE% -u %RUNAS% %COMMAND% /usr/bin/su - %RUNAS% -c "%COMMAND%"
If you leave the Privileged Delegation Setting field blank, the root scripts will not be run by the wizard; you will have to run them manually after the installation. For information about running them manually, see Section 6.2.2.6.
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.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.
(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.
(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.
Repeat Step 3 (b) to Step 3 (i) for every other row you have in the table.
Click Next.
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 Section 6.2.2.2.
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.
If a particular installation phase has failed or has a warning, review the details provided for each phase in the Agent Deployment Details section of the Add Host Status page, and do one of the following:
Note:
To find the cause of a failure, review the log files. One log file is generated per host, so if you installed Management Agents on multiple hosts, then review all the log files. For information on how to access the log files, refer to Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.Fix the problem by reviewing the error description carefully, understanding its cause, and taking action as recommended by Oracle.
You can retry the deployment of Management Agents with the same installation details.
To do so, on the Add Host Status page, click Retry and select Retry Using Same Inputs.
You can retry the deployment of Management Agents with modified installation details.
To do so, on the Add Host Status page, click Retry and select Update Inputs and Retry.
Ignore the warning or failure, and continue with the session if you prefer.
You can choose to proceed with the deployment of Management Agents only on those remote hosts that have successfully cleared the checks, and you can ignore the ones that have Warning or Failed status.
To do so, on the Add Host Status page, click Continue and select Continue, Ignoring Failed Hosts.
You can choose to proceed with the deployment of Management Agents on all the hosts, including the ones that have Warning or Failed status.
Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.
To do so, on the Add Host Status page, click Continue and select Continue, All Hosts.
In the Add Host Targets Wizard, you can click Load from File to add the hosts listed in a file. However, ensure that the file you select has one of the following formats:
Only the host name.
For Example,
host1.example.com
host2.example.com
Note:
If the host list file is in this format, ensure that you select the platform for each added host from the drop down list.The host name followed by the platform name.
For Example,
host1.example.com linux_x64
host2.example.com aix
The supported platform names are linux_x64, linux, solaris, hpunix, hpi, linux64_zseries, aix, linux_ppc64, windows_x64, solaris_x64, win32.
Important:
Using EM CLI, you can install fresh Management Agents, install Shared Agents, and clone existing Management Agents.
Using EM CLI, you can install fresh Management Agents only on a single platform in a single Add Host session. If you want to use EM CLI to install fresh Management Agents on different platforms, then you must create a separate Add Host session for each platform.
Note:
If the output of the EM CLI verbs mentioned in this section is misaligned or is difficult to read, adjust your screen width by specifying an appropriate value for theoracle.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:
Log 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.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
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
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.
If the Management Agent software for a platform on which you want to install a Management Agent is not available, download and apply it using Self Update. For information on how to download and apply the Management Agent software for a platform, see Section 6.2.2.4.
Note:
If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is downloaded and applied using Self Update.To view more information on the syntax and the usage of the list_add_host_platforms
verb, run the following command:
$<ORACLE_HOME>/bin/emcli help list_add_host_platforms
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 Section 6.2.2.2.
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_hosts> -platform=<platform_ID> -installation_base_directory=<install_directory_of_agent> -credential_name=<named_credential_for_agent_install> [-credential_owner=<named_credential_owner>] [-instance_directory=<agent_instance_directory>] [-port=<agent_port>] [-session_name=<add_host_session_name>] [-deployment_type=<type_of_agent_deployment>] [-privilege_delegation_setting=<privilege_delegation>] [-additional_parameters=<additional_params_for_install>] [-source_agent=<source_agent_for_cloned_agent_install>] [-master_agent=<master_agent_for_shared_agent_install>] [-properties_file=<properties_file_having_inputs>] [-preinstallation_script=<pre_install_script>] [-preinstallation_script_on_oms] [-preinstallation_script_run_as_root] [-postinstallation_script=<post_install_script>] [-postinstallation_script_on_oms] [-postinstallation_script_run_as_root] [-wait_for_completion]
Note that the parameters mentioned in [ ]
are optional.
Important:
You can install a Shared Agent and clone a Management Agent by specifying the-deployment_type
option with the submit_add_host
verb. To install a Shared Agent, specify -deployment_type=SHARED.
To clone a Management Agent, specify -deployment_type=CLONE.
By default, the -deployment_type
option is set to FRESH,
so if this option is not specified, a fresh Management Agent is installed on the selected host.For example, $<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, refer Oracle Enterprise Manager Command Line Interface.
To view more information on the syntax and the usage of the submit_add_host
verb, run the following command:
$<ORACLE_HOME>/bin/emcli help submit_add_host
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_Dec_27_2012_3:02:28_AM_PST
This example displays the status of the ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST
Add Host session.
To view the detailed Management Agent deployment status of a particular host, run the get_add_host_status
verb with the -host_name
parameter. For example:
/u01/software/em13c/oraclehome/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_27_2012_3:02:28_AM_PST -host_name=example.com
This command also displays the location of the log file for the deployment of a Management Agent on the specified host. If the deployment failed, you can investigate the failure by reviewing the log files. One log file is generated per host.
Figure 6-3 displays a sample output of the command.
Alternatively, to know where the Management Agent log files are located, see Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
Run the list_add_host_sessions
verb to view the details or track the progress of all the Add Host sessions:
$<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
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_Apr_21_2013_8:02:28_AM_PST' -retry_using_same_inputs
You can retry the deployment of Management Agents with modified installation details.
To do so using EM CLI, use the retry_add_host
verb, with the -update_inputs_and_retry
option:
$<ORACLE_HOME>/bin/emcli retry_add_host -session_name -update_inputs_and_retry [-host_names] [-platform] [-installation_base_directory] [-credential_name] [-credential_owner] [-instance_directory] [-port] [-deployment_type] [-privilege_delegation_setting] [-additional_parameters] [-source_agent] [-master_agent] [-preinstallation_script] [-preinstallation_script_on_oms] [-preinstallation_script_run_as_root] [-postinstallation_script] [-postinstallation_script_on_oms] [-postinstallation_script_run_as_root] [-wait_for_completion]
Note that the parameters mentioned in [ ]
are optional.
For example, /u01/software/em13c/oraclehome/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST' -update_inputs_and_retry -credential_name=oracle2
This example retries the deployment of Management Agents for the ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST
Add Host session, using the oracle2
named credential.
To view more information on the syntax and the usage of the retry_add_host
verb, run the following command:
$<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_Apr_21_2013_8:02:28_AM_PST' -continue_ignoring_failed_hosts.
You can choose to proceed with the deployment of Management Agents on all the hosts, including the ones that have Warning or Failed status.
Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.
To do so using EM CLI, use the continue_add_host
verb, with the -continue_all_hosts
option:
$<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_Apr_21_2013_8:02:28_AM_PST' -continue_all_hosts
To view more information on the syntax and the usage of the continue_add_host
verb, run the following command:
$<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 Oracle Enterprise Manager Command Line Interface.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, Important:
|
-invPtrLoc |
Enter the absolute path to the inventory file that has the location of the Central Inventory (oraInventory). For example, Important:
|
-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 Ensure that you do not pass this parameter if the Central Inventory exists. |
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, 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 |
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. |
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:
If you specify this parameter, ensure that you also specify the OMS HTTP port, using the For example, |
After you install a standalone Management Agent using the Add Host Targets Wizard or EM CLI, follow these steps:
Verify the installation on the Add Host Status page, or using the get_add_host_status
EM CLI verb. Review the progress made on each of the phases of the deployment operation — Initialization, Remote Prerequisite Check, and Agent Deployment.
In the Add Host Targets Wizard, after you click Deploy Agent to install one or more Management Agents, you are automatically taken to the Add Host Status page.
For information on using the get_add_host_status
EM CLI verb, see Section 6.2.2.5.3.
If required, manually verify the installation:
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
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
From the Setup menu, select Manage Cloud Control, then select Agents. Verify that the Management Agent you installed is up and running.
Verify whether all the plug-ins listed in $<AGENT_BASE_DIRECTORY>/plugins.txt
were installed successfully. To do so, run the following command:
$<AGENT_INSTANCE_HOME>/bin/emctl listplugins agent -type all
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.
In Enterprise Manager Cloud Control 12c Release 2 (12.1.0.2), Release 3 (12.1.0.3), Release 4 (12.1.0.4), Release 5 (12.1.0.5), nmosudo
is located in the sbin
directory that is in the agent base directory. For example, <AGENT_BASE_DIRECTORY>/sbin/nmosudo.
In Enterprise Manager Cloud Control 12c Release 1 (12.1.0.1) [with or without Bundle Patch 1], nmosudo
is located in the agent instance directory. For example, <AGENT_INSTANCE_HOME>/bin/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 *
(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
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
By default, the host and the Management Agent get automatically added to the Enterprise Manager Cloud Control console for monitoring. None of the targets running on that host get automatically discovered and monitored.
To monitor the other targets, you need to add them to Enterprise Manager Cloud Control either using the Auto Discovery Results page, the Add Targets Manually page, or the discovery wizards offered for the targets you want to monitor.
For information about discovering targets in Enterprise Manager Cloud Control, refer to Oracle Enterprise Manager Cloud Control Administrator's Guide.
If you installed a Management Agent on a host that has Oracle Fusion Applications deployed on it, the Management Agent must have access to a set of configuration files for the business metrics feature to function properly. If the Management Agent user is in the same group as the Oracle Fusion Applications install user, ensure that the following files have 640
access:
<DOMAIN_HOME>/config/fmwconfig/jps-config-jse.xml <DOMAIN_HOME>/config/fmwconfig/policy-accessor-config.xml <DOMAIN_HOME>/config/fmwconfig/bootstrap/cwallet.sso
Note:
If Oracle Management Agents 13c (13.1.0.x) hang frequently or do not respond on Solaris 9ux and 10ux operating systems, then refer to document ID 1427773.1 on My Oracle Support.
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="agent12c2".
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:\agent13cr1\agent_13.1.0.0.0
denotes the Management Agent Oracle home:
<HOME NAME="agent13c1" LOC="D:\agent13cr1\agent_13.1.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 the Redirecting Oracle Management Agent to Another Oracle Management Service Appendix present in Oracle Enterprise Manager Cloud Control Advanced Installation Guide.
When you repoint your existing Management Agents to a new OMS, you cannot move the targets monitored by the Management Agents, the target history, and the Management Agent history. The monitored targets and the history data is lost.
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:
To create an Agent Gold Image, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click Manage All Images.
Click Create.
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.
Click Submit.
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 Section 6.2.4.2.
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:
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
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Versions and Drafts tab, then from the Actions menu, select Create.
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.1.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.1.0.0.0
is created. The word limit for the image version name is 20 characters.
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, then stage it as described in Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
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.
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
Log 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.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
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 |
---|---|
|
Agent Gold Image name to which the created Agent Gold Image must be added. |
|
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 |
|
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 |
|
Location where the Agent Gold Image is staged for creating the gold agent image version. This location is accessible from all the OMS instances. |
|
Description of the Agent Gold Image. |
|
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. |
|
Management Agent configuration properties separated by \";\" that must be captured while creating the Agent Gold Image. For example, MaxThread;GracefulShutdown. |
|
List of files or directories separated by \";\" that must be excluded from the gold agent image version. For example, |
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
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:
To set a draft version of an Agent Gold Image as the current version, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
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.
To set a particular Agent Gold Image version as the current version using EM CLI, follow these steps:
Log 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.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
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 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
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 Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.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:
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.
On the Add Host Targets: Host and Platform page, do the following:
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.
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.
From the Add menu, select Manually to enter the fully qualified name and select the platform of the host on which you want to install the Management Agent.
The host names that are retrieved from the system for the installation may include IP addresses and short names. However, it is recommended that you provide fully qualified host names, such as foo.mydomain.com,
which persist over the life of the host targets. This is recommended for ease of maintenance and overall security.
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 Section 6.2.2.5.2.
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.
Click Next.
On the Installation Details page, do the following:
In the Deployment Type section, select Fresh Agent Install.
From the table, select the first row that indicates the hosts grouped by their common platform name.
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.
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.
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 Section 6.2.2.2, you can select this credential from the Named Credential list.
For Privileged Delegation Setting, validate the Privilege Delegation setting to be used for running the root scripts. By default, it is set to the Privilege Delegation setting configured in Enterprise Manager Cloud Control.
For example, you can specify one of the following for the Privileged Delegation Setting field:
/usr/bin/sudo -u %RUNAS% %COMMAND% /usr/bin/sudo -u -S %RUNAS% %COMMAND% (if a pseudo terminal is required for remote command execution via SSH) /usr/bin/sesu - %RUNAS% -c "%COMMAND%" /usr/bin/pbrun %PROFILE% -u %RUNAS% %COMMAND% /usr/bin/su - %RUNAS% -c "%COMMAND%"
If you leave the Privileged Delegation Setting field blank, the root scripts will not be run by the wizard; you will have to run them manually after the installation. For information about running them manually, see Section 6.2.2.6.
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.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.
(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.(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.
Repeat Step 3 (b) to Step 3 (i) for every other row you have in the table.
Click Next.
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 Section 6.2.2.2.
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.
If a particular installation phase has failed or has a warning, review the details provided for each phase in the Agent Deployment Details section of the Add Host Status page, and do one of the following:
Note:
To find the cause of a failure, review the log files. One log file is generated per host, so if you installed Management Agents on multiple hosts, then review all the log files. For information on how to access the log files, refer to Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.Fix the problem by reviewing the error description carefully, understanding its cause, and taking action as recommended by Oracle.
You can retry the deployment of Management Agents with the same installation details.
To do so, on the Add Host Status page, click Retry and select Retry Using Same Inputs.
You can retry the deployment of Management Agents with modified installation details.
To do so, on the Add Host Status page, click Retry and select Update Inputs and Retry.
Ignore the warning or failure, and continue with the session if you prefer.
You can choose to proceed with the deployment of Management Agents only on those remote hosts that have successfully cleared the checks, and you can ignore the ones that have Warning or Failed status.
To do so, on the Add Host Status page, click Continue and select Continue, Ignoring Failed Hosts.
You can choose to proceed with the deployment of Management Agents on all the hosts, including the ones that have Warning or Failed status.
Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.
To do so, on the Add Host Status page, click Continue and select Continue, All Hosts.
Important:
Using EM CLI, you can install fresh Management Agents, install Shared Agents, and clone existing Management Agents.
Using EM CLI, you can install fresh Management Agents only on a single platform in a single Add Host session. If you want to use EM CLI to install fresh Management Agents on different platforms, then you must create a separate Add Host session for each platform.
To create an Add Host session and install Management Agents using an Agent Gold Image using EM CLI, follow these steps:
Log 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.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
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
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.
If the Management Agent software for a platform on which you want to install a Management Agent is not available, download and apply it using Self Update. For information on how to download and apply the Management Agent software for a platform, see Section 6.2.2.4.
Note:
If you want to install a Management Agent on a host that is running on the Oracle Enterprise Linux 4.x 64-bit platform, Red Hat Enterprise Linux 4.x 64-bit platform, or the SUSE Linux Enterprise 10 64-bit platform, ensure that the 32-bit version of the Management Agent software for the platform is downloaded and applied using Self Update.To view more information on the syntax and the usage of the list_add_host_platforms
verb, run the following command:
$<ORACLE_HOME>/bin/emcli help list_add_host_platforms
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 Section 6.2.2.2.
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"] [-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"] [-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] [-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 |
---|---|
|
The names of the hosts where the agents need to be installed, separated by a semi colon. |
|
The ARU platform ID of the hosts where the agent need to be installed. |
|
The directory where the Management Agent will be installed. Provide this parameter in double quotes if it is a MS-DOS/Windows style path. |
|
The named credential to be used for installing the Management Agent. |
|
The owner of the named credential. |
|
The instance directory of the Management Agent. Provide this parameter in double quotes if it is a MS-DOS/Windows style path. |
|
The port through which the Management Agent should communicate with the OMS. |
|
The Agent Gold Image name to be used for deployment. Run |
|
The session name which uniquely identifies the Add Host session. |
|
The type of Management Agent deployment. You can install a Shared Agent and clone a Management Agent by specifying the |
|
The privilege delegation setting for installing an Management Agent and running the root script. |
|
Additional parameters for installing a Management Agent. |
|
The source Management Agent for installing a cloned Management Agent. |
|
The master Management Agent for installing a shared Management Agent. |
|
The properties file containing the Management Agent installation inputs. |
|
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. |
|
Indicates that the preinstallation script resides on the OMS host. |
|
Runs the preinstallation script as the root user. |
|
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. |
|
Indicates that the postinstallation script resides on the OMS host. |
|
Runs the postinstallation script as the root user. |
|
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
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_Dec_27_2012_3:02:28_AM_PST
This example displays the status of the ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST
Add Host session.
To view the detailed Management Agent deployment status of a particular host, run the get_add_host_status
verb with the -host_name
parameter. For example:
$<ORACLE_HOME>/bin/emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_27_2012_3:02:28_AM_PST -host_name=example.com
This command also displays the location of the log file for the deployment of a Management Agent on the specified host. If the deployment failed, you can investigate the failure by reviewing the log files. One log file is generated per host.
Figure 6-3 displays a sample output of the command.
Alternatively, to know where the Management Agent log files are located, see Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.
Run the list_add_host_sessions
verb to view the details or track the progress of all the Add Host sessions:
$<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
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_Apr_21_2013_8:02:28_AM_PST' -retry_using_same_inputs
You can retry the deployment of Management Agents with modified installation details.
To do so using EM CLI, use the retry_add_host
verb, with the -update_inputs_and_retry
option:
$<ORACLE_HOME>/bin/emcli retry_add_host -session_name -update_inputs_and_retry [-host_names] [-platform] [-installation_base_directory] [-credential_name] [-credential_owner] [-instance_directory] [-port] [-deployment_type] [-privilege_delegation_setting] [-additional_parameters] [-source_agent] [-master_agent] [-preinstallation_script] [-preinstallation_script_on_oms] [-preinstallation_script_run_as_root] [-postinstallation_script] [-postinstallation_script_on_oms] [-postinstallation_script_run_as_root] [-wait_for_completion]
Note that the parameters mentioned in [ ]
are optional.
For example, $<ORACLE_HOME>/bin/emcli retry_add_host -session_name='ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST' -update_inputs_and_retry -credential_name=oracle2
This example retries the deployment of Management Agents for the ADD_HOST_SYSMAN_Apr_21_2013_8:02:28_AM_PST
Add Host session, using the oracle2
named credential.
To view more information on the syntax and the usage of the retry_add_host
verb, run the following command:
$<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_Apr_21_2013_8:02:28_AM_PST' -continue_ignoring_failed_hosts
You can choose to proceed with the deployment of Management Agents on all the hosts, including the ones that have Warning or Failed status.
Note that choosing this option will ignore the prerequisites in order to allow the Management Agent installation to proceed. If you want to proceed with this option, you must ensure that all the prerequisites are met through manual methods. The practice of ignoring prerequisite checks must be done only with the help of Oracle Support, or with a clear understanding of the impact of bypassing these checks.
To do so using EM CLI, use the continue_add_host
verb, with the -continue_all_hosts
option:
$<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_Apr_21_2013_8:02:28_AM_PST' -continue_all_hosts
To view more information on the syntax and the usage of the continue_add_host
verb, run the following command:
$<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 Oracle Enterprise Manager Command Line Interface.This section provides tips to issues that you may encounter when installing or working with management agents. In particular, this section covers the following:
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:
Stop the agent.
Carry out a backup of the following file:
AGENT_INST_HOME/sysman/config/emd.properties
Open the same file and change agentJavaDefines=-Xmx128M -XX:MaxPermSize=96M
to agentJavaDefines=-Xmx[New Heap Size]M -XX:MaxPermSize=96M
.
Start the agent.