Skip to content

Latest commit

 

History

History
232 lines (174 loc) · 5.17 KB

Initialize-IntersightSnmpTrap.md

File metadata and controls

232 lines (174 loc) · 5.17 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Initialize-IntersightSnmpTrap

SYNOPSIS

Fill in the Synopsis

SYNTAX


Initialize-IntersightSnmpTrap [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-ClassId< SnmpTrap.ClassIdEnum>][-Community< string>][-Destination< string>][-Enabled< bool>][-ObjectType< SnmpTrap.ObjectTypeEnum>][-Port< long>][-Type< SnmpTrap.TypeEnum>][-User< string>][-Version< SnmpTrap.VarVersionEnum>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Initialize cmdlet is used to instantiate the object of complex type in the Powershell session, it does not create the object on the server.

PARAMETERS

-AdditionalProperties

Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ClassId

The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.

Type: SnmpTrap.ClassIdEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Community

SNMP community group used for sending SNMP trap to other devices. Applicable only for SNMP v2c.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Destination

Address to which the SNMP trap information is sent.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Enabled

Enables/disables the trap on the server If enabled, trap is active on the server.

Type: bool
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ObjectType

The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.

Type: SnmpTrap.ObjectTypeEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Port

Port used by the server to communicate with the trap destination. Enter a value between 1-65535. Reserved ports not allowed (22, 23, 80, 123, 389, 443, 623, 636, 2068, 3268, 3269).

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Type

Type of trap which decides whether to receive a notification when a trap is received at the destination.\n* Trap - Do not receive notifications when trap is sent to the destination.\n* Inform - Receive notifications when trap is sent to the destination. This option is valid only for V2 users.

Type: SnmpTrap.TypeEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-User

SNMP user for the trap. Applicable only to SNMPv3.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Version

SNMP version used for the trap.\n* V3 - SNMP v3 trap version notifications.\n* V1 - SNMP v1 trap version notifications.\n* V2 - SNMP v2 trap version notifications.

Type: SnmpTrap.VarVersionEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Json

Returns the json payload received in response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

-WithHttpInfo

Returns the HTTP response with headers and content.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

EXAMPLES

Example 1

PS C:\> Initialize-IntersightSnmpTrap

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS