G Enterprise Manager Configuration Assistant (EMCA) Reference

This appendix contains the following topics:

About EMCA
- Overview
- Operational Notes
EMCA Command Reference

About EMCA

This section contains topics which relate to using the EMCA command-line interface.

Overview
Operational Notes

Overview

Enterprise Manager Configuration Assistant (EMCA) provides a command line interface for configuring Database Control. The primary method for configuring an existing Oracle Database 11g release 2 (11.2) database to be managed with Enterprise Manager Database Control is to use DBCA, but EMCA can be used if a non-graphical user interface is preferred.

WARNING:

During the database configuration using EMCA, the database will be unavailable and users cannot connect to the database or perform operations on the database.

Operational Notes

Usage Information

Every EMCA command can be used in Oracle RAC environments, and certain commands are applicable only in cluster setups. To perform cluster commands using EMCA, use the -cluster flag that is available in almost every EMCA operational mode.

EMCA commands are of the form:

emca [operation] [mode] [flags] [parameters]

For information on the current cluster configuration, you can run the following command:

emca -displayConfig dbcontrol –cluster

EMCA Parameters

Depending upon the parameters you include on the EMCA command line, EMCA prompts you for additional information required to configure Database Control.

Each EMCA command can include optional parameters to specify the additional information required by EMCA. Parameters used with EMCA are of the form [-parameterName parameterValue]. Multiple parameters can be used in combination at the command line. Table G-1 lists the optional parameters that can be used with EMCA:

Note:

You can view a list of the available parameters by entering emca -help at the command line.

Table G-1 EMCA Optional Command-Line Parameters

Parameter	Description
`-respFile`	Specifies the path of an input file listing parameters for EMCA to use while performing its configuration operation. For more information, refer to "Using an Input File for EMCA Parameters".
`-SID`	Database system identifier
`-PORT`	Port number for the listener servicing the database
`-ORACLE_HOME`	Database Oracle Home, as an absolute path
`-LISTENER_OH`	Oracle Home from where the listener is running. If the listener is running from an Oracle Home other than the one on which the database is running, then the parameter LISTENER_OH must be specified.
`-HOST_USER`	Host machine user name (for automatic backup)
`-HOST_USER_PWD`	Host machine user password (for automatic backup)
`-BACKUP_SCHEDULE`	Schedule in the form of "HH:MM" (for daily automatic backups)
`-EMAIL_ADDRESS`	E-mail address for notifications
`-MAIL_SERVER_NAME`	Outgoing Mail (SMTP) server for notifications
`-ASM_OH`	Oracle Automatic Storage Management Oracle Home
`-ASM_SID`	System identifier for Oracle ASM instance
`-ASM_PORT`	Port number for the listener servicing the Oracle ASM instance
`-ASM_USER_ROLE`	User role for connecting to the Oracle ASM instance
`-ASM_USER_NAME`	User name for connecting to the Oracle ASM instance
`-ASM_USER_PWD`	Password for connecting to the Oracle ASM instance
`-DBSNMP_PWD`	Password for DBSNMP user
`-SYSMAN_PWD`	Password for SYSMAN user
`-SYS_PWD`	Password for SYS user
`-SRC_OH`	Oracle Home of the database with Enterprise Manager configuration to be upgraded/restored
`-DBCONTROL_HTTP_PORT`	Use this parameter to specify the port you use to display the Database Control Console in your Web browser. For more information, refer to "Specifying the Ports Used By Database Control".
`-AGENT_PORT`	Use this parameter to specify the Management Agent port for Database Control. For more information, refer to "Specifying the Ports Used By Database Control".
`-RMI_PORT`	Use this parameter to specify the RMI port for Database Control. For more information, refer to "Specifying the Ports Used By Database Control".
`-JMS_PORT`	Use this parameter to specify the JMS port for Database Control. For more information, refer to "Specifying the Ports Used By Database Control".
`-CLUSTER_NAME`	Cluster name (for cluster databases)
`-DB_UNIQUE_NAME`	Database unique name (for cluster databases)
`-SERVICE_NAME`	Database service name (for cluster databases)
`-EM_NODE`	Node from which Database Control console is to be run (for cluster databases). For more information, refer to "Reconfiguring Existing Database Control Configurations on Remote Nodes".
`-EM_NODE_LIST`	Comma-separated list of nodes for agent-only configurations, uploading data to –EM_NODE. For more information, refer to "Reconfiguring Existing Database Control Configurations on Remote Nodes".

Using Tool/Utility Help

To see a list of EMCA options, start EMCA using any of the following commands:

emca -h
emca --h
emca -help
emca --help

These commands display the Help message for the EMCA utility. It also lists the command arguments described in Table G-2, and the optional parameters described in Table G-1.

EMCA Command Reference

Table G-2 EMCA Commands

Command	Description
addInst	Configures Enterprise Manager for a new cluster instance of a database or Oracle ASM storage.
addNode	Configures Enterprise Manager for a new cluster instance of a database or Oracle ASM storage
config all db	Configures both Database Control and central agent management for a database.
config centralAgent	Configures central agent management for a database or an Oracle Automatic Storage Management (Oracle ASM) instance.
config dbcontrol db	Configures Database Control for a database.
deconfig all db	Deconfigures both Database Control and central agent management for a database.
deconfig centralAgent	Deconfigures central agent management for a database or an Oracle ASM instance.
deconfig dbcontrol db	Deconfigures Database Control for a database.
deleteInst	Deconfigures Enterprise Manager for a specific instance of a cluster database or Oracle ASM storage.
deleteNode	Deconfigures Enterprise Manager for a node getting deleted.
displayConfig dbcontrol	Displays information about the current deployment configuration of Database Control in a cluster environment.
reconfig dbcontrol	Reconfigures Database Control deployment for a cluster database.
reconfig ports	Explicitly reassigns Database Control ports.
restore	Restores the current version of Enterprise Manager configuration to an earlier version.
upgrade	Upgrades the configuration of an earlier version of Enterprise Manager to the current version.
version	Prints the version information associated with EMCA

addInst

Use this command to configure Enterprise Manager for a new cluster instance of a database or Oracle ASM.

Syntax

emca -addInst (db | asm) [-silent] [parameters]

Parameters

Table G-3 addInst Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases). Use this option for databases that use Oracle Automatic Storage Management (Oracle ASM) to store the data files. If a database is using Oracle ASM, then all the EMCA configuration commands (except for "-upgrade" and "-restore") detect this automatically and apply the changes to both the database and Oracle ASM instance(s).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

addNode

Use this command to configure Enterprise Manager for a new cluster instance of a database or Oracle ASM.

For more information, refer to "Understanding EMCA with Oracle RAC".

Syntax

emca -addNode (db | asm) [-silent] [parameters]

Parameters

Table G-4 addNode Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases). Use this option for databases that use Oracle Automatic Storage Management (Oracle ASM) to store the data files. If a database is using Oracle ASM, then all the EMCA configuration commands (except for "-upgrade" and "-restore") detect this automatically and apply the changes to both the database and Oracle ASM instance(s).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

Examples

This command is discussed further in the section "Updating Database Control Configuration When Adding and Removing Nodes".

config all db

Use this command to configure both Database Control and central agent management for a database. Options include creating (or recreating) the Database Control repository, configuring automatic backups, and performing these operations on a cluster database.

This operation will configure the database so that it can be centrally managed by the Oracle Enterprise Manager 10g Grid Control Console. To use this option, you must have previously installed the Oracle Management Service component of Enterprise Manager on a network host. In addition, the Oracle Management Agent must be installed on the host where you are running the database.

Syntax

emca -config all db [-repos (create | recreate)] [-cluster] [-silent] 
     [-backup] [parameters]

Parameters

Table G-5 config all db Options

Parameter	Description
`-repos create`	Creates a new Database Control management repository
`-repos recreate`	Drops the current Database Control management repository and then recreates a new one
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

config centralAgent

Use this command to configure a central agent management for a database or an Oracle Automatic Storage Management (Oracle ASM) instance. Options include performing this operation on a cluster environment.

Syntax

emca -config centralAgent (db | asm) [-cluster] [-silent] [parameters]

Parameters

Table G-6 config centralAgent Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases). Use this option for databases that use Oracle Automatic Storage Management (Oracle ASM) to store the data files. If a database is using Oracle ASM, then all the EMCA configuration commands (except for "-upgrade" and "-restore") detect this automatically and apply the changes to both the database and Oracle ASM instance(s).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

config dbcontrol db

Use this command to configure Enterprise Management Database Control for a database. Options include creating (or recreating) Database Control repository, configuring automatic backups, and performing these operations on a cluster database.

Syntax

emca -config dbcontrol db [-repos (create | recreate)] [-cluster] [-silent]
     [-backup] [parameters]

Options

Table G-7 config dbcontrol Options

Parameter	Description
`-repos create`	Creates a new Database Control management repository
`-repos recreate`	Drops the current Database Control management repository and then recreates a new one
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`-backup`	Configures automatic backup for a database. EMCA will prompt for daily automatic backup options. The default Enterprise Manager settings will be used to backup the database files. If you use this option, then EMCA will use the value of the `db_recovery_file_dest` initialization parameter to identify the flashback recovery area for the automated backups. If that parameter is not set, then EMCA will generate an error. You can modify these settings later using the Maintenance page in Database Control.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

Examples

Example 1 Configuring Database Control for a single Oracle ASM instance

To configure Database Console for single instance database using Oracle ASM, simply run the following command to configure the Database Console which will automatically detect the Oracle ASM instance:

emca -config dbcontrol db -repos create

Example 2 Configuring automatic backups of your database

Enter the following command to configure Database Control so it will perform automatic daily backups of your database:

emca -config dbcontrol db -backup

deconfig all db

Deconfigures both Database Control and central agent management for a database. Options include dropping the Database Control repository and performing these operations on a cluster database.

Syntax

emca -deconfig all db [-repos drop] [-cluster] [-silent] [parameters]

Parameters

Table G-8 deconfig all db Options

Parameter	Description
`-repos drop`	Drops the current Database Control management repository.
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

deconfig centralAgent

Use this command to deconfigure the central agent management for a database or an Oracle ASM instance. Options include performing this operation on a cluster environment.

For example, you might use this command to remove the central agent management configuration from a database you are planning to delete. In such a scenario, remove the central agent management configuration before physically deleting the database. This operation does not remove the actual database or its data files.

Syntax

emca -deconfig centralAgent (db | asm) [-cluster] [-silent] [parameters]

Parameters

Table G-9 deconfig centralAgent Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases). Use this option for databases that use Oracle Automatic Storage Management (Oracle ASM) to store the data files. If a database is using Oracle ASM, then all the EMCA configuration commands (except for "-upgrade" and "-restore") detect this automatically and apply the changes to both the database and Oracle ASM instance(s).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

Examples

Example 1 Removing the central agent management configuration from a database being deleted

If you are planning to delete the testdb database, then you would use a command similar to the following to remove the central agent management configuration before physically deleting the database:

emca -deconfig centralAgent db -ORACLE_HOME /u01/app/oracle/10.2/db1
-SID testdb

deconfig dbcontrol db

Use this command to deconfigure Database Control for a database. Options include dropping the Database Control repository and performing these operations on a cluster database.

This operation does not remove the actual database or its data files

Syntax

emca -deconfig dbcontrol db [-repos drop] [-cluster] [-silent] [parameters]

Parameters

Table G-10 deconfig dbcontrol db Options

Parameter	Description
`-repos drop`	Drops the current Database Control management repository.
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

Examples

Example 1 Removing the Database Control configuration from a database being deleted

If you are planning to delete the testdb database, then you would use a command similar to the following to remove the Database Control configuration before physically deleting the database:

emca -deconfig dbcontrol db -repos drop -ORACLE_HOME /u01/app/oracle/10.2/db1
-SID testdb

deleteInst

Use this command to deconfigure Enterprise Manager for a specific instance of a cluster database or Oracle ASM.

Syntax

emca -deleteInst (db | asm) [-silent] [parameters]

Parameters

Table G-11 deleteInst Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases). Use this option for databases that use Oracle Automatic Storage Management (Oracle ASM) to store the data files. If a database is using Oracle ASM, then all the EMCA configuration commands (except for "-upgrade" and "-restore") detect this automatically and apply the changes to both the database and Oracle ASM instance(s).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

deleteNode

Use this command to deconfigure Enterprise Manager for a node being deleted. For more information, refer to "Understanding EMCA with Oracle RAC".

Syntax

emca -deleteNode (db | asm) [-silent] [parameters]

Parameters

Table G-12 deleteNode Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases). Use this option for databases that use Oracle Automatic Storage Management (Oracle ASM) to store the data files. If a database is using Oracle ASM, then all the EMCA configuration commands (except for "-upgrade" and "-restore") detect this automatically and apply the changes to both the database and Oracle ASM instance(s).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

Examples

This command is discussed further in the section "Updating Database Control Configuration When Adding and Removing Nodes".

displayConfig dbcontrol

Use this command to display information about the current deployment configuration of Database Control in a cluster environment. This command must be used with the -cluster option.

Syntax

emca -displayConfig dbcontrol -cluster [-silent] [parameters]

Parameters

Table G-13 displayConfig dbcontrol Options

Parameter Description

-cluster

Performs the operation for a cluster database or Oracle ASM instance

-silent

Performs the operation without prompting for additional information.

If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the –respFile argument. See "Using an Input File for EMCA Parameters" for more information.

parameters

See Table G-1, "EMCA Optional Command-Line Parameters"

reconfig dbcontrol

Use this command to reconfigure Database Control deployment for a cluster database. This command must be used with the -cluster option.

Syntax

emca -reconfig dbcontrol -cluster [-silent] [parameters]

Parameters

Table G-14 reconfig dbcontrol Options

Parameter Description

-cluster

Performs the operation for a cluster database or Oracle ASM instance

-silent

Performs the operation without prompting for additional information.

parameters

See Table G-1, "EMCA Optional Command-Line Parameters"

Examples

This command is discussed further in the section "Reconfiguring Existing Database Control Configurations on Remote Nodes".

reconfig ports

Use this command to explicitly reassign Database Control ports. Options include performing this operation on a cluster environment.

Syntax

emca -reconfig ports [-cluster] [parameters]

Parameters

Table G-15 reconfig ports Options

Parameter	Description
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

Examples

This command is discussed further in the section "Specifying the Ports Used By Database Control".

restore

Use this command to restore the current version of Enterprise Manager configuration to an earlier version. This is the inverse of the -upgrade command. Executing this command reverses any changes that resulted from an -upgrade operation. This operation can be performed for database, Oracle ASM, or database and Oracle ASM instances together simultaneously.

Syntax

emca -restore (db | asm | db_asm) [-cluster] [-silent] [parameters]

Parameters

Table G-16 restore Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`db_asm`	Performs the restore operation for a database and an Oracle ASM instance together. Restoring an Oracle ASM instance does not require restoring the database instances it services. Therefore, the Enterprise Manager configuration can be restored separately for a database and its respective Oracle ASM instance.
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

upgrade

Use this command to upgrade the configuration of an earlier version of Enterprise Manager to the current version. This operation can be performed for database, Oracle ASM, or database and Oracle ASM instances together simultaneously.

This command does not upgrade the actual database or Oracle ASM instances, nor does it upgrade the Enterprise Manager software. Instead, it upgrades the configuration files for the specified instance so that they are compatible with the current version of the Enterprise Manager software. EMCA attempts to upgrade all instances of the specified database or Oracle ASM target on the host, across all Oracle homes (because it is likely that certain target properties, such as listener port or Oracle home, have changed).

Syntax

emca -upgrade (db | asm | db_asm) [-cluster] [-silent] [parameters]

Parameters

Table G-17 upgrade Options

Parameter	Description
`db`	Performs the operation for a database (including cluster databases).
`asm`	Performs the operation for an Oracle ASM-only instance (including cluster Oracle ASM instances)
`db_asm`	Performs the upgrade operation for a database and an Oracle ASM instance together. Upgrading an Oracle ASM instance does not require upgrading the database instances it services. Therefore, the Enterprise Manager configuration can be upgraded separately for a database and its respective Oracle ASM instance.
`-cluster`	Performs the operation for a cluster database or Oracle ASM instance
`-silent`	Performs the operation without prompting for additional information. If this mode is specified, then all the required parameters must be entered at the command line or specified in an input file using the `–respFile` argument. See "Using an Input File for EMCA Parameters" for more information.
`parameters`	See Table G-1, "EMCA Optional Command-Line Parameters"

version

Use this command to print the version information associated with EMCA.

Syntax

emca -version