This is the documentation for the development version. There are no official binaries for it; build it from the source code in git. Download links on these pages work only after the release. For the current release, see version 7.0.

AgentExecuteCommand()

Deprecated in 5.0.

Please use executeAgentCommand() method of Node class.

AgentExecuteCommand(node, commandName, …): bool

Execute agent command (action) on given node. Optional arguments starting from 3rd are passed as command arguments to the agent.

Prior to v. 4.2 this function was named AgentExecuteAction
Table 1. Parameters

node

Node object instance (e.g. $node)

commandName

Name of the command to be executed

…

Optional arguments for command

Return

Boolean indicator of success. false is also returned if the script lacks control access to the node or agent connection cannot be established.

>>> AgentExecuteCommand($node, "System.Restart");
true

>>> AgentExecuteCommand($node, "Custom.RestartService", "jetty9");
true

>>> AgentExecuteCommand($node, "nonexisting action");
false