GatewayAction()

Executes a specifc action for a gateway instance.

Introduced: 6.2.0.75

GatewayAction( gatewayID=string, action=string, waitForIt=boolean, timeout=timespan );

Returns: String

Argument Description Default
gatewayID
string, required

Identifier of the gateway to do the action on.

action
string, required

action to execute, possible values are [start,stop and restart]

waitForIt
boolean, optional

Wait for the process to end (starting, stopping or restarting)

true

timeout
timespan, optional

in case waitForIt is set to true, this defines how long we wait for the process to end, default is one second.

Examples

There are currently no examples for this function 13,812ms WARN No examples for function gatewayaction

See also