DDC File Reference

DDC File Reference



1. Introduction

This section will contain a detail reference of the Dbvisit Standby Configuration (DDC) file variables.

The default settings in a DDC file should work for most environments. Changing or adding new values is not recommended unless you are familiar with the effect of setting these parameters.  Testing parameter changes in a test environment are recommended prior to making any changes in production.



2.  Main Generic Settings

The table below is providing you with a list of the Generic Settings you will find in the Dbvisit Standby Configuration (DDC) file.

Variables are sorted alphabetically in the table below.

Note also that that by design we do not allow editing or adding all variables via the GUI or CLI. The DDC is a plain text file and we recommend add / update / remove values manually as required - in 99% of the cases, this is faster and much easier.



For databases where Dbvisit daemon is used for scheduling archive send and apply, the daemon needs to be restarted after any change to the configuration in DDC file. Any parameter changes made to DDC file will not be effective for the daemon until it is restarted.

Variable Name

Variable Description

Variable Name

Variable Description

DBVISIT_FULLVERSION

Dbvisit Software version number in format 8.x.xx.xxxxx

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

Example:

    DBVISIT_FULLVERSION = 8.0.01.17739

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

The compression method is used to compress the (archive) log files. It is recommended to make use of COMPRESS and UNCOMPRESS options, as this can assist with faster network transfer time as fewer data will be transferred between the primary and standby servers.

Setting compression using this variable only affects the Archive logs being shipped between the primary and standby servers.

The COMPRESS and UNCOMPRESS variables should both be configured to similar compression options. For more details see the UNCOMPRESS variable below



Possible values:

COMPRESS=dbvisit

COMPRESS=/bin/gzip

COMPRESS=N

Recommended (default) values:

Linux:

COMPRESS=/bin/gzip

Windows:

COMPRESS=dbvisit



The following compression options are available:

  • Internal Dbvisit Standby Compression (dbvisit)
    This uses the zlib compression library. Dbvisit Standby will compress the archives on disk first before transferring to the standby server. 
    This will leave the files on the server in a compressed state. Set COMPRESS=dbvisit for Dbvisit Standby internal compression.

  • External Options (/bin/gzip)
    Note: This option is Linux (Unix) only. 
    For Unix and Linux and alternate external compression method (like gzip or compress) can also be specified. 
    Examples:  
    COMPRESS  = /bin/gzip
    COMPRESS  = /usr/bin/compress
    Note: It is recommended to disable any other compression routines used outside Dbvisit Standby that compress the Oracle (archive) log files.

  • 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=No for no compression. This is a default value.

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



PATH

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



DB_NAME

This parameter must match Oracle database parameter db_name.

Example:

    DB_NAME = PROD





3.  Primary Server Settings

This section is specific to the Primary Server settings used in the Dbvisit Standby Configuration file.

Variables are sorted alphabetically in the table below

Variable Name

Variable Description

Variable Name

Variable Description

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



ARCHSOURCE

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



DB_UNIQUE_NAME

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

Example:

  DB_UNIQUE_NAME = PROD





4.  Standby Server Settings

This section is specific to the Standby Server settings in the Dbvisit Standby Configuration (DDC) file.

Variables are sorted alphabetically in the table below

Variable Name

Meaning

Variable Name

Meaning

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

This directory is extremely important to Dbvisit Standby and should not be mistaken for the Oracle Database archive destination or recovery area. This location is used only by Dbvisit Standby and should never be the same location as any of the Oracle database archive destinations or the recovery area (FRA). This location (directory) should exist on the standby database server and should have sufficient space to hold at least 1 days worth of archive logs with 3 or more days recommended.

Note this does not have to be the same location as the log_archive_dest or log_archive_dest_<n> parameter in the database.

This is where Dbvisit Standby will place archive log files on the standby server from where they will be applied.

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.

If you need to use a location to temporary copy archives different from the location on the standby server specified by ARCHDEST, you may specify a different location using ARCHTMP variable



Please ensure this directory is not used for any other files other than (archive) log files for this specific database. 

Example:

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

    Where PROD is the name of the database



Please note that the Archive Logs from the primary server will be copied to the ARCHDEST location on the standby server. During this process the archive logs will be renamed to the following format:

<STANDBY_ARCHIVELOG_NAME> which is by default '%t_%s_%r.arc'

%t thread number

%s sequence number

%r resetlogs_id

example: 1_45628_ 812975118.arc



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



DB_UNIQUE_NAME_DR

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

Example:

  DB_UNIQUE_NAME_DR = PRODDR



5.  E-Mail Settings

5.1.  General E-mail Configuration Variables

Variable Name

Meaning

Variable Name

Meaning

SEND_MAIL_FLAG

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

Examples: 

SEND_MAIL_FLAG = Y



SEND_MAIL_FLAG_DR

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.

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_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.



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.





5.2.  Advanced Mail Settings

This section will cover the more advanced E-mail configuration settings available in the Dbvisit Standby configuration file (DDC).



Variable Name

Meaning

Variable Name

Meaning

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>