XML Parameters for Backups and Restores

The following table describes the supported Sybase backup and restore parameters.

Parameter

Parameter Values

taskFlags/disabled

The option to disable the schedule.

Valid values are:

  • true

  • false

policyType

The storage policy type.

A valid value is DATA_PROTECTION.

innitiatedFrom

Where the restore is initialed from (for example CommCell Console, or command line).

A valid value is COMMANDLINE.

backupsetName

The name of the backup set.

clientName

The name of the client computer, as displayed in the CommCell Console where the instance is located.

appName

The name of the application, 'Sybase'.

instanceName

The name of the Sybase instance.

subTaskType

The sub task.

Valid values are:

  • BACKUP

  • RESTORE

operationType

The type of task.

Valid values are:

  • BACKUP

  • RESTORE

backupLevel

The type of backup to perform

Note: You can only perform a differential backup on a Sybase server that runs Sybase 15.7 SP100 or later.

Valid values are:

  • FULL

  • INCREMENTAL

  • DIFFERENTIAL

createNewIndex

The option to create a new index.

Valid values are

true

false

followMountPoints

The option to follow the mount points.

Valid values are

true

false

useCatalogServer

The option to use a catalog server.

Valid values are

true

false

enforceTransactionLogUsage

The option to use the transaction logs for granular restarts.

Valid values are

true

false

skipConsistencyCheck

The option to skip the consistency check.

Valid values are

true

false

runIncrementalBackup

The option to run an incremental backup.

Valid values are

true

false

incLevel

The incremental level.

Valid values are:

  • NONE, for no incremental level

  • BEFORE_SYNTH, for before synthetic full

  • AFTER_SYNTH, for after synthetic full

doNotTruncateLog

The option to not truncate the logs.

Valid values are

true

false

sybaseSkipFullafterLogBkp

The option to skip a full backup for new Sybase databases after a log backup.

Valid values are

true

false

commCellId

The CommCell ID of the CommServe.

A valid value is 2.

timeRange

The following values can be used to define the given parameter:

  • Latest

  • Point in time

  • TimeRange

noImage

The option to include deleted items in the browse.

Valid values are:

  • true

  • false

useExactIndex

The option to use the index associated with the data protection operation performed at a specific time or the latest index.

Valid values are:

  • true

  • false

copyPrecedence

The backup copy precedence.

copyPrecedenceApplicable

Valid values are:

  • true

  • false

drive

The name of the drive in the pool that performs the restore.

drivePool

The name of the drive pool that performs the restore. Use this option to restore by using a specific drive.

library

The name of the library that performs the restore. Use this option to restore by using a specific library.

mediaAgent

The name of the MediaAgent that performs the restore.

library

The library to use for the restore.

mediaAgent

The MediaAgent to use for the restore

destClient/clientName

The destination client name.

destClient/instanceName

The destination instance name

sybaseRecoverType

The recovery type.

A valid value is STATE_RECOVER.

pointInTime/timeValue

The date and time to use for a point-in-time recovery to a specific log

Sample values:

  • 2015-12-11 09:22:32

  • 2015-01-01 17:22:32

pointofTime

The option to perform a point-in-time restore.

Valid values are:

  • true

  • false

overWrite

The option to perform a point-in-time restore.

Valid values are:

  • true

  • false

fromTime

The time to restore from.

Sample values:

  • 2015-12-11 09:22:32

  • 2015-01-01 17:22:32

refTime

destinationServer/name

The name of the server that is the restore destination.

instanceRestore

The option to restore the instance.

Valid values are:

  • true

  • false

sybaseDatabase/databaseId/name

The Sybase database name.

sybaseDatabase/creationTime

The time that the Sybase database was created.

sybaseDatabase/subclient

The subclient that is associated with the Sybase database.

sybaseDatabase/devices

The devices that are associated with the Sybase database.

A colon (:) separated field that has 8 fields

  1. Source subclient Id: This is an internal field for subclient Id. You must pass this as 0 for the qcommand.

  2. Source dbId: database Id of the Sybase dataserver. You can get this value from the Sybase sysdatabases table.

  3. Source device Id: device id of the source device. You can pass this as 0 for the qcommand.

  4. Source device Name: source Sybase device name. You can get this value from the Sybase sysdatabases table.

  5. Renamed device Name: Device name on the destination (new name for the Sybase device).

  6. Renamed device Path: Destination server Device Path.

  7. Size of the device in bytes: If you already create the device, use 0 for the value.

  8. Renamed Database Name: New name for the database on destination server. The restore is performed on this database. If the database is already created, the created size must match the source.

databaseChain

A colon (:) separated field that has 4 fields.

  1. Source subclient Id: This is an internal field for subclient Id and need to be passed as 0 in qcommand.

  2. Source dbId: database Id of the Sybase dataserver. You can get this value from the Sybase sysdatabases table.

  3. Source database: The name of the source database.

  4. 0

renameDatabases

The option to rename the database

Valid values are:

  • true

  • false

restoreOptions

The option to restore the database

Valid values are:

  • true

  • false

restoreType

The type of restore to perform.

Valid values are:

  • POINT_IN_TIME

  • STEP_BY_STEP

onePassRestore

The option to perform a OnePass restore.

Valid values are:

  • false

sybaseCreateDevices

The option to create the Sybase devices.

Valid values are:

  • true

  • false

startInSuspendedState

The option to start the database in a suspended state.

Valid values are:

  • true

  • false

priority

The job priority

jobDescription

The job description.

Loading...