Remote access

Sometimes the integration is not a protocol the device speaks on your behalf — it is you, on the device, running commands. OpenGate opens these connections from a connector function, so the device must be reachable at an IP address, directly or through a gateway.

SSH and Telnet

Both follow the same three-step shape, and the object properties are set before connecting:

ssh.ip = "10.0.0.7";
ssh.user = "admin";
ssh.identity = "-----BEGIN RSA PRIVATE KEY-----...";
ssh.connect(["$"]);
var out = ssh.send("show version", "#", ["#"]);
ssh.disconnect();

connect and send both take a waitFor list: the strings that tell the client the device has finished talking. Getting those right is most of the work with a shell integration, because there is no framing to rely on — a prompt is the only end-of-message marker you have.

Prefer identity over password where the device supports it, and read either from the provisioned entity rather than hardcoding it in the script.

References: SSH · Telnet

ICMP

A ping, which answers the one question every other integration depends on: is this device reachable at all?

Because async defaults to true, the result usually does not come back in the same execution. It arrives at a separate RESPONSE connector function, which receives the outcome as its payload — that is what the ICMP Response reference documents.

Set async to false when you want the answer inline and are prepared to wait for it.

References: ICMP · ICMP Response

Where to go next