Controller: /nodeworx/cluster/nodes¶
- Required Permissions
CLUSTERING
Action: add
¶
- Added in Version
4.7.0-339
- Description
Add a cluster node.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
The hostname or IP address of the node you would like to add to this cluster. |
||
|
string |
Yes |
|||
|
string |
No* |
LVS-DR, LVS-TUN |
LVS-DR |
The packet forwarding method is the method of load balancing that the system will use to load balance requests to the cluster node. |
|
string |
Yes |
The InterWorx API key from the node which you would like to add. This must be retrieved from the node’s NodeWorx instance. |
||
|
integer |
No* |
1, 0 |
1 |
* indicates that it’s actually required, but probably already has a valid default value.
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete a cluster node.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
apidocs-node1.interworx.com |
||
|
struct (integer) |
No* |
1 |
* indicates that it’s actually required, but probably already has a valid default value.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: forceDelete
¶
- Added in Version
4.8.0-393
- Description
Force deletion of a cluster node, even if the cluster manager cannot reach it.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
apidocs-node1.interworx.com |
||
|
struct (integer) |
No* |
1 |
* indicates that it’s actually required, but probably already has a valid default value.
Action: listClusterNodes
¶
- Added in Version
4.8.0-393
- Description
List cluster nodes.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'hostname' => 'apidocs.interworx.com',
'ipaddr' => '192.168.0.1',
'ipv6' => false,
'role' => '##LG_LOAD_BALANCER## / ##LG_CLUSTER_MANAGER##',
'status' => 'active',
'is_cm' => true,
'is_node' => false,
'packet_forwarding_method' => 'LVS-DR',
'activation_complete' => 'yes',
'activation_details' => '',
'inprogress' => 100,
),
1 =>
array (
'node_id' => '1',
'hostname' => 'apidocs-node1.interworx.com',
'ipaddr' => '192.168.0.254',
'ipv6' => NULL,
'status' => 'active',
'activation_complete' => 'yes',
'packet_forwarding_method' => 'LVS-DR',
'ismanager' => false,
'inprogress' => 100,
'activation_details' => '',
'is_cm' => false,
'is_node' => true,
'role' => '##LG_REAL_SERVER##',
),
),
'reply_code' => 205,
)
Action: queryHostIps
¶
- Added in Version
5.0.14-579
- Description
Resolves IPv4 and IPv6 address of a hostname.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
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: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.