6 Upgrading Oracle Management Agents

This chapter describes how you can upgrade your central agent and one of your standalone Management Agents to 13c using the Agent Upgrade Console or EM CLI, and how you can create an Agent Gold Image and upgrade all your other standalone Management Agents using that gold image. In particular, this chapter covers the following:

WARNING:

You cannot directly subscribe a Shared Agent (NFS Agent) to an Agent Gold Image. To subscribe to an Agent Gold Image, you must first convert the Shared Agent to a standalone Management Agent, and then subscribe to an Agent Gold Image.

Note:

Do not discover any Oracle ZFS Storage Appliance target in 13c environment.

6.1 Overview of Upgrading Management Agents Using Agent Gold Images

Starting with 13c Release 1, Enterprise Manager Cloud Control offers Agent Gold Images, in addition to the Agent Upgrade Console and EM CLI, to upgrade your Management Agents. Oracle recommends that you use Agent Gold Images to upgrade all your Management Agents, although you can use other upgrade approaches.

To understand what an Agent Gold Image is, what it contains, and how you benefit by using it to upgrade your Management Agents, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.

Oracle recommends that you use Agent Gold Images to upgrade all your Management Agents, although you can use other upgrade approaches. However, to update your Management Agents using a gold image, you need a gold image that is based on a 13c standalone Management Agent. You cannot create a gold image using a 13c central agent.

Therefore, if you are upgrading your Enterprise Manager system from 12c, then after upgrading Oracle Management Service (OMS) to 13c, use the Agent Upgrade Console or EM CLI to upgrade your central agent and one of your standalone Management Agents to 13c. Then, create a gold image using the standalone Management Agent that is upgraded to 13c, and finally update all other standalone Management Agents using that gold image. Once you have updated some of your Management Agents to 13c using the gold image, you can use those updated Management Agents to create several other gold images.

The following is the agent base directory structure before and after the update operation:

Before Update

<agent_base_directory>
    |_____agentimage.properties
    |_____agentInstall.rsp
    |_____agent_inst
    |___agent_13.3.0.0.0
    

After Update

<agent_base_directory>
    |_____agentimage.properties
    |_____agentInstall.rsp
    |_____agent_inst
    |_____agent_13.3.0.0.0
    |_____GoldImage_<Image Version Name>
         |_____agent_13.3.0.0.0
         |_____agentimage.properties
         |_____agentInstall.rsp
         |_____plugins.txt
         |_____plugins.txt.status
                                

6.2 Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using the Agent Upgrade Console or EM CLI

This section describes how you can upgrade standalone Management Agents to 13c Release 1 or higher using the Agent Upgrade Console or EM CLI. In particular, this section covers the following:

6.2.1 Overview of Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using the Agent Upgrade Console or EM CLI

The Agent Upgrade Console acts as a single-window solution to mass-upgrade your existing Management Agents to the latest version for which the software is available in Oracle Software Library (Software Library). When you upgrade a Management Agent using the Agent Upgrade Console, the structure of the installation base directory is modified suitably. The following is an example of the installation base directory structure of a 13c Release 2 Management Agent, when it is upgraded to 13c Release 3:

Before Upgrade

<agent_base_directory>
    |agent_13.2.0.0.0
                |sbin
                |_____plugins
    |_____agent_inst
    |_____agentimage.properties
    .
    .
    .

After Upgrade

<agent_base_directory>
                |_____backup_agtup
                |_____agent_13.3.0.0.0
                                |_____sbin
                                |_____plugins
                |_____agent_inst
                |_____agentimage.properties
    .
    .
    .
    

Note:

  • When you upgrade a Management Agent, you cannot change the location of the agent base directory.

  • When you upgrade a Management Agent, the plug-ins installed on the Management Agent host are also upgraded by default, as long as the latest versions of these plug-ins exist in Oracle Software Library (Software Library). If the latest versions of these plug-ins do not exist in the Software Library, their old versions are retained.

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

6.2.2 Before You Begin Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using the Agent Upgrade Console or EM CLI

Before you upgrade your Oracle Management Agents to 13c Release 1 or higher, keep the following points in mind:

  • You must upgrade the central agent installed along with the old Oracle Management Service (OMS).

    Management Agents, including the central agent installed on the OMS host, are not upgraded automatically while you upgrade your OMS to 13c Release 3. Ensure that you upgrade the central agent installed on the OMS host immediately after upgrading the old OMS to 13c Release 3.

    Oracle recommends that you upgrade your central agent immediately after upgrading your OMS instances. However, for some reason if you are unable to upgrade your central agent immediately after upgrading the OMS instances, then ensure that you apply the JDK 1.6u95 patch on your central agent. Otherwise, the targets of the GC WLS domain will not be monitored in the Enterprise Manager Cloud Control Console. This issue will not occur once the central agent is upgraded.

  • You can use the Agent Upgrade Console or EM CLI to upgrade the central agent of only 12c Release 5 (12.1.0.5), 13 c Release 1, or 13 c Release 2.

  • You can upgrade a Management Agent using the Agent Upgrade Console or EM CLI even when you do not have preferred privileged credentials or non-privileged credentials set, or are not aware of the Management Agent credentials. Privileged credentials are only required to run the root.sh script post-upgrade.

    If you upgrade a Management Agent as a user who does not have root privileges, or you upgrade a Management Agent without having preferred privileged credentials, a warning appears. You can ignore this warning during the upgrade. Later, you can log in to the Management Agent host as the root user, and run the $<AGENT_BASE_DIR>/agent_13.3.0.0.0/root.sh script.

  • In some cases, the deployed version of a plug-in may not be supported on the upgraded version of a Management Agent. In these cases, ensure that you either undeploy the plug-ins that are not supported on the upgraded version of the Management Agent, or deploy versions of the plug-ins that are supported on the upgraded Management Agent.

    For more information, seehow to undeploy and deploy a plug-in in the Oracle Enterprise Manager Cloud Control Administrator's Guide..

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

    For information on how to do this, see Applying Patches to Oracle Management Agents While Deploying or Upgrading Them in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

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

    For information on how to do this, see Downloading, Deploying, and Upgrading Plug-Ins in the Oracle Enterprise Manager Cloud Control Administration Guide.

  • Upgrading Management Agents does not require Cygwin, PsExec, or any SSH connectivity tools, as Enterprise Manager uses the existing Management Agent - OMS communication channels to perform the upgrade.

  • You cannot specify a custom inventory location while upgrading Management Agents. The upgraded Management Agent uses the inventory location of the old Management Agent.

  • If you select a Management Agent installed on a cluster, or a shared Management Agent for upgrade, the set of related Management Agents, that is, the other Management Agents of the cluster or the shared Oracle Home are selected for upgrade automatically.

  • You cannot upgrade a Management Agent in the following scenarios:

    • The Management Agent is not up and running

    • The Management Agent is not secure

    • The Management Agent is not reachable

    • The new Management Agent software (of the same version as the OMS version) is not present in Oracle Software Library (Software Library)

    • The Management Agent Oracle home property is missing

    • The Management Agent is already undergoing an upgrade

    • The Management Agent is in blackout state

  • 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 10+. Oracle Management Agent 13c Release 3 was built, tested, and certified on a minimum update version of Solaris 5.10 Update 10+, so Oracle recommends that you install Oracle Management Agent only on Solaris 5.10 Update 10+, and not on any release that was upgraded using patches.

  • You may not be able to upgrade certain Management Agents using the Agent Upgrade Console or EM CLI. Table 6-1 describes the reasons for this.

    Table 6-1 Why Some Management Agents Cannot Be Upgraded

    Reason Description and Recommended Action

    Latest Agent Software Missing

    The latest Management Agent software of the OMS version is not available in Oracle Software Library.

    To upgrade a Management Agent for which the latest Management Agent software is not available, you need to first download and apply the latest software using the Self Update console, then use the Upgrade Agents page.

    To access the Self Update Console, from the Setup menu, select Extensibility, then select Self Update. To download the latest Management Agent software, click Agent Software, select the required software, then click Download. For more information, see Self Update console to download and apply the latest Management Agent software, in the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

    Agent Unsecured

    The Management Agent is not secure.

    To upgrade a Management Agent which is not secure, you need to first secure the Management Agent, then use the Upgrade Agents page.

    To secure the Management Agent, from the Setup menu, select Manage Cloud Control, then select Agents. Click the required Management Agent name. From the Agent menu, click Secure.

    You can also run the following command to secure the Management Agent:

    <EMSTATE>/bin/emctl secure agent

    <EMSTATE> refers to the Management Agent instance directory, that is, <AGENT_BASE_DIRECTORY>/agent_inst

    Oracle Home Property Missing

    The Oracle Home property for the Management Agent is missing.

    This property is required to obtain the platform of the Management Agent that you want to upgrade. For upgrading Shared Agents, this property plays a key role in maintaining the relationship between the Shared Agent and the Master Agent. It is also required for certain essential Management Agent lifecycle operations, such as patching.

    To upgrade a Management Agent for which the Oracle Home property is missing, first run the OMS collections on the Management Agent. To do so, do one of the following:

    • Run the following command from the Management Agent host:

      <EMSTATE>/bin/emctl control agent runCollection <TARGET_NAME>:oracle_home oracle_home_config

      <EMSTATE> refers to the Management Agent instance directory, that is, <AGENT_BASE_DIRECTORY>/agent_inst

      <TARGET_NAME> refers to the Management Agent home listed as oracle_home in the <EMSTATE>/sysman/emd/targets.xml file. You can also verify using the emctl config agent listtargets command.

    • Navigate to the Management Agent Home page in the Enterprise Manager Cloud Control Console. On the Home page of the Management Agent, in the Summary section, in the Configuration subsection, click Oracle Home and Patch Details. On the Oracle Home page, click Refresh Configuration.

    Agent Unreachable

    The Management Agent is not reachable, that is, the Oracle Management Service (OMS) cannot communicate with the Management Agent.

    A Management Agent is generally unreachable when it is down, when it is blocked by the OMS, or when the Management Agent host is down. A Management Agent may also be unreachable due to network problems or certain other issues.

    To upgrade a Management Agent that is unreachable, you need to first restore communication between the OMS and the Management Agent. To restore communication between the OMS and the Management Agent, from the Setup menu, select Manage Cloud Control, then select Agents. Click the required Management Agent name to navigate to the Management Agent home page. Click the displayed error icon, and perform the recommended actions.

    Agent Pending Activation

    The Management Agent version is not 12c Release 2 (12.1.0.2) or later.

    You cannot upgrade 10g, 11g, or 12c Release 1 (12.1.0.1) Management Agents using the Upgrade Agents page. Deinstall these Management Agents and install fresh Management Agents on the hosts.

    For more information, see deinstalling Management Agents, in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide. For more information, see installing fresh Management Agents, in the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

    You can use the Not Upgradable Agents page to search for and view a set of Management Agents that currently cannot be upgraded. To search for and view these Management Agents, follow these steps:

    1. From the Setup menu, select Manage Cloud Control, then select Upgrade Agents.

    2. Click Not Upgradable Agents.

    3. Enter or select values for parameters you want to use to search for Management Agents. You can search for Management Agents using the Management Agent name, version, platform, and the reason why the Management Agent cannot be upgraded.

    4. For Match, select All or Any to search for results that match all the search parameters, or any of the search parameters, respectively.

    5. Click Search.

6.2.3 Prerequisites for Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using the Agent Upgrade Console or EM CLI

Before you upgrade your Management Agents to 13c Release 1 or higher, meet the following prerequisites:

  • If you want to upgrade a Management Agent running on a platform different from the OMS host platform, ensure that the latest Management Agent software for the platform is downloaded and applied in Software Library, using Self Update.

    To access Self Update, from the Setup menu, select Extensibility, then select Self Update. To check whether the latest Management Agent software for a platform is downloaded and applied, click Agent Software, then check the Version and the Status columns for the required platform. The software version for the platform must be the same as the OMS version. The status must read Applied.

    If the latest software is not downloaded and applied, select the software, then click Download to download it. After downloading the software, click Apply to apply the software. If the software has been downloaded, but not applied, click Apply to apply the software.

    For more information, see using Self Update to download and apply the latest Management Agent software for a platform in the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

  • Ensure that the Management Agents you want to upgrade are up and running.

    To verify if a Management Agent is up and running, from the Setup menu, select Manage Cloud Control, then select Agents. Check the Status column of the required Management Agent.

    If the Management Agent is unreachable, click the Management Agent name to navigate to the Management Agent home page. Click the Agent Unreachable icon, and perform the recommended actions.

  • Ensure that the Management Agents you want to upgrade are secure.

    To verify if a Management Agent is secure, from the Setup menu, select Manage Cloud Control, then select Agents. Check the Secure Upload column of the required Management Agent.

    If the Management Agent is not secure, from the Agent menu, select Secure to secure it.

    Also, you can run the following command to verify if a Management Agent is secure:

    <EMSTATE>/bin/emctl status agent

    <EMSTATE> refers to the Management Agent instance directory, that is, <AGENT_BASE_DIRECTORY>/agent_inst

    If the Management Agent is secure, the Management Agent URL displayed is a HTTPS URL. However, if the Management Agent URL displayed is a HTTP URL, secure the Management Agent by running the following command:

    <EMSTATE>/bin/emctl secure agent

  • Ensure that Oracle home collections are run on all the Management Agents that you want to upgrade.

    If Oracle home collections are not run on some Management Agents, they are not upgradable. These Management Agents are displayed on the Not Upgradable Agents page, with the reason displayed as Oracle Home Property Missing. For information on how to access this page, see Table 6-1.

    To run Oracle home collections for all the Management Agent that you want to upgrade, run the following command from the Management Agent host:

    <EMSTATE>/bin/emctl control agent runCollection <TARGET_NAME>:oracle_home oracle_home_config

    <EMSTATE> refers to the Management Agent instance directory, that is, <AGENT_BASE_DIRECTORY>/agent_inst

    <TARGET_NAME> refers to the Management Agent home listed as oracle_home in the <EMSTATE>/sysman/emd/targets.xml file. You can also verify using the emctl config agent listtargets command.

  • Ensure that the old Management Agent does not come up during the Management Agent upgrade process.

    You may have scheduled certain cron jobs, or configured certain notification managers that start up a Management Agent when it is down. The old Management Agent is shut down as part of the upgrade process. Ensure that this Management Agent is not brought up.

  • Ensure that the install user has read permissions on all the files present in Oracle Inventory, and write permissions on the Oracle Inventory directory.

    To grant read permissions on all the files present in Oracle Inventory, run the following command as the install user:

    chmod -R +r $<INVENTORY_LOCATION>

    To grant write permissions on the Oracle Inventory directory, run the following command as the install user:

    chmod +rw $<INVENTORY_LOCATION>

  • Ensure that you meet the hardware requirements described in the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

6.2.4 Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using the Agent Upgrade Console

To upgrade your Management Agents to 13c Release 1 or higher using the Agent Upgrade Console, follow these steps:

  1. From the Setup menu, select Manage Cloud Control, then select Upgrade Agents.
  2. For Job Name, accept the default job name, or enter a unique job name.

    A unique job name enables you to identify the upgrade job, know details of its execution, and track its progress on the Agent Upgrade Status page.

    The job name can have a maximum length of 64 characters. It can consist of alphanumeric and special characters, and can begin with either of these.

  3. Click Add to select the Management Agents you want to upgrade.

    In the Upgradable Agents window, search for the Management Agents you want to upgrade, using the Agent, Installed Version, Platform, and Group fields.

    Select the Management Agents you want to upgrade. Click OK.

    Important:

    • In this release, you can only upgrade your 12c Management Agents , 13 c Release 1, 13c Release 2 Management Agents to 13c Release 3, and not to any other version.

    • If you select a Management Agent that is part of a particular group for upgrade, the other Management Agents of the group are not selected for upgrade by default. If you want to upgrade the other Management Agents of the group, you must select them in the Upgradable Agents window.

  4. (Optional) For Pre-upgrade Script and Post-upgrade Script, enter the absolute path of the script that you want to run before and after the upgrade, respectively.

    For example, /scratch/software/oracle/configure.sh.

    The scripts you want to run must be present at the location you specify, on the Oracle Management Service (OMS) host (on all the OMS hosts in case of a multi-OMS environment), or on all the Management Agent hosts selected for upgrade. They can reside in a shared, NFS-mounted location accessible by the Management Agent hosts selected for upgrade.

    If the script you want to run is present only on the OMS host, and not on the Management Agent hosts selected for upgrade, then select Script on OMS Host.

    Note:

    • You can specify only one pre-upgrade script and one post-upgrade script per session.

    • Only shell scripts (.sh) and batch (.bat) scripts are supported. You should run only shell scripts while upgrading Management Agents installed on Unix platforms, and only batch scripts while upgrading Management Agents installed on Microsoft Windows platforms.

    • If you want to upgrade a Management Agent installed on a Unix platform and a Management Agent installed on a Microsoft Windows platform in the same session, ensure that you do not specify a pre-upgrade or a post-upgrade script. If you want to specify a pre-upgrade or a post-upgrade script for upgrading these Management Agents, upgrade the Management Agents installed on different platforms in different sessions.

  5. (Optional) For Additional Parameters, enter the additional options you want to use for the upgrade.

    For example, specify -ignorePrereqs to skip running the prerequisite checks and directly perform the Management Agent upgrade. If you want to specify multiple additional parameters, separate them using a space.

    Refer to Additional Parameters for 13c Management Agent Upgrade for a list of parameters you can specify.

  6. For Stage Location, accept the default stage location, or enter a custom location. The stage location is used to store temporary Management Agent upgrade files.

    For example, /tmp/software/oracle/EMStage.

    Ensure that the Management Agent install user has write permissions on the custom location you enter. The custom location you enter can be a shared, NFS-mounted location.If the stage location you specify and the agent base directory of the Management Agent you want to upgrade are present on the same disk, then ensure that the disk has at least 3 GB of free space. If they are present on different disks, ensure that the stage directory has at least 2.1 GB of free space, and the agent base directory has at least 750 MB of free space.

    If you want to use a different stage location other than /tmp, you must pass the SCARTCHPATH value in the additional parameter in Agent Upgrade Console.

    For example, SCARTCHPATH=/u01/app/stage.

  7. Click Submit.

    Once you click Submit, a Management Agent upgrade job is created, which is sent to the Enterprise Manager job system. You are automatically taken to the Agent Upgrade Status page for the job, which displays the details of the job steps.

    To view a summary of all the submitted Management Agent upgrade jobs, or search for and view a particular set of Management Agent upgrade jobs, use the Agent Upgrade Results page of the Agent Upgrade Console. To access this page, from the Setup menu, select Manage Cloud Control, then select Upgrade Agents. Click Agent Upgrade Results.

    To revisit the Agent Upgrade Status page for a Management Agent upgrade job, click the name of the job on the Agent Upgrade Results page.

    If you encounter an error during the Management Agent upgrade process, or if the Management Agent upgrade fails, refer to Troubleshooting 13c Management Agent Upgrade.

  8. If the root.sh step was skipped, or if this step failed, log in to the Management Agent host as the root user, navigate to $<AGENT_BASE_DIR>/agent_13.3.0.0.0/ and run the root.sh script on the host manually.

    After root.sh is run, you can clean up your old Management Agents, as described in Performing Postupgrade Cleanup of Old Management Agents.

6.2.4.1 Additional Parameters for 13c Management Agent Upgrade

Table 6-2 describes the additional parameters you can use while upgrading 13c Management Agents using Agent Upgrade Console, or EM CLI. You can enter more than one parameter, using a whitespace as a separator.

Table 6-2 List of Additional Parameters for 13c Management Agent Upgrade

Parameter Description

-ignorePrereqs

Skips running the prerequisite checks.

Specify this parameter when you have already verified the prerequisites, and only want to perform the rest of the upgrade process.

-debug

Logs debug messages useful for debugging and resolving errors.

SCRATCHPATH

Specify this parameter if you do not have enough space on /tmp to use a custom path for the software extraction. You can use SCRATCHPATH to override the /tmp location.

6.2.5 Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using EM CLI

To upgrade your Management Agents to 13c Release 1 or higher using EM CLI, follow these steps:

  1. Log in to EM CLI from the /bin directory present within the Oracle home of the OMS:
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

    For example,

    /u01/software/em13c/oraclehome/hin/emcli login -username=<user_name>

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync
    

    For example,

    /u01/software/em13c/oraclehome/bin/emcli sync

  3. Run the get_upgradable_agents verb to obtain a list of the Management Agents that can be upgraded:
    emcli get_upgradable_agents
                          [-agents="agent_name_search_pattern"]
                          [-platforms="platform_search_pattern"]
                          [-versions="version_search_pattern"]
                          [-groups="group_search_pattern"]
                          [-output_file="output_file_location"]
    

    Note that the parameters mentioned in [ ] are optional.

    For example,

    /u01/software/em13c/oraclehome/bin/emcli get_upgradable_agents -agents="abc%,xyz.domain.com:1243" -platforms="Linux x86,Microsoft Windows x64 (64-bit)" -versions="13.3.0.0.0" -output_file="/scratch/agents_file.txt"

    Use the -output_file option to copy the list of upgradable Management Agents into a file. This file can be used later as an input parameter for the upgrade_agents verb.

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

    $<ORACLE_HOME>/bin/emcli/help get_upgradable_agents
    
  4. Run the upgrade_agents verb to upgrade your Management Agents:
    emcli upgrade_agents
    -agents="names_of_agent_targets" |
    -input_file="agents_file:location_of_input_file"
                          [-allowMd5="true|false"]
                          [-validate_only]
                          [-pre_script_loc="location_of_pre_script"]
                          [-pre_script_on_oms]
                          [-post_script_loc="location_of_post_script"]
                          [-post_script_on_oms]
                          [-job_name="custom_job_name"]
                          [-override_credential="named_credential"]
                          [-additional_parameters]
                          [-stage_location="custom_stage_location"]
    

    Note that the parameters mentioned in [ ] are optional.

    Ensure that you specify all the Management Agents that you want to upgrade by using either -agents, or -input_file="agents_file:<file_name>", or by specifying agents in a response file, and then using -input_file="response_file:<absolute_location>".

    For example,

    /u01/software/em13c/oraclehome/bin/emcli upgrade_agents -agents="abc%,xyz.domain.com:1243" -input_file="agents_file:/scratch/agents_file.txt" -input_file="response_file:/scratch/agent.rsp" -stage_location=/tmp

    The parameters that you specify with the verb override the parameters that you specify in the response file.

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

    $<ORACLE_HOME>/bin/emcli help upgrade_agents
    

    If you encounter an error during the Management Agent upgrade process, or if the Management Agent upgrade fails, refer to Troubleshooting 13c Management Agent Upgrade.

  5. To view the status of the submitted Management Agent upgrade jobs, run the get_agent_upgrade_status verb:
    $<ORACLE_HOME>/bin emcli get_agent_upgrade_status
                          [-agent]
                          [-job_name]
                          [-status]
    

    Note that the parameters mentioned in [ ] are optional.

    For example,

    /u01/software/em13c/oraclehome/bin/emcli get_agent_upgrade_status -status="Running" will display all the Management Agent upgrade jobs that are in progress.

    You can view the detailed job step status of a particular Management Agent that was part of a particular upgrade job by using the get_agent_upgrade_status verb with the -agent and the -job_name options.

    For example,

    /u01/software/em13c/oraclehome/bin/emcli get_agent_upgrade_status -agent=abc.example.com:1243 -job_name=UPGRADE_AGT_13603

    If a particular Management Agent upgrade job failed, check the inputs and run the upgrade_agents verb again. If you want to specify a custom job name (using the -job_name parameter) while retrying the verb, ensure that you provide a unique job name, and not the name of the job that failed. For Management Agent upgrade troubleshooting tips, see Troubleshooting 13c Management Agent Upgrade.

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

    $<ORACLE_HOME>/bin/emcli/help get_agent_upgrade_status
    
  6. If the root.sh step was skipped, or if this step failed, log in to the Management Agent host as the root user, navigate to $<AGENT_BASE_DIR>/agent_13.3.0.0.0/ and run the root.sh script on the host manually.

    After root.sh is run, you can clean up your old Management Agents, as described in Performing Postupgrade Cleanup of Old Management Agents.

Note:

For more information on how to use the EM CLI verbs mentioned in this section, see Using Basic Operational Verbs in the Oracle Enterprise Manager Command Line Interface Guide.

6.2.6 After Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using the Agent Upgrade Console or EM CLI

This section describes the various tasks you can perform after upgrading your Management Agents. It consists of the following:

6.2.6.1 Verifying Your 13c Management Agent Upgrade

This section describes how to verify the 13c Management Agent upgrade. It consists of the following sections:

6.2.6.1.1 Verifying 13c Management Agent Upgrade Using the Enterprise Manager Console

After you upgrade your Management Agents, follow these methods to verify the upgrade using the Enterprise Manager console:

  • From the Setup menu, select Manage Cloud Control, then select Upgrade Agents. Click Agent Upgrade Results. Verify that the job you created to upgrade the Management Agents succeeded.

  • From the Setup menu, select Manage Cloud Control, then select Agents. Click the name of a Management Agent that you want to verify the upgrade for, and verify the Management Agent version. The Management Agent version after the upgrade must be the same as the OMS version.

    Also, on the Agents page, verify that the Management Agent is up and running, is not blocked, and is not under blackout.

  • From the Setup menu, select Manage Cloud Control, then select Agents. Click the name of the Management Agent that you want to verify the upgrade for. From the Agent menu, select Configuration, then select Latest. In the Configuration Properties tab, ensure that none of the configuration properties mention the old Management Agent home.

6.2.6.1.2 Verifying 13c Management Agent Upgrade Using EM CLI

After you upgrade your Management Agents, follow these methods to verify the upgrade using EM CLI:

  • Run the get_agent_upgrade_status verb to verify that the job you created to upgrade the Management Agents succeeded. This is described in detail in Step 5 of Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using EM CLI.

  • Run the get_agent_properties verb to verify the version of the Management Agent and its configuration properties after the upgrade:

    $<ORACLE_HOME>/bin/emcli get_agent_properties -format=csv -agent_name=<agent_host_name>:<agent_port>
    

    For example,

    /u01/software/em13c/oraclehome/bin/emcli get_agent_properties -format=csv -agent_name=abc.example.com:1872

  • Run the get_targets verb to verify the status of the Management Agent (it should be up and running, and not be blocked, under blackout, etc.):

    $<ORACLE_HOME>/bin/emcli get_targets -format="name:csv" -targets=<agent_host_name>:<agent_port>:oracle_emd -alerts
    

    For example,

    /u01/software/em13c/oraclehome/bin/emcli get_targets -format="name:csv" -targets=abc.example.com:3872:oracle_emd -alerts

6.2.6.2 Performing Postupgrade Cleanup of Old Management Agents

After you upgrade your Management Agents to 13c Release 1 or higher, the old agent homes, old Oracle Home targets, and backup directories of the old Management Agents remain, and are not deleted automatically. To delete these post upgrade and free up disk space, you can clean up the old Management Agents using Agent Upgrade Console or EM CLI.

Important:

Ensure that you perform clean up only on those Management Agents that were upgraded successfully. For information on verifying whether a Management Agent was upgraded successfully, see Verifying Your 13c Management Agent Upgrade.

This section describes the methods you can use to clean up 13.3.0.x Management Agents after upgrading them. It consists of the following:

6.2.6.2.1 Performing Postupgrade Cleanup of Old Management Agents Using the Agent Upgrade Console

To clean up the old directories of your old Management Agents using the Clean Up Agents page of the Agent Upgrade Console, follow these steps:

  1. From the Setup menu, select Manage Cloud Control, then select Upgrade Agents.
  2. Click Post Agent Upgrade Tasks.
  3. To change the default clean up job name, enter a unique value for Job Name.

    A unique job name enables you to identify the clean up job, know details of its execution, and track its progress.

    The job name can have a maximum length of 64 characters. It can consist of alphanumeric and special characters, and can begin with either of these.

  4. Click Add to add Management Agents for clean up.
  5. In the Agents for Clean Up window, search for the Management Agents you want to clean up, using the Agent, Platform, Installed Version, and Group fields.
  6. Select the Management Agents you want to clean up. Click OK.
  7. Click Submit.
6.2.6.2.2 Performing Postupgrade Cleanup of Old Management Agents Using EM CLI

To clean up the old directories of your old Management Agents using EM CLI, follow these steps:

  1. Log in to EM CLI from the /bin directory present within the Oracle home of the OMS.
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

    For example,

    /u01/software/em13c/oraclehome/bin/emcli login -username=sysman

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync 
    

    Foe example,

    /u01/software/em13c/oraclehome/bin/emcli sync

  3. Run the get_signoff_agents verb to obtain a list of the Management Agents for which clean up can be performed:
    $<ORACLE_HOME>/bin/emcli get_signoff_agents 
                          [-agents]
                          [-platforms]
                          [-versions]
                          [-groups]
                          [-output_file]
    

    Note that the parameters mentioned in [ ] are optional.

    For example,

    /u01/software/em13c/oraclehome/bin/emcli get_signoff_agents -output_file="/scratch/signoff_agents_file.txt"

    Use the -output_file option to copy the output of the get_signoff_agents verb into a file, which you can later use as an input parameter for the signoff_agents verb.

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

    $<ORACLE_HOME>/bin/emcli help get_signoff_agents
    
  4. Run the signoff_agents verb to clean up your Management Agents:
    $<ORACLE_HOME>/bin/emcli/signoff_agents 
                          -agents | -input_file="agents_file:<absolute_location>" | -input_file="response_file:<absolute_location>"
                          [-job_name]
    

    Note that the parameters mentioned in [ ] are optional.

    Ensure that you specify all the Management Agents that you want to clean up by using either -agents, or -input_file="agents_file:<file_name>", or by specifying agents in a response file, and then using -input_file="response_file:<absolute_location>".

    For example,

    /u01/software/em13c/oraclehome/bin/emcli signoff_agents -agents="abc%,xyz.domain.com:1243" -input_file="agents_file:/scratch/signoff_agents_file.txt" -input_file="response_file:/scratch/agent.rsp" -job_name=CLEAN_UP_12103

    Use the -input_file="agents_file:<absolute_location>" option to specify a file containing the list of Management Agents that you want to clean up. Use the -input_file="response_file:<absolute_location>" option to specify a response file containing all the parameters that you want to use. A response file contains parameters in name value pairs, as shown:

    agents=abc%,xyz%
    job_name=CLEAN_UP_AGT_121030
    

    The parameters that you specify with the verb override the parameters that you specify in the response file.

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

    $<ORACLE_HOME>/bin/emcli help signoff_agents
    

Note:

For more information on how to use the EM CLI verbs mentioned in this section, see Using Basic Operational Verbs in the Oracle Enterprise Manager Command Line Interface Guide.

6.2.6.3 Moving Central Agent Base Directory Outside Oracle Middleware Home (After Upgrading 13c Central Agent)

After upgrading the central agent, if the agent base directory of the upgraded central agent resides within the Oracle Middleware home, and you want to move it outside the Oracle Middleware home, then see Moving the Central Agent Base Directory Outside Oracle Middleware Home.

Important:

Moving the agent base directory is recommended only for central agents (on all platforms, including Microsoft Windows), and not recommended for standalone Management Agents.

6.2.6.4 Viewing 13c Management Agent Upgrade Cleanup Jobs

You can use the Clean Up Agents page or EM CLI to delete the old agent homes, old Oracle Home targets, and backup directories of your old Management Agents, after upgrading them. Once you select the Management Agents you want to clean up and click Submit on the Clean Up Agents page, or run the signoff_agents EM CLI verb, a Management Agent clean up job is created, which is sent to the Enterprise Manager job system. You can use the Clean Up Agent Results page, or the get_signoff_status EM CLI verb to search for and view a particular set of Management Agent clean up jobs.

This section describes the methods you can use to view a particular set of Management Agent clean up jobs. It consists of the following:

6.2.6.4.1 Viewing 13c Management Agent Upgrade Cleanup Jobs Using the Agent Upgrade Console

To view a particular set of Management Agent clean up jobs using the Clean Up Agent Results page of the Agent Upgrade Console, follow these steps:

  1. From the Setup menu, select Manage Cloud Control, then select Upgrade Agents.
  2. Click Post Agent Upgrade Tasks.
  3. Click Clean Up Agent Results.
  4. Enter or select values for parameters that you want to use to search for Management Agent clean up jobs. You can search for these jobs using the job name, the Management Agents that were part of the clean up, and the status of the job.
  5. For Match, select All or Any to search for results that match all the search parameters, or any of the search parameters, respectively.
  6. Click Search.
6.2.6.4.2 Viewing 13c Management Agent Upgrade Cleanup Jobs Using EM CLI

To view a particular set of Management Agent clean up jobs using EM CLI, follow these steps:

  1. Log in to EM CLI from the /bin directory present within the Oracle home of the OMS:
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

    For example,

    /u01/software/em13c/oraclehome/bin/emcli login -username=sysman

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync
    

    For example,

    /u01/software/em13c/oraclehome/bin/emcli sync

  3. Run the get_signoff_status verb to view a particular set of Management Agent clean up jobs:
    $<ORACLE_HOME>/bin/emcli get_signoff_status 
                          [-agent]
                          [-job_name]
                          [-status]
    

    Note that the parameters mentioned in [ ] are optional.

    For example,

    /u01/software/em13c/oraclehome/bin/emcli get_signoff_status -status="Success" displays the Management Agent clean up jobs that succeeded.

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

    $<ORACLE_HOME>/bin/emcli help get_signoff_status
    

Note:

For more information on how to use the EM CLI verbs mentioned in this section, see Using Basic Operational Verbs in the Oracle Enterprise Manager Command Line Interface Guide.

6.2.7 Troubleshooting 13c Management Agent Upgrade

Table 6-3 describes how to troubleshoot certain errors you may encounter while upgrading your Management Agents.

Table 6-3 Troubleshooting Oracle Management Agent Upgrade

Problem Troubleshooting Tip

When you click Submit on the Upgrade Agents page, you encounter an error mentioning that root.sh could not be run for a Management Agent as the preferred privileged credentials for the Oracle Home of the Management Agent are not set.

Do one of the following:

  • Click OK to continue the upgrade. After the upgrade, log in to the Management Agent host as the root user, and run the $<AGENT_BASE_DIR>/agent_13.3.0.0.0/root.sh script on the host.

  • Click Cancel to cancel the upgrade, then do the following:

    1. Set the preferred privileged credentials for the Oracle Home target of the Management Agent.

      For information on how to do this, see Setting My Oracle Support Preferred Credentials in the Oracle Enterprise Manager Cloud Control Administrator's Guide.

    2. Upgrade the Management Agent.

    If you do not want to set the preferred privileged credentials for the Oracle Home target of the Management Agent, when the error message is displayed, click Cancel, then do the following:

    1. Select Override Privileged Credentials, then create a new credential by clicking the displayed icon. If the credential you create is not a root credential, select Sudo or PowerBroker for Run Privilege, and enter root for Run as.

    2. Configure privilege delegation settings on the Management Agent host.

    3. Upgrade the Management Agent.

    If the root.sh job step fails after the upgrade, log in to the Management Agent host as the root user, and run the $<AGENT_BASE_DIR>/agent_13.3.0.0.0/root.sh script manually.

When you click Submit on the Upgrade Agents page, you encounter an error mentioning that root.sh could not be run for a Management Agent as the privilege delegation settings for the Management Agent host are not set.

Do one of the following:

  • When the error message is displayed, click OK to continue the upgrade. After the upgrade, log in to the Management Agent host as the root user, and run the $<AGENT_BASE_DIR>/agent_13.3.0.0.0/root.sh script on the host.

  • When the error message is displayed, click Cancel to cancel the upgrade, then do the following:

    1. Configure privilege delegation settings on the Management Agent host.

      For information on how to do this, see Setting Up Credentials in the Oracle Enterprise Manager Lifecycle Management Administrator's Guide.

    2. Upgrade the Management Agent.

    If the root.sh job step fails after the upgrade, log in to the Management Agent host as the root user, and run the $<AGENT_BASE_DIR>/agent_13.3.0.0.0/root.sh script manually.

When you click Submit on the Upgrade Agents page, you encounter an error mentioning that root.sh could not be run for a Management Agent as Run as root is not set for the Management Agent Oracle Home preferred privileged credential.

Do one of the following:

  • Click OK to continue the upgrade. After the upgrade, log in to the Management Agent host as the root user, and run the $<AGENT_BASE_DIR>/agent_13.3.0.0.0/root.sh script on the host.

  • Click Cancel to cancel the upgrade, then do the following:

    1. Edit the preferred privileged credentials for the Oracle Home target of the Management Agent to ensure that the credential has root privileges. For information on how to do this, see Setting Up Credentials in the Oracle Enterprise Manager Lifecycle Management Administrator's Guide.

    2. Upgrade the Management Agent.

    If the root.sh job step fails after the upgrade, log in to the Management Agent host as the root user, and run the $<AGENT_BASE_DIR>/agent_13.3.0.0.0/root.sh script manually.

When you click Submit on the Upgrade Agents page, the Upgrade Agents step fails.

Diagnose the problem by following these steps:

  1. View the output logs of the failed Management Agent upgrade job steps.

    To view the output log of a Management Agent upgrade job step, on the Upgrade Agents page, click Agent Upgrade Results. Click the name of the Management Agent upgrade job, and select the required Management Agent. Click the name of the failed job step.

  2. View the Management Agent deployment log available at the following location:

    $<AGENT_BASE_DIRECTORY>/agent_13.3.0.0.0/cfgtoollogs/agentDeploy/agentDeploy_<TIMESTAMP>.log
    
  3. View the plug-in upgrade configuration log available at the following location:

    $<AGENT_BASE_DIRECTORY>/backup_agtup/backup_<TIMESTAMP>/agtNew/install/logs/agentplugindeploy_<TIMESTAMP>.log
    

The Management Agent cannot be upgraded as the 32-bit Management Agent software for the host platform is not present in Software Library.

You may encounter this error while upgrading Management Agents that run on the Oracle Enterprise Linux 4.x, Red Hat Enterprise Linux 4.x, and SUSE Linux Enterprise 10 64-bit platforms. If you encounter this error, click OK. Download and apply the latest 32-bit Management Agent software for these platforms, using the Self Update console, then upgrade the Management Agent.

For more information see, using the Self Update console to download and apply the latest Management Agent software in the Oracle Enterprise Manager Cloud Control Basic Installation Guide .

The links on the Agent Upgrade Status page or the Agent Upgrade Results page are not working.

Diagnose the problem by viewing the following logs:

  • $<OMS_INSTANCE_HOME>/user_projects/domains/EMGC_DOMAIN/servers/EMGC_OMS1/logs/*.out

  • $<OMS_INSTANCE_HOME>/user_projects/domains/EMGC_DOMAIN/servers/EMGC_OMS1/logs/*.log

A job step in the Management Agent upgrade process hangs or is executed multiple times.

Diagnose the problem by viewing the following log:

$<OMS_INSTANCE_HOME>/em/EMGC_OMS1/sysman/log/*.trc

EM CLI log in or synchronization fails.

Diagnose the problem by viewing the following log:

$<OMS_INSTANCE_HOME>/em/<oms_name>/sysman/emcli

The upgraded Management Agent is blocked.

Raise an Oracle Support service request. Do not resynchronize the Management Agent.

6.3 Creating an Agent Gold Image

To create an Agent Gold Image, use either of the following methods:

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

To create an Agent Gold Image, follow these steps:

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

6.3.2 Creating an Agent Gold Image Using EM CLI

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

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

6.4 Creating an Agent Gold Image Version

To create an Agent Gold Image version, use either of the following methods:

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

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

Note:

You cannot use unsecure Management Agents to create an Agent Gold Image version. Therefore, always use only secure Management Agents. Before creating an Agent Gold Image version, meet the hardware requirements as described in the hardware requirements chapter of the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

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

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

    The word limit for the image version name is 20 characters.

  6. If you want to create the gold image version using a source Management Agent, for Create image by, select Selecting a source agent, then specify the source Management Agent that you want to use. In this case, you can also specify the following:
    • Work Directory: The working directory that must be used to create the Agent Gold Image. The default working directory is $AGENT_INSTANCE_HOME/install. Ensure that you have minimum 750MB space in this location.

    • Configuration Properties: The Management Agent configuration properties separated by a semicolon (;) 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 separated by ';' that must be excluded from the gold agent image version. For example, agent_13.3.0.0.0/cfgtoollogs/agentDeploy/*;agent_13.3.0.0.0/oui/*. Ensure that you provide only the relative path to the files and directories and not the absolute path.

    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 the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide.

    Note:

    The image can be created from a test system and staged. Also, the stage location should be accessible from the OMS.

  7. Click OK.

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

6.4.2 Creating an Agent Gold Image Version Using EM CLI

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

Note:

You cannot use unsecure Management Agents to create an Agent Gold Image version. Therefore, always use only secure Management Agents. Before creating an Agent Gold Image version, meet the hardware requirements as described in the hardware requirements chapter of the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

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

emctl reload agent

  1. Log in to EM CLI from the /bin directory present within the Oracle home of the OMS:
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync
    
  3. Run the create_gold_agent_image verb to create an Agent Gold Image using the specified source Management Agent or by importing an already created image from another Enterprise Management System:
    $<ORACLE_HOME>/bin/emcli create_gold_agent_image
            -image_name="gold_image_name"
            -version_name="gold_image_version_name"
            -source_agent|-import_location="source_agent|import_location"
            [-gold_image_description="gold_image_description"]
            [-working_directory="working_directory_location"]
            [-config_properties= " agent_configuration_properties"]
            [-exclude_files= "list_of_files_directories_to_exclude"]
    

    Note that the parameters mentioned in [ ] are optional.

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

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

    Parameter Description

    -image_name

    Agent Gold Image name to which the created Agent Gold Image must be added.

    -version_name

    Version name of the Agent Gold Image.

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

    For example, if the agent base directory of the Management Agent being updated is /u01/software/em13c/agentbasedir, and the agent home is /u01/software/em13c/agentbasedir/agent_13.3.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.3.0.0.0 is created. The word limit for the image version name is 20 characters.

    -source_agent

    Management Agent to be used as the source to create the Agent Gold Image.

    To view a list of the Management Agents that can be used as a source to create a gold image, run emcli get_targets -target="oracle_emd".

    -import_location

    Location where the Agent Gold Image is staged for creating the gold agent image version. This location is accessible from all the OMS instances.

    -gold_image_description

    Description of the Agent Gold Image.

    -working_directory

    Working directory to be used to create the Agent Gold Image. The default working directory is $AGENT_INSTANCE_HOME/install. Minimum free space required is 1 GB.

    -config_properties

    Management Agent configuration properties separated by \";\" that must be captured while creating the Agent Gold Image. For example, MaxThread;GracefulShutdown.

    -exclude_files

    List of files or directories separated by \";\" that must be excluded from the gold agent image version. For example, agent_13.3.0.0.0/cfgtoollogs/agentDeploy;agent_13.3.0.0.0/oui. Ensure that you provide only the relative path to the files and directories and not the absolute path.

    Examples:

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

      $<ORACLE_HOME>/bin/emcli create_gold_agent_image -source_agent=example.com:3872 -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING 
      
    • The following example creates an Agent Gold Image OPC_AGI_DB_JUL_13, using example.com:3872 as the source Management Agent, /tmp as the working directory, and adds the gold image version to the gold image OPC_DB_MONITORING:

      $<ORACLE_HOME>/bin/emcli create_gold_agent_image -source_agent=example.com:3872 -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING -working_directory=/tmp
      
    • The following example creates an Agent Gold Image OPC_AGI_DB_JUL_13 using gold image software staged at import location /abc/stage:

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

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

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

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

To set a draft version of an Agent Gold Image as the current version, use either of the following methods:

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

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

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

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

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

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

  1. Log in to EM CLI from the /bin directory present within the Oracle home of the OMS:
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync
    
  3. Run the promote_gold_agent_image verb to promote the Agent Gold Image version to the Current maturity level:
    $<ORACLE_HOME>/bin/emcli promote_gold_agent_image         
    -version_name="gold_image_version_name"       
     -maturity="Current/Restricted/Draft"
     
    

    The -version_name parameter defines the Agent Gold Image 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
    

6.6 Setting a Particular Agent Gold Image Version as the Restricted Version using Gold Agent Images Home Page

To set a draft or active version of a Agent Gold Image as the restricted version, use either of the following methods:

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

To set a draft or active version of a Agent Gold Image as the restricted version, follow these steps:

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

  2. Click the name of the required Agent Gold Image.

  3. Click Manage Image Versions and Subscriptions.

  4. Select the Versions and Drafts tab. Select the gold image version that you want to set as the restricted version, then click Set Restricted Version.

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

To set a draft or active version of a Agent Gold Image version as the restricted version using EM CLI, follow these steps:

  1. Log in to EM CLI from the /bin directory present within the OMS home:
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync
    
  3. Run the promote_gold_agent_image verb to promote the Agent Gold Image version to the Restricted maturity level:
    $<ORACLE_HOME>/bin/emcli promote_gold_agent_image         -version_name="gold_image_version_name"        -maturity="Current/Restricted/Draft"
     
    

    The -version_name parameter defines the Agent Gold Image version 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 Restricted maturity level, run the following:

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

6.7 Subscribing Management Agents to an Agent Gold Image

To subscribe a set of Management Agents to an Agent Gold Image, use either of the following methods:

  • Subscribing Management Agents to an Agent Gold Image Using Gold Agent Images Home Page

  • Subscribing Management Agents to an Agent Gold Image Using EM CLI

    WARNING:

    You cannot directly subscribe a Shared Agent (NFS Agent) to an Agent Gold Image. To subscribe to an Agent Gold Image, you must first convert the Shared Agent to a standalone Management Agent, and then subscribe to an Agent Gold Image.

    Note:

    When you have to subscribe a set of related Management Agents to an Agent Gold Image, it is mandatory to subscribe all the related Agents. However, there is an option to override this in case if you want to subscribe only a selected few Agents to the Agent Gold Image. To achieve this, you have to set the parameter ignoreRelatedCheck to true in the EM_GI_MASTER_INFO table.

6.7.1 Subscribing Management Agents to an Agent Gold Image Using Gold Agent Images Home Page

Note:

You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image.

You cannot subscribe the following Management Agents to an Agent Gold Image:

  • Central Agent.

  • Already subscribed Management Agents.

  • Shared Agents (NFS Agents).

  • Unsecure Management Agents.

  • Management Agents on platforms that are different from the platforms on which the Agent Gold Image is available.

    The platform is identified by the Oracle home collection, so make sure the Oracle home target is discovered and collected. To do so, On the Home page of the Management Agent, in the Summary section, click Oracle Home and Patch Details, and on the following page, click Refresh Configuration.

To subscribe a set of Management Agents to an Agent Gold Image, follow these steps:

  1. From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
  2. Click the name of the required Agent Gold Image.
  3. Click Manage Image Versions and Subscriptions.
  4. Select the Subscriptions tab. Click Subscribe.
  5. Search for and select the required Management Agents, then click Select.

6.7.2 Subscribing Management Agents to an Agent Gold Image Using EM CLI

To subscribe a Management Agent to an Agent Gold Image using EM CLI, follow these steps:

Note:

You cannot subscribe the following Management Agents to an Agent Gold Image:

  • Central Agent.

  • Already subscribed Management Agents.

  • Shared Agents (NFS Agents).

  • Unsecure Management Agents.

  • Management Agents on platforms that are different from the platforms on which the Agent Gold Image is available.

    The platform is identified by the Oracle home collection, so make sure the Oracle home target is discovered and collected. To do so, On the Home page of the Management Agent, in the Summary section, click Oracle Home and Patch Details, and on the following page, click Refresh Configuration.

  1. Log in to EM CLI from the /bin directory present within the Oracle home of the OMS:
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync
    
  3. Run the subscribe_agents verb to subscribe the specified Management Agent to a specific Agent Gold Image:
    $<ORACLE_HOME>/bin/emcli subscribe_agents 
             -image_name="Image Name" 
             [-agents="agent_name_pattern"] 
             [-groups="group_name"]
    

    Note that the parameters mentioned in [ ] are optional.

    The -image_name parameter subscribes the Management Agents to the specified Agent Gold Image.

    The -agents parameter subscribes only the Management Agents that match the specified name pattern.

    The -groups parameter subscribes only the Management Agents that belong to the specified groups.

    Examples:

    • The following example subscribes the Management Agents that match the name pattern abc% or xyz.domain.com:1243 to the Agent Gold Image OPC_AGT_ADC_POD:

      $<ORACLE_HOME>/bin/emcli subscribe_agents -image_name="OPC_AGT_ADC_POD" -agents="abc%,xyz.domain.com:1243"
      
    • The following example subscribes all the Management Agents to the Agent Gold Image OPC_AGT_ADC_POD:

      $<ORACLE_HOME>/bin/emcli subscribe_agents -image_name="OPC_AGT_ADC_POD"
      
    • The following example subscribes all the Management Agents that belong to the group GROUP1 or GRP2 to the Agent Gold Image OPC_AGT_ADC_POD:

      $<ORACLE_HOME>/bin/emcli subscribe_agents -image_name="OPC_AGT_ADC_POD" -groups="GROUP1,GRP2"
      

6.8 Updating Standalone Management Agents Using an Agent Gold Image Version

Important:

Before updating standalone Management Agents using an Agent Gold Image, ensure that the standalone Management Agents subscribe to the gold image. For information on how to subscribe standalone Management Agents to an Agent Gold Image, see Subscribing Management Agents to an Agent Gold Image.

You cannot update a central agent with an Agent Gold Image. A central agent is a Management Agent that is installed by default with every OMS installation.

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 you update 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:12796,1

To update your standalone Management Agents using an Agent Gold Image version, use either of the following methods:

6.8.1 Updating Standalone Management Agents Using Agent Gold Image Version Using Gold Agent Images Home Page

To update your Management Agents using an Agent Gold Image version, follow these steps:

Note:

Before updating a standalone Management Agent using an Agent Gold Image version, meet the hardware requirements as described in the hardware requirements chapter of the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

Note:

When you have to update a set of related Management Agents to an Agent Gold Image, it is mandatory to update all the related agents. However, there is an option to override this in case if you want to update only a selected few Agents to the Agent Gold Image. To achieve this, you have to set the parameter closureRelated to false in the EM_GI_MASTER_INFO table.

  1. From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
  2. Click the name of the required Agent Gold Image.
  3. Click Manage Image Versions and Subscriptions.
  4. Select the Subscriptions tab. Select the Management Agents that you want to update, select Update, then select To Current Version, or To Restricted Version.
  5. Accept the default job name for the Management Agent update job. You can change this, if required.

    If you have not included certain Management Agents in the previous step and want to include them in the update operation now, select Add, then specify the additional Management Agents.

    If there is any change to the sbin directory, particularly for a complete agent upgrade or when there is an sbin-specific patch, after updating the Management Agent, the preferred privileged credentials of the Management Agent host are used for running the root.sh script on the Management Agent.

    If these credentials are not already set, then click Override Preferred Credentials and enter the credentials you want to use instead.

    Click Next.

  6. By default, Image Version Pre Staged is not selected, in this case provide a stage location that is local to the destination host. However, if you select the Image version Pre Staged, provide a shared, NFS-mounted stage location that is accessible by all the Management Agents.

    Also, specify a method for Management Agent deployment. If you select the default option Push, the OMS transfers the Management Agent software to all the hosts that are selected for the update operation. However, if you want the Management Agent present on each destination host to retrieve the Management Agent software from the OMS instead, select Pull.

  7. In the Additional Inputs section, specify any scripts that you want to run before the update operation and after the update operation. Ensure that you select Script on OMS Host if the script exists on the OMS host. Also, specify any additional parameters that you want to use for the update operation. Table 6-2 gives a list of additional parameters used for upgrade.
  8. In the Schedule section, specify values for the following:
    • Batch Size: A Management Agent update activity runs in a way that the Management Agents are updated in batches. The batch size represents the number of Management Agents present in a batch.

    • Job Frequency: The time (in minutes) after which the application checks whether the current batch is complete or not.

    • Success Rate: The percentage of the total number of Management Agents (that is, the Management Agents that are a part of the current update batch and the Management Agents that were a part of the previous update batches) that must have been updated once a batch is complete, before the next batch is allowed to begin.

      For example, if there are 1000 Agents deployed in your enterprise and the batch size is set to 100, the batch success rate is set to 90, and the Agents are updated in batches of 100. In this case, once a batch is complete, the application moves to the next batch only if 90 per cent of the total number of Management Agents are updated successfully.

    • Start: The time when you want to start the update operation, and the time when you want the update operation to end. By default, the time set is Immediately. In this context, it is the OMS time that is considered.

    • Duration: The duration until which you want the update operation to run.

  9. In the Notify section, specify the email addresses to which you want the notifications about the update job progress to be sent.
  10. In the Shell Profile section, select Update Shell Profile, and specify the location of your shell profile, if you want your shell profile to be updated with the new Management Agent Oracle home location.

    By default, this is not selected, and is optional.

  11. In the Cleanup options section, select:
    • Pre-Cleanup to clean up the old or inactive agent homes prior to updating the Management Agents.

    • Post-Cleanup to clean up the old or inactive agent homes after updating the Management Agents.

      Note:

      If the cleanup operation is not performed at this point, it can be done at a later time using the Agent Upgrade Console. For more information, see Performing Postupgrade Cleanup of Old Management Agents.

    A job that updates the Management Agents 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 Update Activities tab.

  12. Click Update.

    A job that updates the Management Agents 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 Update Activities tab.

    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.3.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.3.0.0.0 is created.

6.8.2 Updating Management Agents Using Agent Gold Image Version Using EM CLI

To update Management Agents using an Agent Gold Image version, using EM CLI, follow these steps:

Note:

Before updating a standalone Management Agent using an Agent Gold Image version, meet the hardware requirements as described in the hardware requirements chapter of the Oracle Enterprise Manager Cloud Control Basic Installation Guide.

  1. Log in to EM CLI from the /bin directory present within the Oracle home of the OMS:
    $<ORACLE_HOME>/bin/emcli login -username=<user_name>
    

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

  2. Synchronize EM CLI:
    $<ORACLE_HOME>/bin/emcli sync
    
  3. Run the get_updatable_agents verb to display the Management Agents that can be updated using a particular Agent Gold Image version or Agent Gold Image:
    $<ORACLE_HOME>/bin/emcli get_updatable_agents
    -version_name  | -image_name
    [-agents="Full Agent Name"]
    [-versions="List of Versions"]
    [-groups="List of group names"]
    [-output_file="Location of the output file"]
     
    

    Note that the parameters mentioned in [ ] are optional.

    Note:

    It is mandatory to specify the -version_name parameter or the -image_name parameter. If you specify both, a union of the outputs (when each of these parameters is specified individually) is displayed.

    Note:

    To view a list of Management Agents that cannot be updated, run the get_not_updatable_agents verb:

    emcli get_not_updatable_agents 
            [-version_name  | -image_name] 
     
    

    The parameters mentioned in [ ] are optional.

    Table 6-5 lists and describes the supporting parameters for displaying the Management Agents that can be updated using a particular Management Agent image version.

    Table 6-5 Supported Parameters for Displaying Management Agents That Can Be Updated

    Parameter Description

    -version_name

    Specify this option to display the Management Agents that can be updated using the specified Agent Gold Image version.

    -image_name

    Specify this option to display the Management Agents that can be updated using the specified Agent Gold Image.

    -versions

    Specify this option to display the Management Agents that can be updated, and are of the specified versions.

    -agents

    Specify this option to display the Management Agents that can be updated, and whose name matches the specified name pattern.

    -groups

    Specify this option to display the Management Agents that can be updated, and are a part of those groups whose name matches the specified name pattern.

    -output_file

    Specify this option to add the displayed list of Management Agents that can be updated to an output file.

    Examples:

    • The following example lists the Management Agents that can be updated using the latest Agent Gold Image OPC_AGT_ADC_POD:

      <ORACLE_HOME>/bin/emcli get_updatable_agents -image_name="OPC_AGT_ADC_POD"
      
    • The following example lists the Management Agents that can be updated using the Agent Gold Image version OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli get_updatable_agents -version_name="OPC_AGT_ADC_POD_JUNE"
      
    • The following example lists the Management Agents that are of version  12.1.0.5.0, 13.1.0.0.0, 13.2.0.0.0, or 13.3.0.0.0 and can be updated using the Agent Gold Image version OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli get_updatable_agents -version_name="OPC_AGT_ADC_POD_JUNE" -versions=" 12.1.0.5.0,13.1.0.0.0, 13.2.0.0.0, 13.3.0.0.0"
      
    • The following example lists the Management Agents that belong to GROUP1 or GRP2, and can be updated using the Agent Gold Image version OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli get_updatable_agents -version_name="OPC_AGT_ADC_POD_JUNE" -groups="GROUP1,GRP2"
      
    • The following example lists the Management Agents that can updated using the Agent Gold Image OPC_AGT_ADC_POD_JUNE, and adds the list to the output file /scratch/agents_file.txt:

      <ORACLE_HOME>/bin/emcli get_updatable_agents -image_name="OPC_AGT_ADC_POD_JUNE" -output_file="/scratch/agents_file.txt"
      
  4. Run the update_agents verbs to prepare the environment for updating your Management Agents and to submit the Management Agent update job:
    <ORACLE_HOME>/bin/emcli update_agents 
            -version_name | -image_name  
            -agents="agent_names" | -input_file="agents_file:input_file_location" 
            [-pre_script_loc="location_of_pre_script"]
            [-pre_script_on_oms]
            [-post_script_loc="location_of_post_script"]
            [-post_script_on_oms]
            [-op_name="custom_operation_name"]
            [-override_credential="named_credential"]
            [-additional_parameters]
            [-stage_location="custom_stage_location"]
            [-is_staged="true|false"]
            [-stage_action="push|pull"]
            [-batch_size]
            [-start_time]
            [-end_time]
            [-frequency]<
            [-success_rate] 
            [-runPrecleanup]
            {-runPostcleanup]
            [-email]
            [-update_profile]
            [-profile_path]
    

    Note that the parameters mentioned in [ ] are optional.

    Note:

    It is mandatory to specify the -version_name parameter or the -image_name parameter. Also, it is mandatory to specify the -agents parameter or the -input_file parameter. If you specify both -agents and -input_file, a union of the outputs (when each of these parameters is specified individually) is displayed.

    All parameters can be passed in a response file, using the -input_file parameter. For example, -input_file="response_file:/scratch/response_file.txt".

    In the response file, each parameter must be specified on a new line, and in name value pairs. For example, op_name=UPDATE_AGT_121020

    If the same parameter is passed both on the command line and in the response file, the value of the command line parameter is given precedence.

    Table 6-6 lists and describes the supporting parameters for updating Management Agents using an Agent Gold Image version.

    Table 6-6 Supported Parameters for Updating Management Agents Using Agent Gold Image Version

    Parameter Description

    -version_name

    Agent Gold Image version to which the Management Agents should be updated.

    -image_name

    Agent Gold Image to which the Management Agents should be updated.

    -agents

    Names of all the Management Agents that should be updated.

    -input_file

    Absolute path to the file that lists the Management Agents to be updated.

    -pre_script_loc

    Absolute path to a script that should be run before updating the Management Agents.

    -pre_script_on_oms

    Indicates that the pre-script is present on the OMS host.

    -post_script_loc

    Absolute path to a script that should be run after updating the Management Agents.

    -post_script_on_oms

    Indicates that the post-script is present on the OMS host.

    -op_name

    Custom operation name for the Management Agent update.

    -override_credential

    Overrides the preferred credentials with different named credentials. Typically, the preferred credentials of the Oracle home of the Management Agent are used to run root.sh on certain Management Agents after the update. But passing this option overrides those preferred credentials.

    -additional_parameters

    Additional parameters to be passed for the Management Agent update.

    -stage_location

    Custom stage location for the Management Agent update. Minimum free space required is 1 GB if image is not already staged. Ensure that this location is accessible from all the Management Agents being updated if image is prestaged.

    -is_staged

    Set to 'true' if you have already staged the Agent Gold Image.

    -stage_action

    Set to 'pull' if you want the Management Agents to be updated to pull the Agent Gold Image. Typically, If the Agent Gold Image has not already been staged, by default the Agent Gold Image is pushed to the Management Agents to be updated. Setting to 'pull' pulls the Agent Gold Image instead.

    -batch_size

    Number of Management Agents present in an update batch. Default value is 100.

    -start_time

    Start time for the update job. Specify in \" yyyy-mm-dd hh:mm:ss\" format.

    -end_time

    End time for the update job. Specify in \" yyyy-mm-dd hh:mm:ss\" format.

    -frequency

    Time (in minutes) after which the application should check whether or not the current batch is complete, and should schedule the next batch for update. Default value is.

    -success_rate

    Percentage of the total number of Management Agents that must have been successfully updated in previous batches, before the next batch is allowed to begin. Default value is 90.

    -runPrecleanup

    Cleans up the old agent homes before updating the Management Agents.

    -runPostcleanup

    Cleans up the old agent homes after updating the Management Agents.

    -email

    Email IDs separated by a comma (,) to which notifications should be sent once the batch completes.

    -update_profile

    Indicates that a profile is set with agent Oracle home.

    -profile_path

    Absolute path to user profiles separated by a comma (,) if the update profile option is selected.

    Examples:

    • The following example updates xyz.domain.com:1243 using the latest Agent Gold Image in the series OPC_AGT_ADC_POD:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_series="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243"
      
    • The following example updates xyz.domain.com:1243 using the Agent Gold Image OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_name="OPC_AGT_ADC_POD_JUNE" -agents="xyz.domain.com:1243"
      
    • The following example updates all the Management Agents present in the input file /scratch/agents_file.txt using the Agent Gold Image OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_name="OPC_AGT_ADC_POD_JUNE" -input_file="agents_file:/scratch/agents_file.txt"
      
    • The following example runs /scratch/pre_script, then updates xyz.domain.com:1243 using the Agent Gold Image OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_name="OPC_AGT_ADC_POD_JUNE" -agents="xyz.domain.com:1243" -pre_script_loc="/scratch/pre_script"
      
    • The following example updates xyz.domain.com:1243 using the Agent Gold Image OPC_AGT_ADC_POD_JUNE, then runs /scratch/post_script:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_name="OPC_AGT_ADC_POD_JUNE" -agents="xyz.domain.com:1243" -post_script_loc="/scratch/post_script"
      
    • The following example updates xyz.domain.com:1243 (creates an update job UPDATE_JOB123) using the Agent Gold Image OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_name="OPC_AGT_ADC_POD_JUNE" -agents="xyz.domain.com:1243" -op_name="UPDATE_JOB123"
      
    • The following example updates xyz.domain.com:1243 using the Agent Gold Image OPC_AGT_ADC_POD_JUNE, and uses NAMED_CRED123 to run root.sh after the update:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_name="OPC_AGT_ADC_POD_JUNE" -agents="xyz.domain.com:1243" -override_credential="NAMED_CRED123"
      
    • The following example updates xyz.domain.com:1243 using the Agent Gold Image OPC_AGT_ADC_POD_JUNE, passing two additional parameters:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_name="OPC_AGT_ADC_POD_JUNE" -agents="xyz.domain.com:1243" -additional_parameters="-ignorePrereqs -newParameter"
      
    • The following example updates xyz.domain.com:1243 using the latest Agent Gold Image in the series OPC_AGT_ADC_POD, passing two additional parameters:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_series="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -additional_parameters="-ignorePrereqs -newParameter"
      
    • The following example updates xyz.domain.com:1243 using the latest Agent Gold Image in the series OPC_AGT_ADC_POD, without staging the gold image:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_series="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -is_staged="true"
      
    • The following example updates xyz.domain.com:1243 using the latest Agent Gold Image in the series OPC_AGT_ADC_POD, and the gold image is pulled by xyz.domain.com:1243:

      <ORACLE_HOME>/bin/emcli update_agents -gold_image_series="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -stage_action="pull"
      
    • The following example runs the Management Agent update with maximum of 150 Management Agents getting updated in each batch:

      <ORACLE_HOME>/bin/emcli update_agents -image_name="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -batch_size=150
      
    • The following example runs the Management Agent update with maximum of 150 Management Agents getting updated in each batch:

      Note:

      The next batch gets scheduled only if 80% of the Management Agents are successfully updated in the previous batches.

      <ORACLE_HOME>/bin/emcli update_agents -image_name="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -batch_size=150 success_rate=80
      
    • The following example schedules the agent update job starting at May 7, 10:00:00 AM and ending at May 8, 10:00:00 AM:

      <ORACLE_HOME>/bin/emcli update_agents -image_name="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -start_time="2014-05-07 10:00:00" -end_time="2014-05-08 10:00:00"
      
  5. Run the get_agent_update_status verb to displays the update results of the Management Agent:
    <ORACLE_HOME>/bin/emcli get_agent_update_status 
            -version_name | -op_name 
            [-agent="agent_name_pattern"] 
            [-severity="ERROR|WARNING"] 
            [-severity_id="severity_id"] 
            [-status="PendingUpdateInprogress|Updatable|NotUpdatable|NotExecuted|Success|Inprogress|Failed"]
    

    Note that the parameters mentioned in [ ] are optional.

    Note:

    It is mandatory to specify the -op_name parameter or the -version_name parameter. If you have specified -severity or -severity_id, ensure that you do not specify -version_name or -status.

    Table 6-7 lists and describes the supporting parameters for displaying the update status of the Management Agent.

    Table 6-7 Supported Parameters for Displaying Update Status of the Management Agent

    Parameter Description

    -version_name

    Displays the details of the update operation submitted for the specified Agent Gold Image version name.

    -op_name

    Displays the details of the specified update operation.

    -agent

    Displays the details of the operations submitted for Management Agents that have the specified name pattern.

    -status

    Displays the details of the update operations that have the specified status.

    -severity

    Displays the details of the update operations that have the specified severity level.

    -severity_id

    Displays the details of the update operations that have the specified severity ID

    Examples:

    • The following example displays the details of the update operations submitted for the Agent Gold Image version OPC_AGT_ADC_POD_JUNE:

      <ORACLE_HOME>/bin/emcli get_agent_update_status -version_name="OPC_AGT_ADC_POD_JUNE"
      
    • The following example displays the details of the update operations submitted for the Agent Gold Image OPC_AGT_ADC_POD_JUNE, for the Management Agent xyz.domain.com:1243:

      <ORACLE_HOME>/bin/emcli get_agent_update_status -version_name="OPC_AGT_ADC_POD_JUNE" -agent="xyz.domain.com:1243"
      
    • The following example displays the details of the update operations submitted for the Agent Gold Image OPC_AGT_ADC_POD_JUNE, for the Management Agent xyz.domain.com:1243, that have their status as Failed:

      <ORACLE_HOME>/bin/emcli get_agent_update_status -version_name="OPC_AGT_ADC_POD_JUNE" -agent="xyz.domain.com:1243" -status="Failed"
      
    • The following example displays the details of the update operation UPDATE_JOB123:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123"
      
    • The following example displays the details of the update operation UPDATE_JOB123, for the Management Agent xyz.domain.com:1243:

      <ORACLE_HOME>/bin/emcli get_agent_update_status -op_name="UPDATE_JOB123" -agent="xyz.domain.com:1243"
      
    • The following example displays the details of the update operation UPDATE_JOB123, for Management Agents having the status Failed:

      <ORACLE_HOME>/bin/emcli get_agent_update_status -op_name="UPDATE_JOB123" -status="Failed"
      
    • The following example displays the details of the update operation UPDATE_JOB123 for the Management Agent xyz.domain.com:1243, having the status Failed:

      <ORACLE_HOME>/bin/emcli get_agent_update_status -op_name="UPDATE_JOB123" -status="Failed" -agent="xyz.domain.com:1243"
      
    • The following example displays the Management Agents of the update operation UPDATE_JOB123, for which severity is ERROR:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123" -severity="ERROR"
      
    • The following example displays the Management Agents of the update operation UPDATE_JOB123, for which severity is WARNING, and severity ID is ROOT_RUN_CHECK:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123" -severity="WARNING" -severity_id="ROOT_RUN_CHECK"
      
    • The following example displays the Management Agents of the update operation UPDATE_JOB123, for which severity ID is ROOT_RUN_CHECK:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123" -severity_id="ROOT_RUN_CHECK"
      
    • The following example displays the details of the update operation UPDATE_JOB123 for the Management Agent xyz.domain.com:1243, with severity as ERROR:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123" -severity="ERROR"  -agent="xyz.domain.com:1243"      
      
    • The following example displays the details of the update operation UPDATE_JOB123 for the Management Agent xyz.domain.com:1243, with severity ID as ROOT_RUN_CHECK:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123" -severity_id="ROOT_RUN_CHECK"  -agent="xyz.domain.com:1243"
      
    • The following example displays the details of the update operation UPDATE_JOB123 for the Management Agent xyz.domain.com:1243, with severity as WARNING and severity ID as ROOT_RUN_CHECK:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123" -severity="WARNING" -severity_id="ROOT_RUN_CHECK"  -agent="xyz.domain.com:1243"
      
    • The following example displays the Management Agents of the update operation UPDATE_JOB123, for which severity is ERROR:

      <ORACLE_HOME>/bin/emcli get_agent_update_status  -op_name="UPDATE_JOB123" -severity="ERROR"
      

6.9 Upgrading Hybrid Cloud Gateway Agents and Hybrid Cloud Agents

Enterprise Manager Cloud Control provides you with a single pane of glass for monitoring and managing both your on-premise and Oracle Cloud deployments, all from the same management console. By deploying Hybrid Cloud Agents onto the Oracle Cloud virtual hosts serving your Oracle Cloud services, you are able to manage Oracle Cloud targets just as you would any other.

For more information on Hybrid Cloud Management and for instructions to enable the feature, see Oracle Enterprise Manager Cloud Control Administrator's Guide.

If you have already enabled Hybrid Cloud Management, and want to upgrade your Hybrid Cloud Gateway Agents and the Hybrid Cloud Agents, then see Upgrading Central Agents or Standalone Management Agents to 13c Release 3 Using the Agent Upgrade Console or EM CLI. The procedure to upgrade a Hybrid Cloud Gateway Agent or a Hybrid Cloud Agent is the same as the procedure to upgrade any normal, standalone Management Agent in an on-premise Enterprise Manager environment.