Class monitor:ERDest (CONCRETE)

Class ID:2397
Class Label: ERSPAN Destination
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The ERSPAN destination information.

Naming Rules
RN FORMAT: erdst

    [1] PREFIX=erdst


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/monitor/session-{name}/erdst

[1] sys/monitor/session-{name}/erdst

                


Diagram

Super Mo: monitor:Destination,
Container Mos: monitor:Session (deletable:yes),


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] monitor:Entity Span manager control plane entity information.
 
 
 
 
 
 ├
[V] monitor:Session The monitor session definition. There can only be a few sessions active at a given time (with a maximum of 4).
 
 
 
 
 
 
 ├
[V] monitor:ERDest The ERSPAN destination information.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] monitor:Entity Span manager control plane entity information.
 
 
 ├
[V] monitor:Session The monitor session definition. There can only be a few sessions active at a given time (with a maximum of 4).
 
 
 
 ├
[V] monitor:ERDest The ERSPAN destination information.


Contained Hierarchy
[V] monitor:ERDest The ERSPAN destination information.
 ├
[V] 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.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 
 ├
[V] monitor:Destination The span destination information.
 
 
 
 ├
[V] monitor:ERDest The ERSPAN destination information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: monitor:ERDest
qosp:Dscp
          scalar:UByte
dscp  (monitor:ERDest:dscp)
           Specifies DSCP.
address:Ip dstIp  (monitor:ERDest:dstIp)
           The destination IP address.
monitor:FlowId
          scalar:Uint16
flowId  (monitor:ERDest:flowId)
           The flow ID of the ERSPAN packet.
scalar:Bitmask64 spanCfgFailedBmp  (monitor:ERDest:spanCfgFailedBmp)
           Holds the bitmap of SPAN destinations of the configuration that failed.
scalar:Time spanCfgFailedTs  (monitor:ERDest:spanCfgFailedTs)
          
scalar:UByte spanCfgState  (monitor:ERDest:spanCfgState)
           Indicates the configuration state of a remote SPAN destination.
address:Ip srcIp  (monitor:ERDest:srcIp)
           The source IP address. Traffic from this IP address to the EP is counted
l3:Ttl
          scalar:UByte
ttl  (monitor:ERDest:ttl)
           Specifies time to live (TTL).
monitor:DestEncapT
          scalar:Enum8
type  (monitor:ERDest:type)
           The specific type of the object or component.
monitor:ErSpanVer
          scalar:Enum8
ver  (monitor:ERDest:ver)
           The CDP version supported by the device.
base:Encap vnid  (monitor:ERDest:vnid)
           The VN ID for the VRF.
l3:VrfName
          string:Basic
vrfName  (monitor:ERDest:vrfName)
           The VRF name. This name can be up to 64 alphanumeric characters.
Defined in: monitor:Destination
monitor:Mtu
          scalar:Uint16
mtu  (monitor:Destination:mtu)
           The administrative MTU port on the aggregated interface.
monitor:OperSt
          scalar:Enum8
operSt  (monitor:Destination:operSt)
           The runtime state of the object or policy.
monitor:OperStQual
          string:Basic
operStQual  (monitor:Destination:operStQual)
           The chassis operational status qualifier.
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: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.
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.
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
    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.



dscp

Type: qosp:Dscp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies DSCP.
Constants
CS0 0 CS0 CS0
CS1 8 CS1 CS1
AF11 10 AF11 low drop AF11 low drop
AF12 12 AF12 medium drop AF12 medium drop
AF13 14 AF13 high drop AF13 high drop
CS2 16 CS2 CS2
AF21 18 AF21 low drop AF21 low drop
AF22 20 AF22 medium drop AF22 medium drop
AF23 22 AF23 high drop AF22 high drop
CS3 24 CS3 CS3
AF31 26 AF31 low drop AF31 low drop
AF32 28 AF32 medium drop AF32 medium drop
AF33 30 AF33 high drop AF33 high drop
CS4 32 CS4 CS4
AF41 34 AF41 low drop AF41 low drop
AF42 36 AF42 medium drop AF42 medium drop
AF43 38 AF43 high drop AF42 high drop
CS5 40 CS5 CS5
VA 44 Voice Admit VA
EF 46 Expedited Forwarding EF
CS6 48 CS6 CS6
CS7 56 CS7 CS7
unspecified 64 Unspecified Unspecified
DEFAULT unspecified(64) Unspecified Unspecified





dstIp

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The destination IP address.



flowId

Type: monitor:FlowId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The flow ID of the ERSPAN packet.
Constants
defaultValue 1 --- NO COMMENTS





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





mtu

Type: monitor:Mtu
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative MTU port on the aggregated interface.
Constants
defaultValue 1518 --- NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



operSt

Type: monitor:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
up 1 Up Up
down 2 Down Down
failed 3 Failed Failed
DEFAULT down(2) Down Down





operStQual

Type: monitor:OperStQual
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The chassis operational status qualifier.



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.



spanCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Holds the bitmap of SPAN destinations of the configuration that failed.
Constants
monitor:ERDestlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
monitor:ERDestmodTs_failed_flag 1152921504606846976ull --- NO COMMENTS
monitor:ERDestdstIp_failed_flag 128ull --- NO COMMENTS
monitor:ERDestvrfName_failed_flag 131072ull --- NO COMMENTS
monitor:ERDesttype_failed_flag 16384ull --- NO COMMENTS
monitor:ERDestname_failed_flag 1ull --- NO COMMENTS
monitor:ERDestflowId_failed_flag 256ull --- NO COMMENTS
monitor:ERDestnameAlias_failed_flag 2ull --- NO COMMENTS
monitor:ERDestver_failed_flag 32768ull --- NO COMMENTS
monitor:ERDestsrcIp_failed_flag 4096ull --- NO COMMENTS
monitor:ERDestdescr_failed_flag 4ull --- NO COMMENTS
monitor:ERDestdscp_failed_flag 64ull --- NO COMMENTS
monitor:ERDestvnid_failed_flag 65536ull --- NO COMMENTS
monitor:ERDestttl_failed_flag 8192ull --- NO COMMENTS
monitor:ERDestmtu_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





spanCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



spanCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Indicates the configuration state of a remote SPAN destination.



srcIp

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The source IP address. Traffic from this IP address to the EP is counted



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.






ttl

Type: l3:Ttl
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies time to live (TTL).
Constants
unspecified 0 Unspecified Unspecified
DEFAULT unspecified(0) Unspecified Unspecified





type

Type: monitor:DestEncapT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
gre 1 Gre encapsulated ER-SPAN, gre encapsulated
DEFAULT gre(1) Gre encapsulated ER-SPAN, gre encapsulated





ver

Type: monitor:ErSpanVer
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The CDP version supported by the device.
Constants
ver2 2 Version 2 Version 2
ver3 3 Version 3 Version 3
DEFAULT ver3(3) Version 3 Version 3





vnid

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The VN ID for the VRF.



vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The VRF name. This name can be up to 64 alphanumeric characters.