Telnet 0.11.3

.NET 6.0 .NET Standard 2.0 .NET Framework 4.6.2
NuGet\Install-Package Telnet -Version 0.11.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package Telnet --version 0.11.3
<PackageReference Include="Telnet" Version="0.11.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Telnet --version 0.11.3
#r "nuget: Telnet, 0.11.3"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Telnet as a Cake Addin
#addin nuget:?package=Telnet&version=0.11.3

// Install Telnet as a Cake Tool
#tool nuget:?package=Telnet&version=0.11.3

Build, Publish, Tag

Telnet

We needed to issue simple commands to (and monitor) a router remotely and that's what we've been able to achieve with this little library. It's usage is simple, it doesn't do anything particularly fancy but if all you're wanting to do is interact with a telnet server by issuing commands, parsing text responses and having the opportunity to respond in code accordingly then hopefully having taken the time to wrap this up in a simple NuGet package will make your life easier!

FWIW I'm happy to take merge requests if they meet incumbent standards, don't break anything and accomodate the code file sharing so all versions work (and likely receive the same change). I'm no TCPIP/Telnet expert but if I can help out with bugs or feature requests I'll do what I can, outside my day job ofc!

v0.9 introduced a significant bump to Net versions and some potentially breaking code changes. Changes to your consuming code should be minimal, but be prepared to test thoroughly. Please raise an Issue if you encounter any problems; in part it'll help others with the same problems and we'll see what we can do to accomodate your use cases.

v0.10 introduced an unintended dependency that's removed as of 0.11.2.

Usage:

.NET Fiddle https://dotnetfiddle.net/S9Ii6n

    // Async Example
    namespace PrimS.Telnet.CiTests
    {
      using System;
      using FluentAssertions;
      using System.Threading;
      using System.Threading.Tasks;
      using System.Text.RegularExpressions;
      using Xunit;

      public class ReadMeExampleFixture
      {
        public const string Pattern =
          "(?:WAN2 total TX: )([0-9.]*) " +
          "((?:[KMG]B)|(?:Bytes))" +
          "(?:[, ]*RX: )([0-9.]*) " +
          "((?:[KMG]B)|(?:Bytes))";
        private const int TimeoutMs = 5000;

        [Fact]
        public async Task ReadMeExample()
        {
          using (var server = new DummyTelnetServer())
          {
            using (var client = new Client(
              server.IPAddress.ToString(),
              server.Port,
              new CancellationToken()))
            {
              client.IsConnected.Should().Be(true);
              Client.IsWriteConsole = false;
              (await client.TryLoginAsync(
                "username",
                "password",
                TimeoutMs)).Should().Be(true);
              await client.WriteLineAsync("show statistic wan2");
              string s = await client.TerminatedReadAsync(
                ">",
                TimeSpan.FromMilliseconds(TimeoutMs));
              s.Should().Contain(">");
              s.Should().Contain("WAN2");
              var regEx = new Regex(Pattern);
              regEx.IsMatch(s).Should().Be(true);
              MatchCollection matches = regEx.Matches(s);
              matches.Count.Should().Be(1);
              matches[0].Captures.Count.Should().Be(1);
              matches[0].Groups.Count.Should().Be(5);
              matches[0].Groups[0].Value.Should().Be(
                "WAN2 total TX: 6.3 GB ,RX: 6.9 GB");
              matches[0].Groups[1].Value.Should().Be("6.3");
              matches[0].Groups[2].Value.Should().Be("GB");
              matches[0].Groups[3].Value.Should().Be("6.9");
              matches[0].Groups[4].Value.Should().Be("GB");
            }
          }
        }
      }
    }
    //Sync Example
    namespace PrimS.Telnet.CiTests
    {
      using FluentAssertions;
      using Xunit;
      using System;
      using System.Text.RegularExpressions;

      [TestClass]
      public class ReadMeExampleFixture
      {
        public const string Pattern =
          "(?:WAN2 total TX: )([0-9.]*) " +
          "((?:[KMG]B)|(?:Bytes))" +
          "(?:[, ]*RX: )([0-9.]*) " +
          "((?:[KMG]B)|(?:Bytes))";
        private const int TimeoutMs = 5000;

        [Fact]
        public void ReadMeExample()
        {
          using (var server = new DummyTelnetServer())
          {
            using (var client = new Client(
              server.IPAddress.ToString(),
              server.Port,
              new CancellationToken()))
            {
              client.IsConnected.Should().Be(true);
              Client.IsWriteConsole = false;
              client.TryLogin(
                "username",
                "password",
                TimeoutMs).Should().Be(true);
              client.WriteLine("show statistic wan2");
              string s = client.TerminatedRead(
                ">",
                TimeSpan.FromMilliseconds(TimeoutMs));
              s.Should().Contain(">");
              s.Should().Contain("WAN2");
              var regEx = new Regex(Pattern);
              regEx.IsMatch(s).Should().Be(true);
              MatchCollection matches = regEx.Matches(s);
              matches.Count.Should().Be(1);
              matches[0].Captures.Count.Should().Be(1);
              matches[0].Groups.Count.Should().Be(5);
              matches[0].Groups[0].Value.Should().Be(
                "WAN2 total TX: 6.3 GB ,RX: 6.9 GB");
              matches[0].Groups[1].Value.Should().Be("6.3");
              matches[0].Groups[2].Value.Should().Be("GB");
              matches[0].Groups[3].Value.Should().Be("6.9");
              matches[0].Groups[4].Value.Should().Be("GB");
            }
          }
        }
      }
    }
    // VB.NET Example
    Private Async Function RunRemoteScript(
      commandLine As String) As Task(Of Boolean)
        Using telnet = New Client(
          "HostName",
          23,
          _cancellationSource.Token)
            If Not telnet.IsConnected Then Return False
            Dim loggedOn = Await telnet.TryLoginAsync(
              "username",
              "password",
              SocketTimeout, "#"))
            If Not loggedOn Then Return False
            Await telnet.WriteLine(commandLine)
            Dim serverResponse = Await telnet.TerminatedReadAsync(
              "#",
              TimeSpan.FromMilliseconds(SocketTimeout))
            Debug.Print(serverResponse)
            Await telnet.WriteLine("exit")
            Dim logoutMessage = Await telnet.ReadAsync(
              New TimeSpan(100))
            Debug.Print(logoutMessage)
        End Using
        Return True  ' If we got this far; celebrate
    End Function
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.6.2

    • No dependencies.
  • .NETFramework 4.7.2

    • No dependencies.
  • .NETFramework 4.8

    • No dependencies.
  • .NETStandard 2.0

    • No dependencies.
  • .NETStandard 2.1

    • No dependencies.
  • net6.0

    • No dependencies.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Telnet:

Package Downloads
TeamSpeak3.Metrics

Collect metrics from your TeamSpeak 3 Server

DreamNucleus.Heos

A .Net HEOS CLI client using Reactive Extensions

Rosystec.Scan.Lib

sensor aggregator

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.11.3 174 9/17/2022
0.11.2 422 9/3/2022
0.11.1 105 9/2/2022
0.11.0 152 9/2/2022
0.10.2 457 8/22/2022
0.10.1 116 8/21/2022
0.10.0 82 8/20/2022
0.9.1 285 8/18/2022
0.9.0-beta0001 6,994 5/16/2018
0.8.6 109,102 9/3/2020
0.8.6-beta0001 312 9/2/2020
0.8.4 38,442 10/9/2019
0.8.3 23,791 3/7/2019
0.8.2 3,152 1/30/2019
0.8.1 52,015 5/8/2018
0.8.0 29,472 3/12/2017
0.7.0 9,615 9/6/2016
0.6.1 51,649 2/25/2016
0.6.0 1,318 1/27/2016
0.5.0 1,316 12/8/2015
0.4.0 1,723 10/27/2015
0.3.2 1,275 9/15/2015
0.3.1 2,059 6/20/2015
0.2.5 54,487 12/15/2014
0.2.0 1,096 11/27/2014
0.1.0 1,237 11/26/2014

0.11.3 exposes the TcpByteStream(ISocket) and TcpClient(System.Net.Sockets.TcpClient) ctors
     allowing more open access to creating a viable client than (string hostName, int port).