Class fv:ABD (ABSTRACT)

Class ID:1868
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: []
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstract representation of a private layer 2 network context that belongs to a specific tenant or context, or is shared. This is an abstract class and cannot be instantiated.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: fv:L2Dom,
Sub Mos: fv:ABDPol, fv:BDDef,


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] pol:DefRoot Represents the policy definition's subtree root.
 
 
 
 ├
[V] fv:Def An abstraction of the fabric virtualization policy definition.
 
 
 
 
 ├
[V] fv:Dom A virtual fabric domain.
 
 
 
 
 
 ├
[V] fv:L2Dom A private layer 2 domain.
 
 
 
 
 
 
 ├
[V] fv:ABD An abstract representation of a private layer 2 network context that belongs to a specific tenant or context, or is shared. This is an abstract class and cannot be instantiated.
 
 
 
 
 
 
 
 ├
[V] fv:ABDPol Abstract representation of a bridge domain policy.
 
 
 
 
 
 
 
 
 ├
[V] fv:BD A bridge domain is a unique layer 2 forwarding domain that contains one or more subnets. Each bridge domain must be linked to a context.
 
 
 
 
 
 
 
 
 ├
[V] fv:SvcBD A service bridge domain.
 
 
 
 
 
 
 
 ├
[V] fv:BDDef A private layer 2 network context that belongs to a specific tenant or context, or is shared.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: fv:ABD
scalar:Bool OptimizeWanBandwidth  (fv:ABD:OptimizeWanBandwidth)
           OptimizeWanBandwidth flag is enabled between sites
scalar:Bool arpFlood  (fv:ABD:arpFlood)
           A property to specify whether ARP flooding is enabled. If flooding is disabled, unicast routing will be performed on the target IP address.
fv:BDConfIssuesType
          scalar:Bitmask64
configIssues  (fv:ABD:configIssues)
           Bitmask representation of the configuration issues found during the endpoint group deployment.
scalar:Bool epClear  (fv:ABD:epClear)
           Represents the parameter used by the node (i.e. Leaf) to clear all EPs in all leaves for this BD.
l2:EpMoveDetectMode
          scalar:Bitmask32
epMoveDetectMode  (fv:ABD:epMoveDetectMode)
           The End Point move detection option uses the Gratuitous Address Resolution Protocol (GARP). A gratuitous ARP is an ARP broadcast-type of packet that is used to verify that no other device on the network has the same IP address as the sending device.
scalar:Bool intersiteBumTrafficAllow  (fv:ABD:intersiteBumTrafficAllow)
           Control whether BUM traffic is allowed between sites
scalar:Bool intersiteL2Stretch  (fv:ABD:intersiteL2Stretch)
           l2Stretch flag is enabled between sites
scalar:Bool ipLearning  (fv:ABD:ipLearning)
           NO COMMENTS
scalar:Bool limitIpLearnToSubnets  (fv:ABD:limitIpLearnToSubnets)
           Limits IP address learning to the bridge domain subnets only. Every BD can have multiple subnets associated with it. By default, all IPs are learned.
address:Ip llAddr  (fv:ABD:llAddr)
           The override of the system generated IPv6 link-local address.
fv:DefaultMAC
          address:MAC
mac  (fv:ABD:mac)
           The MAC address of the bridge domain (BD) or switched virtual interface (SVI). Every BD by default takes the fabric wide default mac address. If user wants then he can override that address and with a different one By default the BD will take a 00:22:BD:F8:19:FF mac address.
scalar:Bool mcastAllow  (fv:ABD:mcastAllow)
           Multicast. Flag to indicate if multicast is enabled
fabric:InheritableMtu
          scalar:Uint32
mtu  (fv:ABD:mtu)
           The layer 2 maximum transmit unit (MTU) size.
l2:MultiDstPktAct
          scalar:Enum8
multiDstPktAct  (fv:ABD:multiDstPktAct)
           The multiple destination forwarding method for L2 Multicast, Broadcast, and Link Layer traffic types.
vz:GPCTag
          scalar:Uint32
pcTag  (fv:ABD:pcTag)
           The default class ID for unknown unicast traffic terminating on this bridge domain.
fv:ScopeId
          scalar:Uint32
scope  (fv:ABD:scope)
          
scalar:Bool unicastRoute  (fv:ABD:unicastRoute)
           The forwarding method based on predefined forwarding criteria (IP or MAC address).
l2:UnkMacUcastAct
          scalar:Enum8
unkMacUcastAct  (fv:ABD:unkMacUcastAct)
           The forwarding method for unknown layer 2 destinations.
l2:UnkMcastAct
          scalar:Enum8
unkMcastAct  (fv:ABD:unkMcastAct)
           The parameter used by the node (i.e. a leaf) for forwarding data for an unknown multicast destination.
address:MAC vmac  (fv:ABD:vmac)
           Virtual MAC address of the BD/SVI. This is used when the BD is extended to multiple sites using l2 Outside.
Defined in: fv:L2Dom
mcast:Group
          address:IPv4
bcastP  (fv:L2Dom:bcastP)
           Outer multicast group IP address.
Defined in: fv:Dom
fv:Seg
          scalar:Uint32
seg  (fv:Dom:seg)
           A LAN domain segment.
Defined in: pol:DefRoot
naming:Descr
          string:Basic
descr  (pol:DefRoot:descr)
           Overrides:pol:Def:descr
           Specifies a description of the policy definition root.
Defined in: pol:Def
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

OptimizeWanBandwidth

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
OptimizeWanBandwidth flag is enabled between sites
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





arpFlood

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A property to specify whether ARP flooding is enabled. If flooding is disabled, unicast routing will be performed on the target IP address.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





bcastP

Type: mcast:Group
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Outer multicast group IP address.



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





configIssues

Type: fv:BDConfIssuesType
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Bitmask representation of the configuration issues found during the endpoint group deployment.
Constants
ok 0ull ok NO COMMENTS
igmp-snoop-disabled-on-multicast-if 0x1ull igmpsnoop disabled on multicast enabled BD NO COMMENTS
DEFAULT ok(0ull) ok NO COMMENTS





descr

Type: naming:Descr
Primitive Type: string:Basic

Overrides:pol:Def:descr
Paths: 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 root.



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.



epClear

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Represents the parameter used by the node (i.e. Leaf) to clear all EPs in all leaves for this BD.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





epMoveDetectMode

Type: l2:EpMoveDetectMode
Primitive Type: scalar:Bitmask32

Like: l2:BD:epMoveDetectMode
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The End Point move detection option uses the Gratuitous Address Resolution Protocol (GARP). A gratuitous ARP is an ARP broadcast-type of packet that is used to verify that no other device on the network has the same IP address as the sending device.
Constants
garp 1u GARP based detection Detection through GARP
DEFAULT 0 --- Ep move detection mode





intersiteBumTrafficAllow

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Control whether BUM traffic is allowed between sites
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





intersiteL2Stretch

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
l2Stretch flag is enabled between sites
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





ipLearning

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





limitIpLearnToSubnets

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Limits IP address learning to the bridge domain subnets only. Every BD can have multiple subnets associated with it. By default, all IPs are learned.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





llAddr

Type: address:Ip

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The override of the system generated IPv6 link-local address.



mac

Type: fv:DefaultMAC
Primitive Type: address:MAC

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The MAC address of the bridge domain (BD) or switched virtual interface (SVI). Every BD by default takes the fabric wide default mac address. If user wants then he can override that address and with a different one By default the BD will take a 00:22:BD:F8:19:FF mac address.
Constants
defaultValue 280487012409856ull --- NO COMMENTS





mcastAllow

Type: scalar:Bool

Like: l2:BD:mcastAllow
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Multicast. Flag to indicate if multicast is enabled
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





mtu

Type: fabric:InheritableMtu
Primitive Type: scalar:Uint32

Units: bytes
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The layer 2 maximum transmit unit (MTU) size.
Constants
inherit 1u inherit NO COMMENTS
DEFAULT inherit(1u) inherit NO COMMENTS





multiDstPktAct

Type: l2:MultiDstPktAct
Primitive Type: scalar:Enum8

Like: l2:BD:multiDstPktAct
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The multiple destination forwarding method for L2 Multicast, Broadcast, and Link Layer traffic types.
Constants
bd-flood 0 Flood in BD BD Flood, flood with all L2 encapsulations in that BD
encap-flood 1 Flood in Encapsulation Flood with the L2 Encapsulation
drop 2 Drop Drop
DEFAULT bd-flood(0) Flood in BD BD Flood, flood with all L2 encapsulations in that BD





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.



pcTag

Type: vz:GPCTag
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The default class ID for unknown unicast traffic terminating on this bridge domain.
Constants
any 0u any NO COMMENTS
DEFAULT 0 --- A shorthand for GroupPolicyClassTag: A tag that is used to identify and classify a particular group of resources/end-points for policy enforcement purposes





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.



scope

Type: fv:ScopeId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 0u --- NO COMMENTS





seg

Type: fv:Seg
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A LAN domain segment.



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.






unicastRoute

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The forwarding method based on predefined forwarding criteria (IP or MAC address).
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





unkMacUcastAct

Type: l2:UnkMacUcastAct
Primitive Type: scalar:Enum8

Like: l2:BD:unkMacUcastAct
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The forwarding method for unknown layer 2 destinations.
Constants
flood 0 Flood Flooding
proxy 1 Hardware Proxy Proxy
DEFAULT proxy(1) Hardware Proxy Proxy





unkMcastAct

Type: l2:UnkMcastAct
Primitive Type: scalar:Enum8

Like: l2:BD:unkMcastAct
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The parameter used by the node (i.e. a leaf) for forwarding data for an unknown multicast destination.
Constants
flood 0 Flood Flooding
opt-flood 1 Optimized Flood Optimized flooding
DEFAULT flood(0) Flood Flooding





vmac

Type: address:MAC

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Virtual MAC address of the BD/SVI. This is used when the BD is extended to multiple sites using l2 Outside.
Constants
not-applicable 0ull Not Configured NO COMMENTS
DEFAULT not-applicable(0ull) Not Configured NO COMMENTS