Send-Trap Cmdlet

Parameters   Output Objects   Config Settings  

The Send-Trap component is used to sends SNMP traps to a remote address.

Syntax

Send-Trap [parameters]

Remarks

Depending upon the value of the Version parameter, the packet is constructed as an SNMPv1, SNMPv2 or SNMPv3 Trap PDU. The following parameters provide more control over how traps are generated: Port, Agent, Community, Enterprise.

For SNMPv3 traps, the User, AuthenticationPassword, and EncryptionPassword parameters can be set. If any values are provided in the ObjectID, ObjectType, ObjectValue arrays, they are sent unchanged. In the case of an SNMPv2 or SNMPv3 Trap, if the Obj properties are not specified, the following values are set: sysUpTime.0 equal to Uptime and snmpTrapOID.0 equal to OID.

For SNMPv2 and SNMPv3 Traps, OID must contain the full OID of the Trap. Automatic translation is handled internally from node labels to node OIDs assuming that a valid MIB file is provided. For SNMPv1, OID must be of the form "GenericTrap.SpecificTrap". These values are sent in the PDU header. Agent and Enterprise are taken from their corresponding parameters.

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 coldStart trap send-trap -manager 10.0.1.255 -oid coldStart.0 #send a custom coldStart trap send-trap -manager 10.0.1.255 -oid coldStart.0 -objectID 1.1 -objectType Integer -objectValue 20 #send a custom coldStart trap with multiple objects send-trap -manager 10.0.1.255 -oid coldStart.0 -objectID 1.1,1.2,1.3 -objectType Integer,Integer,Integer -objectValue 20,31,53

Below are some examples using SNMPv1:

#send a coldStart trap using SNMPv1 send-trap -version 1 -manager 10.0.1.255 -oid 0.0 #send a custom coldStart trap using SNMPv1 send-trap -version 1 -manager 10.0.1.255 -oid 0.0 -objectID 1.1 -objectType Integer -objectValue 20 #send a custom coldStart trap with multiple objects and custom enterprise send-trap -version 1 -manager 10.0.1.255 -enterprise 1.5.7.5.8.3.4.1.4 -oid 0.0 -objectID 1.1,1.2 -objectType Integer,Integer -objectValue 20,31

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 value of the Community parameter for SNMP traps.
Config	Specifies one or more configuration settings.
EncryptionAlgorithm	The encryption algorithm used for the request.
EncryptionPassword	The password to use for SNMPv3 privacy encryption.
Enterprise	The type of the object generating the trap.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
Manager	The Manager to which to send the trap.
Mib	Extra mib files to use for the Label to OID translation and vice versa.
ObjectID	A collection of OIDs to add to the trap.
ObjectType	A collection of Object types to add to the trap.
ObjectValue	The Object value collection to add to the trap.
OID	The OID to use for the request.
Timeout	The maximum time allowed for the operation.
Uptime	Time passed since the agent was initialized (in hundredths of a second).
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.

Trap	This object is returned for each trap received by the component.

Config Settings

---

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

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 (Send-Trap Cmdlet)

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

Syntax

Send-Trap -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 (Send-Trap Cmdlet)

The address of the SNMP agent.

Syntax

Send-Trap -Agent string

Remarks

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

Default Value

""

Parameter Alias

SNMPAgent

AuthenticationPassword Property (Send-Trap Cmdlet)

The password to use for SNMPv3 authentication.

Syntax

Send-Trap -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 (Send-Trap Cmdlet)

The authentication protocol used.

Syntax

Send-Trap -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 (Send-Trap Cmdlet)

The value of the Community parameter for SNMP traps.

Syntax

Send-Trap -Community string

Remarks

Typical values are "public" or "private". The default value is "public".

Default Value

"public"

Config Property (Send-Trap Cmdlet)

Specifies one or more configuration settings.

Syntax

Send-Trap -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 (Send-Trap Cmdlet)

The encryption algorithm used for the request.

Syntax

Send-Trap -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 (Send-Trap Cmdlet)

The password to use for SNMPv3 privacy encryption.

Syntax

Send-Trap -EncryptionPassword string

Remarks

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

Default Value

""

Parameter Alias

EncPassword

Enterprise Property (Send-Trap Cmdlet)

The type of the object generating the trap.

Syntax

Send-Trap -Enterprise string

Remarks

This setting specifies the type of object generating the SNMP Trap. The default value is "1.3.6.1.6.3.1.1.5" (i.e. SNMPv2-MIB::snmpTraps).

Default Value

"1.3.6.1.6.3.1.1.5"

LocalIP Property (Send-Trap Cmdlet)

The IP address of the local interface to use.

Syntax

Send-Trap -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 (Send-Trap Cmdlet)

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

Syntax

Send-Trap -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

""

Manager Property (Send-Trap Cmdlet)

The Manager to which to send the trap.

Syntax

Send-Trap -Manager string

Remarks

Manager is the remote host to which the cmdlet sends a trap.

Default Value

""

Parameter Position

0

This is a required parameter.

Mib Property (Send-Trap Cmdlet)

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

Syntax

Send-Trap -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

ObjectID Property (Send-Trap Cmdlet)

A collection of OIDs to add to the trap.

Syntax

Send-Trap -ObjectID string[]

Remarks

Use the ObjectID, ObjectType, and ObjectValue collections to build a custom trap. Note that specifying these values gives you complete control over the contents of the trap, so you are responsible for adding the sysUpTime and the snmpTrapOID objects as well. To automatically send a standard trap, containing only the sysUpTime and the snmpTrapOID, use the TrapOID parameter instead.

The object id-s are encoded as strings of numbers separated by "."-s, for instance: "1.3.6.1.6.3.1.1.5.1" (OID for "coldstart"). The corresponding object types and values (if any) are specified by the ObjectType and ObjectValue collections.

Default Value

null

Parameter Position

1

Parameter Alias

ObjId

This is a required parameter.

ObjectType Property (Send-Trap Cmdlet)

A collection of Object types to add to the trap.

Syntax

Send-Trap -ObjectType string[]

Remarks

Use the ObjectID, ObjectType, and ObjectValue collections to build a custom trap. Note that specifying these values gives you complete control over the contents of the trap, so you are responsible for adding the sysUpTime and the snmpTrapOID objects as well. To automatically send a standard trap, containing only the sysUpTime and the snmpTrapOID, use the TrapOID parameter instead.

ObjectType is used to create an outgoing SNMP packet. The corresponding object ids and values are specified by the ObjectID and ObjectValue collections.

Possible object type values include:

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

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

Default Value

null

Parameter Position

3

Parameter Alias

Objtype

This is a required parameter.

ObjectValue Property (Send-Trap Cmdlet)

The Object value collection to add to the trap.

Syntax

Send-Trap -ObjectValue string[]

Remarks

Use the ObjectID, ObjectType, and ObjectValue collections to build a custom trap. Note that specifying these values gives you complete control over the contents of the trap, so you are responsible for adding the sysUpTime and the snmpTrapOID objects as well. To automatically send a standard trap, containing only the sysUpTime and the snmpTrapOID, use the TrapOID parameter instead.

ObjectValue is used to create an outgoing SNMP packet. The corresponding object ID and type are specified by the ObjectID and ObjectType collections.

Default Value

null

Parameter Position

2

Parameter Alias

Objvalue

This is a required parameter.

OID Property (Send-Trap Cmdlet)

The OID to use for the request.

Syntax

Send-Trap -OID string

Remarks

Use this parameter to automatically send a standard trap, containing the sysUpTime and the snmpTrapOID. The OID can be a label or an actual OID, such as "coldstart" or 1.3.6.1.6.3.1.1.5.1.

To specify custom objects in the trap, use the ObjectID, ObjectType, and ObjectValue collections instead.

Default Value

""

Parameter Position

1

Parameter Alias

TrapOID

Timeout Property (Send-Trap Cmdlet)

The maximum time allowed for the operation.

Syntax

Send-Trap -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

Uptime Property (Send-Trap Cmdlet)

Time passed since the agent was initialized (in hundredths of a second).

Syntax

Send-Trap -Uptime int

Remarks

Uptime is used when sending SNMP traps, and it normally provides the time since the cmdlet was started in 1/100ths of a second.

If another value is desired, you may set this Uptime to a custom value. From that point on, Uptime will contain the value set plus time elapsed. Due to the nature of the cmdlet, the time elapsed should be very small.

Default Value

0

User Property (Send-Trap Cmdlet)

The username to use for authentication.

Syntax

Send-Trap -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 (Send-Trap Cmdlet)

The version of SNMP to use for the request.

Syntax

Send-Trap -Version int

Remarks

The default version used is 2.

Default Value

2

Trap Output Object (Send-Trap Cmdlet)

This object is returned for each trap received by the component.

Syntax

Object Trap {
   string Host;
   string[] OID;
   string[] OIDValue;
   string[] OIDType;
   int Version;
   string User;
   bool IsAuthenticated;
}

Remarks

The OID, OIDValue and OIDType fields are arrays because SNMP v2 and v3 traps may contain multiple objects.

Config Settings (Send-Trap 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.

Base Config Settings