SNMP and PowerShell - Revision history

Sstrutt: /* Overview */ Updated for v8 of library

2016-10-10T10:43:53Z

Overview: Updated for v8 of library

← Older revision		Revision as of 10:43, 10 October 2016
Line 8:		Line 8:
	You don't need to use /n's [http://www.powershellinside.com/powershell/netcmdlets/ NetCmdlets], or run the [http://www.net-snmp.org/ Net-SNMP] executables, as other examples on the web do.		You don't need to use /n's [http://www.powershellinside.com/powershell/netcmdlets/ NetCmdlets], or run the [http://www.net-snmp.org/ Net-SNMP] executables, as other examples on the web do.

	In order to make the library available for PowerShell to use...		=== Installation ===
	~~# Download~~ the ~~latest~~ '''~~BigDipper~~''' binary (eg ~~bigdipper_7~~.~~5_bin~~.zip) from http://sharpsnmplib.codeplex.com/releases/view/~~78947~~ and extract		In order to make the library available for PowerShell to use you need to have the .NET dll library file available for Powershell
			# Go to http://sharpsnmplib.codeplex.com and browse to the '''Downloads''' tab
			#* Current latest is v8 (TritonMate), later versions are available from [https://www.nuget.org Nuget]
			# Download the latest binary (eg tritonmate_8.0_bin.zip from http://sharpsnmplib.codeplex.com/releases/view/79079) and extract
	# Copy the <code>SharpSnmpLib.dll</code> file to somewhere you can find it		# Copy the <code>SharpSnmpLib.dll</code> file to somewhere you can find it
	#* EG in a folder <code>/lib/LexTmSharpSNMP/</code> under where you run your scripts from		#* EG in a folder <code>/lib/LexTmSharpSNMP/</code> under where you run your scripts from
			#* Note that you may need to Unblock the file (right-click and select '''Properties''' and look for '''Unblock''' towards bottom of Properties window)

	'''Windows 2008 Server doesn't have .NET 3.5 or 4 installed by default''', therefore it needs to be installed. To do so...		'''Windows 2008 Server doesn't have .NET 3.5 or 4 installed by default''', therefore it needs to be installed. To do so...

Sstrutt: Added Google Ad

2016-10-04T14:57:29Z

Added Google Ad

← Older revision		Revision as of 14:57, 4 October 2016
Line 1:		Line 1:
			{{#widget:Widget:GoogleAdSenseSkyscraper}}
	== Overview ==		== Overview ==
	This page covers using PowerShell as an SNMP client, so that you can poll/probe/interrogate SNMP servers (be they servers, network devices, UPS's, etc).		This page covers using PowerShell as an SNMP client, so that you can poll/probe/interrogate SNMP servers (be they servers, network devices, UPS's, etc).

Sstrutt: /* Example Usage */ Added link to vBlog examples

2013-06-17T16:47:31Z

Example Usage: Added link to vBlog examples

← Older revision		Revision as of 16:47, 17 June 2013
Line 150:		Line 150:

	== Example Usage ==		== Example Usage ==
			{\| class="vwiki-boxout"
			\|-
			\| '''For further examples see - http://vblog.strutt.org.uk/tag/sharpsnmplib/'''
			\|}


	If you saved the [[#Generic_Objects\|Generic Objects]] workaround script, the SNMP DLL file, and the above functions in <code>lib</code> sub-folder to where your running your PowerShell from, then you could perform queries as follows...		If you saved the [[#Generic_Objects\|Generic Objects]] workaround script, the SNMP DLL file, and the above functions in <code>lib</code> sub-folder to where your running your PowerShell from, then you could perform queries as follows...

Sstrutt: Minor typo fixes and PowerShell v3 Generic Objects compatability

2013-05-31T10:34:38Z

Minor typo fixes and PowerShell v3 Generic Objects compatability

← Older revision		Revision as of 10:34, 31 May 2013
Line 8:		Line 8:

	In order to make the library available for PowerShell to use...		In order to make the library available for PowerShell to use...
	# Download the latest '''BigDipper''' binary from http://sharpsnmplib.codeplex.com/releases/view/78947 and extract		# Download the latest '''BigDipper''' binary (eg bigdipper_7.5_bin.zip) from http://sharpsnmplib.codeplex.com/releases/view/78947 and extract
	# Copy the <code>SharpSnmpLib.dll</code> file to somewhere you can find it		# Copy the <code>SharpSnmpLib.dll</code> file to somewhere you can find it
	#* EG in a folder <code>/lib/LexTmSharpSNMP/</code> under where you run your scripts from		#* EG in a folder <code>/lib/LexTmSharpSNMP/</code> under where you run your scripts from
Line 26:		Line 26:

	=== Generic Objects ===		=== Generic Objects ===
	In order to use the library you need to be able to create generic objects, which doesn't work in PowerShell v1. Its meant to be fixed in v2, but I've not got it to work (probably because I don't actually understand what they are really. So I've used this [http://www.leeholmes.com/blog/2006/08/18/creating-generic-types-in-powershell/ workaround by Lee Holmes].		==== PowerShell v1 and v2 ====
			In order to use the library you need to be able to create generic objects, which doesn't work in PowerShell v1. Its meant to be fixed in v2, but I've not got it to work (probably because I don't actually understand what they are really. So I've used this [http://www.leeholmes.com/blog/2006/08/18/creating-generic-types-in-powershell/ workaround by Lee Holmes]).

	The function below is Lee Holmes' work wrapped into a function...		The function below is Lee Holmes' work wrapped into a function...
Line 60:		Line 61:
	}		}
	</source>		</source>

			==== PowerShell v3 ====
			Generic Objects do work in PowerShell v3! So you don't need to use the <code>New-GenericObject</code> function provided above. It's still used in the examples below so that they're backwards compatible, but I've also added a commented out line which you can use instead, should you be running v3.

	== SNMP Get ==		== SNMP Get ==
Line 69:		Line 73:

	# Create OID variable list		# Create OID variable list
	$vList = New-GenericObject System.Collections.Generic.List Lextm.SharpSnmpLib.Variable		$vList = New-GenericObject System.Collections.Generic.List Lextm.SharpSnmpLib.Variable # PowerShell v1 and v2
			# $vList = New-Object 'System.Collections.Generic.List[Lextm.SharpSnmpLib.Variable]' # PowerShell v3
	foreach ($sOID in $sOIDs) {		foreach ($sOID in $sOIDs) {
	$oid = New-Object Lextm.SharpSnmpLib.ObjectIdentifier ($sOID)		$oid = New-Object Lextm.SharpSnmpLib.ObjectIdentifier ($sOID)
Line 113:		Line 118:

	# Create list for results		# Create list for results
	$results = New-GenericObject System.Collections.Generic.List Lextm.SharpSnmpLib.Variable		$results = New-GenericObject System.Collections.Generic.List Lextm.SharpSnmpLib.Variable # PowerShell v1 and v2
			# $results = New-Object 'System.Collections.Generic.List[Lextm.SharpSnmpLib.Variable]' # PowerShell v3

	# Create endpoint for SNMP server		# Create endpoint for SNMP server
Line 191:		Line 197:
	# Download the file below to a <code>lib</code> sub-folder, underneath where you normally run your scripts from		# Download the file below to a <code>lib</code> sub-folder, underneath where you normally run your scripts from
	#* http://dl.sandfordit.com/scripts/SNMP.ps1		#* http://dl.sandfordit.com/scripts/SNMP.ps1
			#* You may need to unblock the downloaded file, right-click over the file and select '''Properties''', then click '''Unblock'''
	# Download the latest '''BigDipper''' binary from http://sharpsnmplib.codeplex.com/releases/view/78947 and extract		# Download the latest '''BigDipper''' binary from http://sharpsnmplib.codeplex.com/releases/view/78947 and extract
	# Copy the <code>SharpSnmpLib.dll</code> file to a <code>LexTmSharpSNMP/</code> folder, underneath the <code>lib</code> folder		# Copy the <code>SharpSnmpLib.dll</code> file to a <code>LexTmSharpSNMP/</code> folder, underneath the <code>lib</code> folder

Sstrutt: Added "Snap-In for PowerShell"

2013-02-12T12:36:35Z

Added "Snap-In for PowerShell"

@@ Line 185: / Line 185: @@
 .1.3.6.1.2.1.1.7.0                                          76
 </pre>
 [[Category:SNMP]]
 [[Category:PowerShell]]

Sstrutt: /* Overview */ Added Win2008 needs .NET 3.5 note

2012-11-19T23:31:10Z

Overview: Added Win2008 needs .NET 3.5 note

← Older revision		Revision as of 23:31, 19 November 2012
Line 8:		Line 8:

	In order to make the library available for PowerShell to use...		In order to make the library available for PowerShell to use...
	# Download the latest ''BigDipper'' binary from http://sharpsnmplib.codeplex.com/releases/view/78947 and extract		# Download the latest '''BigDipper''' binary from http://sharpsnmplib.codeplex.com/releases/view/78947 and extract
	# Copy the <code>SharpSnmpLib.dll</code> file to somewhere you can find it		# Copy the <code>SharpSnmpLib.dll</code> file to somewhere you can find it
	#* EG in a folder <code>/lib/LexTmSharpSNMP/</code> under where you run your scripts from		#* EG in a folder <code>/lib/LexTmSharpSNMP/</code> under where you run your scripts from

			'''Windows 2008 Server doesn't have .NET 3.5 or 4 installed by default''', therefore it needs to be installed. To do so...
			# Go into Server Manager \| Roles
			# Select '''Add roles''' to start the wizard
			# Select/tick the '''Application Server''' role, and then ''Add required feature''
			# Complete the wizard

	You can then load the assembly into your PowerShell session by something like...		You can then load the assembly into your PowerShell session by something like...
Line 54:		Line 60:
	}		}
	</source>		</source>


	== SNMP Get ==		== SNMP Get ==

Sstrutt: Minor update to intro

2012-08-29T07:14:04Z

Minor update to intro

← Older revision		Revision as of 07:14, 29 August 2012
Line 1:		Line 1:
	== Overview ==		== Overview ==
			This page covers using PowerShell as an SNMP client, so that you can poll/probe/interrogate SNMP servers (be they servers, network devices, UPS's, etc).

	'''All of the scripts below utilises the [http://sharpsnmplib.codeplex.com/ #SNMP (SharpSNMP) Suite] for .NET/Mono.''' Its an open source		'''All of the scripts below utilises the [http://sharpsnmplib.codeplex.com/ #SNMP (SharpSNMP) Suite] for .NET/Mono.''' Its an open source
	[[Acronyms#S\|SNMP]] library that supports .NET 3.5 and 4.0, which means that you can use it with PowerShell. The library has a wide range of functionality and the scripts below just cover what I consider to be the core of what you might want to do with PowerShell.		[[Acronyms#S\|SNMP]] library that supports .NET 3.5 and 4.0, which means that you can use it with PowerShell. The library has a wide range of functionality and the scripts below just cover what I consider to be the core of what you might want to do with PowerShell.
Line 18:		Line 20:

	=== Generic Objects ===		=== Generic Objects ===
	In order to use the library you need to be able to create generic objects, which doesn't work in PowerShell v1. Its meant to be fixed in v2, but I've not got it to work (probably because I don't actually understand what they are really. So I've used ~~the~~ [http://www.leeholmes.com/blog/2006/08/18/creating-generic-types-in-powershell/ workaround by Lee Holmes].		In order to use the library you need to be able to create generic objects, which doesn't work in PowerShell v1. Its meant to be fixed in v2, but I've not got it to work (probably because I don't actually understand what they are really. So I've used this [http://www.leeholmes.com/blog/2006/08/18/creating-generic-types-in-powershell/ workaround by Lee Holmes].

	The function below is Lee Holmes' work wrapped into a function...		The function below is Lee Holmes' work wrapped into a function...

Sstrutt: /* Example Usage */ Typo correct

2012-08-29T07:03:37Z

Example Usage: Typo correct

← Older revision		Revision as of 07:03, 29 August 2012
Line 156:		Line 156:
	OID Data		OID Data
	--- ----		--- ----
	.1.3.6.1.2.1.1.5.0 ~~UKA~~-SR-~~VIUTL-10~~		.1.3.6.1.2.1.1.5.0 TEST-SVR-01


Line 163:		Line 163:
	OID Data		OID Data
	--- ----		--- ----
	.1.3.6.1.2.1.1.4.0 ~~Technical Support~~		.1.3.6.1.2.1.1.4.0 Tinker box

	PS C:\Users\simon\Documents\Scripts> Invoke-SnmpWalk "192.168.10.201" ".1.3.6.1.2.1.1"		PS C:\Users\simon\Documents\Scripts> Invoke-SnmpWalk "192.168.10.201" ".1.3.6.1.2.1.1"

Sstrutt: Minor intro update

2012-08-23T09:21:39Z

Minor intro update

← Older revision		Revision as of 09:21, 23 August 2012
Line 2:		Line 2:
	'''All of the scripts below utilises the [http://sharpsnmplib.codeplex.com/ #SNMP (SharpSNMP) Suite] for .NET/Mono.''' Its an open source		'''All of the scripts below utilises the [http://sharpsnmplib.codeplex.com/ #SNMP (SharpSNMP) Suite] for .NET/Mono.''' Its an open source
	[[Acronyms#S\|SNMP]] library that supports .NET 3.5 and 4.0, which means that you can use it with PowerShell. The library has a wide range of functionality and the scripts below just cover what I consider to be the core of what you might want to do with PowerShell.		[[Acronyms#S\|SNMP]] library that supports .NET 3.5 and 4.0, which means that you can use it with PowerShell. The library has a wide range of functionality and the scripts below just cover what I consider to be the core of what you might want to do with PowerShell.

			You don't need to use /n's [http://www.powershellinside.com/powershell/netcmdlets/ NetCmdlets], or run the [http://www.net-snmp.org/ Net-SNMP] executables, as other examples on the web do.

	In order to make the library available for PowerShell to use...		In order to make the library available for PowerShell to use...

Sstrutt: Initial creation

2012-08-20T16:07:30Z

Initial creation

New page

== Overview ==
'''All of the scripts below utilises the [http://sharpsnmplib.codeplex.com/ #SNMP (SharpSNMP) Suite] for .NET/Mono.''' Its an open source
[[Acronyms#S|SNMP]] library that supports .NET 3.5 and 4.0, which means that you can use it with PowerShell. The library has a wide range of functionality and the scripts below just cover what I consider to be the core of what you might want to do with PowerShell.

In order to make the library available for PowerShell to use...
# Download the latest ''BigDipper'' binary from http://sharpsnmplib.codeplex.com/releases/view/78947 and extract
# Copy the <code>SharpSnmpLib.dll</code> file to somewhere you can find it
#* EG in a folder <code>/lib/LexTmSharpSNMP/</code> under where you run your scripts from

You can then load the assembly into your PowerShell session by something like...
<source lang="powershell">
[reflection.assembly]::LoadFrom( (Resolve-Path ".\lib\LexTmSharpSNMP\SharpSnmpLib.dll") )
</source>

All of the scripts below use SNMP v2, which is a bit more efficient than v1. Though note that it is not secure, data (including community strings) are passed across the network unencrypted - if you need to be secure, you need to use SNMP v3 (which isn't covered below - sorry).

=== Generic Objects ===
In order to use the library you need to be able to create generic objects, which doesn't work in PowerShell v1. Its meant to be fixed in v2, but I've not got it to work (probably because I don't actually understand what they are really. So I've used the [http://www.leeholmes.com/blog/2006/08/18/creating-generic-types-in-powershell/ workaround by Lee Holmes].

The function below is Lee Holmes' work wrapped into a function...
<source lang="powershell">
function New-GenericObject {
# Creates an object of a generic type - see http://www.leeholmes.com/blog/2006/08/18/creating-generic-types-in-powershell/

param(
[string] $typeName = $(throw “Please specify a generic type name”),
[string[]] $typeParameters = $(throw “Please specify the type parameters”),
[object[]] $constructorParameters
)

## Create the generic type name
$genericTypeName = $typeName + ‘`’ + $typeParameters.Count
$genericType = [Type] $genericTypeName

if(-not $genericType)
{
throw “Could not find generic type $genericTypeName”
}

## Bind the type arguments to it
[type[]] $typedParameters = $typeParameters
$closedType = $genericType.MakeGenericType($typedParameters)
if(-not $closedType)
{
throw “Could not make closed type $genericType”
}

## Create the closed version of the generic type
,[Activator]::CreateInstance($closedType, $constructorParameters)
}
</source>

== SNMP Get ==
The basic polling and probing method in SNMP.
<source lang="powershell">
function Invoke-SNMPget ([string]$sIP, $sOIDs, [string]$Community = "public", [int]$UDPport = 161, [int]$TimeOut=3000) {
# $OIDs can be a single OID string, or an array of OID strings
# $TimeOut is in msec, 0 or -1 for infinite

# Create OID variable list
$vList = New-GenericObject System.Collections.Generic.List Lextm.SharpSnmpLib.Variable
foreach ($sOID in $sOIDs) {
$oid = New-Object Lextm.SharpSnmpLib.ObjectIdentifier ($sOID)
$vList.Add($oid)
}

# Create endpoint for SNMP server
$ip = [System.Net.IPAddress]::Parse($sIP)
$svr = New-Object System.Net.IpEndPoint ($ip, 161)

# Use SNMP v2
$ver = [Lextm.SharpSnmpLib.VersionCode]::V2

# Perform SNMP Get
try {
$msg = [Lextm.SharpSnmpLib.Messaging.Messenger]::Get($ver, $svr, $Community, $vList, $TimeOut)
} catch {
Write-Host "SNMP Get error: $_"
Return $null
}

$res = @()
foreach ($var in $msg) {
$line = "" | Select OID, Data
$line.OID = $var.Id.ToString()
$line.Data = $var.Data.ToString()
$res += $line
}

$res
}
</source>

== SNMP Walk ==
Used to get the results for a portion of the devices' MIB tree
<source lang="powershell">
function Invoke-SnmpWalk ([string]$sIP, $sOIDstart, [string]$Community = "public", [int]$UDPport = 161, [int]$TimeOut=3000) {
# $sOIDstart
# $TimeOut is in msec, 0 or -1 for infinite

# Create OID object
$oid = New-Object Lextm.SharpSnmpLib.ObjectIdentifier ($sOIDstart)

# Create list for results
$results = New-GenericObject System.Collections.Generic.List Lextm.SharpSnmpLib.Variable

# Create endpoint for SNMP server
$ip = [System.Net.IPAddress]::Parse($sIP)
$svr = New-Object System.Net.IpEndPoint ($ip, 161)

# Use SNMP v2 and walk mode WithinSubTree (as opposed to Default)
$ver = [Lextm.SharpSnmpLib.VersionCode]::V2
$walkMode = [Lextm.SharpSnmpLib.Messaging.WalkMode]::WithinSubtree

# Perform SNMP Get
try {
[Lextm.SharpSnmpLib.Messaging.Messenger]::Walk($ver, $svr, $Community, $oid, $results, $TimeOut, $walkMode)
} catch {
Write-Host "SNMP Walk error: $_"
Return $null
}

$res = @()
foreach ($var in $results) {
$line = "" | Select OID, Data
$line.OID = $var.Id.ToString()
$line.Data = $var.Data.ToString()
$res += $line
}

$res
}
</source>

== Example Usage ==
If you saved the [[#Generic_Objects|Generic Objects]] workaround script, the SNMP DLL file, and the above functions in <code>lib</code> sub-folder to where your running your PowerShell from, then you could perform queries as follows...

<pre>
Windows PowerShell
Copyright (C) 2009 Microsoft Corporation. All rights reserved.

PS C:\Users\simon> cd .\Documents\Scripts
PS C:\Users\simon\Documents\Scripts> . .\lib\New-GenericObject.ps1
PS C:\Users\simon\Documents\Scripts> [reflection.assembly]::LoadFrom( (Resolve-Path ".\lib\LexTmSharpSNMP\SharpSnmpLib.dll") )

GAC Version Location
--- ------- --------
False v2.0.50727 C:\Users\simon\Documents\Scripts\lib\LexTmSharpSNMP\SharpSnmpLib.dll

PS C:\Users\simon\Documents\Scripts> . .\lib\SNMP-Funcs.ps1
PS C:\Users\simon\Documents\Scripts> Invoke-SnmpGet "192.168.10.201" ".1.3.6.1.2.1.1.5.0"

OID Data
--- ----
.1.3.6.1.2.1.1.5.0 UKA-SR-VIUTL-10

PS C:\Users\simon\Documents\Scripts> Invoke-SnmpGet "192.168.10.201" ".1.3.6.1.2.1.1.4.0"

OID Data
--- ----
.1.3.6.1.2.1.1.4.0 Technical Support

PS C:\Users\simon\Documents\Scripts> Invoke-SnmpWalk "192.168.10.201" ".1.3.6.1.2.1.1"
0

OID Data
--- ----
.1.3.6.1.2.1.1.1.0 Hardware: AMD64 Family 16 Model 2 Stepping 3 AT/AT COMPA...
.1.3.6.1.2.1.1.2.0 .1.3.6.1.4.1.311.1.1.3.1.2
.1.3.6.1.2.1.1.3.0 287291086 (33.06:01:50.8600000)
.1.3.6.1.2.1.1.4.0 Tinker box
.1.3.6.1.2.1.1.5.0 TEST-SVR-01
.1.3.6.1.2.1.1.6.0
.1.3.6.1.2.1.1.7.0 76
</pre>

[[Category:SNMP]]
[[Category:PowerShell]]