Skip to main content

Configuration File

This section will help you understand the CxLink Backup configuration process and to locate all the configuration files.

Topics


Where is the configuration file located?

The Agent configuration file uses YAML to better support complex configurations, and to provide a consistent configuration experience. The configuration file (emory.cfg) is located in different directories depending on the database server engine.

DatabasePath
SAP HANA/hana/shared/$SAPSYSTEMNAME/global/hdb/opt/conf/emory.cfg
SAP ASE$SYBASE/$SYBASE_ASE/emory.cfg
Oracle/oracle/$ORACLE_SID/sapprof/emory.cfg
MaxDB/opt/emory/$SAPSYSTEMNAME.cfg
IBM DB2/opt/emory/$SAPSYSTEMNAME.cfg

What is the configuration file structure?

The following tables summarize the configuration parameters added as part of the agent installation process, and additional parameters that you can add or change:

ParameterPossible ValuesDescription
Version2.0Current agent configuration version
Providersmultiple valuesMore information in: Storage Provider Profiles
BackupStorageProviderstorage_provider_nameStorage Provider profile used to store the generated backups
RecoverStorageProviderstorage_provider_nameStorage Provider profile used to restore backups from a different source in a disaster recovery scenario
SystemCopyProviderstorage_provider_name(HANA ONLY) Storage Provider profile used to restore backups from a different source in a system copy scenario
Logging- maxage: days
- rotation_time: days
More information in: Logging and traces
Lifecycle- active: true or false
- retention_period

- retention: days
- cronexpression: * * * *
More information in: Logging and traces
Monitoringtrue / falseSend backup execution information to CxLink Portal, SNS topic and/or local filesytem. More information in: Dashboard and in Notifications

For version 2201.24 and below, legacy configuration file is maintained:

ParameterPossible ValuesDescription
Version1.0Current agent configuration version
Providersmultiple valuesMore information in: Storage Provider Profiles
BackupStorageProviderstorage_provider_nameStorage Provider profile used to store the generated backups
RecoverStorageProviderstorage_provider_nameStorage Provider profile used to restore backups from a different source in a disaster recovery scenario
SystemCopyProviderstorage_provider_name(HANA ONLY) Storage Provider profile used to restore backups from a different source in a system copy scenario
Logging- maxage: days
- rotation_time: days
More information in: Logging and traces
Lifecycle- active: true or false
- retention_period

- retention: days
- cronexpression: * * * *
More information in: Logging and traces
ConsoleDashboardtrue / falseSend backup execution information to CxLink Portal. More information in: Dashboard
Notificator- active: true or false
- SNSArn: SNS topic ARN
More information in: Notifications
info

When you upgrade from a version 2201.24 or below to a version above 2201.24, configuration file is automatically migrated.