external help file	Module Name	online version	schema
Intersight.PowerShell.dll-Help.xml	Intersight.PowerShell		2.0.0

Set-IntersightSnmpPolicy

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightSnmpPolicy [-AccessCommunityString< string>][-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-CommunityAccess< SnmpPolicy.CommunityAccessEnum>][-Description< string>][-Enabled< bool>][-EngineId< string>][[-Moid]< string>][-Name< string>][-Organization< OrganizationOrganizationRelationship>][-Profiles< System.Collections.Generic.List`1[PolicyAbstractConfigProfileRelationship]>][-SnmpPort< long>][-SnmpTraps< System.Collections.Generic.List`1[SnmpTrap]>][-SnmpUsers< System.Collections.Generic.List`1[SnmpUser]>][-SysContact< string>][-SysLocation< string>][-Tags< System.Collections.Generic.List`1[MoTag]>][-TrapCommunity< string>][-V2Enabled< bool>][-V3Enabled< bool>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Update a 'SnmpPolicy' resource.

PARAMETERS

-AccessCommunityString

The default SNMPv1, SNMPv2c community name or SNMPv3 username to include on any trap messages sent to the SNMP host. The name can be 18 characters long.

Type: string
Parameter Sets: (All)
Aliases:

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

-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

-CommunityAccess

Controls access to the information in the inventory tables. Applicable only for SNMPv1 and SNMPv2c users.\n* Disabled - Blocks access to the information in the inventory tables.\n* Limited - Partial access to read the information in the inventory tables.\n* Full - Full access to read the information in the inventory tables.

Type: SnmpPolicy.CommunityAccessEnum
Parameter Sets: (All)
Aliases:

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

-Description

Description of the policy.

Type: string
Parameter Sets: (All)
Aliases:

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

-Enabled

State of the SNMP Policy on the endpoint. If enabled, the endpoint sends SNMP traps to the designated host.

Type: bool
Parameter Sets: (All)
Aliases:

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

-EngineId

User-defined unique identification of the static engine.

Type: string
Parameter Sets: (All)
Aliases:

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

-Moid

The unique identifier of this Managed Object instance.

Type: string
Parameter Sets: (All)
Aliases:

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

-Name

Name of the concrete policy.

Type: string
Parameter Sets: (All)
Aliases:

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

-Organization

A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: OrganizationOrganizationRelationship
Parameter Sets: (All)
Aliases:

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

-Profiles

An array of relationships to policyAbstractConfigProfile resources.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: System.Collections.Generic.List`1[PolicyAbstractConfigProfileRelationship]
Parameter Sets: (All)
Aliases:

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

-SnmpPort

Port on which Cisco IMC SNMP agent runs. 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

-SnmpTraps

Note :- Use Initialize-IntersightSnmpTrap to create the object of complex type SnmpTrap

Type: System.Collections.Generic.List`1[SnmpTrap]
Parameter Sets: (All)
Aliases:

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

-SnmpUsers

Note :- Use Initialize-IntersightSnmpUser to create the object of complex type SnmpUser

Type: System.Collections.Generic.List`1[SnmpUser]
Parameter Sets: (All)
Aliases:

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

-SysContact

Contact person responsible for the SNMP implementation. Enter a string up to 64 characters, such as an email address or a name and telephone number.

Type: string
Parameter Sets: (All)
Aliases:

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

-SysLocation

Location of host on which the SNMP agent (server) runs.

Type: string
Parameter Sets: (All)
Aliases:

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

-Tags

Note :- Use Initialize-IntersightMoTag to create the object of complex type MoTag

Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:

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

-TrapCommunity

SNMP community group used for sending SNMP trap to other devices. Valid only for SNMPv2c users.

Type: string
Parameter Sets: (All)
Aliases:

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

-V2Enabled

State of the SNMP v2c on the endpoint. If enabled, the endpoint sends SNMP v2c properties to the designated host.

Type: bool
Parameter Sets: (All)
Aliases:

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

-V3Enabled

State of the SNMP v3 on the endpoint. If enabled, the endpoint sends SNMP v3 properties to the designated host.

Type: bool
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:\> Set-IntersightSnmpPolicy

Files

Set-IntersightSnmpPolicy.md

Latest commit

History