Class span:ASrc (ABSTRACT)

Class ID:4134
Class Label: Abstract SPAN Source
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-protocol-l2]
Read Access: [admin, tenant-protocol-l2]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The abstraction of an SPAN source. The SPAN source 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 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: 

[1] uni/epp/fv-{[epgPKey]}/srcgrpdef-{name}/

[3] uni/tn-{name}/out-{name}/lnodep-{name}/lifp-{name}/rspathL3OutAtt-{[tDn]}/srcgrpdef-{name}/

[5] uni/infra/srcgrp-{name}/

[7] uni/tn-{name}/srcgrp-{name}/

[9] uni/fabric/srcgrp-{name}/

                


Diagram

Super Mo: pol:Def,
Sub Mos: span:AVSrc, span:Src, span:SrcDef,
Container Mos: span:ASrcGrp (deletable:yes),
Relations To: fv:EPg, span:FilterGrp, l3ext:Out, fabric:PathEp,
Relations: span:RsSrcToEpg, span:RsSrcToFilterGrp, span:RsSrcToL3extOut, span:RsSrcToPathEp,


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:Def Represents self-contained policy document.
 
 
 ├
[V] span:ASrc The abstraction of an SPAN source. The SPAN source 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 SPAN source and a SPAN destination. The type of session (Tenant, Access or fabric) determines the allowed types of SPAN sources and de...
 
 
 
 ├
[V] span:AVSrc The abstraction of a VSPAN source. The VSPAN source is where traffic is sampled. A VSPAN source can an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (Access VSPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric VSPAN). When you create a traffic monitoring session, you must select a VSPAN source and a VSPAN destination. The type of session (Tenant, Access or fabric) determines the allowed types of span sources...
 
 
 
 
 ├
[V] span:VSrc The VSPAN source, which is where traffic is sampled. A VSPAN source can be an endpoint group (EPG), one or more ports, or port traffic filtered by an EPG (Access VSPAN), a Layer 2 bridge domain, or a Layer 3 context (Fabric VSPAN). When you create a traffic monitoring session, you must select a VSPAN source and a VSPAN destination. The type of session (Tenant, Access, or Fabric) determines the allowed types of VSPAN sources and destinations. The ...
 
 
 
 
 ├
[V] span:VSrcDef The VSPAN VSrcDef is used for VSPAN source definitions.
 
 
 
 ├
[V] span:Src The SPAN or ERSPAN source 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 be eithe...
 
 
 
 ├
[V] span:SrcDef The SPAN source definitions. The 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 dest...


Events
                


Faults
                span:ASrc:configFailed


Fsms
                


Properties Summary
Defined in: span:ASrc
span:Direction
          scalar:Enum8
dir  (span:ASrc:dir)
           The direction of the packets to monitor
span:SrcFaultSt
          scalar:Enum16
fstate  (span:ASrc:fstate)
          
span:FaultMap
          scalar:Uint64
fstateMap  (span:ASrc:fstateMap)
          
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
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

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 a description of the policy definition.



dir

Type: span:Direction
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The direction of the packets to monitor
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.



fstate

Type: span:SrcFaultSt
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
no-fault 0 NoFault Unspecified
no-vpc-src-for-local-dest 1 No VPC source for local destination VPC
src-epg-not-ready 2 Source Epg not ready EPG
src-epg-not-available 3 Source Epg not available EPP
src-port-same-as-dest 4 Source Port is the same as destination port PORT
invalid-src-port-type 5 Source Port is of the wrong type PORT
invalid-src-epg-type 6 Source EPG is of the wrong type EPG
nonlocal-src-port 7 Source Port is not local Port
unavailable-src-port 8 Unavailable source PathEp Port
src-ifconn-not-available 9 Source fvIfConn not available IfConn
DEFAULT no-fault(0) NoFault Unspecified





fstateMap

Type: span:FaultMap
Primitive Type: scalar:Uint64

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



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



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



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.