Tunnel

Object contains information about tunnel.

Instance attributes

address ⇒ InetAddress

InetAddress class object with address of the node that opened this tunnel

agentBuildTag: String

Agent build tag

agentId: String

Agent ID of the agent that opened the tunnel

agentVersion: String

Agent version of the node that opened the tunnel

certificateExpirationTime: int

UNIX timestamp of the current certificate expiration time

guid: String

Tunnel GUID

hostname: String

Hostname of the node that opened the tunnel

hardwareId: String

Hardware ID of the node that opened the tunnel, as a hexadecimal string

id: int

Tunnel id

inbound: bool

TRUE if the tunnel was established by the agent connecting to the server (inbound tunnel), FALSE if the server connected to the agent (outbound tunnel).

isAgentProxy: bool

TRUE if agent proxy is enabled on the agent that opened the tunnel

isBound: bool

TRUE if tunnel is bound

isSnmpProxy: bool

TRUE if SNMP proxy is enabled on the agent that opened the tunnel

isSnmpTrapProxy: bool

TRUE if SNMP trap proxy is enabled on the agent that opened the tunnel

isUserAgentInstalled: bool

TRUE if user agent is installed on the agent that opened the tunnel

macAddresses: Array

Array with MAC addresses as Strings

platformName: String

Platform name of the node that opened the tunnel

startTime: int

UNIX timestamp with tunnel start time

serialNumber: String

Serial number

systemInfo: String

System information of the node that opened the tunnel

systemName: String

System name of the node that opened the tunnel

zoneUIN: int

Node’s zone UIN if set in agent’s configuration file

Instance methods

bind(node): bool

Bind the tunnel to a specified node. Only unbound inbound tunnels can be bound; on success the server issues a certificate to the agent and resets the tunnel.

Table 1. Parameters

node

Node

Node object to bind the tunnel to
Return

true on success, false on failure (tunnel is outbound, already bound or bind in progress, node not found, or certificate request failed).