NOTICE: This Documentation is for JetBackup 4 for Linux.

Please CLICK HERE for the latest JetBackup 5 for Linux Documentation.

manageDatabaseServer

Description

With this function, you can create/manage database servers.

To view the parameters that related to database type click on Database type related parameters.

Parameters

This is the basic parameters for all destination types.

Parameter name	Type	Description	Possible values	Example
_id	String	Required on action modify The ID of the database server.		5d269e0a2e74d50bb6113814
action	String	Required The action you want to perform.	create modify
name	String	Required on action create Database Server name.		local
type	String	Required on action create Database Server type.	MySQL MongoDB PostgreSQL
authentication	Object	Required on action create Available authentication parameters required to establish database connection.	To view the possible values click on Database type related parameters.	authentication[hostname]=1.1.1.1&authentication[username]=root&authentication[password]=********
options	Object	Available database options parameters.	To view the possible values click on Database type related parameters.	options[flag]=1&options[dump_max_packet]=2048
jobs_count	Integer	Number of jobs using the database server.
enabled	Boolean	Whether authentication is enabled/disabled on the database server. (not available on MySql type)
hostname	String	Required on authentication enabled The hostname/ip of the database server.
port	Integer	Required on authentication enabled The remote database server port. [Defaults to 3306(MySQL), 27017(MongoDB), 5432(PostgreSQL) if left empty]		5432
username	String	Required on authentication enabled Name of the database user.
password	String	Required on authentication enabled Password of the database user.

Database type related parameters

MySQL Options Parameters

Options Parameter name	Type	Description	Possible Values	Example
dump_max_packet	Integer	The maximum packet length to send to or receive from server.	Default - 0 32 MB - 32 64 MB - 64 128 MB - 128 256 MB - 256 512 MB - 512 1 GB - 1024 2 GB - 2048	options[dump_max_packet]=2048
dump_gtid_purged	String	This option enables control over global transaction ID (GTID) information written to the dump file, by indicating whether to add a SET @@GLOBAL.gtid_purged statement to the output. This option may also cause a statement to be written to the output that disables binary logging while the dump file is being reloaded.	Default - ' ' Enabled - ON Disabled - OFF Automatically - AUTO	options[dump_gtid_purged]=ON
flags	Integer	MySQL Flag options you want to use.	To view the possible values click on MySQL Flag Options	options[flag]=1

MongoDB Authentication Parameters

Authentication Parameter name	Type	Description	Possible Values	Example
database	String	The authorized database in MongoDB.

Returns

This API call returns destination object.

To view the parameters that returned click on Database Object

Example

jetapi backup -F manageDatabaseServer -D "action=create&name=mysqlAPI&type=MySQL&authentication[hostname]=1.1.1.1&authentication[username]=root&authentication[password]=********"

https://1.1.1.1:3030/API/manageDatabaseServer/?action=create&name=mysqlAPI&type=MySQL&authentication[hostname]=1.1.1.1&authentication[username]=root&authentication[password]=********

JetBackup For Linux API Documentation

On This Page: