Prev Chapter 6: Controller: /nodeworx/cluster/lb
Up Part II: NodeWorx API Spec
Chapter 8: Controller: /nodeworx/command/queue Next
7 Controller: /nodeworx/cluster/nodes
Required Permissions "CLUSTERING"
Added in version 4.7.0-339
Description Add a cluster node.
Input Parameters
| Name | Type | Notes | Required? |
| hostname | string |
Help Entry The hostname or IP address of the node you would like to add to this cluster. |
Yes |
| ipv4 | string | Yes | |
| ipv6 | string | Yes | |
| packet_forwarding_method | string |
Help Entry The packet forwarding method is the method of load balancing that the system will use to load balance requests to the cluster node. Example Values LVS-DR, LVS-TUN Example Default Value LVS-DR |
No* |
| apikey | string |
Help Entry The InterWorx API key from the node which you would like to add. This must be retrieved from the node’s NodeWorx instance. |
Yes |
| test | integer |
Example Values 1, 0 Example Default Value 1 |
No* |
| * indicates that it’s actually required, but probably already has a valid default value | |||
Added in version 4.7.0-339
Description Delete a cluster node.
Input Parameters
| Name | Type | Notes | Required? |
| nodes | struct (string) |
Example Values node1.testing.com |
Yes |
| confirm_action | struct (integer) |
Example Values 1 |
No* |
| * indicates that it’s actually required, but probably already has a valid default value | |||
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 | Notes | Required? |
| nodes | struct (string) |
Example Values node1.testing.com |
Yes |
| confirm_action | struct (integer) |
Example Values 1 |
No* |
| * indicates that it’s actually required, but probably already has a valid default value | |||
Added in version 4.8.0-393
Description List cluster nodes.
Sample output
array (’status’ => 0,
’payload’ =>
array (
0 =>
array (
’hostname’ => ’apidoc.interworx.com’,
’ipaddr’ => ’10.1.15.200’,
’ipv6’ => ’2001:db8::d:1102’,
’role’ => ’##LG_LOAD_BALANCER## / ##LG_CLUSTER_MANAGER##’,
’status’ => ’active’,
’packet_forwarding_method’ => ’LVS-DR’,
’activation_complete’ => ’yes’,
’activation_details’ => ’’,
’inprogress’ => 100,
),
1 =>
array (
’node_id’ => ’1’,
’hostname’ => ’node1.testing.com’,
’ipaddr’ => ’10.1.1.23’,
’ipv6’ => NULL,
’status’ => ’active’,
’activation_complete’ => ’yes’,
’packet_forwarding_method’ => ’LVS-DR’,
’inprogress’ => 100,
’activation_details’ => ’’,
’role’ => ’##LG_REAL_SERVER##’,
),
),
)
Added in version 5.0.14-579
Description Resolves IPv4 and IPv6 address of a hostname.
Input Parameters
| Name | Type | Notes | Required? |
| hostname | string | Yes |
Prev Chapter 6: Controller: /nodeworx/cluster/lb
Up Part II: NodeWorx API Spec
Chapter 8: Controller: /nodeworx/command/queue Next
(C) 2017 by InterWorx LLC