AgentExecuteCommand()

Deprecated in 5.0.

Please use executeAgentCommand() method of NetObj 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

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

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

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