Lucee Function Reference

gatewayaction()

Executes a specifc action for a gateway instance.

Example

gatewayaction(string gatewayID,string action,[boolean waitForIt,[timespan timeout]]):string

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
gatewayID string  Yes   Identifier of the gateway to do the action on.  
action string  Yes   action to execute, possible values are [start,stop and restart]  
waitForIt boolean  No true Wait for the process to end (starting, stopping or restarting)  
timeout timespan  No   in case `waitForIt` is set to `true`, this defines how long we wait for the process to end, default is one second.