This page contains complete overview of 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.
Before modifying any parameter please check the Notes:
Not supported to edit = you’re not supposed to edit these variables because it can break the product functionality and we won’t support configurations with modifications of these parameters. These parameters are listed only for purpose to provide you with complete reference.
Not recommended to edit = we’re not aware of any customers who are using non-default values of this parameter. Non-default values may work, but are not tested by us.
Edit with care = it is possible to adjust this variable, you can however experience issues if this variable isn’t set correctly. Contact Dbvisit support if not sure.
1. Default DDC Parameters
These parameters are present in DDC by default after its creation.
Variable Name | Variable Description | Possible Values | Notes |
|---|---|---|---|
GENERIC SETTINGS | |||
LICENSE_KEY | License key value | Automatically Specified During DDC creation | Not recommended to edit |
DDC_VERSION | DDC Version. | Automatically Specified During DDC creation | Not recommended to edit |
ORATAB | Location of oratab file on the system | /etc/oratab | Not supported to edit |
COMPRESS | Specifies whether compression method is used to compress the (archive) log files and online redo file during switchover. Enable only if network speed isn’t sufficient for transferring archivelogs generated by your primary database in time to sync the standby database. The COMPRESS and UNCOMPRESS variables should both be configured to same compression values. Note: It is recommended to disable any other compression routines used outside Dbvisit Standby that compress the Oracle (archive) log files. | N (default = disabled) dbvisit /bin/gzip Note: This option is Linux (Unix) only.
| Enable only in slow network environments |
UNCOMPRESS | See COMPRESS Description | N | Enable only in slow network environments |
ZIP_EXTENSION | The extension of the compressed file. This depends on the compression method used. | .gz (default) | Not recommended to edit |
DB_NAME | db_name of your primary database as shown by “SQL> sho parameter db_name;”. Primary and standby db_name must always match. | Automatically Specified During DDC creation | |
PRIMARY SERVER SETTINGS | |||
OS | Unused | Not supported to edit | |
PATH | Default Path value for Linux and Windows | Automatically Specified During DDC creation | Not supported to edit |
DBVISIT_BASE | Installation path of Dbvisit StandbyMP software on primary host. Typically /usr/dbvisit or C:\Program Files\Dbvisit | Automatically Specified During DDC creation | Edit with care |
SOURCE | Hostname of PRIMARY server. The value must exactly match with “HostAddress” parameter in dbvagentmanager.ini on the host | Automatically Specified During DDC creation | Edit with care |
ORACLE_SID | ORACLE_SID of your primary database instance Note that incorrect setting may cause Dbvisit to not recognize the database | Automatically Specified During DDC creation | |
ORACLE_HOME | ORACLE_HOME on your primary server | Automatically Specified During DDC creation | |
ORACLE_SID_ASM | ORACLE_SID of your primary ASM instance, empty if no ASM is used and empty for SEHA/RAC deployments | +ASM, +ASM1 | |
NETPORT | Port for dbvagentmanager transfer, as specified by FileTransferListenPort in dbvagentmanager.ini on primary server | 7890 | |
ARCHSOURCE | Staging archivelog location on primary server used for archivelog transfer to standby. For example when copying archivelogs from ASM to local filesystem. All files are deleted after the transfer is finished. As result, this directory should be always empty on primary server | Automatically Specified During DDC creation | |
LOGSWITCH | Determines if a database log switch - "alter system switch logfile" should be performed every time Dbvisit Standby ASU run is executed (defined by ASU interval) on primary database Example: LOGSWITCH = N | N (default) 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 I | |
DB_UNIQUE_NAME | This parameter must match Oracle database parameter db_unique_name set in the primary database. Note that incorrect setting may cause Dbvisit to not recognize the database. | Automatically Specified During DDC creation | |
BCKDIR | When adding new PDB on primary (and while PDB_SYNC is set to Y) this parameter defines in which directory Dbvisit will create PDB backup which is used for synchronizing the PDB to standby database. | [DBVISIT_BASE]/standbymp/oracle/backup | |
PRIMARY RAC SETTINGS | |||
RAC1,2,3,4,5 | Defines structure of primary Oracle Cluster. Hostnames of RAC or SEHA node as shown in oracle grid together with oracle instance, thread number and corresponding ASM Instance: thread_num:host name:oracle sid:oracle sid asm Example for 2 node RAC ASM database: RAC1 = 1:proddb1:PROD1:+ASM1 RAC2 = 2:proddb2:PROD2:+ASM2 SEHA ACFS database example: RAC1 = 1:proddb1:PROD1: RAC2 = 1:proddb2:PROD1: NEVER use IP addresses. | Automatically Specified During DDC creation | Edit with care |
STANDBY SERVER SETTINGS | |||
OS_DR | Unused | Not supported to edit | |
PATH_DR | Default Path value for Linux and Windows | Automatically Specified During DDC creation | Not supported to edit |
DBVISIT_BASE_DR | Installation path of Dbvisit StandbyMP software on standby host. Typically /usr/dbvisit or C:\Program Files\Dbvisit | Automatically Specified During DDC creation | Edit with care |
DESTINATION | Hostname of STANDBY server. The value must exactly match with “HostAddress” parameter in dbvagentmanager.ini on the host | Automatically Specified During DDC creation | Edit with care |
ORACLE_SID_DR | ORACLE_SID of your standby database instance | Automatically Specified During DDC creation | |
ORACLE_HOME_DR | ORACLE_HOME on your standby server | Automatically Specified During DDC creation | |
ORACLE_SID_ASM_DR | ORACLE_SID of your standby ASM instance, empty if no ASM is used and empty for SEHA/RAC deployments | +ASM, +ASM1 | |
NETPORT_DR | Port for dbvagentmanager transfer, as specified by FileTransferListenPort in dbvagentmanager.ini on primary server | 7890 | |
ARCHDEST | Staging archivelog location on standby server which hold archivelogs transferred by Dbvisit StandbyMP from primary server. | Automatically Specified During DDC creation | |
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. This variable is effective only with COMPRESS and UNCOMPRESS parameters set Example: LEAVE_COMPRESS_DR = Y | Y N (default) | |
DB_UNIQUE_NAME_DR | This parameter must match Oracle database parameter db_unique_name set in the standby database Note that incorrect setting may cause Dbvisit to not recognize the database. | Automatically Specified During DDC creation | |
BCKDIR_DR | When adding new PDB on primary (and while PDB_SYNC is set to Y) this parameter defines in which directory Dbvisit will receive the PDB backup on standby | [DBVISIT_BASE]/standbymp/oracle/backup | |
STANDBY RAC SETTINGS | |||
RAC1,2,3,4,5_DR | Defines structure of standby Oracle Cluster. See “PRIMARY RAC SETTINGS” | Automatically Specified During DDC creation | Edit with care |
MAIL SETTINGS | |||
These settings enable additional dbvctl mail notifications on top of notification set in controlcenter (global mail notifications). We recommend following approach:
SEND_MAIL_FLAG = Y SEND_MAIL_FLAG_DR = Y SUCCESSMAIL = N SUCCESSMAIL_DR = N If only these 4 variables are set, all other necessary details such as SMTP server, port and recipients are used from global mail notifications settings and you don’t need to specify them in the DDC file | |||
SEND_MAIL_FLAG | Enables additional Dbvctl Mail Notifications from primary server. Dbvctl Notifications are additional module on top of notifications specified in dbvcontrol. Examples: SEND_MAIL_FLAG = Y | N (default) Y Enables sending additional Dbvctl Mail Notifications | |
SEND_MAIL_FLAG_DR | Enables additional Dbvctl Mail Notifications from standby server. Dbvctl Notifications are additional module on top of notifications specified in dbvcontrol. Examples: SEND_MAIL_FLAG = Y | N (default) Y Enables sending additional Dbvctl Mail Notifications | |
SUCCESSMAIL | Defines whether dbvctl notification is set every time action is successful on primary server. If set to N, dbvctl notifications are sent only for failed actions | N Dbvctl Mail Notifications are sent for failed actions only Y (default) Dbvctl Mail Notifications are sent for all actions | |
SUCCESSMAIL_DR | Defines whether dbvctl notification is set every time action is successful on standby server. If set to N, dbvctl notifications are sent only for failed actions | N Dbvctl Mail Notifications are sent for failed actions only Y (default) Dbvctl Mail Notifications are sent for all actions | |
ADMINS | List of email addresses separated by comma, to receive dbvctl notifications. We recommend to NOT set this value | Not recommended to edit | |
MAILCFG_FROM | Specifies the FROM email address of the primary server. We recommend to NOT set this value | Not recommended to edit | |
MAILCFG_FROM_DR | Specifies the FROM email address of the standby server. We recommend to NOT set this value | Not recommended to edit | |
MAILCFG_SMTP_SERVER | Specifies the SMTP server to send the email to We recommend to NOT set this value | Not recommended to edit | |
MAILCFG_SMTP_SERVER_DR | Specifies the SMTP server to send the email to from standby server We recommend to NOT set this value | Not recommended to edit | |
ADVANCED_MAIL_SETTINGS | |||
These are additional settings for dbvctl mail notifications on top of notification set in controlcenter (global mail notifications). As with previous settings, we recommend to:
EMAIL_LOG_GAP_REPORT IGNORE_MAIL_ERROR MAILCFG_ATTACH_TRACEFILE MAILCFG_ATTACH_TRACEFILE_MAX_SIZE_IN_BYTES MAILCFG_DEBUG MAILSUBJECT_PREFIX_LOG_GAP_REPORT MAILSUBJECT_PREFIX_SUCCESSFUL MAILSUBJECT_PREFIX_HEARTBEAT all other necessary details such as SMTP passwords are used from global mail notifications settings and you don’t need to specify them in the DDC file | |||
EMAIL_LOG_GAP_REPORT | If user initiates log gap report (GUI, dbvctl, dbvcli) this variable controls whether email will be sent with log gap report summary. This variable controls whether summary of log gap report action initiated by the user | N Email with Log gap report summary is not sent after log gap report is initiated by the user. Y (Default value) Email with Log gap report summary is sent after log gap report is initiated by the user. | |
IGNORE_MAIL_ERROR | This variable set behavior which follows encountering error during sending of email (for example SMTP server is not reachable). With default value, any dbvctl process will stop & fail if there’s any problem with sending email. | N (Default value) Any email errors will cause processing to stop at the email processing step. Y Email errors will be ignored and just logged to trace file, instead of error out on email related errors - this ensures that processing can still continue even if there are issues with email configuration. | |
_MAILCFG_ALWAYS_ATTACH_TRACEFILE | This parameter is used to specify whether to attach trace files to all emails | N (Default) Tracefile is not attached to mail notification Y Tracefile is always attached to mail notification | |
MAILCFG_ATTACH_TRACEFILE | This parameter is used to specify whether to attach trace files to error emails | N Tracefile is not attached to mail notification Y (Default) Tracefile is always attached to mail notification | |
MAILCFG_ATTACH_TRACEFILE_MAX_SIZE_IN_BYTES | This variable is used to specify a file size limit in bytes to attaching the trace file. | 768000 (Default) | |
MAILCFG_AUTH_USER | This parameter is used to specify a username required for SMTP authentication (username) on the primary server. We recommend to NOT set this value | Not recommended to edit | |
MAILCFG_AUTH_USER_DR | This parameter is used to specify a username required for SMTP authentication (username) on the standby server. We recommend to NOT set this value | Not recommended to edit | |
_MAILCFG_AUTH_PASSWD | This parameter is used to specify a password required for SMTP authentication (username) on the primary server. We recommend to NOT set this value | Not recommended to edit | |
_MAILCFG_AUTH_PASSWD_DR | This parameter is used to specify a password required for SMTP authentication (username) on the standby server. We recommend to NOT set this value | Not recommended to edit | |
MAILCFG_BCC | Specify email address you want to cc Dbvisit Standby email alerts to. | Not recommended to edit | |
MAILCFG_CC | Specify email address you want to bcc Dbvisit Standby email alerts to. | Not recommended to edit | |
MAILCFG_DEBUG | Turn on smtp debug messages in the dbvctl trace files. Possible values are 0 (default) or 1 (enable debug). Usually only set after Dbvisit Support instructions. | 0 (Default) No debug in the trace for sent mails 1 debug information of SMTP Server communication is written to the trace | |
MAILCFG_PORT | This parameter allows you to specify SMTP port on the primary server. We recommend to NOT change this value | 25 (Default) | Not recommended to edit |
MAILCFG_PORT_DR | This parameter allows you to specify SMTP port on the standby server. We recommend to NOT set this value | Not recommended to edit | |
MAILCFG_FORMAT | Specifies the format of mail messages sent by dbvctl notifications We recommend to NOT change this value | HTML (Default) Mails are sent in new HTML format introduced in Dbvisit version 10 TEXT Mails are sent in text format | Not recommended to edit |
MAILCFG_FORMAT_DR | Specifies the format of mail messages sent by dbvctl notifications We recommend to NOT change this value | HTML (Default) Mails are sent in new HTML format introduced in Dbvisit version 10 TEXT Mails are sent in text format | Not recommended to edit |
MAILCFG_TIME_OUT | This parameter allows the option to specify SMTP timeout in seconds. We recommend to NOT change this value | 60 (Default) | Not recommended to edit |
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 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_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 | ||
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 Log Gap Report email. Example: MAILSUBJECT_PREFIX_LOG_GAP_REPORT=52 | ||
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. We recommend to NOT change this value | Not recommended to edit | |
PRIMARY ARCHIVE LOG MANAGEMENT SETTINGS These parameters enable and set AMM module for primary server. They work in unification and you shouldn’t set them individually without understanding how AMM works. Refer to AMM guide for more details: Post Tasks - Archivelogs (AMM) | |||
ARCHSOURCE_MANAGEMENT | This wholly disables or enables AMM module on primary. By default AMM on primary is disabled. | N (Default) Y | |
DAYS_TO_KEEP_ARCHSOURCE | Specify the number of days to keep the archive log files on the primary server. If this value (in days) is reached, the archive log files will be removed from the server. If you are not sure, set it to 1. Ensure that enough disk space is available to store the archive logs. | whole numbers, 0 to disable | |
NUM_ARCHSOURCE_TO_KEEP | Specifies the number of archive log files to keep on the primary server. Archive log files greater than this number will be removed (oldest first). If you are not sure, set it to 0 (disable). | whole and decimal numbers (use . character), 0 to disable | |
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. If this value is set to non-zero and archivelog is never backed up by RMAN, AMM will never delete the archivelog. | 0 (Default) | |
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 the threshold as an integer. | percent, 0 to disable | |
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 the threshold as an integer. | percent, 0 to disable | |
DELETE_ARCHSOURCE_THRESHOLD | Specify if archive log files should be deleted once the percentage threshold (Threshold in % of how much disk space may be used) on the primary server is reached. Once the threshold is reached oldest archive log files are deleted first. By default, this is set as No and Multiplatform notification will send out an email or slack notification once this is reached if enabled. | N (Default) Y | |
STANDBY ARCHIVE LOG MANAGEMENT SETTINGS These parameters enable and set AMM module for standby server. They work in unification and you shouldn’t set them individually without understanding how AMM works. Refer to AMM guide for more details: Post Tasks - Archivelogs (AMM) | |||
ARCHDEST_MANAGEMENT | Specifies if the AMM module to manage the archive log files is turned on or off on the standby server. This is recommended to set to yes as it will manage the archive logs that are shipped from primary to standby’s Archive log destination location(ARCHDEST). | N (Default) Y | |
DAYS_TO_KEEP_ARCHDEST | Specifies the number of archive log files to keep on the standby server. Archive 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). | whole numbers, 0 to disable | |
NUM_ARCHDEST_TO_KEEP | Specifies the number of days to keep the archive log files on the standby server. After this, the archive log files will be removed from the server. This is specific to the archive log destination location in standby from which the archivelog is applied. | whole and decimal numbers (use . character), 0 to disable | |
THRESHOLD_ARCHDEST | 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 standby server. | percent, 0 to disable | |
DELETE_ARCHDEST_THRESHOLD | Specifies if the archive log files should be deleted once the percentage threshold (THRESHOLD_ARCHDEST) on the standby server is reached. Once the threshold is reached the oldest archive log files are deleted first. | N (Default) Y | |
DAEMON SETTINGS | |||
DMN_DBVISIT_INTERVAL | This parameter specifies in seconds the synchronization interval for Automated Standby Update (ASU). This job triggers logswitch & transfers jobs (DMN_DBVISIT jobs) on primary if no new archivelog is generated by the primary database itself. Do not edit this value directly, instead use GUI, CLI or API to set ASU interval | 600 | Not supported to edit |
DMN_MONITOR_INTERVAL | This parameter specifies in seconds the interval of checks on primary database v$archived_log for newly generated archivelogs (DMN_MONITOR job). This interval should be always less than DMN_DBVISIT_INTERVAL. If there’s a new archivelog found by this DMN_MONITOR job, DMN_DBVISIT logswitch & transfer job is then triggered on primary. It is not supported to set this interval to 0 | 5 | Not recommended to edit |
DMN_DBVISIT_TIMEOUT | Timeout for ASU DMN_DBVISIT_INTERVAL job to complete on primary | 3600 | Not recommended to edit |
DMN_MONITOR_TIMEOUT | Timeout for ASU DMN_MONITOR_INTERVAL job to complete on primary | 60 | Not recommended to edit |
DMN_MONITOR_LOG_NUM | Threshold of number of new archivelogs which will cause DMN_MONITOR job to trigger DMN_DBVISIT job. By default any new archivelog on primary is immediately transferred by DMN_DBVISIT job to standby (default value 1). Increasing this value to for example 3 would cause the DMN_DBVISIT jobh to be triggered only after 3rd new archivelog is generated. | 1 | Edit with care |
DMN_MAX_FAIL_NOTIFICATIONS | Max number of email notifications sent by failure on Primary server | 3 | Not recommended to edit |
DMN_BLACKOUT_STARTTIME | Unused | Not supported to edit | |
DMN_BLACKOUT_ENDTIME | Unused | Not supported to edit | |
DMN_DBVISIT_INTERVAL_DR | Unused | 600 | Not supported to edit |
DMN_MONITOR_INTERVAL_DR | Unused | 5 | Not supported to edit |
DMN_DBVISIT_TIMEOUT_DR | Unused | 3600 | Not supported to edit |
DMN_MONITOR_TIMEOUT_DR | Unused | 60 | Not supported to edit |
DMN_MONITOR_LOG_NUM_DR | Unused | 1 | Not supported to edit |
DMN_MAX_FAIL_NOTIFICATIONS_DR | Unused | 3 | Not supported to edit |
DMN_BLACKOUT_STARTTIME_DR | Unused | Not supported to edit | |
DMN_BLACKOUT_ENDTIME_DR | Unused | Not supported to edit | |
ADVANCED SETTINGS | |||
SYS_LOGON | Dbvisit Standby does not require an Oracle password as it uses OS authentication by default. Example "connect / as sysdba". This is ensured by using sqlnet.ora 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 | |||
_SYS_PASSWD | |||
SYS_LOGON_STRING | |||
APPLY_DELAY_LAG_MINUTES | |||
ARCHTMP | |||
ARCHIVE_LOG_GAP_THRESHOLD | |||
TRANSFER_LOG_GAP_THRESHOLD | |||
COMPARE_CHECKSUM | Enabl | ||
CP | |||
RSH | |||
DAYS_TO_KEEP_TRACE | |||
NUM_TRACE_TO_KEEP | |||
HOSTNAME_CMD | |||
HOSTNAME_CMD_DR | |||
SEND_HEARTBEAT | |||
SEND_HEARTBEAT_DR | |||
SEND_HEARTBEAT_TIME24 | |||
APPLY_ARCHIVE_RMAN | |||
CASCADE | |||
DBVISIT_DEBUG | |||
NTF_TASKS_SHOW | |||
DBV_PRE_POST_PROC_NAME | |||
PDB_SYNC | |||
ODA KVM DB SPECIFIC | |||
2. Frequently Used Non-default DDC Parameters
These parameters are not present in DDC file after creation. They are however useful in resolving some common errors and some specific situations.