Get-SNMP Cmdlet

Parameters   Output Objects   Config Settings  

The Get-SNMP component is used to query SNMP agents.

Syntax

Get-SNMP [parameters]

Remarks

The GET-SNMP cmdlet implements a standard SNMP Manager as specified in the SNMP RFCs. The cmdlet supports SNMP v1, v2c, and v3 through the Version parameter.

The cmdlet provides encoding/decoding, transport capabilities, and OID resolution, allowing for SNMP agents to be monitored directly from Powershell.

SNMP Get, GetNext, Walk and GetBulk are all supported.

SNMPv3 USM security is enabled by setting properties such as User and AuthenticationPassword. SNMPv3 encryption is enabled by setting EncryptionPassword.

Automatic translation from Node labels to OIDs is integrated in the cmdlet, allowing for a seamless integration with MIB files of different vendors.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# snmp broadcast for agent information get-snmp -agent 255.255.255.255 -oid 1.3.6.1.2.1.1.1.0 -translate # perform a get-next request get-snmp 10.0.1.11 sysDescr.0 -next:$true # send a get-bulk request get-snmp -agent 10.0.1.11 -oid sysName.0, sysDescr.0 -bulk 5 -NonRepeaters 1

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFileThe location of a file to which debug information is written.
AgentThe address of the SNMP agent.
AuthenticationPasswordThe password to use for SNMPv3 authentication.
AuthenticationProtocolThe authentication protocol used.
BulkIndicates the number of maxRepetitions used to send a GetBulkRequest.
CommunityThe community string used to authenticate SNMP packets.
ConfigSpecifies one or more configuration settings.
EncryptionAlgorithmThe encryption algorithm used for the request.
EncryptionPasswordThe password to use for SNMPv3 privacy encryption.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
MibExtra mib files to use for the Label to OID translation and vice versa.
NextSend a GetNext request for the OID .
NonRepeatersCount of variables not to be repeated.
OIDThe OID to use for this request.
PortThe UDP port where the remote SNMP agent is listening.
TimeoutThe maximum time allowed for the operation.
TranslateResolve OIDs to labels in the response for the SNMP request.
UserThe username to use for authentication.
VersionThe version of SNMP to use for the request.
WalkDoes an SNMP walk starting with the oid specified by OID .

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

OIDReturned from the SNMP operation.

Config Settings


The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.

HexMACAddressDetermines if MAC addresses are automatically hex encoded.
UseScalarInstanceWhether to automatically use the OID for scalar object instances.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Get-SNMP Cmdlet)

The location of a file to which debug information is written.

Syntax

Get-SNMP -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

Agent Property (Get-SNMP Cmdlet)

The address of the SNMP agent.

Syntax

Get-SNMP -Agent string

Remarks

The address or host name of the SNMP agent with which to communicate.

Default Value

""

Parameter Position

0

Parameter Alias

SNMPAgent

This is a required parameter.

AuthenticationPassword Property (Get-SNMP Cmdlet)

The password to use for SNMPv3 authentication.

Syntax

Get-SNMP -AuthenticationPassword string

Remarks

Every time EncryptionPassword or AuthenticationPassword are set, a localized key is computed automatically, and cached internally.

Default Value

""

Parameter Alias

AuthPassword

AuthenticationProtocol Property (Get-SNMP Cmdlet)

The authentication protocol used.

Syntax

Get-SNMP -AuthenticationProtocol string

Remarks

AuthenticationProtocol is used to specify the authentication protocol used when sending a secure trap.

Possible authentication protocol types are:

  • MD5 (default)
  • SHA

Default Value

1

Parameter Alias

AuthProtocol

Bulk Property (Get-SNMP Cmdlet)

Indicates the number of maxRepetitions used to send a GetBulkRequest.

Syntax

Get-SNMP -Bulk int

Remarks

Specifies the number of lexicographic successors to be returned. The NonRepeaters flag can also be set to the number of non repeaters for the GetBulk request.

Default Value

0

Community Property (Get-SNMP Cmdlet)

The community string used to authenticate SNMP packets.

Syntax

Get-SNMP -Community string

Remarks

Must match the community name that is specified on the agent.

Typical values are "public" or "private".

This parameter is used for all SNMP packets sent by the cmdlet.

Default Value

"public"

Config Property (Get-SNMP Cmdlet)

Specifies one or more configuration settings.

Syntax

Get-SNMP -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

EncryptionAlgorithm Property (Get-SNMP Cmdlet)

The encryption algorithm used for the request.

Syntax

Get-SNMP -EncryptionAlgorithm string

Remarks

EncryptionAlgorithm is used to specify the encryption algorithm used when sending a secure request.

Possible encryption algorithm types are:

  • DES (default)
  • AES
  • 3DES
  • AES192
  • AES256

Default Value

1

Parameter Alias

EncAlgorithm

EncryptionPassword Property (Get-SNMP Cmdlet)

The password to use for SNMPv3 privacy encryption.

Syntax

Get-SNMP -EncryptionPassword string

Remarks

Every time EncryptionPassword or AuthenticationPassword are set, a localized key is computed automatically, and cached internally.

Default Value

""

Parameter Alias

EncPassword

LocalIP Property (Get-SNMP Cmdlet)

The IP address of the local interface to use.

Syntax

Get-SNMP -LocalIP string

Remarks

This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).

Default Value

""

Parameter Alias

LocalAddress

LogFile Property (Get-SNMP Cmdlet)

The location of a file to which debug information is written.

Syntax

Get-SNMP -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

Mib Property (Get-SNMP Cmdlet)

Extra mib files to use for the Label to OID translation and vice versa.

Syntax

Get-SNMP -Mib string[]

Remarks

The cmdlet will automatically pick up the mib files located in the "mibs" folder of the NetCmdlets module location. By default this will be "%UserProfile%\Documents\WindowsPowerShell\Modules\NetCmdlets\mibs".

By default some standard mib files are provided with the installation.

Default Value

null

Next Property (Get-SNMP Cmdlet)

Send a GetNext request for the OID .

Syntax

Get-SNMP -Next SwitchParameter

Remarks

If doing multiple GetNext requests a bulk or a walk would be a better alternative depending on the functionality that you want to achieve.

Default Value

false

NonRepeaters Property (Get-SNMP Cmdlet)

Count of variables not to be repeated.

Syntax

Get-SNMP -NonRepeaters int

Remarks

NonRepeaters specifies the number of variables for which a single lexicographic successor is to be returned.

Default Value

0

OID Property (Get-SNMP Cmdlet)

The OID to use for this request.

Syntax

Get-SNMP -OID string[]

Remarks

The OID can be a label or an actual OID, such as sysDescr.0 or 1.3.6.1.2.1.1.1.0.

Default Value

null

Parameter Position

1

Parameter Alias

Label

This is a required parameter.

Port Property (Get-SNMP Cmdlet)

The UDP port where the remote SNMP agent is listening.

Syntax

Get-SNMP -Port int

Remarks

Port specifies a service port on the remote host to which to connect.

A valid port number (a value between 1 and 65535) is required for the connection to take place.

Default Value

161

Parameter Alias

AgentPort

Timeout Property (Get-SNMP Cmdlet)

The maximum time allowed for the operation.

Syntax

Get-SNMP -Timeout int

Remarks

After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.

Default Value

10

Translate Property (Get-SNMP Cmdlet)

Resolve OIDs to labels in the response for the SNMP request.

Syntax

Get-SNMP -Translate SwitchParameter

Remarks

If the Translate switch is set, the cmdlet will attempt to resolve the textual syntax for any OID returned from the agent(s). If the Mib parameter is set, the cmdlet will use the specified Mib, the cmdlet will automatically pick up the mib files located in the MIBS folder of the NetCmdlets installation directory.

If the Translate switch is not set, or the OID cannot be matched, the numerical syntax will be returned.

Default Value

false

Parameter Alias

Resolve

User Property (Get-SNMP Cmdlet)

The username to use for authentication.

Syntax

Get-SNMP -User string

Remarks

When setting User you could also set EncryptionPassword and/or AuthenticationPassword depending on whether the desired behavior is authentication, encryption or both.

Default Value

""

Version Property (Get-SNMP Cmdlet)

The version of SNMP to use for the request.

Syntax

Get-SNMP -Version int

Remarks

The default version used is 2.

Default Value

2

Walk Property (Get-SNMP Cmdlet)

Does an SNMP walk starting with the oid specified by OID .

Syntax

Get-SNMP -Walk SwitchParameter

Remarks

A walk will traverse all OIDs in the OID table that are lexographically greater than OID. The result is given through a series of OID objects.

Default Value

false

OID Output Object (Get-SNMP Cmdlet)

Returned from the SNMP operation.

Syntax

Object OID {
   string Host;
   string OID;
   string OIDValue;
   byte[] OIDValueB;
   string OIDType;
   int ErrorIndex;
   int ErrorStatus;
   string ErrorDescription;
}

Remarks

For each OID in every response received by the cmdlet an OID object will be returned.

Host contains the host address that the response was returned from.

OID contains the OID name for the response. If the Translate switch is set, the cmdlet will attempt to resolve the textual syntax for the OID.

OIDValue contains the value for the OID.

OIDValueB contains the value for the OID expressed as a byte array.

OIDType contains the type of OID received.

Possible object type values include:

  • Integer
  • OctetString
  • Null
  • ObjectID
  • IPAddress
  • Counter32
  • Gauge32
  • TimeTicks
  • Opaque
  • NSAP
  • Counter64
  • UnsignedInteger32

The cmdlet also supports the following artificial object values used to designate error conditions:

NoSuchObjectNo such object error.
NoSuchInstanceNo such instance error.
EndOfMibViewEnd of MIB View error.

ErrorIndex contains the index of the variable which caused the error.

ErrorStatus contains the status code.

The following is a list of valid SNMP status code values:

0 (noError) No error.
1 (tooBig) The response cannot fit in a single SNMP message.
2 (noSuchName) Variable does not exist.
3 (badValue) Invalid value or syntax.
4 (readOnly) Variable is read-only.
5 (genError) Other error (SNMPv1).
6 (noAccess) Access denied.
7 (wrongType) Wrong object type.
8 (wrongLength) Wrong length.
9 (wrongEncoding) Wrong encoding.
10 (wrongValue) Wrong value.
11 (noCreation) No creation.
12 (inconsistentValue) Inconsistent value.
13 (resourceUnavailable) Resource unavailable.
14 (commitFailed) Commit failed.
15 (undoFailed) Undo failed.
16 (authorizationError) Authorization error.
17 (notWritable) Variable is not writable.
18 (inconsistentName) Inconsistent name.
The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).

ErrorDescription provides a textual description of the error.

Config Settings (Get-SNMP Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Get-SNMP Config Settings

HexMACAddress:   Determines if MAC addresses are automatically hex encoded.

If the OID of the returned value begins with ifPhysAddrress (1.3.6.1.2.1.2.2.1.6) and this setting is true (default) the OIDValue will automatically be hex encoded and formatted in the format 00:0C:29:C6:31:07.

UseScalarInstance:   Whether to automatically use the OID for scalar object instances.

When set to true the cmdlet will attempt to determine if the OID is a scalar object by finding the OID in a loaded Mib file. If the OID can be found in the MIB, and the OID is a scalar object, then the cmdlet will automatically append a ".0" to the OID to represent the scalar object instance.

If the specified OID already ends with ".0" it will not be modified.

When set to False no modification of the OID will take place. The default value is True.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a cmdlet is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all cmdlets used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.