Controller: /nodeworx/mysql¶
- Required Permissions
MYSQL
Action: add
¶
- Added in Version
4.7.0-339
- Description
Add a new mysql server to the pool.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::add
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: autoRestart
¶
- Added in Version
4.7.0-339
- Description
Set the mysql server auto-restart status.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
1, 0 |
0 |
With this option on you can have MySQL restarted automatically if MySQL goes down unexpectedly. |
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
* indicates that it’s actually required, but probably already has a valid default value.
Action: default
¶
- Added in Version
4.7.0-339
- Description
Sets the default mysql server to use for new SiteWorx accounts and resellers.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::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. |
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Deletes a mysql server from the pool.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::delete
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
4.7.0-339
- Description
Magic function - test for failure mechanism.
Action: isRunning
¶
- Added in Version
4.7.0-339
- Description
Checks if the service is running or not.
Sample Output¶
array (
'status' => 0,
'payload' => true,
'reply_code' => 205,
)
Action: isRunningOnNode
¶
- Added in Version
4.7.0-339
- Description
Checks if the service is running on a specific node (Clustering only).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
* indicates that it’s actually required, but probably already has a valid default value.
Action: list
¶
- Added in Version
4.7.0-339
- Description
List MySQL servers.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listServers
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 => 'localhost',
1 => 'remote_db',
),
'reply_code' => 205,
)
Action: listActiveServers
¶
- Added in Version
4.7.0-339
- Description
List active MySQL servers.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listActiveServers
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 => 'localhost',
1 => 'remote_db',
),
'reply_code' => 205,
)
Action: listDeletableServers
¶
- Added in Version
4.7.0-339
- Description
List deletable MySQL servers.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listDeletableServers
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 => 'remote_db',
),
'reply_code' => 205,
)
Action: listGeneralName
¶
- Added in Version
4.7.0-339
- Description
Lists the “normal” name - ie “web server” instead of “httpd”.
Sample Output¶
array (
'status' => 0,
'payload' => '##LG_MYSQLSERVER##',
'reply_code' => 205,
)
Action: listInactiveServers
¶
- Added in Version
4.7.0-339
- Description
List inactive MySQL servers.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listInactiveServers
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
),
'reply_code' => 205,
)
Action: listPortNumbers
¶
- Added in Version
4.7.0-339
- Description
Lists a string of the port numbers that this service uses, comma-seperated.
Sample Output¶
array (
'status' => 0,
'payload' => '3306',
'reply_code' => 205,
)
Action: listPortNumbersArray
¶
- Added in Version
4.7.0-339
- Description
Lists array of port numbers and ranges that this service uses.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 => 3306,
),
'reply_code' => 205,
)
Action: listRequiredPermissions
¶
- Added in Version
4.7.0-339
- Description
Lists an array of permissions required to control the service.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 => 'MYSQL',
),
'reply_code' => 205,
)
Action: listServiceInfo
¶
- Added in Version
4.7.0-339
- Description
Lists the service name, ports, page, and status.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'id' => 'mysqld',
'name' => '##LG_MYSQLSERVER##',
'ports' => '3306',
'page' => '/nodeworx/mysql',
'ctrl' => '/nodeworx/mysql',
'is_running' => 1,
),
'reply_code' => 205,
)
Action: listServiceName
¶
- Added in Version
4.7.0-339
- Description
Lists the service name - ie “httpd” instead of “web server”.
Sample Output¶
array (
'status' => 0,
'payload' => 'mysqld',
'reply_code' => 205,
)
Action: listServicePage
¶
- Added in Version
4.7.0-339
- Description
Lists the page that controls the service.
Sample Output¶
array (
'status' => 0,
'payload' => '/nodeworx/mysql',
'reply_code' => 205,
)
Action: nickname
¶
- Added in Version
4.7.0-339
- Description
Change a mysql server’s nickname.
Warning
This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::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: options
¶
- Added in Version
4.7.0-339
- Description
Configure various mysql service options.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
151 |
The number of connections to the MySQL server allowed at once. |
|
|
integer |
No* |
100 |
If set, the server blocks further connections from a remote host when the number of interrupted connections from that host exceeds this number. You can unblock a host with the command FLUSH HOSTS. |
|
|
integer |
No* |
10 |
The number in seconds of MySQL connection timeout. This is also used for the first answer from the server. - In Seconds |
|
|
integer |
No* |
28800 |
The number of seconds the server waits for activity on a connection before closing it. - In Seconds |
|
|
integer |
No* |
134217728 |
This is the memory buffer shared by all threads. Other buffers used by the server are allocated as needed. - In Bytes |
|
|
integer |
No* |
2097152 |
The size of the buffer used when sorting table data. The default value is 1MB. This option is available only for isamchk. - In Bytes |
|
|
integer |
No* |
131072 |
The size of the buffer used to store data being read from files. The default value is 260KB. This option is available only for isamchk. - In Bytes |
|
|
integer |
No* |
16777216 |
Set the maximum packet length to send to or receive from the server. The default value is 16MB. - In Bytes |
|
|
integer |
No* |
151 |
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires. |
|
|
integer |
No* |
2000 |
Set the number of open tables cached. Table cache is related to max connections. For example, for 200 concurrent running connections, you should have a table cache of at least 200 * N, where N is the maximum number of tables in a join. You also need to reserve some extra file descriptors for temporary tables and files. |
|
|
integer |
No* |
1048576 |
Set the maximum size of individual query results that can be cached. The default value is 1MB. - In Bytes |
|
|
integer |
No* |
1048576 |
Set the size of the query cache. Setting it to 0 disables the query cache. The default cache size is 0. - In Bytes |
|
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
* indicates that it’s actually required, but probably already has a valid default value.
Action: queryAutoRestart
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “autoRestart”.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'autorestart' => '0',
),
'reply_code' => 205,
)
Action: queryOptions
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “options”.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'max_connections' => '151',
'max_connect_errors' => '100',
'connect_timeout' => '10',
'wait_timeout' => '28800',
'key_buffer_size' => '134217728',
'sort_buffer_size' => '2097152',
'read_buffer_size' => '131072',
'max_allowed_packet' => '16777216',
'thread_cache_size' => '151',
'table_open_cache' => '2000',
'query_cache_limit' => '1048576',
'query_cache_size' => '1048576',
),
'reply_code' => 205,
)
Action: queryProcesses
¶
- Added in Version
4.8.0-393
- Description
Query processes on the local mysql server.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'id' => '6',
'username' => 'iworx',
'command' => 'Sleep',
'time' => '161',
),
1 =>
array (
'id' => '74',
'username' => 'iworx',
'command' => 'Query',
'time' => '0',
),
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
4.7.0-339
- 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: restart
¶
- Added in Version
4.7.0-339
- Description
Restart the service.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
Action: restartOnNode
¶
- Added in Version
4.7.0-339
- Description
Restarts the service on a specific node (Clustering only).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
* indicates that it’s actually required, but probably already has a valid default value.
Action: rootpass
¶
- Added in Version
4.7.0-339
- Description
Change the given MySQL Server’s root password.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
|||
|
string |
Yes |
Confirm the password field by providing it again. Must match the password provided. |
Action: rrdGraph
¶
- Added in Version
4.7.0-339
- Description
Set the mysql server connections RRD graph display status.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
1, 0 |
0 |
Use the dropdown to turn the MySQL server activity graph on or off. |
* indicates that it’s actually required, but probably already has a valid default value.
Action: start
¶
- Added in Version
4.7.0-339
- Description
Start the service.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
Action: startOnBoot
¶
- Added in Version
4.7.0-339
- Description
Set the mysql server start-on-boot-status.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
1, 0 |
1 |
If set to ‘Yes’, MySQL will be automatically started when the server starts up. |
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
* indicates that it’s actually required, but probably already has a valid default value.
Action: startOnNode
¶
- Added in Version
4.7.0-339
- Description
Starts the service on a specific node (Clustering only).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
* indicates that it’s actually required, but probably already has a valid default value.
Action: stop
¶
- Added in Version
4.7.0-339
- Description
Stop the service.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
Action: stopOnNode
¶
- Added in Version
4.7.0-339
- Description
Stops the service on a specific node (Clustering only).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
* indicates that it’s actually required, but probably already has a valid default value.
Action: win
¶
- Added in Version
4.7.0-339
- Description
Magic function - test for testing success mechanism.