Set-SNMP Cmdlet

Parameters   Output Objects   Config 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.

LogFile	The location of a file to which debug information is written.
Agent	The address of the SNMP agent.
AuthenticationPassword	The password to use for SNMPv3 authentication.
AuthenticationProtocol	The authentication protocol used.
Community	The community string used to authenticate SNMP packets.
Config	Specifies one or more configuration settings.
EncryptionAlgorithm	The encryption algorithm used for the request.
EncryptionPassword	The password to use for SNMPv3 privacy encryption.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
Mib	Extra mib files to use for the Label to OID translation and vice versa.
OID	The OID to use for this request.
OIDType	The type for the value of the OID.
OIDValue	The value of the OID.
Port	The UDP port where the remote SNMP agent is listening.
Timeout	The maximum time allowed for the operation.
User	The username to use for authentication.
Version	The 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.

OID	Returned 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.

UseScalarInstance	Whether to automatically use the OID for scalar object instances.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Set-SNMP Cmdlet)

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

Syntax

Set-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 (Set-SNMP Cmdlet)

The address of the SNMP agent.

Syntax

Set-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 (Set-SNMP Cmdlet)

The password to use for SNMPv3 authentication.

Syntax

Set-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 (Set-SNMP Cmdlet)

The authentication protocol used.

Syntax

Set-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

Community Property (Set-SNMP Cmdlet)

The community string used to authenticate SNMP packets.

Syntax

Set-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 (Set-SNMP Cmdlet)

Specifies one or more configuration settings.

Syntax

Set-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 (Set-SNMP Cmdlet)

The encryption algorithm used for the request.

Syntax

Set-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 (Set-SNMP Cmdlet)

The password to use for SNMPv3 privacy encryption.

Syntax

Set-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 (Set-SNMP Cmdlet)

The IP address of the local interface to use.

Syntax

Set-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 (Set-SNMP Cmdlet)

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

Syntax

Set-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 (Set-SNMP Cmdlet)

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

Syntax

Set-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

OID Property (Set-SNMP Cmdlet)

The OID to use for this request.

Syntax

Set-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.

OIDType Property (Set-SNMP Cmdlet)

The type for the value of the OID.

Syntax

Set-SNMP -OIDType string[]

Remarks

The type for the new value of the OID for the SET SNMP request.

Default Value

null

Parameter Position

3

Parameter Alias

Type

OIDValue Property (Set-SNMP Cmdlet)

The value of the OID.

Syntax

Set-SNMP -OIDValue string[]

Remarks

The new value of the OID for the SET SNMP request.

Default Value

null

Parameter Position

2

Parameter Alias

Value

Port Property (Set-SNMP Cmdlet)

The UDP port where the remote SNMP agent is listening.

Syntax

Set-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 (Set-SNMP Cmdlet)

The maximum time allowed for the operation.

Syntax

Set-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

User Property (Set-SNMP Cmdlet)

The username to use for authentication.

Syntax

Set-SNMP -User string

Remarks

Every time User and Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

Version Property (Set-SNMP Cmdlet)

The version of SNMP to use for the request.

Syntax

Set-SNMP -Version int

Remarks

The default version used is 2.

Default Value

2

OID Output Object (Set-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:

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:

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 (Set-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.

Set-SNMP Config Settings

Base Config Settings