Oracle Management Agent (Management Agent) is one of the core components of Enterprise Manager Cloud Control that enables you to convert an unmanaged host to a managed host in the Enterprise Manager system. The Management Agent works in conjunction with the plug-ins to monitor the targets running on that managed host. Therefore, at any point in time, if you want to monitor a target running on a host, you must first convert that unmanaged host to a managed host by installing a Management Agent.
In the past, Enterprise Manager Cloud Control has offered several approaches for installing Management Agents, including the Add Host Targets Wizard, EM CLI, and response files to silently perform the installation. Starting with 13c, Enterprise Manager Cloud Control offers Agent Gold Images that can be used for mass-deployment and upgrade of Management Agents in your environment.
An Agent Gold Image represents the ideal state of a Management Agent in a data center managed by Enterprise Manager, having a customized configuration of the desired versions of the Management Agent software, the desired versions of the monitoring plug-ins, and the desired patches.
An Agent Gold Image version is created by an Enterprise Manager user, using a live reference Management Agent that is thoroughly tested and tuned. An Agent Gold Image version can be used to provision new Management Agents or update existing Management Agents on a large number of hosts.
This chapter describes how you can manage the lifecycle of an Agent Gold Image. In particular, this chapter covers the following:
The following terminologies are commonly used while discussing Agent Gold Images:
Agent Gold Image and Agent Gold Image version: An Agent Gold Image represents the ideal state of a Management Agent in a data center, having customized configurations of the desired versions of the Management Agent software, the desired versions of the monitoring plug-ins, and the desired patches.
An Agent Gold Image is expected to undergo revisions whenever you plan to upgrade your Management Agents, upgrade the plug-ins deployed on your Management Agents, deploy new plug-ins on your Management Agents, or deploy new patches on your Management Agents or plug-ins. Each of these sequential revisions of an Agent Gold Image is termed as an Agent Gold Image version.
Updating a Management Agent: This can refer to upgrading a Management Agent (that is, upgrading the Management Agent software), deploying new plug-ins on a Management Agent, upgrading the existing plug-ins on a Management Agent, applying Management Agent and plug-in patches, and any combination of these. You can perform any combination of these tasks using Agent Gold Image versions.
Current version of an Agent Gold Image: The up-to-date version of an Agent Gold Image that you want to use to standardize the Management Agents in your enterprise.
Restricted version of an Agent Gold Image: An Agent Gold Image version that must be used only for limited deployment, perhaps for testing purposes, and not for mass deployment. By default, you can deploy or update a maximum of 10 Management Agents using a restricted version of a particular Agent Gold Image. It is recommended that administrators seek the permission of the super administrator before using this gold image version to deploy or update Management Agents. At any given point, for a Management Agent gold image, you can have only one restricted version.
Subscribing a Management Agent to an Agent Gold Image: Associating a Management Agent with a particular Agent Gold Image. This is a prerequisite for updating Management Agents using a particular Agent Gold Image version.
Unsubscribing a Management Agent from an Agent Gold Image: Disassociating a Management Agent from the Agent Gold Image that it subscribes to. Perform this task if you do not want to manage the update operations of a particular Management Agent using an Agent Gold Image anymore.
Agent Gold Image compliance: Out of all the Management Agents subscribed to a particular gold image, the percentage of Management Agents that are on the current version of the Agent Gold Image.
Using an Agent Gold Image, you can perform the following tasks:
Provision new Management Agents.
Update any existing Management Agents.
Upgrade your Management Agents (that is, upgrading the Management Agent software).
Deploy new plug-ins on your Management Agents.
Upgrade the existing plug-ins that are deployed on your Management Agents.
Deploy patches on your Management Agents.
Deploy patches on the plug-ins that are deployed on your Management Agents.
Check the Agent Gold Image compliance level to identify what percentage of Management Agents in your environment are already associated with an Agent Gold Image, and what percentage are not.
Track the Agent Gold Image activities, such as the gold image jobs submitted, their status, the start and end time of the activity, and so on.
Note:
You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Section 8.1.In addition, you cannot use an unsecure Management Agent to create an Agent Gold Image version. Therefore, always use only a secure Management Agent as the source for creating an Agent Gold Image version.
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 access the Agent Gold Image console, from the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Table 11-1 describes the various parts of the Gold Agent Image Console.
Table 11-1 Description of the Gold Agent Image Console
Number | Description |
---|---|
1 |
A pictorial representation of the compliance level - out of all the Management Agents that are subscribed to an Agent Gold Image, how many are deployed or updated with a gold image and how many are yet to be deployed or updated with a gold image. Hover your mouse over the graph to see the exact number of Management Agents. |
2 |
Name of the Agent Gold Image. To view more details about an Agent Gold Image, click the gold image. On the Gold Image page, view details of the image versions created for that gold image. Also, for each gold image version, view general details, the associated instance properties, the plug-ins and patches deployed, the activities performed on it, and the stage locations configured for it. Note: The Gold Image page lists only those gold image versions that have been set to current (active) or restricted version status. It does not list gold image versions of any other status. If you want to view all the gold image versions of a particular gold image, regardless of their status, then on the Agent Gold Images page, click Manage Image Versions and Subscriptions. And on the Manage Image page, click the Versions And Drafts tab. |
3 |
Number of Management Agents associated or subscribed to the Agent Gold Image. This includes the Management Agents that are not only updated with the gold image but also the ones that are not updated but subscribed to the gold image. Subscribing Management Agents to a gold image is a prerequisite for updating Management Agents with a particular gold image version. |
4 |
Number of Management Agents subscribed to a gold image and also updated with that gold image. |
5 |
Percentage of Management Agent on the latest gold image version. |
6 |
Number of gold image versions subscribed to by the Management Agents. This includes all gold image versions, including the latest version that Management Agents are subscribed to. |
7 |
Platform for which the Agent Gold Image is created. |
8 |
Enables you to manage the Agent Gold Images. You can create, edit, or remove a gold image. You can also view details of the gold images created so far. |
9 |
List of the Agent Gold Image activities, such as the jobs submitted to the Enterprise Manager job system, their status, the time at which the activity began, the time at which the activity ended, and so on. |
10 |
Name of the Agent Gold Image and the date and time when they were last changed. |
11 |
List of Agent Gold Images that have pending updates. |
12 |
List of notifications related to Agent Gold Images. |
This section illustrates the base directory structure of a Management Agent that is provisioned, upgraded, or updated using a gold image. It consists of the following:
Agent Base Directory Structure After a Management Agent Is Provisioned Using a Gold Image
Agent Base Directory Structure After Upgrade or Update from 12c to 13c Using a Gold Image
The following is the agent base directory structure of a Management Agent that is provisioned using a gold image.
<agent_base_directory> |_____agent_13.1.0.0.0 |_____bin |_____sysman |_____root.sh |_____agent.rsp |_____oraInst.loc |_____plugins |_____OPatch |_____oracle_common |_____cfgtoollogs |_____perl |_____stage |_____ocm |_____lib |_____inventory |_____install |_____config |_____EMStage |_____. |_____. |_____. |_____oraInventory |_____agent_inst |_____sbin |_____plugins.txt |_____plugins.txt.status |_____agentimage.properties
The following is the agent base directory structure of a Management Agent that is upgraded or updated using a gold image.
<agent_base_directory> |_____GoldImage_<gold_image_name> |_____agentInstall.rsp |_____agent_13.1.0.0.0 |_____agentimage.properties |_____backup_agtup |_____plugins.txt |_____plugins.txt.status |_____agent_inst |_____agentimage.properties |_____core |_____plugins |_____plugins.txt |_____plugins.txt.status |_____sbin |_____cfgtoollogs |_____install |_____inventory |_____oraInst.loc |_____. |_____. |_____.
Note:
To view a visual demonstration on Agent Gold Image console and its operations, 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:12891,1
You can perform the following lifecycle management operations for an Agent Gold Image:
Setting a Particular Agent Gold Image Version as the Current Version
Setting a Particular Agent Gold Image Version as the Restricted Version
Updating Management Agents Using an Agent Gold Image Version
To create an Agent Gold Image, use either of the following methods:
To create an Agent Gold Image, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click Manage All Images.
Click Create.
Specify the gold image name, a description (optional), and the platform of the source Management Agent that you want to use to create the Agent Gold Image versions. Ensure that you use only a standalone Management Agent as the source, and not a central agent.
Click Submit.
When you create an Agent Gold Image version using EM CLI, the Agent Gold Image gets automatically created.
To create an Agent Gold Image by creating an Agent Gold Image version using EM CLI, see Section 11.5.4.2
Note:
You can only edit an Agent Gold Image if you haven't created any Agent Gold Image versions.To edit an Agent Gold Image, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click Manage All Images.
Select the gold image that you want to edit, then click Edit.
Edit the gold image name, description, and platform details.
Click Submit.
Note:
You can only delete an Agent Gold Image if you have not created any Agent Gold Image versions.To delete an Agent Gold Image, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click Manage All Images.
Select the gold image that you want to delete, then click Remove.
To create an Agent Gold Image version, use either of the following methods:
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
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Versions and Drafts tab, then from the Actions menu, select Create.
Specify an image version name, and a description for the image version, if required.
When you create an image version and update a Management Agent with it, Enterprise Manager Cloud Control uses the image version name you provide here to create a subdirectory in the agent base directory for the Management Agent being updated.
For example, if the agent base directory of the Management Agent being updated is /u01/software/em13c/agentbasedir,
and the agent home is /u01/software/em13c/agentbasedir/agent_13.1.0.0.0,
and if you provide OPB_BP1
as the image version name, then when you update the Management Agent with the image version, a new subdirectory /u01/software/em13c/agentbasedir/GoldImage_OPB_BP1/agent_13.1.0.0.0
is created. The word limit for the image version name is 20 characters.
If you want to create the gold image version using a source Management Agent, for Create image by, select Selecting a source agent, then specify the source Management Agent that you want to use. In this case, you can also specify the following:
Work Directory: The working directory that must be used to create the Agent Gold Image. The default working directory is $AGENT_INSTANCE_HOME/install.
Ensure that you have minimum 750MB space in this location.
Configuration Properties: The Management Agent configuration properties separated by 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 that you want to exclude from the Agent Base Directory of the source agent while creating the Agent Gold Image. Ensure that you provide the complete file path. If there are two or more files, then separated them by a semicolon (;).
However, if you want to create the gold image version by importing an existing gold image version, for Create image by, select Importing an image, then specify the location of the gold image version that you want to import. In order to be able to import an image, the image should already be staged. If you have not already staged the image for this purpose, then stage it as described in Section 11.5.6.1.
Click OK.
A job that creates the Agent Gold Image version is submitted to the Enterprise Manager job system. You can view the status of this job on the Gold Agent Image Activities page, in the Image Activities tab.
To create an Agent Gold Image version using EM CLI, follow these steps:
Note:
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
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the create_gold_agent_image
verb to create an Agent Gold Image using the specified source Management Agent or by importing an already created image from another Enterprise Management System:
$<OMS_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 11-2 lists and describes the parameters supported for creating an Agent Gold Image version using EM CLI.
Table 11-2 Supported Parameters for Creating an Agent Gold Image Version
Parameter | Description |
---|---|
|
Agent Gold Image name to which the created Agent Gold Image must be added. |
|
Version name of the Agent Gold Image. When you create an image version and update a Management Agent with it, Enterprise Manager Cloud Control uses the image version name you provide here to create a subdirectory in the agent base directory for the Management Agent being updated. For example, if the agent base directory of the Management Agent being updated is |
|
Management Agent to be used as the source to create the Agent Gold Image. To view a list of the Management Agents that can be used as a source to create a gold image, run |
|
Location where the Agent Gold Image is staged for creating the gold agent image version. This location is accessible from all the OMS instances. |
|
Description of the Agent Gold Image. |
|
Working directory to be used to create the Agent Gold Image. The default working directory is $AGENT_INSTANCE_HOME/install. Minimum free space required is 1 GB. |
|
Management Agent configuration properties separated by \";\" that must be captured while creating the Agent Gold Image. For example, MaxThread;GracefulShutdown. |
-exclude_files |
List of files or directories separated by \";\" that must be excluded from the gold agent image version. For example, |
Examples:
The following example creates an Agent Gold Image OPC_AGI_DB_JUL_13, using example.com:3872
as the source Management Agent, and adds the gold image version to the gold image OPC_DB_MONITORING:
$<OMS_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:
$<OMS_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:
$<OMS_HOME>/bin/emcli create_gold_agent_image -import_location=/abc/stage -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING
To delete an Agent Gold Image version, use either of the following methods:
To delete an Agent Gold Image version, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Versions and Drafts tab.
Note:
an active (current) image cannot be deleted.Select the gold image version that you want to delete, then from the Actions menu, select Delete.
To delete an Agent Gold Image version using EM CLI, follow these steps:
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the delete_gold_agent_image
verb:
$<OMS_HOME>/bin/emcli delete_gold_agent_image -version_name="gold_image_version_name_to_delete"
Use the -version_name
parameter to specify the Agent Gold Image version that you want to delete.
For example, to delete the Agent Gold Image OPC_AGI_DB_JUL_13, run the following:
$<OMS_HOME>/bin/emcli delete_gold_agent_image -version_name=OPC_AGI_DB_JUL_13
To stage a functional Agent Gold Image version on a host, use either of the following methods:
To stage an Agent Gold Image version on a host, follow these steps:
Note:
Before staging 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.From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Versions and Drafts tab. Select the gold image version that you want to stage, then from the Actions menu, select Stage.
Specify the host, and the location on the host where you want to stage the Agent Gold Image version. Click OK.
A job that stages the Agent Gold Image version is submitted to the Enterprise Manager job system. You can view the status of this job on the Gold Agent Image Activities page, in the Image Activities tab.
To stage an Agent Gold Image version using EM CLI, follow these steps:
Note:
Before staging 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.Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the stage_gold_agent_image
verb to stage an Agent Gold Image on a destination host:
$<OMS_HOME>/bin/ emcli stage_gold_agent_image -version_name="gold_image_version_to_stage" -image_name="gold_image_name " -host_name="staging_destination_host" -stage_location="stage_location_on_destination_host"
Table 11-3 lists and describes the parameters supported for staging an Agent Gold Image version using EM CLI.
Table 11-3 Supported Parameters for Staging an Agent Gold Image Version
Parameter | Description |
---|---|
|
Agent Gold Image version that should be staged. |
|
Agent Gold Image that should be staged. |
|
Destination host where the Agent Gold Image should be staged. As a prerequisite, a Management Agent should be running on this host. |
|
Location on the destination host where the Agent Gold Image should be staged. The location should be a shared location and should be accessible by the Management Agents being updated by that Agent Gold Image. Otherwise, the location should be accessible from the OMS that is used to import the Agent Gold Image from this location. In addition, the minimum free space required is 1 GB. |
For example, to stage the Agent Gold Image OPC_AGI_DB_JUL_13 of gold image OPC_AGI_DB, at the stage location /net/stage/agent
on the host example.com,
run the following:
$<OMS_HOME>/bin/emcli stage_gold_agent_image -version_name=OPC_AGI_DB_JUL_13 -stage_location=/net/stage/agent -host_name=example.com
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:
To set a draft version of an Agent Gold Image as the current version, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Versions and Drafts tab. Select the gold image version that you want to set as the current version, then click Set Current Version.
A job that promotes the Agent Gold Image draft version to the current version is submitted to the Enterprise Manager job system. You can view the status of this job on the Gold Agent Image Activities page, in the Image Activities tab.
To set a particular Agent Gold Image version as the current version using EM CLI, follow these steps:
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the promote_gold_agent_image
verb to promote the Agent Gold Image version to the Current maturity level:
$<OMS_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:
$<OMS_HOME>/bin/emcli promote_gold_agent_image -version_name=OPC_AGI_DB_JUL_13 -maturity=Current
To set a draft or active version of an Agent Gold Image as the restricted version, use either of the following methods:
To set a draft or active version of an Agent Gold Image as the restricted version, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Versions and Drafts tab. Select the gold image version that you want to set as the restricted version, then click Set Restricted Version.
To set a draft or active version of an Agent Gold Image version as the restricted version using EM CLI, follow these steps:
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the promote_gold_agent_image
verb to promote the Agent Gold Image version to the Restricted maturity level:
$<OMS_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 Restricted maturity level, run the following:
$<OMS_HOME>/bin/emcli promote_gold_agent_image -version_name=OPC_AGI_DB_JUL_13 -maturity=Restricted
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
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:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Subscriptions tab. Click Subscribe.
Search for and select the required Management Agents, then click Select.
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 Management Agent to an Agent Gold Image using EM CLI, follow these steps:
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the subscribe_agents
verb to subscribe the specified Management Agent to a specific Agent Gold Image:
$<OMS_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:
$<OMS_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:
$<OMS_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:
$<OMS_HOME>/bin/emcli subscribe_agents -image_name="OPC_AGT_ADC_POD" -groups="GROUP1,GRP2"
To unsubscribe Management Agents from an Agent Gold Image, use either of the following methods:
Unsubscribing Management Agents to an Agent Gold Image Using Gold Agent Images Home Page
Unsubscribing Management Agents to an Agent Gold Image Using EM CLI
To unsubscribe Management Agents from an Agent Gold Image, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Subscriptions tab. Select the Management Agents that you want to unsubscribe from the Agent Gold Image. Click Unsubscribe. Select OK.
To unsubscribe a Management Agent from an Agent Gold Image using EM CLI, follow these steps:
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the unsubscribe_agents
verb to unsubscribe the specified Management Agent from a specific Agent Gold Image:
$<OMS_HOME>/bin/emcli unsubscribe_agents -image_name="Image Name" [-agents="Full Agent Name"] [-groups="List of group names"] [-closure_related="true/false"] [-closure_nfs="true/false"]
Note that the parameters mentioned in [ ]
are optional.
Table 11-4 lists and describes the supported parameters for unsubscribing Management Agents from an Agent Gold Image.
Table 11-4 Supported Parameters for Unsubscribing Management Agents
Parameter | Description |
---|---|
|
Unsubscribes the Management Agents that subscribe to the specified Agent Gold Image. |
|
Unsubscribes the Management Agents that match the specified name pattern. |
|
Unsubscribes the Management Agents that belong to the specified groups. |
|
Does not unsubscribe the related Management Agents if the value specified for this parameter is 'false'. |
|
Does not unsubscribe the related shared agents if the value specified for this parameter is 'false'. |
Examples:
The following example unsubscribes the Management Agents that subscribe to the Agent Gold Image OPC_AGT_ADC_POD, and match the name pattern abc%
or xyz.domain.com:1243:
$<OMS_HOME>/bin/emcli unsubscribe_agents -image_name="OPC_AGT_ADC_POD" -agents="abc%,xyz.domain.com:1243"
The following example unsubscribes all the Management Agents that subscribe to the Agent Gold Image OPC_AGT_ADC_POD:
$<OMS_HOME>/bin/emcli unsubscribe_agents -image_name="OPC_AGT_ADC_POD"
The following example unsubscribes the Management Agents that subscribe to the Agent Gold Image OPC_AGT_ADC_POD, and belong to the group GROUP1 or GRP2:
$<OMS_HOME>/bin/emcli unsubscribe_agents -image_name="OPC_AGT_ADC_POD" -groups="GROUP1,GRP2"
The following example unsubscribes xyz.domain.com:1243
and all its related shared agents that subscribe to the Agent Gold Image OPC_AGT_ADC_POD:
$<OMS_HOME>/bin/emcli unsubscribe_agents -image_name="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -closure_shared="true"
The following example unsubscribes xyz.domain.com:1243
and all its related Management Agents that subscribe to the Agent Gold Image OPC_AGT_ADC_POD:
$<OMS_HOME>/bin/emcli unsubscribe_agents -image_name="OPC_AGT_ADC_POD" -agents="xyz.domain.com:1243" -closure_related="true"
See Oracle Enterprise Manager Cloud Control Basic Installation Guide.
Note:
You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image. For information about Shared Agents, see Section 8.1.To update a Management Agent using an Agent Gold Image version, follow these steps:
Create an Agent Gold Image. To do this, see Section 11.5.1.
Create an Agent Gold Image version. To do this, see Section 11.5.4.
Set a particular Agent Gold Image version as the current version. To do this, see Section 11.5.7.
Subscribe Management Agents to an Agent Gold Image. To do this, see Section 11.5.9.
Update Management Agents. To update your Management Agents using an Agent Gold Image version, use either of the following procedures:
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 parameterclosureRelated
to false
in the EM_GI_MASTER_INFO
table.Note:
You cannot install, update, or upgrade a Shared Agent (NFS Agent) using an Agent Gold Image.To update a Management Agent using an Agent Gold Image version, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
Click the name of the required Agent Gold Image.
Click Manage Image Versions and Subscriptions.
Select the Subscriptions tab. Select the Management Agents that you want to update, select Update, then select To Current Version, or To Restricted Version.
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.
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.
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 11-5 provides the additional parameters that you can use while updating Management Agents.
Table 11-5 List of Additional Parameters for 13c Management Agent Update
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. |
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.
In the Notify section, specify the email addresses to which you want the notifications about the update job progress to be sent.
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.
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 Oracle Enterprise Manager Cloud Control Upgrade Guide.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.
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.
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.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.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
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 theget_not_updatable_agents
verb:
emcli get_not_updatable_agents [-version_name | -image_name]
The parameters mentioned in [ ]
are optional.
Table 11-6 lists and describes the supporting parameters for displaying the Management Agents that can be updated using a particular Management Agent image version.
Table 11-6 Supported Parameters for Displaying Management Agents That Can Be Updated
Parameter | Description |
---|---|
|
Specify this option to display the Management Agents that can be updated using the specified Agent Gold Image version. |
|
Specify this option to display the Management Agents that can be updated using the specified Agent Gold Image. |
|
Specify this option to display the Management Agents that can be updated, and are of the specified versions. |
|
Specify this option to display the Management Agents that can be updated, and whose name matches the specified name pattern. |
|
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. |
|
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.1.0 or 12.1.0.2.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.1.0,12.1.0.2.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"
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 11-7 lists and describes the supporting parameters for updating Management Agents using an Agent Gold Image version.
Table 11-7 Supported Parameters for Updating Management Agents Using Agent Gold Image Version
Parameter | Description |
---|---|
|
Agent Gold Image version to which the Management Agents should be updated. |
|
Agent Gold Image to which the Management Agents should be updated. |
|
Names of all the Management Agents that should be updated. |
|
Absolute path to the file that lists the Management Agents to be updated. |
|
Absolute path to a script that should be run before updating the Management Agents. |
|
Indicates that the pre-script is present on the OMS host. |
|
Absolute path to a script that should be run after updating the Management Agents. |
|
Indicates that the post-script is present on the OMS host. |
|
Custom operation name for the Management Agent update. |
|
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 to be passed for the Management Agent update. |
|
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. |
|
Set to 'true' if you have already staged the Agent Gold Image. |
|
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. |
|
Number of Management Agents present in an update batch. Default value is 100. |
|
Start time for the update job. Specify in \" yyyy-mm-dd hh:mm:ss\" format. |
|
End time for the update job. Specify in \" yyyy-mm-dd hh:mm:ss\" format. |
|
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. |
|
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. |
|
Cleans up the old agent homes before updating the Management Agents. |
|
Cleans up the old agent homes after updating the Management Agents. |
|
Email IDs separated by a comma (,) to which notifications should be sent once the batch completes. |
|
Indicates that a profile is set with agent Oracle home. |
|
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"
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 11-8 lists and describes the supporting parameters for displaying the update status of the Management Agent.
Table 11-8 Supported Parameters for Displaying Update Status of the Management Agent
Parameter | Description |
---|---|
|
Displays the details of the update operation submitted for the specified Agent Gold Image version name. |
|
Displays the details of the specified update operation. |
|
Displays the details of the operations submitted for Management Agents that have the specified name pattern. |
|
Displays the details of the update operations that have the specified status. |
|
Displays the details of the update operations that have the specified severity level. |
|
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"
To view a list of the Agent Gold Image activities (that is, the jobs that are submitted to the Enterprise Manager job system) and details such as their status, the time at which the activity begun, the time at which the activity ended, and so on, use either of the following methods:
To view a list of the Agent Gold Image activities, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
In the Activities section, click Show all activities.
To view the status details of Agent Gold Image activities, Management Agent update activities, or Management Agent unsubscribe activities, select the Image Activities, Update Activities, or Unsubscribe Activities tab, respectively.
To view the execution details of a particular Agent Gold Image activity, Management Agent update activity, or Management Agent unsubscribe activity, click the job name.
To view the activity details of an Agent Gold Image using EM CLI, follow these steps:
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the list_gold_agent_image_activities
verb to list the activities that the specified Agent Gold Image is a part of:
$<OMS_HOME>/bin/emcli list_gold_agent_image_activities -version_name="gold_image_version_name" [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ]
Note that the parameters mentioned in [ ]
are optional.
Table 11-9 lists and describes the supported parameters for viewing details about the Agent Gold Image.
Table 11-9 Supported Parameters for Viewing Details about the Agent Gold Image
Parameter | Description |
---|---|
|
Agent Gold Image version whose activities you want to view. |
|
Displays a tabular form of the output without column headers. |
|
This parameter is equivalent to |
|
This parameter defines the type of the output format. The default value of this parameter is
|
For example, to view activity details for the Agent Gold Image OPC_AGI_DB_JUL_13, run the following command:
$<OMS_HOME>/bin/emcli list_gold_agent_image_activities -version_name=OPC_AGI_DB_JUL_13
You can also run the get_gold_agent_image_activity_status
to check the activity status of the Agent Gold Image:
$<OMS_HOME>/bin/emcli get_gold_agent_image_activity_status -operation_name="gold_image_operation_name" [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ]
Table 11-10 lists and describes the supported parameters for viewing the activity status of the Agent Gold Image.
Table 11-10 Supported Parameters for Viewing Activity Status of the Agent Gold Image
Parameter | Description |
---|---|
|
Displays the status of a particular Agent Gold Image activity. |
|
Displays a tabular form of the output without column headers. |
|
This parameter is equivalent to |
|
This parameter defines the type of the output format. The default value of this parameter is
|
For example, to display the activity status of the Agent Gold Image operation GOLDAGENTIMAGE_CREATE_2013_12_22_12_12_52_535, run the following command:
$<OMS_HOME>/bin/emcli get_gold_agent_image_activity_status -operation_name=GOLDAGENTIMAGE_CREATE_2013_12_22_12_12_52_535
To check the compliance level for all the Agent Gold Images, from the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
You can view a pictorial representation (a vertical bar graph) of the number of Management Agents that are on gold image and not on gold image. Hover your mouse over the vertical bars to see the exact number of Management Agents that are in question.
In the table below the vertical bar graph, you can view details about the gold images created so far. To check the compliance level, see the Compliance column.
You can view details about the Agent Gold Images, using either of the following methods:
To view details about the Agent Gold Images and gold image versions using the Gold Agent Images Home page, from the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
You can view a pictorial representation (a vertical bar graph) of the number of Management Agents that are on gold image and not on gold image. Hover your mouse over the vertical bars to see the exact number of Management Agents that are in question.
In the table below the vertical bar graph, you can view details about the gold images created so far. Table 11-11 describes these details.
Table 11-11 Gold Agent Image Details
Column Name | Description |
---|---|
Gold Image Name |
Name of the Agent Gold Image. To view more details about an Agent Gold Image and its versions, click the gold image. On the Gold Agent Images page, view details about the deployments and the image versions created for that gold image. Also, for each gold image version, view general details, the associated instance properties, the plug-ins and patches deployed, the activities performed on it, and the stage locations configured for it. Note: The Gold Image page lists only those gold image versions that have been set to current (active) or restricted version status. It does not list gold image versions of any other status. If you want to view all the gold image versions of a particular gold image, regardless of their status, then on the Agent Gold Images page, click Manage Image Versions and Subscriptions. And on the Manage Image page, click the Versions And Drafts tab. |
Subscribed Agents |
Number of Management Agents associated or subscribed to the Agent Gold Image. This includes the Management Agents that are not only updated with the gold image but also the ones that are not updated but subscribed to the gold image. Subscribing Management Agents to a gold image is a prerequisite for updating Management Agents with a particular gold image version. |
Agents on Gold Image |
Number of Management Agents subscribed to a gold image and also updated with that gold image. |
Compliance |
Percentage of Management Agent on the latest gold image version. |
Number of Deployed Gold Image Versions |
Number of gold image versions subscribed to by the Management Agents. This includes all gold image versions, including the latest version that Management Agents are subscribed to. |
Platform Name |
Platform for which the Agent Gold Image is created. |
To view details about an Agent Gold Image using EM CLI, follow these steps:
Log in to EM CLI from the /bin
directory present within the OMS home:
$<OMS_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<OMS_HOME>/bin/emcli sync
Run the list_gold_agent_images
verb to list the various Agent Gold Images that have been created.:
$<OMS_HOME>/bin/emcli list_gold_agent_images [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ]
Note that the parameters mentioned in [ ]
are optional.
Table 11-12 lists and describes the supported parameters for displaying the list of Agent Gold Images.
Table 11-12 Supported Parameters for Displaying the List of Agent Gold Images
Parameter | Description |
---|---|
|
Displays a tabular form of the output without column headers. |
|
This parameter is equivalent to |
|
This parameter defines the type of the output format. The default value of this parameter is
|
Run the list_gold_agent_imageversions
verb to list the Agent Gold Image versions:
$<OMS_HOME>/bin/emcli list_gold_agent_imageversions [-image_name="gold_image_name"] [-all] [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ]
Note that the parameters mentioned in [ ]
are optional.
Table 11-13 lists and describes the supported parameters for displaying the list of Agent Gold Image versions.
Table 11-13 Supported Parameters for Displaying the List of Agent Gold Image Versions
Parameter | Description |
---|---|
|
A parameter to view the Agent Gold Image versions that are part of a particular Agent Gold Image. |
|
A parameter to view all the Agent Gold Images. |
|
A parameter to display a tabular form of the output without column headers. |
|
This parameter is equivalent to |
|
This parameter defines the type of the output format. The default value of this parameter is
|
For example, to display the Agent Gold Image versions that are promoted to Current, run the following command:
$<OMS_HOME>/bin/emcli list_gold_agent_imageversions
To display the Agent Gold Image versions that are part of the OPC_DB_MONITORING and promoted to Current, run the following command:
$<OMS_HOME>/bin/emcli list_gold_agent_imageversions -image_name=OPC_DB_MONITORING
Run the get_gold_agent_image_details
verb to display a list of the platform, plug-in, patch, configuration properties, and Management Agent details of an Agent Gold Image:
$<OMS_HOME>/bin/emcli get_gold_agent_image_details -version_name="gold_image_version_name" [-platform] [-plugin] [-patch] [-config_properties] [-agent] [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ]
Note that the parameters mentioned in [ ]
are optional.
Table 11-14 lists and describes the supported parameters for displaying the platform, plug-in, patch, configuration properties, and Management Agent details of the Agent Gold Image.
Table 11-14 Supported Parameters for Displaying the Details of the Agent Gold Image
Parameter | Description |
---|---|
|
The name of the Agent Gold Image version whose details you want to view. |
|
The platform details of the Agent Gold Image. |
|
The plug-in details of the Agent Gold Image. |
|
The patch details of the Agent Gold Image. |
|
The configuration properties of the Agent Gold Image. |
|
The Management Agent details of the Agent Gold Image. |
|
A tabular form of the output without column headers. |
|
This parameter is equivalent to |
|
This parameter defines the type of the output format. The default value of this parameter is
|
For example, to display the platform, plug-in, and patch details of the Agent Gold Image OPC_AGI_DB_JUL_13, run the following command:
$<OMS_HOME>/bin/emcli get_gold_agent_image_details -version_name=OPC_AGI_DB_JUL_13
You can also run the list_agents_on_gold_image
verb to list the Management Agents that were deployed or updated using a particular Agent Gold Image version or overall agent deployment report for Agent Gold Image:
$<OMS_HOME>/bin/emcli list_agents_on_gold_image -version_name|-image_name="gold_image_version_name|gold_image_name" [-agent_name="agent_name_pattern"]
Note that the parameters mentioned in [ ]
are optional.
Specify the -version_name
parameter to view the Management Agents that were deployed or updated using a particular Agent Gold Image version.
Specify the -image_name
parameter to view the number of Management Agents deployed for given Agent Gold Image.
Specify the -agent_name
parameter to view only the Management Agents that match the specified name pattern.
For example, to display the Management Agents that were deployed or updated using the Agent Gold Image OPC_AGI_DB_JUL_13, run the following command:
$<OMS_HOME>/bin/emcli list_agents_on_gold_image -version_name=OPC_AGI_DB_JUL_13
To display the number of Management Agents that were deployed or updated using any of the Agent Gold Image versions that are part of the gold image OPC_DB_MONITORING, run the following command:
$<OMS_HOME>/bin/emcli list_agents_on_gold_image -image_name=OPC_DB_MONITORING
To view notifications related to Agent Gold Images, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
On the Gold Agent Images page, in the Notifications section that is on the right, view the notifications pertaining to gold images.
To view the Agent Gold Images with pending updates, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
On the Gold Agent Images page, in the Actions Required section that is on the right, view the pending updates against the gold images.
To drill down further and update the Management Agents with the latest gold image version, click the gold image name.
To view the last Agent Gold Image that was changed, follow these steps:
From the Setup menu, select Manage Cloud Control, then select Gold Agent Images.
On the Gold Agent Images page, in the Last Image Change section that is on the right, view the date and time stamp of the gold image that was last changed.
To view the log files related to Agent Gold Image, see Appendix A.
To view the status of unsubscribed operations, follow these steps:
Log in to EM CLI from the /bin directory present within the Oracle home:
$<ORACLE_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
Run the emcli get_agent_unsubscribe_status
verb to view the status of unsubscribed operations:
<ORACLE_HOME>/bin/emcli get_agent_unsubscribe_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 the parameters mentioned in [ ] are optional.
Table 11-15 lists and describes the parameters supported for viewing the status of unsubscribed operations using EM CLI.
Note:
It is mandatory to specify the -op_name parameter or the -version_name parameter. If you have specified -severity or -severity_id, then ensure that you do not specify -version_name or -status.Table 11-15 Supported Parameters for Viewing the Status of Unsubscribed Operations
Parameters | Description |
---|---|
-version_name |
Version name of the unsubscribed Agent Gold Image. |
--op_name |
Operation name of the unsubscribed Agent Gold Image. |
-agent |
Agent name of the unsubscribed Agent Gold Image. |
-severity |
Severity status of the Agent Gold Image. |
-severity_id |
Severity ID of the Agent Gold Image. |
-status |
Status of the unsubscribed Agent Gold Image. |
Examples:
The following example displays the details of the unsubscribe operations submitted for the Agent Gold Image version 'OPC_AGT_ADC_POD_JUNE':
emcli get_agent_unsubscribe_status -version_name="OPC_AGT_ADC_POD_JUNE"
The following example displays the details of the unsubscribe operations submitted for the Agent Gold Image 'OPC_AGT_ADC_POD_JUNE', for the Management Agent xyz.domain.com:1243:
emcli get_agent_unsubscribe_status -version_name="OPC_AGT_ADC_POD_JUNE" -agent="xyz.domain.com:1243"
The following example displays the details of the unsubscribe 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':
emcli get_agent_unsubscribe_status -version_name="OPC_AGT_ADC_POD_JUNE" -agent="xyz.domain.com:1243" -status="Failed"
The following example displays the details of the unsubscribe operation 'UNSUBSCRIBE_JOB123':
emcli get_agent_unsubscribe_status -op_name="UNSUBSCRIBE_JOB123"
The following example displays the details of the unsubscribe operation 'UNSUBSCRIBE_JOB123' for the Management Agent xyz.domain.com:1243, having the status 'Failed':
emcli get_agent_unsubscribe_status -op_name="UNSUBSCRIBE_JOB123" -status="Failed" -agent="xyz.domain.com:1243"
To view a list of Management Agents subscribed to a given Agent Gold Image, follow these steps:
Log in to EM CLI from the /bin directory present within the Oracle home:
$<ORACLE_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
Run the emcli list_gold_image_subscribed_agent verb to view the status of unsubscribed operations:
<ORACLE_HOME>/bin/emcli list_gold_image_subscribed_agent -image_name="gold_image_name" [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ]
Note the parameters mentioned in [ ] are optional.
Table 11-16 lists and describes the parameters supported to view the list of all agents subscribed to a given Management Gold image.
Table 11-16 Supported Parameters for Viewing the List of Management Agents Subscribed to a Given Agent Gold Image
Parameters | Description |
---|---|
-image_name |
Image name of a particular Management Agent that is subscribed to an Agent Gold Image. |
-noheader |
A tabular form of the output without column headers. |
-script |
This is equivalent to -format="name:script". |
-format |
Defines the format of a particular Management Agent that is subscribed to an Agent Gold Image. |
Example:
The following example displays all the agents subscribed to OPC_DB_MONITORING image:
emcli list_gold_image_subscribed_agent -image_name=OPC_DB_MONITORING
To create an Agent Gold Image Update Policy and to define default values for Management Agent Upgrade, follow these steps:
Log in to EM CLI from the /bin directory present within the Oracle home:
$<ORACLE_HOME>/bin/emcli login -username=<user_name>
Once you run this command, EM CLI will prompt you for a password. Enter the password for the user name you specified.
Synchronize EM CLI:
$<ORACLE_HOME>/bin/emcli sync
Run the emcli set_gold_agent_update_policy verb to define default values for Management Agent Upgrade:
<ORACLE_HOME>/bin/emcli set_gold_agent_update_policy [-additional_parameters="Additional_parameters seperated by space"] [-pre_script_loc="Absolute path of Prescript location"] [-post_script_loc="Absolute path of Postscript location"] [-is_pre_script_on_oms="true/false"] [-is_post_script_on_oms="true/false"] [-stage_location="Absolute path of stage location] [-is_staged="true/false"] [-stage_action="Stage action] [-batch_size="Batch size"] [-frequency="Frequency"] [-success_rate="Success rate"] [-update_profile="true/false"] [-profile_path="Profile path"] [-email="Email IDs separated by comma"] [-run_preCleanup="true/false"] [-run_postCleanup="true/false"]
Note the parameters mentioned in [ ] are optional.
Table 11-17 lists and describes the parameters supported to upgrade and define default values for Management Agents.
Table 11-17 Supported Parameters for Upgrading Agents and Defining Default Values
Parameters | Description |
---|---|
-additional_parameters |
Additional parameters set in the repository to create an Agent Gold Image Policy. |
-pre_script_loc |
Prescript location set in the repository to create an Agent Gold Image Policy. |
-post_script_loc |
Postscript location set in the repository to create an Agent Gold Image Policy. |
-is_pre_script_on_oms |
Value set in the repository for this parameter to create an Agent Gold Image Policy. |
-is_post_script_on_oms |
Value set in the repository for this parameter to create an Agent Gold Image Policy. |
-stage_location |
Stage location value set in the repository to create an Agent Gold Image Policy. |
-is_staged |
Value set for this parameter in the repository to create an Agent Gold Image Policy. |
-stage_action |
Value set for stage action in the repository to create an Agent Gold Image Policy. |
-batch_size |
Value set for batch size in the repository to create an Agent Gold Image Policy. |
-frequency |
Value set for frequency in the repository to create an Agent Gold Image Policy. |
-success_rate |
Value set for success rate in the repository to create an Agent Gold Image Policy. |
-update_profile |
Value set for update profile in the repository to create an Agent Gold Image Policy. |
-profile_path |
Value set for profile path in the repository to create an Agent Gold Image Policy. |
|
Email set in the repository to create an Agent Gold Image Policy. |
-run_preCleanup |
Value set for this parameter to create an Agent Gold Image Policy. |
-run_postCleanup |
Value set for this parameter to create an Agent Gold Image Policy. |
Examples:
The following example sets additional parameters in the repository:
emcli set_gold_agent_update_policy -additional_parameters=-ignorePrereqs
The following example sets prescript location in the repository:
emcli set_gold_agent_update_policy -pre_script_loc=/home/john/pretscript
The following example sets stage location in the repository:
emcli set_gold_agent_update_policy -stage_location=/scratch/tmp
The following example sets batch size in the repository:
emcli set_gold_agent_update_policy -batch_size=100
The following example sets the success rate in the repository:
emcli set_gold_agent_update_policy -success_rate=90