OAT configuration parameters|V4.2.1| docs|Distributed Database

OAT configuration parameters

Last Updated：2024-07-09 02:06:37 Updated

This topic describes all system parameters of OceanBase Admin Toolkit (OAT) in use.

Parameter	Default value	Description	Effective only after restart
oat.backup.remote_backup	none	Specifies whether to enable the 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 enable this feature, set the backup directory in the `username@remote_host:backup_dir` format. For example: `test@xxx.xxx.xxx.1:/oat_backup_files`. The system backup is executed based on the value of 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 the specified backup directory exists on the remote server. The `ssh username@remote_host` statement can be executed in the OAT container without using the password. If the `username` is not `root`, the `sudo rsync` command can be run without using the password.	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 to retain non-essential data in the database, such as the collected monitoring metrics and the scheduling records of background polling tasks.	No
oat.nlb.metadb_vport	3306	The preferred port number when NLB automatically generates a load balancing rule for MetaDB.	No
oat.run_mode	production	The running mode of OAT. Valid values: `production` adn `poc`. In POC mode, for example, the check on the server environment is less strict.	No
oat.task.health_check_interval_seconds	30	The interval, in seconds, between health checks of a server, component, or product. We recommend that you set the interval to longer than 10s.	No
oat.task.log_reserve_days	15	The duration, in days, that 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, OS information, network information, and hosted services.	No
ocp.credential	{}	The username and password used to call the OceanBase Cloud Platform (OCP) API. You must specify the credentials in a JSON string: `{"ocp_name":{"username":"xxx","password":"xxx"}}`.	No