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
-
TRUEif the tunnel was established by the agent connecting to the server (inbound tunnel),FALSEif the server connected to the agent (outbound tunnel).
- 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): bool
-
Bind the tunnel to a specified node. Only unbound inbound tunnels can be bound. If the agent uses a server-issued certificate, the server issues a new certificate to the agent; if the agent uses an externally provisioned certificate, the server sets a certificate mapping by subject on the node instead. In both cases the tunnel is then reset.
Table 1. Parameters node
Node object to bind the tunnel to
Returntrueon success,falseon failure (tunnel is outbound, already bound or bind in progress, node not found, certificate request failed, or the externally provisioned certificate has no subject or its subject is already mapped to another node).