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.2.0.0.0/cfgtoollogs/agentDeploy/*;agent_13.2.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.2.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.2.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.2.0.0.0/cfgtoollogs/agentDeploy;agent_13.2.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