X4 Produktdokumentation

Telnet Connector

Dieser Adapter stellt eine Verbindung zu Servern über das Teletype Network Protocol her.

Eigenschaften (Properties) 


Operation

Vom Adapter ausgeführte Operation

Mögliche Werte: Execute: Führt die Befehle aus, die über ein Input-XML zur Verfügung gestellt wurden

Parameter


Adapter

Adapter-Hauptklasse (nicht verändern!)

Mögliche Werte:de.softproject.integration.adapter.telnet.TelnetAdapter: Hauptklasse (Standard)

host

Erforderlicher Parameter: Host des Servers zu dem die Verbindung hergestellt werden soll

Mögliche Werte:

  • IP: Beliebige gültige Host-IP, z. B.  1.1.1.1

  • String: Beliebiger gültiger Host-Name, z. B. myServer.com

port

Port des Servers zu dem die Verbindung hergestellt werden soll

Mögliche Werte:

  • Beliebige ganze Zahl

  • 23 (Standard): Standard-Port für Telnet-Verbindungen

user

Benutzername für die Telnet-Verbindung

Mögliche Werte: Zeichenkette mit dem Benutzernamen, z. B. MyUser

password

Passwort für die Telnet-Verbindung

Mögliche Werte: Zeichenkette mit dem Passwort, z. B. MyPassword

timeout

Verbindungs-Timeout in Millisekunden

Mögliche Werte:

  • Beliebige ganze Zahl

  • 30000 (Standard): Standardwert von 30 Sekunden

responseDelay

Antwort-Verzögerung in Millisekunden

Mögliche Werte:

  • Beliebige ganze Zahl

  • 750 (Standard): Standardwert von 0.75 Sekunden

cleanAnsiVTSequences

Angabe, ob die Ausgabe ANSI-VT-Zeichen enthalten soll oder nicht

Mögliche Werte:

  • true (Standard): Die Ausgabe enthält ANSI-VT-Zeichen

  • false: Die Ausgabe enthält keine ANSI-VT-Zeichen

Statuswerte


1

Die Adapter-Operation wurde erfolgreich ausgeführt

-1

Bei der Ausführung des Adapters kam es zu einem FehlerThe adapter operation was executed successfully 

Input

Bei der Verbindungsherstellung über Telnet, verwendet der Adapter standardmäßig Labels innerhalb der Zugangsdaten login: und password:. Wenn Sie jedoch eine Verbindung zu einem Rechner herstellen möchten, der abweichende Zugangs-Labels hat, können diese im Input-XML über den Knoten <Configuration> konfiguriert werden.

Der Telnet Connector erwartet folgende Input-Struktur: 

XML
<Telnet> <!-- Any root name respecting XML naming rules -->
	<!-- Optional attributes. If ignored, the default patterns will be used. -->
	<Configuration loginLabel="Username: " passwordLabel="Password: "/> 
	<Commands>
		<Command value="ls -ll" />
		<Command value="mkdir /home/luis/myNewFolder"/>
		<Command value="touch /home/luis/myNewFolder/aNewEmptyFile.txt"/>
		<Command value="ls -ll"/>
	</Commands>
	<!-- Any number of Command nodes, which will be executed in the same connection -->
</Telnet>

Erläuterung:

  • Telnet: Wurzelknoten

  • Configuration: Knoten mit demselben Inhalt wie im Input angegeben. Obwohl der Knoten erforderlich ist, sind die Attribute loginLabel und passwordLabel optional.

  • Commands: Knoten, der alle verwendeten Befehle umschließt

  • Command: Beliebige Anzahl an Command-Knoten mit einem value-Attribut, der die auszuführenden Befehle enthält.

Output

Der Telnet Connector gibt eine XML-Struktur aus, die folgender Ausgabe ähnelt:

XML
<Telnet>
	<LoginResult>Successful</LoginResult>
	<Configuration loginLabel="Username: " passwordLabel="Password: "/>
	<Commands>
		<Command value="ls -ll">total 52
			-rw-rw-r-- 1 ivan ivan 555 feb 24 15:30 a.txt
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Desktop
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Documents
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Downloads
			-rw-r--r-- 1 ivan ivan 8980 feb 20 12:45 examples.desktop
			drwxrwxr-x 2 ivan ivan 4096 feb 21 14:54 mio
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Music
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Pictures
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Public
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Templates
			drwxr-xr-x 2 ivan ivan 4096 feb 20 12:59 Videos
			$
		</Command>
	</Commands>
	<!-- Command node containing the value (response) for each Command node available in the input file -->
</Telnet>

Erläuterung:

  • Telnet: Wurzelknoten

  • LoginResult: Information zum Login-Ergebnis. Der Wert des Knotens ist entweder Failed oder Successful.

  • Configuration: Knoten mit demselben Inhalt wie im Input angegeben. 

  • Commands: Knoten, der alle verwendeten Befehle umschließt

  • Command: Beliebige Anzahl an Command-Knoten mit einem value-Attribut, der die auszuführenden Befehle enthält. Der Inhalt dieses Knotens ist das vom Telnet-Server ausgegebene Ergebnis des Befehls.