Chapter 7: Controller: /nodeworx/cluster/nodes Up Part II: NodeWorx API Spec Chapter 9: Controller: /nodeworx/cron 

8 Controller: /nodeworx/command/queue

Required Permissions "CLUSTERING"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => false,
)
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 Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
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_COMMAND_QUEUE##’,
)
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’ => ’N/A’,
)
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 => ’N/A’,
),
)
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 => ’CLUSTERING’,
),
)
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’ => ’iworx-queue-d’,
’name’ => ’##LG_COMMAND_QUEUE##’,
’ports’ => ’N/A’,
’page’ => ’/nodeworx/command/queue’,
’ctrl’ => ’/nodeworx/command/queue’,
’is_running’ => 0,
),
)
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’ => ’iworx-queue-d’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/command/queue’,
)
Action: queryCommandHistory
Added in version 4.7.0-339
Description View history of the command queue.
Input Parameters
Name Type Notes Required?
count integer Example Default Value
20
No*
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryQueuedCommands
Added in version 4.7.0-339
Description Query the command queue on a node.
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id 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 Stops the service.
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
 Chapter 7: Controller: /nodeworx/cluster/nodes Up Part II: NodeWorx API Spec Chapter 9: Controller: /nodeworx/cron 

(C) 2017 by InterWorx LLC