Cisco System Model: Classsnmp:TrapDest

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class snmp:TrapDest (CONCRETE)

Class ID:1691
Class Label: SNMP Trap Destination
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin]
Read Access: [admin, ops]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

A destination to which traps and informs are sent.

Naming Rules
RN FORMAT: trapdest-{host}-port-{port} [1] PREFIX=trapdest- PROPERTY = host [2] PREFIX=-port- PROPERTY = port DN FORMAT: [1] uni/fabric/snmpgroup-{name}/trapdest-{host}-port-{port}

Diagram
Super Mo: file:ARemoteHost, Container Mos: snmp:Group (deletable:yes), Relations To: fv:ATg, fv:AREpP, Relations: file:RsARemoteHostToEpg, file:RsARemoteHostToEpp,

Containers Hierarchies

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

fabric:Topology The root for IFC topology.

├

fabric:Pod A pod.

├

fabric:Node The root node for the APIC.

├

ctx:Local The local Context.

├

ctx:Application The context application.

├

pol:Uni Represents policy definition/resolution universe.

├

fabric:Inst A container object for fabric policies.

├

snmp:Group The SNMP destination group contains information needed to send traps or informs to a set of destinations.. SNMP is an application-layer protocol that provides a message format for communication between SNMP managers and agents. SNMP provides a standardized framework and a common language used for the monitoring and management of devices in a network.

├

snmp:TrapDest A destination to which traps and informs are sent.

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

pol:Uni Represents policy definition/resolution universe.

├

fabric:Inst A container object for fabric policies.

├

├

snmp:TrapDest A destination to which traps and informs are sent.

Contained Hierarchy

snmp:TrapDest A destination to which traps and informs are sent.

├

fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.

├

fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.

├

fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.

├

file:RsARemoteHostToEpg A source relation to the endpoint group through which the remote host is reachable.

├

file:RsARemoteHostToEpp A source relation to the abstract representation of the resolvable endpoint profile.

├

fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.

├

├

health:Inst A base class for a health score instance.(Switch only)

├

health:Inst A base class for a health score instance.(Switch only)

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.

├

pol:Obj Represents a generic policy object.

├

pol:Comp Represents a policy component. This object is part of the policy definition.

├

file:ARemoteHost Remote host with reachability information

├

snmp:TrapDest A destination to which traps and informs are sent.

Events

                snmp:TrapDest:creation__snmp_TrapDest

                snmp:TrapDest:deletion__snmp_TrapDest

                snmp:TrapDest:modification__snmp_TrapDest

                snmp:TrapDest:creation__snmp_TrapDest

                snmp:TrapDest:modification__snmp_TrapDest

                snmp:TrapDest:deletion__snmp_TrapDest

Faults
snmp:TrapDest:snmpTrapDestEpgDn snmp:TrapDest:snmpTrapDestVrfName

Fsms

Properties Summary

Defined in: snmp:TrapDest
address:HostNameOrDottedQuad string:Basic	host (snmp:TrapDest:host) Overrides:file:ARemoteHost:host The host for the SNMP trap destination. SNMP traps enable an agent to notify the management station of significant events by way of an unsolicited SNMP message.
reference:BinRef	monPolDn (snmp:TrapDest:monPolDn) The monitoring policy attached to this observable object.
snmp:NotificationType scalar:Enum8	notifT (snmp:TrapDest:notifT)
mon:Port scalar:Uint32	port (snmp:TrapDest:port) The service port of the SNMP trap destination. SNMP traps enable an agent to notify the management station of significant events by way of an unsolicited SNMP message.
snmp:SecName string:Basic	secName (snmp:TrapDest:secName) The SNMP destination security name.
snmp:V3SecLvl scalar:Enum8	v3SecLvl (snmp:TrapDest:v3SecLvl) The SNMP V3 security level for the destination path.
snmp:Version scalar:Enum8	ver (snmp:TrapDest:ver) The CDP version supported by the device.

Defined in: file:ARemoteHost
reference:BinRef	epgDn (file:ARemoteHost:epgDn) Management EpG dn
l3:VrfName string:Basic	vrfName (file:ARemoteHost:vrfName) The vrf that remote host belongs to

Defined in: pol:Comp
naming:Descr string:Basic	descr (pol:Comp:descr) Specifies the description of a policy component.

Defined in: pol:Obj
naming:Name string:Basic	name (pol:Obj:name) Overrides:naming:NamedObject:name null

Defined in: naming:NamedObject
naming:NameAlias string:Basic	nameAlias (naming:NamedObject:nameAlias) NO COMMENTS

Defined in: mo:TopProps
mo:ModificationChildAction scalar:Bitmask32	childAction (mo:TopProps:childAction) Delete or ignore. For internal use only.
reference:BinRef	dn (mo:TopProps:dn) A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN	rn (mo:TopProps:rn) Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus scalar:Bitmask32	status (mo:TopProps:status) The upgrade status. This property is for internal use only.

Defined in: mo:Ownable
scalar:Uint16	uid (mo:Ownable:uid) A unique identifier for this object.

Defined in: mo:Resolvable
mo:Owner scalar:Enum8	lcOwn (mo:Resolvable:lcOwn) A value that indicates how this object was created. For internal use only.

Defined in: mo:Modifiable
mo:TStamp scalar:Date	modTs (mo:Modifiable:modTs) The time when this object was last modified.

Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Comments:

Delete or ignore. For internal use only.

Constants
deleteAll	16384u	deleteAll	NO COMMENTS
ignore	4096u	ignore	NO COMMENTS
deleteNonPresent	8192u	deleteNonPresent	NO COMMENTS
DEFAULT	0	---	This type is used to

descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+

Comments:

Specifies the description of a policy component.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

Comments:

A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

epgDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

Management EpG dn

host

Type: address:HostNameOrDottedQuad
Primitive Type: string:Basic

Overrides:file:ARemoteHost:host

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Regex: ˆ(?=.{0,255}$)[0-9A-Za-z:\[\]](\[{0,1})(?:(?:[0-9A-Za-z]|-|:){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-|:){0,61}[0-9A-Za-z])?)*\.?(\]{0,1})$

Comments:

The host for the SNMP trap destination. SNMP traps enable an agent to notify the management station of significant events by way of an unsolicited SNMP message.

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

A value that indicates how this object was created. For internal use only.

Constants
local	0	Local	NO COMMENTS
policy	1	Policy	NO COMMENTS
replica	2	Replica	NO COMMENTS
resolveOnBehalf	3	ResolvedOnBehalf	NO COMMENTS
implicit	4	Implicit	NO COMMENTS
DEFAULT	local(0)	Local	NO COMMENTS

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The time when this object was last modified.

Constants
never	0ull	never	NO COMMENTS
DEFAULT	never(0ull)	never	NO COMMENTS

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The monitoring policy attached to this observable object.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:

null

nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+

Comments:

NO COMMENTS

notifT

Type: snmp:NotificationType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

Constants
traps	1	traps	NO COMMENTS
DEFAULT	traps(1)	traps	NO COMMENTS

port

Type: mon:Port
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)65535l

Comments:

The service port of the SNMP trap destination. SNMP traps enable an agent to notify the management station of significant events by way of an unsolicited SNMP message.

Constants
defaultValue	162u	---	NO COMMENTS

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

Comments:

Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

secName

Type: snmp:SecName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "32"

Comments:

The SNMP destination security name.

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus

Comments:

The upgrade status. This property is for internal use only.

Constants
created	2u	created	In a setter method: specifies that an object should be created. An error is returned if the object already exists. In the return value of a setter method: indicates that an object has been created.
modified	4u	modified	In a setter method: specifies that an object should be modified In the return value of a setter method: indicates that an object has been modified.
deleted	8u	deleted	In a setter method: specifies that an object should be deleted. In the return value of a setter method: indicates that an object has been deleted.
DEFAULT	0	---	This type controls the life cycle of objects passed in the XML API. When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed. In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed. When invoking a setter method, the ModificationStatus is optional: If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.

uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

A unique identifier for this object.

v3SecLvl

Type: snmp:V3SecLvl
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

The SNMP V3 security level for the destination path.

Constants
noauth	1	noauth	NO COMMENTS
auth	2	auth	NO COMMENTS
priv	3	priv	NO COMMENTS
DEFAULT	noauth(1)	noauth	NO COMMENTS

ver

Type: snmp:Version
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

The CDP version supported by the device.

Constants
v1	1	v1	NO COMMENTS
v2c	2	v2c	NO COMMENTS
v3	3	v3	NO COMMENTS
DEFAULT	v2c(2)	v2c	NO COMMENTS

vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The vrf that remote host belongs to

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail