Controller: ClusterNodes

API Controller /nodeworx/cluster/nodes
Required Permissions ["CLUSTERING"]
Action Description
add Add a cluster node.
delete Delete a cluster node.
forceDelete Force deletion of a cluster node, even if the cluster manager cannot reach it.
listClusterNodes List cluster nodes.

Action: add (Added in version 4.2.0-260)

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
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-CP 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

Action: delete (Added in version 4.2.0-260)

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

Action: forceDelete (Added in version 4.8.0-393)

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

Action: listClusterNodes (Added in version 4.8.0-393)

List cluster nodes.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'hostname' => 'cos5-inst.interworx.com',
      'ipaddr' => '208.69.122.234',
      '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' => '00000000001',
      'hostname' => 'node1.testing.com',
      'ipaddr' => '10.1.1.23',
      'status' => 'active',
      'activation_complete' => 'yes',
      'packet_forwarding_method' => 'LVS-DR',
      'inprogress' => 100,
      'activation_details' => '',
      'role' => '##LG_REAL_SERVER##',
    ),
  ),
)