Contents

Agent.GetConnectionInformation

Method

GetConnectionInformation

ModuleAgent
LibraryCore
Action

Returns Switch connection and Background Channel information.

Parameters(None)
Return values

SwitchName (string): Hostname of the Switch to which the Agent is connected.

SwitchId (int): The database identifier of the Switch instance to which the Agent is connected.

Worker (int): The Switch worker number hosting the Agent connection.

Slot (int): The Switch slot number on the given Switch worker hosting the Agent connection.

SwitchConnectionTime (string): The UTC date and time that the Agent connected to the Switch. See notes.

LocalIpAddress (string): Local IP address that the Agent is using to connect to the Switch. From v5.1.

LocalPort (string): Local port that the Agent is using to connect to the Switch. From v5.1.

RemoteIpAddress (string): Remote IP address of the Switch. From v5.1.

RemotePort (string): Remote port of the Switch. From v5.1.

SwitchCertThumbprint (string) Thumbprint of the certificate received from the Switch. From v5.1.

ClientCertThumbprint (string): Thumbprint of the certificate sent to the Switch. From v5.1.

BGCCertThumbprint (string): Thumbprint of the certificate received from the Background Channel. From v5.1.

BGCConnectionTime (string). The UTC date and time that the Agent last attempted a Background Channel connection. From v5.1.

BGCConnected (string): Indicates whether the last Background Channel connection succeeded. From v5.1.

There is no v5.1 1E Client for Android so the new values are not yet available on Android.
Example
 Agent.GetConnectionInformation();
Platforms
  • Windows
  • Linux
  • MacOS
  • Solaris Intel
  • Solaris Sparc
  • Android
Notes

If 1E Nomad is available, then the Tachyon Agent will not access the Background Channel directly and cannot report on that connection.

Return values are always strings. If you need to perform comparison or mathematical operations on numbers then you need to CAST the string.