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
- isAgentProxy: bool
-
TRUEif agent proxy is enabled on the agent that opened the tunnel
- isBound: bool
-
TRUEif tunnel is bound
- isSnmpProxy: bool
-
TRUEif SNMP proxy is enabled on the agent that opened the tunnel
- isSnmpTrapProxy: bool
-
TRUEif SNMP trap proxy is enabled on the agent that opened the tunnel
- isUserAgentInstalled: bool
-
TRUEif 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): int
-
Bind the tunnel to a specified node. Only unbound tunnels can be bound; on success the server issues a certificate to the agent and resets the tunnel.
Table 1. Parameters node
Node object to bind the tunnel to
ReturnRequest completion code:
0on success, non-zero error code on failure (tunnel already bound or bind in progress, node not found, or certificate request failed).