Controller: /nodeworx/mysql/remote¶
- Required Permissions
MYSQL
Action: activate
¶
- Added in Version
4.8.0-393
- Description
Reactivate a mysql server if it has gone offline.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Select the database server from the list that you would like to use. |
|
|
string |
Yes |
The root username of the MySQL Server. Note: this is *not* the system root username. |
||
|
string |
Yes |
The root password of the MySQL Server. Note: this is *not* the system root password. |
Action: add
¶
- Added in Version
4.8.0-393
- Description
Add a new mysql server to the pool.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
|||
|
string |
Yes |
Enter the host or IP address (with port if needed) of the database server. |
||
|
string |
Yes |
The root username of the MySQL Server. Note: this is *not* the system root username. |
||
|
string |
Yes |
The root password of the MySQL Server. Note: this is *not* the system root password. |
Action: default
¶
- Added in Version
4.8.0-393
- Description
Sets the default mysql server to use for new SiteWorx accounts and resellers.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Select the database server from the list that you would like to use. |
Action: delete
¶
- Added in Version
4.8.0-393
- Description
Deletes a mysql server from the pool.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
remote_db |
Select the database server from the list that you would like to use. |
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: getDefaultServerDetails
¶
- Added in Version
6.5.0-1712
- Description
Get the default server details.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'server_id' => '1',
'nickname' => 'localhost',
'can_delete' => false,
'version' => '10.6.17-MariaDB',
'host' => '192.168.0.1',
'is_running' => true,
'can_connect' => true,
'is_local' => true,
'has_unmapped_users' => false,
'has_unmapped_dbs' => false,
'is_default' => true,
),
'reply_code' => 205,
)
Action: getDefaultServerHost
¶
- Added in Version
6.5.0-1712
- Description
Get the default server hostname.
Sample Output¶
array (
'status' => 0,
'payload' => '192.168.0.1',
'reply_code' => 205,
)
Action: getDefaultServerNickname
¶
- Added in Version
6.5.0-1712
- Description
Get the default server nickname.
Sample Output¶
array (
'status' => 0,
'payload' => 'localhost',
'reply_code' => 205,
)
Action: listActiveServers
¶
- Added in Version
4.8.0-393
- Description
List active MySQL servers.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 => 'localhost',
1 => 'remote_db',
),
'reply_code' => 205,
)
Action: listDeletableServers
¶
- Added in Version
4.8.0-393
- Description
List deletable MySQL servers.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 => 'remote_db',
),
'reply_code' => 205,
)
Action: listInactiveServers
¶
- Added in Version
4.8.0-393
- Description
List inactive MySQL servers.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
),
'reply_code' => 205,
)
Action: listMappableDatabases
¶
- Added in Version
6.6.0-1720
- Description
List mappable databases.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Action: listMappableDatabaseUsers
¶
- Added in Version
6.6.0-1720
- Description
List mappable database users.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Action: listMappableSiteworxAccounts
¶
- Added in Version
6.6.0-1720
- Description
List mappable siteworx users.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Action: listServers
¶
- Added in Version
4.8.0-393
- Description
Lists the available mysql servers.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'server_id' => '1',
'nickname' => 'localhost',
'can_delete' => false,
'version' => '10.6.17-MariaDB',
'host' => '192.168.0.1',
'is_running' => true,
'can_connect' => true,
'is_local' => true,
'has_unmapped_users' => false,
'has_unmapped_dbs' => false,
'is_default' => true,
),
1 =>
array (
'server_id' => '5',
'nickname' => 'remote_db',
'can_delete' => true,
'version' => '10.6.17-MariaDB',
'host' => 'localhost',
'is_running' => true,
'can_connect' => true,
'is_local' => false,
'has_unmapped_users' => false,
'has_unmapped_dbs' => false,
'is_default' => false,
),
),
'reply_code' => 205,
)
Action: mapDatabase
¶
- Added in Version
6.6.0-1720
- Description
Add unmapped databases to a Siteworx account.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
string |
Yes |
example.com |
Action: mapDatabaseUser
¶
- Added in Version
6.6.0-1720
- Description
Add unmapped users to a Siteworx account.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
||
|
integer |
Yes |
|||
|
string |
Yes |
example.com |
Action: nickname
¶
- Added in Version
4.8.0-393
- Description
Change a mysql server’s nickname.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Select the database server from the list that you would like to use. |
Action: queryDefault
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “default”.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Select the database server from the list that you would like to use. |
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'server_copy' => 'localhost',
'server' => 'localhost',
),
'reply_code' => 205,
)
Action: queryProcesses
¶
- Added in Version
4.8.0-393
- Description
Query processes on the local mysql server.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, … |
Action: rootpass
¶
- Added in Version
4.8.0-393
- Description
Change the given MySQL Server’s root password.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
localhost, remote_db |
Select the database server from the list that you would like to use. |
|
|
string |
Yes |
|||
|
string |
Yes |
Confirm the password field by providing it again. Must match the password provided. |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.