Set-SNMP Cmdlet

Parameters   Output Objects   Configuration Settings  

The Set-SNMP component exposes functionality to PowerShell to send SNMP SET requests.

Syntax

Set-SNMP [parameters]

Remarks

Managing SNMP agents directly from Powershell by changing OID values of remote agents is as easy as setting a few parameters.

Version allows the user to specify the version of SNMP to use, v1, v2 and v3 are supported. If v3 is selected, the User and AuthenticationPassword parameters can be set to authenticate to the agent before changing the OID value, and EncryptionPassword can be used to enable SNMPv3 encryption. The OID is specified by OID and the new value is specified by OIDValue.

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.


# Send a set-request
set-snmp 10.0.1.173 sysDescr.0 -value "New System Description"

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.
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.
OIDThe OID to use for this request.
OIDTypeThe type for the value of the OID.
OIDValueThe value of the OID.
PortThe UDP port where the remote SNMP agent is listening.
TimeoutThe maximum time allowed for the operation.
UserThe username to use for authentication.
VersionThe version of SNMP to use for the request.

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.

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.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
NetCmdlets 2020 - Version 20.0 [Build 8165]