SSH Client (PowerShell) - Revision history

Sstrutt: /* Renci SSH.NET */ Reworded

2013-08-12T13:43:52Z

Renci SSH.NET: Reworded

← Older revision		Revision as of 13:43, 12 August 2013
Line 13:		Line 13:

	== Renci SSH.NET ==		== Renci SSH.NET ==
	[http://sshnet.codeplex.com/ Renci SSH.NET] is ~~an ongoing~~ project~~, its~~ still ~~in beta~~, ~~but already provides~~ a ~~workable solution with all the core features you're likely to want~~. ~~Plus as its in active development there's high chance that any probs you might have would~~ be ~~promptly worked on~~. It provides both .NET 4.0 and 3.5 libraries, ''~~'you need to~~ use ~~the~~ .NET 3.5 library ~~for PowerShell v2''',~~ see [http://vblog.strutt.org.uk/2011/11/ssh-client-using-powershell/#comment-245 here] for guidance on how to get working ~~with~~ PowerShell v1.		[http://sshnet.codeplex.com/ Renci SSH.NET] is a stable project still receiving ongoing active development, providing a .NET SSH library, which can be used by PowerShell. It is very easy to use, and robust.

			It provides both .NET 4.0 and 3.5 libraries (see [[Getting_Started_(PowerShell)#Installed_Version...\|Installed_Version]] if you don't know what version of PowerShell you're running)
			* PowerShell v1 - use .NET 3.5 library and see [http://vblog.strutt.org.uk/2011/11/ssh-client-using-powershell/#comment-245 here] for additional guidance on how to get working
			* PowerShell v2 - use .NET 3.5 library
			* PowerShell v3 - use either .NET 3.5 or .NET 4 libraries

	To get running you need to download the binary DLL file...		To get running you need to download the binary DLL file...
Line 23:		Line 28:
	</source>		</source>

	~~'''If~~ you don't have .~~NET 3.5 installed''', you'll need to do so from~~ https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 ~~(the main installer is just a downloader~~/~~bootstrapper, there's a full fat install package link at the bottom of the page)~~.		You may need to install .NET if you don't have it running already. Install [https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 .NET 3.5] or [https://www.microsoft.com/en-gb/download/details.aspx?id=30653 .NET 4.5] as appropriate

	'''If you get an error that includes <code>Exception from HRESULT: 0x80131515</code>''', you need to ''Unblock'' the downloaded DLL. Right-click over the file and select '''Properties''', then click on the '''Unblock''' button (if there's no button, its already unblocked).		'''If you get an error that includes <code>Exception from HRESULT: 0x80131515</code>''', you need to ''Unblock'' the downloaded DLL. Right-click over the file and select '''Properties''', then click on the '''Unblock''' button (if there's no button, its already unblocked).

Sstrutt: /* Renci SSH.NET */ Corrected download link, added Unblock error, added Meta

2013-08-12T11:24:18Z

Renci SSH.NET: Corrected download link, added Unblock error, added Meta

← Older revision		Revision as of 11:24, 12 August 2013
Line 15:		Line 15:
	[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, its still in beta, but already provides a workable solution with all the core features you're likely to want. Plus as its in active development there's high chance that any probs you might have would be promptly worked on. It provides both .NET 4.0 and 3.5 libraries, '''you need to use the .NET 3.5 library for PowerShell v2''', see [http://vblog.strutt.org.uk/2011/11/ssh-client-using-powershell/#comment-245 here] for guidance on how to get working with PowerShell v1.		[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, its still in beta, but already provides a workable solution with all the core features you're likely to want. Plus as its in active development there's high chance that any probs you might have would be promptly worked on. It provides both .NET 4.0 and 3.5 libraries, '''you need to use the .NET 3.5 library for PowerShell v2''', see [http://vblog.strutt.org.uk/2011/11/ssh-client-using-powershell/#comment-245 here] for guidance on how to get working with PowerShell v1.

	To get running you need to download the binary DLL file ~~from~~ http://sshnet.codeplex.com/~~releases/view/72214~~, and put it in a place where you can load the assembly (the DLL file) into your PowerShell session, eg		To get running you need to download the binary DLL file...
			# Go to http://sshnet.codeplex.com/
			# Go to the '''Downloads''' page
			# Download the '''SshNet 3.5 Binary''', and put it in a place where you can load the assembly (the DLL file) into your PowerShell session, eg
	<source lang="powershell">		<source lang="powershell">
	[void][reflection.assembly]::LoadFrom( (Resolve-Path ".\lib\RenciSSH\Renci.SshNet.dll") ) # DLL file is in \lib\RenciSSH\ folder below the calling script		[void][reflection.assembly]::LoadFrom( (Resolve-Path ".\lib\RenciSSH\Renci.SshNet.dll") ) # DLL file is in \lib\RenciSSH\ folder below the calling script
	</source>		</source>

	If you don't have .NET 3.5 installed, you'll need to do so from https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 (the main installer is just a downloader/bootstrapper, there's a full fat install package link at the bottom of the page).		'''If you don't have .NET 3.5 installed''', you'll need to do so from https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 (the main installer is just a downloader/bootstrapper, there's a full fat install package link at the bottom of the page).

			'''If you get an error that includes <code>Exception from HRESULT: 0x80131515</code>''', you need to ''Unblock'' the downloaded DLL. Right-click over the file and select '''Properties''', then click on the '''Unblock''' button (if there's no button, its already unblocked).

	For some examples of what can you do, see my vBlog pages at http://vblog.strutt.org.uk/tag/renci-sshnet/.		For some examples of what can you do, see my vBlog pages at http://vblog.strutt.org.uk/tag/renci-sshnet/.

Sstrutt: /* Renci SSH.NET */ Added links to vBlog

2012-07-19T10:24:29Z

Renci SSH.NET: Added links to vBlog

← Older revision		Revision as of 10:24, 19 July 2012
Line 13:		Line 13:

	== Renci SSH.NET ==		== Renci SSH.NET ==
	[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, its still in beta, but already provides a workable solution with all the core features you're likely to want. Plus as its in active development there's high chance that any probs you might have would be promptly worked on. It provides both .NET 4.0 and 3.5 libraries, '''you need to use the .NET 3.5 library for PowerShell v2'''.		[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, its still in beta, but already provides a workable solution with all the core features you're likely to want. Plus as its in active development there's high chance that any probs you might have would be promptly worked on. It provides both .NET 4.0 and 3.5 libraries, '''you need to use the .NET 3.5 library for PowerShell v2''', see [http://vblog.strutt.org.uk/2011/11/ssh-client-using-powershell/#comment-245 here] for guidance on how to get working with PowerShell v1.

	To get running you need to download the binary DLL file from http://sshnet.codeplex.com/releases/view/72214, and put it in a place where you can load the assembly (the DLL file) into your PowerShell session, eg		To get running you need to download the binary DLL file from http://sshnet.codeplex.com/releases/view/72214, and put it in a place where you can load the assembly (the DLL file) into your PowerShell session, eg
Line 22:		Line 22:

	If you don't have .NET 3.5 installed, you'll need to do so from https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 (the main installer is just a downloader/bootstrapper, there's a full fat install package link at the bottom of the page).		If you don't have .NET 3.5 installed, you'll need to do so from https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 (the main installer is just a downloader/bootstrapper, there's a full fat install package link at the bottom of the page).

			For some examples of what can you do, see my vBlog pages at http://vblog.strutt.org.uk/tag/renci-sshnet/.

	=== Simple Command ===		=== Simple Command ===

Sstrutt: Added "Download File"

2012-04-24T13:00:26Z

Added "Download File"

← Older revision		Revision as of 13:00, 24 April 2012
Line 15:		Line 15:
	[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, its still in beta, but already provides a workable solution with all the core features you're likely to want. Plus as its in active development there's high chance that any probs you might have would be promptly worked on. It provides both .NET 4.0 and 3.5 libraries, '''you need to use the .NET 3.5 library for PowerShell v2'''.		[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, its still in beta, but already provides a workable solution with all the core features you're likely to want. Plus as its in active development there's high chance that any probs you might have would be promptly worked on. It provides both .NET 4.0 and 3.5 libraries, '''you need to use the .NET 3.5 library for PowerShell v2'''.

	To get running you need to download the binary DLL file from http://sshnet.codeplex.com/releases/view/72214, and put it in a place where you can load the assembly into your PowerShell session, eg		To get running you need to download the binary DLL file from http://sshnet.codeplex.com/releases/view/72214, and put it in a place where you can load the assembly (the DLL file) into your PowerShell session, eg

	<source lang="powershell">		<source lang="powershell">
Line 22:		Line 22:

	If you don't have .NET 3.5 installed, you'll need to do so from https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 (the main installer is just a downloader/bootstrapper, there's a full fat install package link at the bottom of the page).		If you don't have .NET 3.5 installed, you'll need to do so from https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 (the main installer is just a downloader/bootstrapper, there's a full fat install package link at the bottom of the page).

			=== Simple Command ===
			Whilst this is a very simplistic example, involving connecting to a device/server and running the <code>ifconfig</code> command (Unix equivalent of <code>ipconfig</code>; it does open the door to more involved usage where you can run a command, parse the result, then run further commands based on the response.

	'''Create a SSH Client object, and connect...'''		'''Create a SSH Client object, and connect...'''
Line 32:		Line 35:
	* <code>Could not load file or assembly 'System.Core, Version=3.5.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089' or one of its dependencies. The system cannot find the file specified.</code>		* <code>Could not load file or assembly 'System.Core, Version=3.5.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089' or one of its dependencies. The system cannot find the file specified.</code>

	'''Run a command (eg a Unix <code>ifconfig</code> against the server...'''		'''Run a command (eg a Unix <code>ifconfig</code>) against the server...'''
	<source lang="powershell">		<source lang="powershell">
	if ($SshClient.IsConnected) {		if ($SshClient.IsConnected) {
	$SshCommand = $SshClient.RunCommand("ifconfig")		$SshCommand = $SshClient.RunCommand("ifconfig") # Result of 'ifconfig' is returned to $SshCommand
	$ifconfig = $SshCommand.Result.Split("`n")		$ifconfig = $SshCommand.Result.Split("`n") # Split up the result into individual lines for easier parsing
	}		}
	</source>		</source>
Line 46:		Line 49:
	$SshClient.Dispose()		$SshClient.Dispose()
	</source>		</source>

			=== Download File ===
			Simple example showing how to use PowerShell to open up a [[Acronyms#S\|SFTP]] connection to a server, and download a file.

			'''Create a SFTP Client object, and connect...'''
			<source lang="powershell">
			$ConnInfo = New-Object Renci.SshNet.PasswordConnectionInfo("ssh-server", 22, "user", "pass")
			$SftpClient = New-Object Renci.SshNet.SftpClient($ConnInfo)
			$SftpClient.Connect()
			</source>

			'''Create an IO stream to local file'''
			<source lang="powershell">
			$RxFile = "c:\temp\download.txt"
			$RxFileStream = [System.IO.File]::Create($RxFile)
			</source>

			'''Download file''', in this case, an [[:Category:Apache\|Apache]] log file
			<source lang="powershell">
			$SftpClient.DownloadFile("/var/log/apache2/access.log", $RxFileStream) # Download file contents to stream
			$RxFileStream.Flush() # Flush contents through
			$RxFileStream.Close() # Write to file and close stream
			</source>

			'''Clear down...'''
			<source lang="powershell">
			$RxFileStream.Dispose()
			$SftpClient.Disconnect()
			$SftpClient.Dispose()
			</source>


	[[Category:PowerShell]]		[[Category:PowerShell]]
	[[Category:SSH]]		[[Category:SSH]]

Sstrutt: /* Renci SSH.NET */ Some rewording, and added .NET not installed error

2012-04-20T09:31:25Z

Renci SSH.NET: Some rewording, and added .NET not installed error

← Older revision		Revision as of 09:31, 20 April 2012
Line 13:		Line 13:

	== Renci SSH.NET ==		== Renci SSH.NET ==
	[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, still in beta, but already provides a workable solution. ~~Providing~~ both .NET 4.0 and 3.5 libraries (you need 3.5 for PowerShell v2).		[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, its still in beta, but already provides a workable solution with all the core features you're likely to want. Plus as its in active development there's high chance that any probs you might have would be promptly worked on. It provides both .NET 4.0 and 3.5 libraries, '''you need to use the .NET 3.5 library for PowerShell v2'''.

	To get running you need to download the binary DLL file from http://sshnet.codeplex.com/releases/view/72214, and put it in a place where you can load the assembly into your PowerShell session, eg		To get running you need to download the binary DLL file from http://sshnet.codeplex.com/releases/view/72214, and put it in a place where you can load the assembly into your PowerShell session, eg

	<source lang="powershell">		<source lang="powershell">
	[void][reflection.assembly]::LoadFrom( (Resolve-Path ".\lib\RenciSSH\Renci.SshNet.dll") ) # DLL file is in \lib\RenciSSH\ below calling script		[void][reflection.assembly]::LoadFrom( (Resolve-Path ".\lib\RenciSSH\Renci.SshNet.dll") ) # DLL file is in \lib\RenciSSH\ folder below the calling script
	</source>		</source>

	Create a SSH Client object, and connect...		If you don't have .NET 3.5 installed, you'll need to do so from https://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21 (the main installer is just a downloader/bootstrapper, there's a full fat install package link at the bottom of the page).

			'''Create a SSH Client object, and connect...'''
	<source lang="powershell">		<source lang="powershell">
	$SshClient = New-Object Renci.SshNet.SshClient("ssh-server", 22, "user", "password")		$SshClient = New-Object Renci.SshNet.SshClient("ssh-server", 22, "user", "password")
Line 27:		Line 29:
	</source>		</source>

	Run a command (eg a Unix <code>ifconfig</code> against the server...		If the connect fails with the following error - you need to install .NET 3.5 (the SSH library is trying to use components that don't exist).
			* <code>Could not load file or assembly 'System.Core, Version=3.5.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089' or one of its dependencies. The system cannot find the file specified.</code>

			'''Run a command (eg a Unix <code>ifconfig</code> against the server...'''
	<source lang="powershell">		<source lang="powershell">
	if ($SshClient.IsConnected) {		if ($SshClient.IsConnected) {
Line 35:		Line 40:
	</source>		</source>

	Clear down...		'''Clear down...'''
	<source lang="powershell">		<source lang="powershell">
	$SshCommand.Dispose()		$SshCommand.Dispose()

Sstrutt: Initial creation - content from PowerShell Examples page

2012-04-18T13:31:03Z

Initial creation - content from PowerShell Examples page

New page

== Tamir Gal SharpSSH ==
There are a number of examples of using PowerShell to act as a client to interact with SSH servers, all that I've found using [http://www.tamirgal.com/blog/page/SharpSSH.aspx Tamir Gal's SharpSSH .NET library] - eg [http://poshcode.org/1010 PoSh 1010]. Its a port of a Java implementation and whilst some people have obviously had success in using it, I always seemed to get the following error when trying to write to SSH session with a Vyatta router...

# ChannelSession.run
System.IO.IOException: Write end dead
at Tamir.Streams.PipedInputStream.read()
at Tamir.Streams.PipedInputStream.read(Byte[] b, Int32 off, Int32 len)
at Tamir.Streams.PipedInputStream.Read(Byte[] buffer, Int32 offset, Int32 count)
at Tamir.SharpSsh.java.io.JStream.Read(Byte[] buffer, Int32 offset, Int32 count)
at Tamir.SharpSsh.jsch.ChannelSession.run()

I suspect the ''Write end dead'' fault is caused by the SSH server throwing an error and closing the socket, due to an disliked command. Which in a way, is fair enough, but its not a particularly graceful way of handling things.

== Renci SSH.NET ==
[http://sshnet.codeplex.com/ Renci SSH.NET] is an ongoing project, still in beta, but already provides a workable solution. Providing both .NET 4.0 and 3.5 libraries (you need 3.5 for PowerShell v2).

To get running you need to download the binary DLL file from http://sshnet.codeplex.com/releases/view/72214, and put it in a place where you can load the assembly into your PowerShell session, eg

<source lang="powershell">
[void][reflection.assembly]::LoadFrom( (Resolve-Path ".\lib\RenciSSH\Renci.SshNet.dll") ) # DLL file is in \lib\RenciSSH\ below calling script
</source>

Create a SSH Client object, and connect...
<source lang="powershell">
$SshClient = New-Object Renci.SshNet.SshClient("ssh-server", 22, "user", "password")
$SshClient.Connect()
</source>

Run a command (eg a Unix <code>ifconfig</code> against the server...
<source lang="powershell">
if ($SshClient.IsConnected) {
$SshCommand = $SshClient.RunCommand("ifconfig")
$ifconfig = $SshCommand.Result.Split("`n")
}
</source>

Clear down...
<source lang="powershell">
$SshCommand.Dispose()
$SshClient.Disconnect()
$SshClient.Dispose()
</source>

[[Category:PowerShell]]
[[Category:SSH]]