1. Command Line Interface
  2. Verb Reference
  3. EM CLI Verbs
  4. configure_db_ha
  5. configure_db_ha -installSoftware

configure_db_ha -installSoftware

Installs the Recovery Manager (RMAN) backup module in the Oracle Homes or installs the Recovery Appliance file system backup agent on the hosts of one or more databases.

Format
emcli configure_db_ha –installSoftware
	(
	 (–target_name="<database target name>" –target_type="oracle_database|rac_database")
	 | input_file="target_list:<full pathname of input file>"
   )
	(
	 (–install_backup_module –module_type=”ra|cloud” [-force_install_backup_module]
	 [–db_host_cred="<database host named credential>"])
	 | (–install_fs_agent [–fs_agent_host_cred=”<host named credential>”]
	 [–fs_agent_install_directory=”<full pathname of OSB client installation directory>”])
	)
	[–staging_directory=”<full pathname where Backup Module and file system backup agent installation will be staged on database hosts>”]
	[–schedule=
		{                                            
		 start_time:yyyy/MM/dd HH:mm;               
		 tz:{java timezone ID};                                     
		}]

[ ]  indicates that the parameter is optional.    
Options
  • target_name

    A single-instance or cluster database target name, this operation is limited to one database. The Operation can be performed on multiple databases by using the -input_file option instead of -target_name/-target_type.

  • target_type

    The type of the target specified by –target_name, either a single–instance database (oracle_database) or a cluster database (rac_database).

  • input_file

    The input file that contains information for each database that is configured. This option is an alternative to –target_name/–target_type. The target_name and target_type lines are required for each database. The db_cred and db_host_cred lines are optional; if these are present for a database, they override the command-line named credential settings (if any) for that database. The following format is used while installing a backup module with the –install_backup_module option:

    target.0.target_name=<database #1 target name>
target.0.target_type=oracle_database|rac_database
target.0.db_host_cred=<database host named credential for database #1>
target.1.target_name=<database #1 target name>
target.1.target_type=oracle_database|rac_database
target.1.db_host_cred=<database host named credential for database #2>
    The following format is used while installing the file system backup agent with the install_fs_backup_agent:
    target.0.target_name=<database #1 target name>
target.0.target_type=oracle_database|rac_database
target.0.fs_agent_host_cred=<host named credential for the host(s) of database #1>
target.1.target_name=<databse #1 target name>
target.1.target_type=oracle_database|rac_database
target.1.fs_agent_host_cred=<host named credential for the host(s) of database #2>
  • install_backup_module

    Installs the version of the Backup Module (of the type specified by the –module_type argument) stored in the Enterprise Manager software library in the Oracle Homes of the specified target databases. By default, the module will be installed if there is no existing module in the database Oracle Home, unless the -force_install_backup_module flag is specified. This module cannot be specified in combination with –install_osb_client.

  • module_type

    The type of RMAN backup module to be installed. The possible values are: ra – Recovery Appliance Backup Module and cloud – Oracle Database Cloud Backup Module

  • force_install_backup_module

    Use in combination with -install_backup_module. Forces the installation of the backup module version stored in Enterprise Manager's software library into the Oracle homes of the specified target databases, regardless of whether there is an existing backup module installed in the Oracle homes. This will overwrite any existing backup module,this option should only be selected if it is known that the backup module version in the software library is the version desired to be installed on all the specified target databases. Not required, Default value does not force the install the backup module if there is an existing module in the database Oracle Home even if -install_backup_module is passed. Scope: Both

  • db_host_cred
    The name of an existing Enterprise Manager database host named credential that can be used to run operating system commands on the specified target database hosts. The credential should be for a user that has write permission for all Oracle Homes. If this argument is not specified,preferred credentials will be used. If multiple databases are specified, this should be a global named credential.

    Note:

    If the -input_file option is used, this option can be optionally overridden for individual databases.
  • install_fs_backup_agent

    Installs the file system backup agent on all hosts of the specified target databases.

  • fs_agent_host_cred

    The name of an existing Enterprise Manager host privileged named credential (not a database host credential) that can be used to perform the file system backup agent installation on all the hosts of the specified target databases. The credential should specify the root user or a user with root privilege delegation. If this argument is not specified, preferred credentials for the host targets associated with the databases is used. If multiple databases are specified, this should be a global named credential.

  • fs_agent_install_directory

    The directory where the file system backup agent is installed on all database hosts. The directory must exist on all the hosts. The default directory is /usr/local/oracle/backup.

  • staging_directory

    The full place-name where Backup Module and file system backup agent installation will be staged on database hosts.

  • schedule
    Schedule the deployment procedure. If this argument is not provided, the procedure will run immediately. Default value will schedule the procedure for immediate execution.
    • start_time: Time when the procedure has to start execution. The format should be "yyyy/MM/dd HH:mm"
    • tz: The timezone ID (optional)
    • frequency: Valid values are once/interval/weekly/monthly/yearly. If frequency is set to interval then repeat has to be specified. If frequency is set to yearly, both day and month have to specified.
    • repeat: Frequency with which the procedure has to be repeated. (Required only if frequency is set to interval)
    • days: A comma separated list of days. Required for weekly, monthly, or yearly frequency, if frequency is weekly the valid range is 1 to 7, If frequency is monthly or yearly the valid range is 1 to 30.
    • months: Comma separated list of months. Required only if frequency is yearly, valid range is 1 to 12.
    • end_time: End time for procedure executions. If it is not specified, the procedure will run indefinitely. Format should be "yyyy/MM/dd HH:mm"
    :
Example 1

The following example installs the Recovery Appliance Backup in the Oracle Home of one single-instance database “Finance”. It does not install the Backup Module if the module is already installed. This example uses named database and host credentials: 

	emcli configure_db_ha –installSoftware
	–target_name="Finance" –target_type="oracle_database" –db_host_cred="DB_HOST_USER"
	-install_backup_module –module_type=”ra”
Example 2

The following example installs the Oracle Database Cloud Backup Module in the Oracle Home of one RAC database “Finance”. It performs a forced installation if the module is already installed. This example uses named database host credentials:

	emcli configure_db_ha –installSoftware
	–target_name="Finance" –target_type="rac_database"
	–install_backup_module –module_type=”cloud” –force_install_backup_module –db_host_cred="DB_HOST_USER"
Example 3

The following example installs the Recovery Appliance file system backup agent on all cluster database nodes of one cluster database “Finance” in a non-default location. This example uses privileged host credentials:

	emcli configure_db_ha –installSoftware 
	–target_name="Finance" –target_type="rac_database"
	–install_osb_client –osb_install_directory=”/usr/local/osb12”
	–osb_host_cred=”HOST_PRIV_CRED”
Example 4

The following example installs the Recovery Appliance Backup Module in the Oracle Homes of multiple databases specified in the input file “/tmp/dblist”. It performs a forced installation if the module is already installed. This example uses preferred database host credentials. The operation scheduled for a future time as specified:

	emcli configure_db_ha –installSoftware
	–input_file="target_list:/tmp/dblist" –install_backup_module 
	–module_type=”ra” -force_install_backup_module
	-schedule="start_time:2016/06/28 18:31;tz:PST;"
Example 5

The following example installs the Recovery Appliance file system backup agent on all hosts of multiple databases specified in an input file in the default location. This example uses preferred privileged host credentials. The file system backup agent installation files are staged in a custom staging area location: 

	emcli configure_db_ha –installSoftware
	-install_fs_backup_agent -staging_director="tmp/stage"