Overview Package Class Deprecated Help

db
DatabaseManager

The DatabaseManager class contains properties related to the NFM-P database. Policies control various database logs and backups. Information for the primary and standby databases, backups, and related redundancy states is available.

public class DatabaseManager

Properties
accStatsDataPartInt

type=int
default=1
minimum=1
maximum=1000
units=days
Displayed(tab/group)=Accounting Statistic Data Retention Period (/Primary Database)
alertLogFilePolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Policy ID (File Policies/Alert Log File Policy)
alertLogFilePolicyName

type=string
access=read-only
default=Default Policy
Displayed(tab/group)=Description (File Policies/Alert Log File Policy)
archiveLogMode

type=string
access=read-only
default=
Displayed(tab/group)=Archive Log Mode (/Primary Database)
archiveLogsTobeApplied

type=int
access=read-only
default=0
Displayed(tab/group)=Number Of Archive Logs To be Applied (/Redundancy Status)
backupFrequency

type=int
default=1
minimum=1
maximum=1000
Displayed(tab/group)=Backup Interval (Backup/Backup Schedule)
backupFrequencyUnit

type=db.ScheduledTaskFrequency
default=hours
Displayed(tab/group)=Interval Unit (Backup/Backup Schedule)
backupNumberOfSets

type=int
default=3
minimum=1
maximum=10
Displayed(tab/group)=Number to Keep (Backup/Backup Schedule)
backupScheme

type=db.ScheduledBackupScheme
access=read-create
default=scheduled
backupStartTime

type=Date
default=0
Displayed(tab/group)=Start Time (Backup/Backup Schedule)
backupState

type=db.ProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=Backup State (Backup/Backup Status)
backupType

type=db.BackupType
default=full
cacheBufferHitRatio

type=string
access=read-only
default=
compressionState

type=db.CompressionState
access=read-only
default=disabled
Displayed(tab/group)=Compression State (Backup/Backup Status)
coreDumpFilePolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Policy ID (File Policies/Core Dump File Policy)
coreDumpFilePolicyName

type=string
access=read-only
default=Default Policy
Displayed(tab/group)=Description (File Policies/Core Dump File Policy)
created

type=string
access=read-only
default=
Displayed(tab/group)=Creation Time (/Primary Database)
db.AuxiliaryDatabaseCluster-Set type=Children-Set
db.AuxiliaryDbBackup-Set type=Children-Set
dbBackupFileRsyncState

type=db.DbBackupFileRsyncState
access=read-only
default=notAttempted
Displayed(tab/group)=Backup File Rsync State (Backup/Backup Status)
dbHostName

type=string
access=read-only
default=
Displayed(tab/group)=IP Address (/Primary Database)
dbInstanceName

type=string
access=read-only
default=
Displayed(tab/group)=Instance Name (/Primary Database)
dbName

type=string
access=read-only
default=
Displayed(tab/group)=Database Name (/Primary Database)
dbid

type=string
access=read-only
default=
Displayed(tab/group)=DBID (/Primary Database)
enableBackupCompression

type=boolean
default=false
Displayed(tab/group)=Enable Backup File Compression (Backup/Backup Setting)
enableDbErrorMonitoring

type=boolean
default=false
Displayed(tab/group)=Enable Database Error Monitoring (/Primary Database)
failoverState

type=db.ProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=Failover State (/Redundancy Status)
interruptReadSessionsOnDbSwitchover

type=boolean
default=false
Displayed(tab/group)=Interrupt Read sessions after time out (/DB Switchover)
interruptWriteSessionsOnDbSwitchover

type=boolean
default=false
Displayed(tab/group)=Interrupt Write sessions after time out (/DB Switchover)
isAuxDbEnabled

type=boolean
access=read-only
default=false
isScheduleEnabled

type=boolean
default=true
Displayed(tab/group)=Schedule Enabled (Backup/Backup Schedule)
isSwitchoverAllowed

type=generic.TruthValue
access=read-only
default=true
lastAttemptedBackupType

type=db.LastBackupType
access=read-only
default=notAttempted
Displayed(tab/group)=Last Attempted Backup Type (Backup/Backup Status)
lastBackupAttemptTimestamp

type=string
access=read-only
default=
Displayed(tab/group)=Last Attempted Backup Time (Server Time) (Backup/Backup Status)
lastBackupDir

type=string
access=read-only
default=
minimum=0
maximum=200
Displayed(tab/group)=Directory of the Last Successful Backup (Backup/Backup Status)
lastBackupSuccessTimestamp

type=string
access=read-only
default=
Displayed(tab/group)=Last Successful Backup Time (Server Time) (Backup/Backup Status)
lastFailoverAttemptTimestamp

type=string
access=read-only
default=
Displayed(tab/group)=Last Attempted Failover Time (/Redundancy Status)
lastReinstantiateStandbyAttemptTimestamp

type=string
access=read-only
default=
Displayed(tab/group)=Last Attempted Standby Re-instantiation Time (/Redundancy Status)
lastSuccessBackupHost

type=string
access=read-only
Displayed(tab/group)=Host Name of the Last Successful Backup (Backup/Backup Status)
lastSuccessBackupType

type=db.LastBackupType
access=read-only
default=notAttempted
Displayed(tab/group)=Last Successful Backup Type (Backup/Backup Status)
lastSwitchoverAttemptTimestamp

type=string
access=read-only
default=
Displayed(tab/group)=Last Attempted Switchover Time (/Redundancy Status)
listenerLogFilePolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Policy ID (File Policies/Listener Logs File Policy)
listenerLogFilePolicyName

type=string
access=read-only
default=Default Policy
Displayed(tab/group)=Description (File Policies/Listener Logs File Policy)
listenerPort

type=string
access=read-only
default=
Displayed(tab/group)=Listener Port (/Primary Database)
manualBackupDest

type=string
default=
minimum=0
maximum=200
Displayed(tab/group)=Manual Backup Directory (Backup/Backup Setting)
nextAutoReinstantiationAttemptTimestamp

type=string
access=read-only
default=
Displayed(tab/group)=Next Auto Standby Re-instantiation Attempt Time (/Redundancy Status)
nextBackupSet

type=int
access=read-only
default=1
minimum=1
maximum=10
nextScheduledBackupTimestamp

type=string
access=read-only
default=
Displayed(tab/group)=Next Scheduled Backup Time (Server Time) (Backup/Backup Status)
openMode

type=string
access=read-only
default=
Displayed(tab/group)=Open Mode (/Primary Database)
primaryDnsHostName

type=string
access=read-only
Displayed(tab/group)=Host Name (/Primary Database)
protectionMode

type=string
access=read-only
default=
Displayed(tab/group)=Protection Mode (/Primary Database)
redoLogWaits

type=string
access=read-only
default=
reinstantiateStandbyState

type=db.ReinstantiateStandbyDBState
access=read-only
default=notAttempted
Displayed(tab/group)=Standby Re-instantiation State (/Redundancy Status)
schedBackupDest

type=string
default=
minimum=0
maximum=200
Displayed(tab/group)=Scheduled Backup Directory (Backup/Backup Setting)
scheduledBackup

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Scheduled Backup (Backup/Backup Status)
scheduledBackupType

type=db.BackupType
default=full
Displayed(tab/group)=Backup Type (Backup/Backup Schedule)
sharedPoolMissRatio

type=string
access=read-only
default=
sortInMemory

type=string
access=read-only
default=
units=operations
sortOnDisk

type=string
access=read-only
default=
units=operations
stagingBackupDest

DEPRECATED: 10.0 - Unused. Always return empty
type=string
access=read-only
default=
minimum=0
maximum=300
standbyDbConfigured

type=generic.TruthValue
access=read-only
default=false
standbyDbHostName

type=string
access=read-only
default=
Displayed(tab/group)=IP Address (/Standby Database)
standbyDbName

type=string
access=read-only
default=
Displayed(tab/group)=Instance Name (/Standby Database)
standbyDnsHostName

type=string
access=read-only
Displayed(tab/group)=Host Name (/Standby Database)
switchoverState

type=db.ProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=Switchover State (/Redundancy Status)
timeToApplyArchiveLogs

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Estimated Time To Apply Archive Logs (/Redundancy Status)
traceLogFilePolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Policy ID (File Policies/Trace and Audit Logs File Policy)
traceLogFilePolicyName

type=string
access=read-only
default=Default Policy
Displayed(tab/group)=Description (File Policies/Trace and Audit Logs File Policy)
version

type=string
access=read-only
default=
minimum=0
maximum=80
Displayed(tab/group)=Version (/Primary Database)
waitForReleaseDbSessionsOnDbSwitch

type=int
default=15
minimum=1
maximum=120
units=minutes
Displayed(tab/group)=DB Session wait time (/DB Switchover)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

backup

Perform a database backup to the provided location on the database server. The ManualBackupDest and BackupType have to be set.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation - db.DatabaseManager configuration information
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
db.DatabaseManager.backupException

getDbStatus

Determine the status of the Primary/Standalone database.
  1. Value of 1 for UP
  2. Value of 2 for DOWN
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
primaryDbStatus : int -
Exceptions:
db.DatabaseManager.getDbStatusException

getProxyStatus

Determine the status of the database proxies.
  1. Bit value 00 for Primary Proxy DOWN, Standby Proxy DOWN
  2. Bit value 01 for Primary Proxy UP, Standby Proxy DOWN
  3. Bit value 10 for Primary Proxy DOWN, Standby Proxy UP
  4. Bit value 11 for Primary Proxy UP, Standby Proxy UP
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
proxyStatus : int -
Exceptions:
db.DatabaseManager.getProxyStatusException

getStandbyDbStatus

Determine the status of the Standby database.
  1. Value of 4 for UP
  2. Value of 5 for DOWN
  3. Value of 6 for OUT OF SYNC
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
standbyDbStatus : int -
Exceptions:
db.DatabaseManager.getStandbyDbStatusException

isDbRedundant

Determine if the database is redundant (either Primary or Standby).
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
isDbRedundant : boolean -
Exceptions:
db.DatabaseManager.isDbRedundantException

reinstantiateStandby

Re-create the Standby database. To be used after a database failover occurs.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
db.DatabaseManager.reinstantiateStandbyException

switchover

Perform a database switchover. The Primary database and Standby database switch roles.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
db.DatabaseManager.switchoverException