Main Generic Settings

Owned by Anton Els (Unlicensed)
Last updated: Jun 23, 2016 by Donna Zehl (Unlicensed)
4 min read

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.

Variable Name

Variable Description

COMPRESS

The compression method 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 less 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=ssh

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.
  • SSH compression (ssh)
    NOTE: Can only be used if SSH is used instead of Dbvnet (Linux Only)
    This uses the zlib compression library to compress the files as they are being transferred to the standby server. This option is only available if ssh (secure shell) is being for the transfer method. 
    This will leave the files uncompressed on the server.  Set COMPRESS=ssh for ssh 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.

 

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) or secure ftp (sftp). 

The external copy method must be configured so that no password or pass phrase is required.  Only change this value if recommended by Dbvisit support.

Example:

    CP = /usr/bin/scp

 

DBVNET_PORT

Dbvnet network listener port number. If not defined (left with empty value) DBVNET will be disabled. 

Recommended (Default) Value:

DBVNET_PORT = 7890

To Disable Dbvnet:

DBVNET_PORT =

 

Note: If disabling Dbvnet, SSH must be used and configured using password-less authentication, as well as the SSH port must be set in the DDC file.


ORACLE_HOME

Specify the Oracle Home of the database (optional parameter)

In most cases this setting is not required as Dbvisit Standby can determine the ORACLE_HOME using the ORATAB file or Windows registry

 

ORACLE_SID

Name of the Oracle database for which these configuration variables apply. In a RAC environment, this will be the name of the instance.

Example in a single instance environment:

ORACLE_SID = PROD

Example when configured in RAC environment (node 1):

ORACLE_SID = PROD1

 

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

 

OWNER

The Operating System (OS) account that will run Dbvisit Standby. 

It is recommended that this be the same user as the Oracle database software owner.  This account must also exist on the standby database server.  In most environments the “oracle” user is used.

Example (Default) value:

OWNER = oracle

 

PATH

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

 

RSH

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.  Only change this value if recommended by Dbvisit support.

Example:

RSH = /usr/bin/ssh

 

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 colon 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

 

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=ssh

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.

  • SSH compression (ssh)
    NOTE: Can only be used if SSH is used instead of Dbvnet (Linux Only)
    This uses the zlib compression library to compress the files as they are being transferred to the standby server. This option is only available if ssh (secure shell) is being for the transfer method. 
    If COMPRESSION=ssh was set, it is required to set the UNCOMPRESS value to "ssh" 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

 

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