OAT configuration parameters|V4.3.0|OceanBase Admin Tool|docs|OceanBase Documentations

OceanBase Admin Tool

V4.3.0

Download PDF

Parameter	Default value	Description	Restart required
oat.backup.remote_backup	none	Specifies whether to enable remote backup of OAT data, such as the database records, local logs, and local installation packages. The value `none` indicates that this feature is disabled. If you want to enable this feature, specify a backup directory in the `username@remote_host:backup_dir` format. Example: `test@xxx.xxx.xxx.1:/oat_backup_files`. The system backs up data based on the remote backup schedule specified for the oat.backup.remote_backup_schedule parameter. You can run the `rsync over ssh` command to push the backup data to a remote server. Make sure that the following conditions are met: The remote server supports the `rsync` command and contains the specified backup directory. You can run the `ssh username@remote_host` command in the OAT container without the need to provide the password. You can run the `sudo rsync` command without the need to provide the password when the specified user is not the root user.	No
oat.backup.remote_backup_schedule	`0 5 * * *`	The remote backup schedule in a CRON expression.	No
oat.database.auto_purge_beyond_days	60	The number of days for which the non-essential data in the database is retained. The non-essential data includes the collected monitoring metrics and the scheduling records of backend polling tasks.	No
oat.nlb.metadb_vport	3306	The port number that is preferentially used when Network Load Balancer (NLB) automatically generates a load balancing rule for MetaDB.	No
oat.run_mode	strict	The running mode of OAT. Valid values: `loose` and `strict`. OAT in loose mode checks the server environment in a less strict manner.	No
oat.task.health_check_interval_seconds	30	The interval, in seconds, between health checks of a server, component, or service. We recommend that you set this parameter to a value greater than 10.	No
oat.task.log_reserve_days	15	The number of days for which a local task log file is retained.	No
oat.task.monitor_server_schedule	`0 * * * *`	The schedule in a CRON expression for collecting the server information, such as the hardware specifications, operating system, network, and hosted services.	No
ocp.credential	{}	The username and password used to call the OceanBase Cloud Platform (OCP) API. You must specify the credential in a JSON string of the `{"ocp_name":{"username":"xxx","password":"xxx"}}` format.	No

Parameter

Default value

Description

Restart required

oat.backup.remote_backup

none

Specifies whether to enable remote backup of OAT data, such as the database records, local logs, and local installation packages. The value none indicates that this feature is disabled. If you want to enable this feature, specify a backup directory in the username@remote_host:backup_dir format. Example: test@xxx.xxx.xxx.1:/oat_backup_files. The system backs up data based on the remote backup schedule specified for the oat.backup.remote_backup_schedule parameter. You can run the rsync over ssh command to push the backup data to a remote server.
Make sure that the following conditions are met:

The remote server supports the rsync command and contains the specified backup directory.
You can run the ssh username@remote_host command in the OAT container without the need to provide the password.
You can run the sudo rsync command without the need to provide the password when the specified user is not the root user.

oat.backup.remote_backup_schedule

0 5 * * *

The remote backup schedule in a CRON expression.

oat.database.auto_purge_beyond_days

The number of days for which the non-essential data in the database is retained. The non-essential data includes the collected monitoring metrics and the scheduling records of backend polling tasks.

oat.nlb.metadb_vport

3306

The port number that is preferentially used when Network Load Balancer (NLB) automatically generates a load balancing rule for MetaDB.

oat.run_mode

strict

The running mode of OAT. Valid values: loose and strict. OAT in loose mode checks the server environment in a less strict manner.

oat.task.health_check_interval_seconds

The interval, in seconds, between health checks of a server, component, or service. We recommend that you set this parameter to a value greater than 10.

oat.task.log_reserve_days

The number of days for which a local task log file is retained.

oat.task.monitor_server_schedule

0 * * * *

The schedule in a CRON expression for collecting the server information, such as the hardware specifications, operating system, network, and hosted services.

ocp.credential

{}

The username and password used to call the OceanBase Cloud Platform (OCP) API. You must specify the credential in a JSON string of the {"ocp_name":{"username":"xxx","password":"xxx"}} format.