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.

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 value of the Community parameter for SNMP traps.
ConfigSpecifies one or more configuration settings.
EncryptionAlgorithmThe encryption algorithm used for the request.
EncryptionPasswordThe password to use for SNMPv3 privacy encryption.
EnterpriseThe type of the object generating the trap.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
ManagerThe Manager to which to send the trap.
MibExtra mib files to use for the Label to OID translation and vice versa.
ObjectIDA collection of OIDs to add to the trap.
ObjectTypeA collection of Object types to add to the trap.
ObjectValueThe Object value collection to add to the trap.
OIDThe OID to use for the request.
TimeoutThe maximum time allowed for the operation.
UptimeTime passed since the agent was initialized (in hundredths of a second).
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.

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

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 (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:

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

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

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:   Tells the cmdlet 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 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 DLL is no longer required as a reference, as all unmanaged code is stored in that file.