Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class span:ASource (ABSTRACT)

Class ID:2324
Class Label: Source
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, tenant-protocol]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The abstraction of a SPAN source. A SPAN source is where traffic is sampled. A SPAN source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (Access SPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric SPAN). When you create a traffic monitoring session, you must select a SPAN source and a SPAN destination. The type of session (Tenant, Access or fabric) determines the allowed types of SPAN sources and destinations. The destination can be either a port or an EPG. If the destination is a port, it should not be one that has been configured for other purposes.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: pol:Comp,
Sub Mos: span:FabSource, span:Source,
Relations To: span:FltGrp, l1:If,
Relations: span:RsSpanSrcToFltGrpAtt, span:RsSpanSrcToL1IfAtt,


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] span:ASource The abstraction of a SPAN source. A SPAN source is where traffic is sampled. A SPAN source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (Access SPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric SPAN). When you create a traffic monitoring session, you must select a SPAN source and a SPAN destination. The type of session (Tenant, Access or fabric) determines the allowed types of SPAN sources and d...
 
 		 
 		 
 		 ├
 		[V] span:FabSource The fabric source port (also called a monitored port), which is a switched port that you monitor for network traffic analysis. In a single local SPAN session, you can monitor source port traffic such as received (Rx), transmitted (Tx), or bidirectional (both). The switch supports any number of source ports (up to the maximum number of available ports on the switch).
 
 		 
 		 
 		 ├
 		[V] span:Source The SPAN or ERSPAN source, which is where traffic is sampled. A source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (Access SPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric SPAN). When you create a traffic monitoring session, you must select a source and a destination. The type of session (Tenant, Access, or Fabric) determines the allowed types of sources and destinations. The destination can b...


Events


Faults


Fsms


Properties Summary
Defined in: span:ASource
reference:BinRef ASrcDn  (span:ASource:ASrcDn)
           DN of the corresponding Src
span:Direction
          scalar:Enum8 		dir  (span:ASource:dir)
          
string:Basic domain  (span:ASource:domain)
           domain of the source
span:Mode
          scalar:Enum8 		mode  (span:ASource:mode)
          
span:SrcT
          scalar:Enum8 		type  (span:ASource:type)
          
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.
Properties Detail

ASrcDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
DN of the corresponding Src


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.


dir

Type: span:Direction
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
in 1 Incoming Incoming
out 2 Outgoing Outgoing
both 3 Both Both
DEFAULT both(3) Both Both




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.


domain

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
domain of the source


mode

Type: span:Mode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
access 1 Access Access
fabric 2 Fabric Fabric
DEFAULT access(1) Access Access




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


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.


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.





type

Type: span:SrcT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
port 1 Port Monitor all packets on this port
encap 2 Encap Monitor all packets of the encap
port-encap 3 Port and encap Monitor all packets on the port with encap
port-l3out 4 Port and l3out Monitor all packets on the port with l3out
port-drop 5 Packets dropped on port Monitor all packets dropped on this port
global-drop 6 All dropped packets Monitor all packets that are dropped
DEFAULT port(1) Port Monitor all packets on this port






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail