This following sections describe how to use Oracle Configuration Manager:
Configuration data is automatically collected on a regular schedule. By default, collections are scheduled to run once a day at the time the original installation was done. Therefore, no matter how many times you view the data within that 24 hour time period, the data will remain the same until the time of the next collection.
To start a manual collection of configuration data, enter the following command:
<ocm_install_root>/ccr/bin/emCCR collect
This command collects the configuration data and uploads it to the server located at Oracle. Configuration data is collected only if the Scheduler has been started. The Scheduler is always running unless it has been manually stopped with the emCCR stop
command. In this case, you will have to manually restart the Scheduler so that configuration data can be automatically collected. Check the status of the Scheduler by entering emCCR status
which indicates whether the Scheduler has been started. To start the Scheduler, enter the following command:
<ocm_install_root>/ccr/bin/emCCR start
The Scheduler acts as a coordinator of activities, and provides both a richer schedule capability and the ability to perform collections on a regular schedule. Scheduled collections are only available when Oracle Configuration Manager is running in Connected mode.
Configuration data can be collected daily, weekly, or monthly, at a particular date and time. You can set the interval for automatically collecting the configuration data with the emCCR set collection_interval
command.
These commands can be used only if the Scheduler has been started:
emCCR stop emCCR set collection_interval emCCR hold emCCR resume emCCR getupdates emCCR upload
For more information on these commands, refer to Appendix C, "Oracle Configuration Manager Commands."
If you are using Oracle Configuration Manager in Disconnected mode, configuration data needs to be manually collected. As the Scheduler is not running in this mode, it cannot be used to automatically collect configuration data at regular intervals.
You can collect configuration data manually by using the emCCR
collect
command. When you run this command, the ocmconfig.jar
is created in the OCM_CONFIG_HOME/state/upload/
directory. This file contains the manually collected configuration data. You can then upload this file to Oracle by way of My Oracle Support from another system that has internet access. For more details on manual collection of configuration data, refer to emCCR collect
.
In Disconnected mode, the only commands supported are:
emCCR collect emCCR status emCCR enable_target emCCR disable_target emCCR update_components configCCR emCCR help
For more information on these commands, refer to Appendix C, "Oracle Configuration Manager Commands."
You can update Oracle Configuration Manager either manually or automatically.
Note:
If you have disabled the Auto Update feature: With OCM 12.0, an adapter server was added to support older collectors and to transform requests to the new protocol. Beginning with OCM 12.1.2, support for this adapter server has been retired.By default all collectors are automatically upgraded through the OCM Auto Update feature; so, your version should always be current. However, if you have disabled the OCM Auto Update feature, then you must manually upgrade your installed OCM to the latest version (use the emCCR getupdates
command, as described below).
Updating Oracle Configuration Manager Automatically: After the Oracle Configuration Manager client has been installed in Connected mode, it automatically schedules a collection. If any updates to the Oracle Configuration Manager client are available, they are downloaded and applied before the configuration data is collected.
To disable the automatic updates, enter the following command:
<ocm_install_root>/ccr/bin/emCCR automatic_update off
Updating Oracle Configuration Manager Manually: You can manually apply updates by using the emCCR
update_components
command. These updates can include a new Oracle Configuration Manager distribution or packages; and the Diagnostic Checks package. Copy the packages to a directory and deploy them by using the emCCR
update_components
command. This command can be used in both Connected and Disconnected modes. For more information on this command, refer to emCCR update_components
.
If you have disabled the automatic updates, the updates can be manually downloaded and applied. To manually download and deploy the updates, enter the following command:
<ocm_install_root>/ccr/bin/emCCR getupdates
Important:
Automatic updates are not possible if Oracle Configuration Manager is installed on a shared, read-only file system. In this situation, the automatic update feature should be disabled and all updates performed manually.With Oracle Configuration Manager, you can disable or mask collections to add a customized layer of security. By disabling or masking a collection, you can protect any data you consider to be sensitive or private.
Disable IP, MAC, or Broadcast Address Collection
You can disable the collection of the Host IP Address, the Network Interface MAC Address, and the Broadcast Address. To disable the collection of these items, you must add the following entries to the OCM_CONFIG_HOME/config/collector.properties
file:
To disable the collection of network addresses, also known as Host IP Addresses, add the following entry:
ccr.metric.host.ecm_hw_nic.inet_address=false
To disable the collection of the MAC address, also known as the hardware address, add the following entry:
ccr.metric.host.ecm_hw_nic.mac_address=false
To disable the collection of the Broadcast address, add the following entry:
ccr.metric.host.ecm_hw_nic.broadcast_address=false
Mask Database Column Collection
You can mask the collection of the Database columns by using data masking. Data masking means replacing the appropriate field with a mask character, such as an X.
The masking operation is defined in the collector.properties
file located in the $ORACLE_HOME/ccr/hosts/<hostname>/config/
directory or the $ORACLE_HOME/ccr/config/
directory.
To mask the database user name in the database collection, include the following in the collector.properties
file:
ccr.metric.oracle_database.db_users.username=mask
You can mask any column using the following naming convention:
ccr.metric.<metric table name>.<table colum name>
Note that this property name should be lower case.
You can get these values from the review.xml
file, which can be viewed on your browser.
For example, to hide the IP address column (IP_ADDR
) for MGMT_ECM_HW_HOSTS
, add the following:
ccr.metric.mgmt_ecm_hw_hosts.ip_addr=false
To remove the database user name mask, remove the associated line from the collector.properties
file.
Beginning with OCM 12.1, you can disable or mask any column by following the name space mentioned, ccr.metric.<metric table name>.<table column name>
, and then the values can be mask for masking the column or false for disabling the column.
For example, here is a sample metric from one of the collection file in the CCR_CONFIG_HOME/state/review
directory:
<ROWSET OMS_PROTOCOL_VERSION="11.2.0.0.0" TABLE="MGMT_ECM_HW_HOSTS" META_VER="4.3" INCREMENTAL="FALSE" CONFIG="TRUE"> <ROW> <IP_ADDR>0.0.0.0</IP_ADDR> <VALUE>abcxyz</VALUE> </ROW>
To disable the ip_addr
column, add the following entry to the collector.properties
file:
ccr.metric.mgmt_ecm_hw_hosts.ip_addr=false
To mask the ip_addr
column, add the following entry to the collector.properties
file:
ccr.metric.mgmt_ecm_hw_hosts.ip_addr=mask
Note:
The metric table name (mgmt_ecm_hw_hosts
in the example) and table column name (ip_addr
in the example) should be in lower case.The NFS mounted file system information is no longer collected by default. Only local file system information is collected by default.
To enable the collection of NFS mounted file system information, add the following entry to the OCM_CONFIG_HOME/config/collector.properties
file.
metric.host.ecm_os_filesystem.nfs_enable=true
In support of mass deployment using a scripted installation, Oracle Configuration Manager installation and configuration supports the ability to create and specify a response file. The response file contains all the user required input needed when running the setupCCR
and configCCR
commands.
Note:
When using a response file that contains an authenticated proxy server and it was created using JDK version 1.4.2 or later, you must use JDK version 1.4.2 or later. Otherwise, you will get an error message and Oracle Configuration Manager will exit.To specify the response file with the setupCCR
and configCCR
commands, use the -R
qualifier with the <response file>
argument.
configCCR [-R <response file>] setupCCR [-R <response file>]
To create a response file, use the emocmrsp
response generation utility, located in the $ORACLE_HOME/ccr/bin
directory. This utility walks you through the interrogation phase of an installation and records your responses to the prompts. The information is recorded in an Oracle Configuration Manager private format response file. By default, the response file is created in the current directory with the file name ocm.rsp
. To view the contents of the response file, use the -verbose
option on the command line.
Note:
To create a response file that installs but does not configure Oracle Configuration Manager, click ENTER when prompted for the e-mail address and specify Yes when asked to confirm if you want to remain uninformed.To create the response file, enter the following command:
emocmrsp [-output <response-file>] [-help] [-no_banner] [-repeater <URL>] [<CSI> [<MyOracleSupportUserName>] ] [-verbose <response-file>] [-verify <response-file>]
The following qualifiers are allowed:
Qualifier | Description |
---|---|
<CSI> | To use Customer Support Identifier for registration, enter CSI at the end of the command line. You can either enter the MyOracleSupportUserName on the command line or be prompted for it.
Note: If |
<MyOracleSupportUserName> | My Oracle Support User Name holding the CSI in its My Oracle Support profile. |
-help | Displays this usage information. |
-no_banner | Indicates the banner for the response utility is not to be displayed. |
-output <response_file> | Creates a response file with the name specified. If you do not specify this qualifier, the response file is created in your current working directory with the file name ocm.rsp . |
-repeater <URL> | Indicates the URL of the Oracle Support Hub. |
-verbose <response-file> | Displays contents of the response file specified. |
-verify <response-file> | Verifies that the contents of the response file are valid. |
Example
$ORACLE_HOME/ccr/bin/emocmrsp OCM Installation Response Generator 10.3.8.0.0 - Production Copyright (c) 2005, 2012, Oracle. All rights reserved. Provide your email address to be informed of security issues, install and initiate Oracle Configuration Manager. Easier for you if you use your My Oracle Support Email address/User Name. Visit http://www.oracle.com/support/policies.html for details. Email address/User Name: test@company.com Provide your My Oracle Support password to receive security updates via your My Oracle Support account. Password (optional): The OCM configuration response file (ocm.rsp) was successfully created.
If you cannot access the Oracle server, you will be prompted for the URL of the Oracle Support Hub. If NONE is entered to indicate that no Oracle Support Hub is to be used, or if a proxy server is required to access the Oracle Support Hub, you will be prompted for proxy server information. If NONE is entered for both Oracle Support Hub and proxy server, Oracle Configuration Manager will be installed in Disconnected mode.
If you do not specify password when prompted, the setup will use unauthenticated mode.
Because the information is stored in an internal format, to see the contents of the response file, use the emocmrsp -verbose
command.
Example Using -verbose Qualifier
This example displays the contents of a response file.
$ORACLE_HOME/ccr/bin/emocmrsp -verbose <response_file> OCM Installation Response Generator 10.3.8.0.0 - Production Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. Response file created: Jan 3, 2012 3:09:29 PM Created by: ssmith License agreement: accepted Connected configuration state: connected Proxy configuration: (none specified) Oracle Support Hub: http://host123.company.com:7654 Response file registration via: My Oracle Support username My Oracle Support registration username: ccrother@ssmith.com
Example Using -verify Qualifier
$ORACLE_HOME/ccr/bin/emocmrsp -verify <response_file> OCM Installation Response Generator 10.3.8.0.0 - Production Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. Configuration connectivity verified successfully.
For a given environment, the administrator installing Oracle Configuration Manager sets things so that all the parts of that environment are functioning properly. Part of that set up is determining the environment variables used in Oracle Configuration Manager.
To run the configuration collection, Oracle Configuration Manager needs to be in sync with the given environment. The emSnapshotEnv script (shell script on UNIX; Visual Basic script on Windows) captures the values of the environment variables required by Oracle Configuration Manager. The environment variables are listed in Table 5-1:
Table 5-1 Environment Variables Used in Oracle Configuration Manager
Environment Variable | Description | Used on UNIX | Used on Windows |
---|---|---|---|
|
Used for WebLogic Server |
yes |
yes |
|
Used for clustering |
yes |
yes |
|
Used for clustering |
yes |
yes |
|
Used for Oracle E-Business Suite |
yes |
no |
|
Must point to an appropriate JDK directory |
yes |
yes |
|
Used to define the location of instance-specific data in a shared home environment. |
yes |
yes |
|
This is the default. |
yes |
yes |
|
Used for WebLogic Server |
yes |
yes |
The diagnostic health check evaluation (Diagnostic Checks) feature performs diagnostic health checks against your installations and generates diagnostic results that are uploaded to Oracle. The Diagnostic Checks feature is included in the regular Oracle Configuration Manager configuration collection. Oracle Support uses these results to provide efficient and timely resolution to requests for assistance.
The Diagnostic Checks feature is enabled by default, however the associated package required to collect the diagnostic data is not available until you manually download it from Oracle. To use the Diagnostics Checks feature:
Download the Diagnostic Checks package from the location provided to you by your Oracle Support representative.
Copy the package to a directory on your system and deploy the package into your environment using the emCCR update_components -staged_dir
<location_of_package> command.
The package might require configuration. After the installation, run the configCCR -D -v
command to determine if there are properties to be configured. Running the emccr status
command after the first collection identifies that there are properties that need to be configured for a target diagnostic check collection. To configure properties, use the configCCR -D
command.
Perform a collection using the emCCR collect
command.
Diagnostic Checks information is collected and uploaded to Oracle.
The collector uses diagexclude_<target_type>.ini
files to determine if any diagnostics checks need to be excluded from a collection. Diagnostics checks can be excluded on a per target basis.To exclude certain diagnostics checks:
Copy
OCM_CONFIG_HOME/config/diagchecks_exclude/diagexclude.template file to OCM_CONFIG_HOME/config/diagchecks_exclude/diagexclude_<target_type>.ini file
Edit the diagexclude_<target_type>.ini
file.
The format of the diagexclude_<target_type>.ini
file is as follows:
excludeAll [ExcludedGroups] <GroupName1> <GroupName2> ... [ExcludedChecks] <CheckName1> <CheckName2> ...
where:
Fields | Description |
---|---|
excludeAll | Disables all diagnostic checks. When this field is present, all subsequent exclusions are ignored. This field is optional. |
ExcludedGroups | Section header for the names of the groups excluded for the target type |
GroupName1 | Name of the group. Group name is defined in the diagcheck metadata and script files located in the OCM_INSTALL_ROOT/diagchecks/<target_type> directory. |
ExcludedChecks | Section header for the names of the checks excluded for the target type |
CheckName1 | Name of the check. Check name is defined in the diagcheck metadata and script files located in the ccr_home/diagchecks/<target_type> directory. |
$ cat ccr/diagchecks/host/DiagMetadata.xml check1.xml check2.xml <?xml version="1.0" encoding="windows-1252" ?> <DiagMetadata TYPE="host" VERSION="1.0"> <DiagGroup NAME="group1" FILENAME="check1.xml"> </DiagGroup> <DiagGroup NAME="group2" FILENAME="check2.xml"> </DiagGroup> </DiagMetadata>
$ ls ccr/diagchecks/host/DiagMetadata.xml check1.xml check2.xml $ cat ccr/diagchecks/host/check2.xml <DiagnosticChecks> <DiagnosticCheck NAME="mycheck1"> ... </DiagnosticCheck> <DiagnosticCheck NAME="mycheck2">
Example of disabling a group and check
ccr_config_home/config/diagchecks_exclude/diagexclude_host.ini [ExcludedGroups] group2 [ExcludedChecks] mycheck1