Dbvisit Software version number in format 9.x.x

The version number is set automatically when creating a new DDC file or when upgrading an existing DDC file to a higher version

Example:

    DDC_VERSION = 9.0.0

ORATAB

If Linux (UNIX) based installations are used this parameter should be configured to point to your Oracle “oratab” file. 

This file is used by Dbvisit Standby to obtain the Oracle Software installation home (ORACLE_HOME) for the specified ORACLE_SID.

On Linux, the default location for this file is /etc/oratab but on other variations of UNIX such as Solars this location can be /var/opt/oracle/oratab

Example (Default) value:

ORATAB = /etc/oratab

COMPRESS

UNCOMPRESS

The UNCOMPRESS variable specifies the method that should be used to "uncompress" the archive logs.

The method specified for UNCOMPRESS should match similar compression setting as specified for the COMPRESS variable.

Possible values:

UCOMPRESS=dbvisit

UNCOMPRESS=/bin/gunzip

UNCOMPRESS=N

Recommended (default) values:

Linux:

COMPRESS=/bin/gunzip

Windows:

COMPRESS=dbvisit

The following un-compress options are available:

• Internal Dbvisit Standby Compression (dbvisit)
  This uses the zlib compression library is used to uncompress the archive log files. If COMPRESSION=dbvisit was set, it is required to set the UNCOMPRESS value to "dbvisit" as well.
  
  

• External Options (/bin/gunzip)
  Note: This option is Linux (Unix) only. 
  For Unix and Linux and alternate external compression methods (like gzip/gunzip or compress/uncompress) can also be specified. 
  Examples:  
  if you specified COMPRESS  = /bin/gzip then UNCOMPRESS= /bin/gunzip
  if you specified COMPRESS  = /usr/bin/compress then UNCOMPRESS=/usr/bin/uncompress
  
  

• Compression Disabled
  Use this option if the network speed is sufficiently fast to transfer uncompressed (archive) log files and disk space is sufficient to hold uncompressed files. 
  Set COMPRESS=N and UNCOMPRESS=N for no compression/uncompression. This is a default value.

ZIP_EXTENSION

The extension of the compressed file.

This depends on the compression method used. In most cases this is either:

    .gz (for gzip and Dbvisit Standby internal compression)

    .Z (for compress)

Example (default):

    ZIP_EXTENSION = .gz

This parameter must match Oracle database parameter db_name.

Example:

    DB_NAME = PROD

The path to the server environment.  The default settings should be fine for most environments and these values should not be changed unless instructed by Dbvisit Support.

Windows (default) example:

PATH = C:\WINDOWS;C:\WINDOWS\system32 

Linux (default) example:

PATH = /usr/bin:/bin:/usr/sbin:/usr/local/bin:/sbin

DBVISIT_BASE

Dbvisit software installation directory, also known as the DBVISIT_BASE directory.

Example (Linux Default):

    DBVISIT_BASE = /usr/dbvisit

Example (Windows Default):

    DBVISIT_BASE = c:\Program Files\dbvisit

SOURCE

The primary server on which the primary database is installed. Dbvisit Standby software must be installed on this server.

In a RAC environment use the name of a virtual server.

Example:

SOURCE = dbvlin101

ORACLE_HOME

Specify the Oracle Home of the primary database

Example:

ORACLE_HOME = /u01/app/oracle/product/11.2.0/prod

ORACLE_SID

Name of the Oracle instance on the primary server in a single instance environment.

Leave empty in a RAC environment.

An example in a single instance environment:

ORACLE_SID = PROD

Example when configured in RAC environment:

ORACLE_SID =

ORACLE_SID_ASM

Specifies the name of the ASM instance on the primary server in a single instance environment - if the primary database uses ASM.

If the primary database does not use ASM, leave empty.

Leave empty in a RAC environment.

Example (when using single instance environment running ASM):

ORACLE_SID_ASM = +ASM

Example (RAC):

ORACLE_SID_ASM =

LOGSWITCH

Determines if a database log switch - "alter system switch logfile" should be performed every time Dbvisit Standby executes on the primary database. A database log switch will start the background process to archive the current redo log.

Possible Values:

• N (default value)
  Dbvisit Standby will perform a database log switch ONLY when there are no new archive logs to transfer. If Dbvisit Standby is executed and an Archive log was generated since the last run, no log switch will be performed and the already created archive log will be transferred to the standby database. If no archive logs have been created since the last Dbvisit Standby execution, a log switch will be forced to start the generation of an archive log to be transferred.
  
  
• Y
  Dbvisit Standby will perform a database log switch every time it executes.

• I(ignore)
  Dbvisit Standby will never perform a database log switch.  Use this option with caution as Dbvisit Standby will not be able to guarantee how far behind in time the standby database is.  
  Only when Oracle performs a database log switch will Dbvisit Standby transfer the current archived redo log to the standby database.

If you are not sure, set to the default value which is "N".

Example:

    LOGSWITCH = N

A file system location on the primary server where archive logs will be transferred if this server becomes a standby one as a result of Graceful Switchover.

Prior to Graceful Switchover Dbvisit does not utilize this parameter.

Example:

   ARCHSOURCE = /u01/app/oracle/dbvisit/archive/PROD

If using ASM storage for the primary database, this will also be the directory on the primary server where Dbvisit Standby will extract the ASM archive log files to, before shipping them to the standby server.

Also, the ARCHTMP location must have full read/write permission for the user and group when ASM is used.

This parameter must match Oracle database parameter db_unique_name set in the primary database

Example:

  DB_UNIQUE_NAME = PROD

DBVISIT_BASE_DR

Dbvisit software installation directory. This is also known as the DBVISIT_BASE directory.

Example (Linux):

    DBVISIT_BASE = /usr/dbvisit

Example (Windows):

    DBVISIT_BASE = c:\Program Files\dbvisit

DESTINATION

Standby server on which the standby database is installed. Dbvisit Standby software must be installed on this server.

In a RAC environment use the name of a virtual server.

Example: 

    DESTINATION = dbvlin102

ORACLE_HOME_DR

Specify the Oracle Home of the standby database

Example:

ORACLE_HOME_DR = /u01/app/oracle/product/11.2.0/prod

ORACLE_SID_DR

Name of the Oracle instance on the standby server in a single instance environment.

Leave empty in a RAC environment.

Example in a single instance environment:

ORACLE_SID_DR = PRODDR

Example when configured in RAC environment:

ORACLE_SID_DR =

ORACLE_SID_ASM_DR

Specifies the name of the ASM instance on the standby server in a single instance environment if the standby database uses ASM.

If the standby database does not use ASM, leave empty.

Leave empty in a RAC environment.

Example (when using single instance environment running ASM):

ORACLE_SID_ASM_DR = +ASM

Example (RAC):

ORACLE_SID_ASM_DR =

NETPORT

Network listener port number. When using Dbvnet default port number is 7890. When using ssh default port number is 22.

Example:

NETPORT = 7890

NETPORT = 22

Note: If using SSH, it must be configured using password-less authentication.

ARCHDEST

LEAVE_COMPRESS_DR

Specifies whether the archive log files should be left compressed or not on the standby server AFTER being applied on the standby database.

Possible Values:

• Y
  Compress log AFTER being applied
  
  
• N
  Leave log uncompressed AFTER being applied

If you are not sure, set to N (default).

Example:

    LEAVE_COMPRESS_DR = Y

This parameter must match Oracle database parameter db_unique_name set in the standby database

Example:

  DB_UNIQUE_NAME_DR = PRODDR

Set to Y for Dbvisit to send emails from the primary server. The default is N.

Examples: 

SEND_MAIL_FLAG = Y

Set to Y for Dbvisit to send emails from the standby server. The default is N.

Examples: 

SEND_MAIL_FLAG_DR = Y

ADMINS

This variable holds the administrator email address where emails will be sent upon success or failure of Dbvisit Standby. Multiple emails should be separated with a comma (,). Also, see SUCCESS_MAILTO.

Examples: 

ADMINS = alert@mycompany.com

ADMINS = alert@mycompany.com,dba@mycompany.com

SUCCESSMAIL

Specifies when Dbvisit Standby should send an email from the primary server.

Possible Values:

• Y (default value)
  Every time Dbvisit Standby is run an email will be sent.

• N
  Only when an error occurs or a threshold is exceeded will an email be sent.  

Example (default) value:

SUCCESSMAIL = Y

SUCCESSMAIL_DR

Specifies when Dbvisit Standby should send an email from the standby server.

Possible Values:

• Y  (default value)
  Every time Dbvisit Standby is run an email will be sent.

• N
  Only when an error occurs or a threshold is exceeded will an email be sent. 

Example (default) value:

SUCCESSMAIL_DR = Y

MAILCFG_FROM

Specifies the FROM email address of the primary server. If this is not specified, the emails may not arrive.

Note that if you are using SSL/TLS SMTP server, the username used for the Authentication will become the FROM address.

Example:

MAILCFG_FROM = oracledba@dbvlin101.dbvisit.com

MAILCFG_FROM_DR

Specifies the FROM email address of the standby server. If this is not specified, the emails may not arrive.

Note that if you are using SSL/TLS SMTP server, the username used for the Authentication will become the FROM address.

Example:

MAILCFG_FROM_DR = oracledba@dbvlin102.dbvisit.com

MAILCFG_SMTP_SERVER

Specifies the SMTP server to send the email to. Is only used if the mail client is Dbvisit. Is not required when the mail client is Sendmail.

Examples:

If you are using Linux or Unix based systems, you can specify the SMTP server to be the localhost if it is allowed to relay email:

• • • MAILCFG_SMTP_SERVER = localhost

If you have a specific SMTP server, please specify it here. The default port used is 25 if you are using a different port make sure you update the MAILCFG_PORT parameter.

• • • MAILCFG_SMTP_SERVER = smtp.example.com
    • MAILCFG_SMTP_SERVER = mail.example.com

If you are using GMAIL (SSL/TLS) make sure that you specify MAILCFG_PROTOCOL=SSL and MAILCFG_PORT=465 (which is the default Gmail SMTP port) and make sure that you also specify your MAILCFG_AUTH_USER and MAILCFG_AUTH_PASSWD. Note that the MAILCFG_AUTH_USER will become the FROM email address.

• • • MAILCFG_SMTP_SERVER = smtp.gmail.com
  
  

MAILCFG_SMTP_SERVER_DR

Optional SMTP mail server for the standby server.

Only used if SMTP mail server for the standby server differs from the main SMTP mail server (MAILCFG_SMTP_SERVER).

Examples:

If you are using Linux or Unix based systems, you can specify the SMTP server to be the localhost, if it is allowed to relay email:

• • • MAILCFG_SMTP_SERVER = localhost

If you have a specific SMTP server, please specify it here. The default port used is 25 if you are using a different port make sure you update the MAILCFG_PORT parameter.

• • • MAILCFG_SMTP_SERVER = smtp.example.com
    • MAILCFG_SMTP_SERVER = mail.example.com

If you are using GMAIL (SSL/TLS) make sure that you specify MAILCFG_PROTOCOL=SSL and MAILCFG_PORT=465 (which is the default Gmail SMTP port) and make sure that you also specify your MAILCFG_AUTH_USER and MAILCFG_AUTH_PASSWD. Note that the MAILCFG_AUTH_USER will become the FROM email address.

• • • MAILCFG_SMTP_SERVER = smtp.gmail.com

MAILCFG_AUTH_USER

This parameter is used to specify a username required for SMTP authentication (username) on the primary server.

Examples:

MAILCFG_AUTH_USER=<your_username>

MAILCFG_AUTH_USER=admin

MAILCFG_AUTH_USER_DR

This parameter is used to specify a username required for SMTP authentication (username) on the standby server

Examples:

MAILCFG_AUTH_USER_DR=<your_username>

MAILCFG_AUTH_USER_DR=admin

_MAILCFG_AUTH_PASSWD

This variable is used to specify the password required for SMTP authentication (password) on the primary server

Example:

_MAILCFG_AUTH_PASSWD=<your_password>

_MAILCFG_AUTH_PASSWD=adminpassword

_MAILCFG_AUTH_PASSWD_DR

This variable is used to specify the password required for SMTP authentication (password) on the standby server

Example:

_MAILCFG_AUTH_PASSWD_DR=<your_password>

_MAILCFG_AUTH_PASSWD_DR=adminpassword

MAILCFG_CC

Specify email address you want to cc Dbvisit Standby email alerts to.

Example:

MAILCFG_CC=admin@example.com

MAILCFG_BCC

Specify email address you want to bcc Dbvisit Standby email alerts to.

Example:

MAILCFG_BCC=admin@example.com

MAILCFG_ATTACH_TRACEFILE

This parameter is used to specify whether to attach trace files to error emails so that these can be forwarded to Dbvisit support.

Possible Values:

• Y (Default)
  Attach trace files with error email.
  
  
• N
  Trace files are not attached with error email.

It is advisable to initially set to Yes

Example:

MAILCFG_ATTACH_TRACEFILE=Y

MAILCFG_ATTACH_TRACEFILE_MAX_SIZE_IN_BYTES

This variable is used to specify a file size limit to attaching the trace file.

Example:

MAILCFG_ATTACH_TRACEFILE_MAX_SIZE_IN_BYTES = 768000

MAILCFG_PORT

This parameter allows you to specify another SMTP port on the primary server if the default is not used.

Example:

MAILCFG_PORT=25

If using GMAIL, make sure that you specify the correct port. The default is MAILCFG_PORT=465 for GMAIL SMTP server.

MAILCFG_PORT_DR

This parameter allows you to specify another SMTP port on the standby server if the default is not used.

Example:

MAILCFG_PORT_DR=25

If using GMAIL, make sure that you specify the correct port. The default is MAILCFG_PORT=465 for GMAIL SMTP server.

MAILCFG_DEBUG

Turn on smtp debug messages in the trace files. Possible values are 0 (default) or 1 (enable debug)

Example:

MAILCFG_DEBUG=1

MAILCFG_TIME_OUT

This parameter allows the option to specify SMTP timeout in seconds.

Example (default) value:

MAILCFG_TIME_OUT=60

This parameter should only be set if SSL/TLS is used.

Example, for Gmail (smtp.gmail.com) you can specify:

MAILCFG_PROTOCOL=SSL

If you are not using SSL/TLS, do not set this parameter in your DDC. If it is set to make sure it does not have any values assigned:

MAILCFG_PROTOCOL=

SUCCESS_MAILTO

This is used to separate the success emails from the failure emails. If set, then all successful Dbvisit Standby emails will be sent to this email address.

Failure or unsuccessful emails will be sent to the email address specified by ADMINS. If not set, then all emails will go to ADMINS.

Example:

    SUCCESS_MAILTO=success@mycompany.com

EMAIL_LOG_GAP_REPORT

Determines if the Dbvisit Standby log gap report will be emailed. When Dbvisit Standby is run with the inspect command (dbvisit -i) the Dbvisit Standby log gap report will be displayed.

Setting this to Yes will email this report to the email address specified by ADMINS. The Dbvisit Standby log gap report will always be written to the Dbvisit Standby Database Repository (DDR).

Possible Values:

• Y (Default Value)
  Email the Dbvisit Standby log gap report to the email address specified by ADMINS.
  
  
• N
  Do not email the Dbvisit Standby log gap report.

Example:

    EMAIL_LOG_GAP_REPORT=Y

MAILSUBJECT_PREFIX_HEARTBEAT

This variable can be used to set a prefix for the email subject line. This can then be used to set filtering rules for emails.

MAILSUBJECT_PREFIX_HEARTBEAT is for the Dbvisit Standby heartbeat email.

Example:

MAILSUBJECT_PREFIX_LOG_GAP_REPORT=51

The result will be:

"51 - Dbvisit report for PRODB: Transfer log gap: 0 Archive log gap: 0"

MAILSUBJECT_PREFIX_LOG_GAP_REPORT

This variable can be used to set a prefix for the email subject line. This can then be used to set filtering rules for emails.

MAILSUBJECT_PREFIX_HEARTBEAT is for the Dbvisit Standby Log Gap Report email.

Example:

MAILSUBJECT_PREFIX_LOG_GAP_REPORT=52

MAILSUBJECT_PREFIX_SUCCESSFUL

This variable can be used to set a prefix for the email subject line. This can then be used to set filtering rules for emails.

MAILSUBJECT_PREFIX_SUCCESSFUL is for the Dbvisit Standby Succesful email.

Example:

MAILSUBJECT_PREFIX_LOG_GAP_REPORT=53

SEND_HEARTBEAT

Determines if a daily heartbeat message is sent to ensure Dbvisit Standby is still scheduled on the primary server. 

Possible Values:

• Y
  Dbvisit Standby sends daily heartbeat email (default)
  
  
• N
  Dbvisit Standby will not send daily heartbeat email.

SEND_HEARTBEAT_DR

Determines if a daily heartbeat message is sent to ensure Dbvisit Standby is still scheduled on the standby server. 

Possible Values:

• Y
  Dbvisit Standby sends daily heartbeat email (default)
  
  
• N
  Dbvisit Standby will not send daily heartbeat email.

SEND_LOG_GAP_WITH_HEARTBEAT

Possible Values:

• Y
  Include the Dbvisit Standby log gap report in the daily heartbeat email that is sent from the primary server.
  
  
• N
  Do not include the Dbvisit Standby log gap report in the daily heartbeat email.

Default value: Y

Example:

    SEND_LOG_GAP_WITH_HEARTBEAT=Y

Note: This parameter is available only from Dbvisit Standby Release 9.0.18

This parameter redirects error messages to a particular email id specified. If the parameter is left blank (No email id specified), the email by default is sent to the email id's specified in ADMIN parameter.

Note: This parameter is available only from Dbvisit Standby Release 9.0.18

This parameter redirects Alert messages to the mail id specified. If not by default it is sent to ADMIN mail ID. 

Note: This parameter is available only from Dbvisit Standby Release 9.0.18

The log gap reports are sent to the email id specified in this parameter. If the parameter is left blank(No email id specified), the email by default is sent to the email id's specified in ADMIN.

EMAIL_LOG_GAP_REPORT must be set to Y for this parameter to be effective.

Note: This parameter is available only from Dbvisit Standby Release 9.0.18

The heartbeat emails are redirected to the email id specified in this parameter. If the parameter is left blank (No email id specified), the email by default is sent to the email id's specified in ADMIN parameter. The SEND_HEARBEAT and SEND_HEARTBEAT_DR must be set to Y 

ARCHSOURCE_MANAGEMENT

Specify if the AMM module to manage the archive log files are turned on or off on the primary server.

Possible Values:

• Y
  Enable the AMM module on the primary server.
  
  
• N (default)
  Disable the AMM module on the primary server.

Example:

ARCHSOURCE_MANAGEMENT= Y

DAYS_TO_KEEP_ARCHSOURCE

NUM_ARCHSOURCE_TO_KEEP

Specifies the number of archive log files to keep on the primary server. Log files greater than this number will be removed (oldest first).

To disable this setting, set to 0. If you are not sure, set to 0 (disable).

Example:

    NUM_ARCHSOURCE_TO_KEEP = 0

ARCHSOURCE_BACKUP_COUNT

Specify the number of times an archive log has to be backed up by RMAN before Dbvisit Standby deletes it from the primary server.

To disable this setting, set to 0 which is the default value.

Example:

ARCHSOURCE_BACKUP_COUNT = 0

THRESHOLD_ARCHSOURCE

Specifies the threshold in percentage (%) of how much disk space may be taken up by the archive log files on disk before an alert is triggered on the primary server. A value of 80 means at 80% space threshold is reached, an alert will be triggered.

Please specify threshold as an integer. 

Example:

    THRESHOLD_ARCHSOURCE = 80

FRA_THRESHOLD_ARCHSOURCE

Specifies the threshold in percentage (%) of how much FRA (flash/fast recovery area) space may be taken up by the archive log files on disk before an alert is triggered on the primary server. A value of 80 means at 80% FRA space threshold is reached, an alert will be triggered.

Please specify threshold as an integer. 

Example:

   FRA_ THRESHOLD_ARCHSOURCE = 80

DELETE_ARCHSOURCE_THRESHOLD

ARCHDEST_MANAGEMENT

Specifies if the AMM module to manage the archive log files is turned on or off on the standby server.

Possible Values:

• Y
  Enable the AMM module on the standby server.
  
  
• N (default)
  Disable the AMM module on the standby server.
  
  

If you are not sure, set to Yes.

Example:

    ARCHDEST_MANAGEMENT= Y

DAYS_TO_KEEP_ARCHDEST

NUM_ARCHDEST_TO_KEEP

Specifies the number of archive log files to keep on the standby server. Log files greater than this number will be removed (oldest first).

To disable this setting, set to 0. If you are not sure, set to 0 (disable).

Example:

NUM_ARCHDEST_TO_KEEP = 0

DELETE_ARCHDEST_THRESHOLD

THRESHOLD_ARCHDEST

SYS_LOGON

Dbvisit Standby does not require an Oracle password as it uses OS authentication by default. Example "connect / as sysdba".

However, these variables can be used to enable Dbvisit Standby to logon as an SYS user using the sysdba role. Example "connect sys/password as sysdba"

This may be required when SQLNET.AUTHENTICATION_SERVICES = (NTS) cannot be set or a password file cannot be used.

The SYS_LOGON variable enables or disables this feature.

Possible values are Y or N (default). If you are not sure, set to N or leave blank.

Example: 

SYS_LOGON = N

SYS_USER

Name of the user to logon to the database. It is recommended to use the "SYS" user when using these variables.

Is only affected if SYS_LOGON = Yes. If you are not sure leave it blank.

Example:

SYS_USER = sys

_SYS_PASSWD

SYS_LOGON_STRING

The logon string to the database. It is not recommended to change this from the default value "as sysdba". Only change this if instructed by Dbvisit Support.

Is only effective if SYS_LOGON = Y and SYS_USER are set.

The default value is "as sysdba"

Example:

SYS_LOGON_STRING = as sysdba

APPLY_DELAY_LAG_MINUTES

By default, Dbvisit Standby is making use of SQL commands to perform standby database recovery.

The recover command is executed from SQL*Plus and the requested archive log is provided for recovery.

When running this in an Oracle RAC environment, where the standby database will need to recover using multiple threads, the recovery process - especially in busy systems or systems where many archive logs needs to be applied,

can take longer than it would, if as an alternative the recovery process is making use of RMAN recovery commands.

To enable the use of RMAN recovery commands on the standby database to perform recovery, set APPLY_ARCHIVE_RMAN=Y in the DDC file.

The default value is APPLY_ARCHIVE_RMAN=N

This parameter will only have an effect on the standby database.

The archive logs will still be shipped to the standby database and located in the Dbvisit Standby ARCHDEST. From here when Dbvisit Standby is executed on the standby database,

the archive logs will be catalogued in the controlfile and then applied using RMAN recovery commands. This process does require that the archive logs on the standby be uncompressed in the ARCHDEST, which will require more storage for the ARCHDEST to hold the uncompressed archive logs.

Setting APPLY_ARCHIVE_RMAN=Y can be used for non-RAC databases as well.

ARCHTMP

Specifies a temporary location on the primary server to copy archives from ASM before shipping them to the standby, in case of an ASM primary database. 

Defaults to ARCHSOURCE /ARCHDEST

If using ASM storage for the primary database, this will also be the directory on the primary server where Dbvisit Standby will extract the ASM archive log files to, before shipping them to the standby server.

Also, the ARCHTMP location must have full read/write permission for the user and group when ASM is used.

ARCHIVE_LOG_GAP_THRESHOLD

Dbvisit Standby will generate an alert if the log gap from the Dbvisit Standby "log gap report" (can be run with the command: dbvisit -i) exceeds this specified value.

Set to 0 to turn off 

Note: The "Archive Log Gap" is the difference between the last archived sequence on the primary and the last applied sequence on the standby database. The archive log gap should be near 0 (except when APPLY_DELAY_LAG_MINUTES is used).

Specifies cascading database configuration when the source database is a standby database

Defaults to N

Example:

    CASCADE=Y

COMPARE_CHECKSUM

Determines if Dbvisit Standby will perform a checksum and compare the checksum on the file that has been transferred. If the checksum is not the same, Dbvisit Standby will alert. 

Possible Values:

• Y
  Dbvisit Standby will calculate the checksum on the file being transferred and will alert if the transferred file is not the same as the original file.  
  
  
• N
  Dbvisit Standby will not perform a checksum. It is not guaranteed that the transferred file will be the same as the original file.  

Default value: N

Example:

    COMPARE_CHECKSUM=Y

 If the checksum is enabled and checksum difference detected during transfer, dbvctl will fail with an error referring to checksum difference"

CP

External copy method, to transfer the (archive) log files from the source server to the standby server. 

It is recommended to use a secure copy method (SCP).

The external copy method must be configured so that no password or passphrase is required.

Set this parameter when not using Dbvnet.

Example:

    CP = /usr/bin/scp

DAYS_TO_KEEP_TRACE

Dbvisit debug level

Defaults to 1

Set to 0 to turn tracing of (not recommended)
Set to 1 for standard tracing
Set to 2 for extended tracing

Example:

    DBVISIT_DEBUG=2

HOSTNAME_CMD

If Dbvisit Standby is part of a cluster and a different hostname should be used instead of the regular hostname returned by the current server, then this variable can be used to specify a command to set the source hostname for Dbvisit Standby. 

For example, When Dbvisit Standby is used in a cluster and the virtual cluster name should be used instead of the physical hostname.

Example:

HOSTNAME_CMD=/usr/local/bin/hostname.sh

The above script can then contain the following:

#!/bin/bash

echo "server1"

The name "server1" should be able to resolve to an IP address. In case of a cluster configuration (example Oracle Fail-Safe), this name should resolve to the Cluster IP address.

If the HOSTNAME_CMD file is specified but does not exist on the server, then Dbvisit Standby ignores the HOSTNAME_CMD and uses the regular method to obtain the hostname of the server. This is useful if the standby server is a regular server and the default hostname is sufficient.

If Dbvisit Standby is part of a cluster and a different hostname should be used instead of the regular hostname returned by the current server, then this variable can be used to specify a command to set the destination hostname for Dbvisit Standby. 

For example, When Dbvisit Standby is used in a cluster and the virtual cluster name should be used instead of the physical hostname.

Example:

HOSTNAME_CMD_DR=/usr/local/bin/hostname.sh

The above script can then contain the following:

#!/bin/bash

echo "server1"

The name "server1" should be able to resolve to an IP address. In case of a cluster configuration (example Oracle Fail-Safe), this name should resolve to the Cluster IP address.

If the HOSTNAME_CMD_DR file is specified but does not exist on the server, then Dbvisit Standby ignores the HOSTNAME_CMD_DR and uses the regular method to obtain the hostname of the server. This is useful if the standby server is a regular server and the default hostname is sufficient.

Comma separated list of tasks to be shown in GUI

Default value: CSD,SYNC,ACTIONS,FUNCTIONS

CSD - Create Standby database
SYNC - Synchronise Standby Database
ACTIONS - Database actions: start, stop, activate, switchover, open read only, upgrade, update DDC
FUNCTIONS - Selected functions (recreate standby control file, refresh standby datafile)
TRANSFER - Dbvisit transfer logs on the primary
APPLY - Dbvisit apply logs on the standby
Example:
    NTF_TASKS_SHOW = CSD,SYNC,ACTIONS,FUNCTIONS,TRANSFER,APPLY

NUM_TRACE_TO_KEEP

External remote shell method for Dbvisit Standby operation.  It is recommended to use SSH (secure shell).  The external remote shell method must be configured so that no password or pass phrase is required. 

Set this parameter when not using Dbvnet

Example:

RSH = /usr/bin/ssh

RUN_INSPECT

If this value is set (default is yes) Dbvisit Standby will Automatically run "dbvisit -i" command on the primary server every time Dbvisit executes.

The command "dbvisit -i" collects the archive and transfer log gap information from the standby database and saves this information for reporting purposes in the Dbvisit Standby repository.

This parameter can be set to "N" (No) which will disable the run of "dbvisit -i" command at the beginning of each Dbvisit Standby execution on the primary server.

This can improve the execution time of Dbvisit Standby on the primary server, but there will be no reporting information available in the Dbvisit Standby repository.

The default value is Y

RUN_INSPECT = Y

Determines if a daily heart beat message is sent from source server to ensure Dbvisit is still scheduled.

Y = Dbvisit sends daily heartbeat email.
N = Dbvisit will not send daily heartbeat email.

Warning: If set to N, you must have an alternative method to ensure Dbvisit is processing is active.

Determines if a daily heart beat message is sent from destination server to ensure Dbvisit is still scheduled.

Y = Dbvisit sends daily heartbeat email.
N = Dbvisit will not send daily heartbeat email.

Warning: If set to N, you must have an alternative method to ensure Dbvisit is processing is active.

SEND_HEARTBEAT_TIME24

This variable will indicate the time of the day the Heartbeat (Email) will be sent.

The Heartbeat is a daily email to Dbvisit Standby is active. This will be sent from the primary and standby server.

The time is in 24-hour format and should be between 0000 and 2359 and must be 4 digits. If this variable is not present, an email will be sent at the start of each day (midnight).

Multiple times separated by comma can be set. It is recommended that you also review the E-Mail setup variables.

Example:

SEND_HEARTBEAT_TIME24 = 0700

Example with multiple times specified:

SEND_HEARTBEAT_TIME24 = 0700:1300:1800

ARCHIVE_LOG_GAP_THRESHOLD is the difference between the last archived sequence on the primary and the last applied sequence on the standby database. The archive log gap should be near 0 (except when APPLY_DELAY_LAG_MINUTES is used). 

TRANSFER_LOG_GAP_THRESHOLD is the difference between the last archived sequence on the primary and the last sequence transferred to the standby server. The transfer log gap should be near 0.

The dbvisit -i <database> command must be scheduled for these settings to be effective.

Example:

ARCHIVE_LOG_GAP_THRESHOLD = 0

TRANSFER_LOG_GAP_THRESHOLD = 4

ALERT_IF_STDBY_READ_ONLY

When the standby database is in READ ONLY mode, the latest changes (archive logs) cannot be applied. This setting determines the action taken when Dbvisit Standby is executed on the standby server.

Possible Values:

• Y (Default Value)
  Dbvisit Standby will alert if the standby database is in READ ONLY mode and Dbvisit Standby is run to apply archive logs (Default).
  
  
• N
  Dbvisit Standby will NOT alert if the standby database is in READ ONLY mode and Dbvisit Standby is run to apply archive logs. Dbvisit Standby will exit normally with a message in the Dbvisit Standby log file.

Example:

ALERT_IF_STDBY_READ_ONLY=N

AMM_CHECK_TRANSFERRED

Dbvisit Archive Log Management Module (AMM) checks if an archive log has been transferred to the standby server(s) before deleting it. The default value for this parameter is "Y".

Example:

    AMM_CHECK_TRANSFERRED = Y

AMM_PROCESS_MULTIPLE_ARCH_DEST

Dbvisit Archive Log Management Module (AMM) processes multiple archive destinations when deleting logs on the primary server. Set this parameter to "N" to disable this functionality.

Example:

   AMM_PROCESS_MULTIPLE_ARCH_DEST = Y

As of 8.0.18, the parameter FORCE_USE_CKSUM_EXTERNAL was removed and not used.  It was not recommended to use this parameter.
External checksum utility will be used if CKSUM is set to a full path of this external utility.

Example:

CKSUM=/usr/bin/cksum

For multiple standby databases, Dbvisit AMM module checks if an archive log has been transferred to a standby server before deleting it if Dbvisit Standby has run at least once within the last DBV_LAST_RUN_OFFSET days

The default value is 1

DBV_PRE_POST_PROC_NAME

(This parameter was previously called as DBV_PRE_POST_PROC and has been changed to DBV_PRE_POST_PROC_NAME from Dbvisit Standby Version 9.0.18)

The name of the pre- and post-processing script.  If a different named script should be called, then this variable can be set. If no pathname is given the Dbvisit Standby install directory is assumed. 

Default value Windows: dbv_pre_post_processing.cmd

Default value Non Windows: dbv_pre_post_processing.sh

See the Pre- and post-processing section for more information.

Example:

    DBV_PRE_POST_PROC_NAME = rman_backup.cmd

May take values PARALLEL to enforce parallel recovery of the database, or NOPARALLEL to enforce serial recovery of the database.

If not specified then reset to NOPARALLEL for databases version 11.1 and higher

Defaults to none

Example:

DBV_RECOVERY_PARALLELISM = PARALLEL

Setting this to Y:

• Dbvisit Standby when executed on the primary, will initiate Dbvisit Standby on the standby server as the last step of running Dbvisit Standby on the primary server. 
• will mean Dbvisit Standby should no longer be scheduled on the standby server (as it is now initiated from the primary server). 

Dbvisit Standby will no longer function as two independent processes with independent alerting and a new strategy must be in place to ensure that notification is received in case of a failure. 

Warning: Only set this to Y if you understand the implications and make sure you test this in your specific configuration.

Possible Values are Y or N.

Example:

INITIATE_DBVISIT_ON_STANDBY=N

If Dbvisit Standby detects a lock on a file that it is trying to process, this parameter specifies the maximum wait in seconds Dbvisit Standby will retry the lock.

If the file is still locked after LOCK_MAX_TIME_SEC, then Dbvisit Standby will raise an alert.

Example:

LOCK_MAX_TIME_SEC=10

If Dbvisit Standby detects a lock on a file that it is trying to process, this parameter specifies the wait in milliseconds before Dbvisit Standby will attempt to access the file again. On some platforms the minimum timeout time may be 1 second.

Example:

LOCK_RETRY_TIMEOUT_MILLISEC=500

Dbvisit Standby log files are will automatically according to these settings.

LOG_FILE_ROTATE_MAX indicates how many backups are made of the log files before it is overwritten.

The first backup will be dbvisit_hist.log.1

The second backup will be dbvisit_hist.log.2

etc.

LOG_FILE_SIZE_MAX_MB indicates the size of the log file before the log file is rotated as above.                              

Example:

LOG_FILE_ROTATE_MAX = 5

LOG_FILE_SIZE_MAX_MB = 5

Wait in seconds to allow log switch to occur. If it is found that the archives are not yet completely written to when Dbvisit Standby tries to transfer them to the standby server, then this parameter may be increased. 

If Oracle has not completed the log switch before Dbvisit Standby attempts to compress and transfer the logs, Dbvisit Standby will raise an error message.

Default value: 3

Example:

    LOG_SWITCH_WAIT_IN_SEC=3

Specifies the number of times that Dbvisit Standby should attempt to apply the missing log file before raising an error.

Note this number is also used to raise an error if Dbvisit Standby cannot be started in case a previous scheduled Dbvisit Standby is still running.
Ensure that this number is not too low and not too high.

If you are unsure, set the value to 3 and increase to 6 or 9 as needed.

Example (default) value:
MAX_TIMES_TRIED = 3

Number of archive logs Dbvisit AMM module keeps on the server when deleting logs, regardless of AMM settings

The default value is 3

When the OS_ENV_VAR* is set, it will be set as an OS environment variable by dbvctl

OS_ENV_VAR1 Comma separated OS variable name,value to set on the Source
OS_ENV_VAR2 Comma separated OS variable name,value to set on the Source

OS_ENV_VAR1_DR Comma separated OS variable name,value to set on the Destination
OS_ENV_VAR2_DR Comma separated OS variable name,value to set on the Destination

Example:
    OS_ENV_VAR1 = A, 100
    Will set env var A to value 100 when executing dbvctl

    A = 100

Determines if Dbvisit Standby temporary files (.dbv) should be deleted after Dbvisit Standby processing. 

Possible Values:

• Y (Default Value)
  Dbvisit Standby temporary files will be deleted. 
  
  
• N
  Dbvisit Standby temporary files will NOT be deleted.

Example:

    REMOVE_TEMP_FILES=Y

Time in seconds to wait before performing another transfer if a previous transfer failed.

Default value: 5

Example:

    RETRIES_WAIT_IN_SEC=10

The CSD process is by default making use of RMAN (when direct transfer is not used).  To be more specific COMPRESSED BACKUPSET is used for the backups.  

In certain scenarios it might be required to adjust the backup option to not use compressed backups or to rather use image copies.  This can be done by setting the RMAN_DBF_BACKUP_TYPE parameter in the primary server DDC file.  This parameter can be set to specify if a backupset, compressed backupset or image copies are to be used during the CSD operation:

Valid options are:

RMAN_DBF_BACKUP_TYPE=AS BACKUPSET
RMAN_DBF_BACKUP_TYPE=AS COMPRESSED BACKUPSET
RMAN_DBF_BACKUP_TYPE=AS COPY

Allow for different secure shell (ssh) options.

For example (Unix/Linux):

    -l login_name

Specifies the user to log in as on the remote machine.  

See man ssh in Unix and Linux for ssh options.

See sexec on Windows for ssh options.

Example:

RSH_OPTIONS=-l oracle2

The variable has the default value of N.

If there are any services in the database running the value has to be set to Y by editing the DDC  either by using the GUI console or by using a text editor

This will result in adding a -f/force flag to the srvctl "stop instance" command to avoid below error.

Example:

If service is used in database check using the below command.

oracle@kiwi1[/home/oracle]: srvctl status service -d DEV -s DEVSRV
Service DEVSRV is running on instance(s) DEV1

If you see any service running change the value of the variable to Y

The variable has the default value of N.

If there are any services in the database running the value has to be set to Y by editing the DDC either by using the GUI console or by using a text editor

This will result in adding a -f/force flag to the srvctl "stop instance" command to avoid below error.

Example:

If service is used in database check using the below command.

oracle@kiwi1[/home/oracle]: srvctl status service -d DEV -s DEVSRV
Service DEVSRV is running on instance(s) DEV1

If you see any service running change the value of the variable to Y

Shows the timestamp in the trace file. There is no significant overhead in displaying the timestamp in the trace file.

Possible Values:

• Y
  Will show current timestamp on every line in the trace file. 
  
  
• N
  Will not show timestamp in the trace file.

Default value: Yes

Example:

    SHOW_TIME_IN_TRACE=Y

Determines when to show the trace file name. 

Possible Values:

• Y
  Will show trace file name in alerts, errors and success emails.
  
  
• N
  Will show trace file name in alerts and errors.

Default value: N

Example:

    SHOW_TRACEFILE_NAME=N

Specifies if windows service should be shut down when the standby database is shut down during creating of standby database and Graceful Switchover

Do not set or modify this setting if not instructed by Dbvisit Support.

The default value is N

Optional Parameter - This parameter is set by default to 5 and is used to timeout SSH idle connection.

Default is set to 5 seconds. This parameter can be changed in the DDC file.

Example:

    SSH_CONNECT_TIMEOUT=10

SSH_SKIP_OUTPUT

If the ssh connection contains an ssh banner, then Dbvisit Standby will not be able to interpret the data correctly. This setting can be used to tell Dbvisit Standby to ignore the ssh banner.

For example if the ssh banner is as follows:

*************************************************************************** 
 NOTICE TO USERS 
  
 This computer system is the private property of xxxxx.

 It is for authorized use only. Users (authorized or unauthorized) 
 have no explicit or implicit expectation of privacy. 
  
 By using this system, the user consents to such interception, monitoring, 
 recording, copying, auditing, inspection, and disclosure at the 
 discretion of such personnel or officials. Unauthorized or improper use 
 of this system may result in civil and criminal penalties and 
 administrative or disciplinary action, as appropriate. By continuing to 
 use this system you indicate your awareness of and consent to these terms 
 and conditions of use. LOG OFF IMMEDIATELY if you do not agree to the 
 conditions stated in this warning. 
 ****************************************************************************

Then the following can be set to ignore this:

Example:

SSH_SKIP_OUTPUT=***

This will skip the output lines beginning with *** and ending with ***

SSH_SKIP_OUTPUT_LINES

By setting this parameter to a number value, that number of lines will be ignored during ssh connections. 

Example:

If your ssh banner is 5 lines, you can specify:

SSH_SKIP_OUTPUT_LINES=5

The first 5 lines of ssh output (which will include the banner) will be skipped.

Optional Parameter - This parameter is not set by default in the DDC file and the default value will be used for the naming of the archive logs inside the Dbvisit ARCHDEST location on the standby database server.

Note: This is the format Dbvisit Standby will be using on the standby server inside the ARCHDEST location and is not related to the database archive log format.

The default archive log format in the Dbvisit Standby ARCHDEST is %t_%s_%r.arc ( "<thread>_<sequence>_<resetlogs_id>.arc"). If required the new parameter STANDBY_ARCHIVELOG_NAME can be set in the DDC to specify a new format.

Example if you want to set the format so that the database name PROD is in the archive log format name, you can set the following in the DDC file where you append the database name as part of the format:

STANDBY_ARCHIVELOG_NAME=PROD_%t_%s_%r.arc

Important - %t, %s and %r must be set.

Dbvisit Standby will be looking for logs with this format on the standby server during recovery. If your logs were in a different format, make sure they are renamed to the new format you specify - if you modify it.

The default value will be used if this parameter is not set in the DDC file (this is the recommended option)

SYNCH_DBVISIT_INSTALL

Determines the number of retries when the checksum of the transferred log file does not match the original file. When the checksum does not match, the file will be transferred again.

If the checksum does not match after TRANSFER_RETRIES attempts, an alert will be raised.

Default value: 2

Example:

    TRANSFER_RETRIES=2 

USE_LONG_SERVER_NAME

Dbvisit Standby uses short names for the primary and standby servers set by SOURCE and DESTINATION respectively.

To use fully qualified domain names for the SOURCE and DESTINATION settings set to Y.

Default value is N

Example:

USE_LONG_SERVER_NAMES = N

WIN_SERVICE_WAIT

How long in seconds to wait for the Windows Oracle service to start or stop before starting or stopping the database.

Default value: 10

Example:

    WIN_SERVICE_WAIT=10