NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

Get-SNMP Cmdlet

Parameters   Output Objects   Configuration Settings  

The Get-SNMP cmdlet 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.

Configuration Settings


The following is a list of configuration 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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
NetCmdlets 2016 - Version 16.0 [Build 6335]