Class ipv4:NlbVip (CONCRETE)

Class ID:13167
Class Label: NLB endpoint
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: [access-connectivity, access-protocol, admin, fabric-connectivity, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: no (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 ]

This MO indicates RouteEP is an NLB

Naming Rules
RN FORMAT: nlb-{mode}-mac-{mac}

    [1] PREFIX=nlb- PROPERTY = mode


    [2] PREFIX=-mac- PROPERTY = mac




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ipv4/inst/dom-{name}/rtipep-{[prefix]}/nlb-{mode}-mac-{mac}

[1] sys/ipv4/inst/dom-{name}/rtipep-{[prefix]}/nlb-{mode}-mac-{mac}

                


Diagram

Super Mo: ip:NlbVip,
Container Mos: ipv4:RouteEP (deletable:no),


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] ipv4:Entity A container for IPV4 control plane entity information.
 
 
 
 
 
 ├
[V] ipv4:Inst A container for IPV4 instance information.
 
 
 
 
 
 
 ├
[V] ipv4:Dom The domain (VRF) information.
 
 
 
 
 
 
 
 ├
[V] ipv4:RouteEP  Static route IP Endpoint definitions
 
 
 
 
 
 
 
 
 ├
[V] ipv4:NlbVip  This MO indicates RouteEP is an NLB
[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] ipv4:Entity A container for IPV4 control plane entity information.
 
 
 ├
[V] ipv4:Inst A container for IPV4 instance information.
 
 
 
 ├
[V] ipv4:Dom The domain (VRF) information.
 
 
 
 
 ├
[V] ipv4:RouteEP  Static route IP Endpoint definitions
 
 
 
 
 
 ├
[V] ipv4:NlbVip  This MO indicates RouteEP is an NLB


Contained Hierarchy
[V] ipv4:NlbVip  This MO indicates RouteEP is an NLB
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] 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.
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:Ep A static endpoint.
 
 
 ├
[V] ip:NlbVip  NLB MO
 
 
 
 ├
[V] ipv4:NlbVip  This MO indicates RouteEP is an NLB


Events
                


Faults
                ipv4:NlbVip:nlb-mac-same-as-anycast-mac
ipv4:NlbVip:nlb-vip-same-as-anycast-vip
ipv4:NlbVip:nlb-vip-same-as-ep-reach-vip
ipv4:NlbVip:nlb-vip-same-as-svi-ip
ipv4:NlbVip:invalid-group-config
ipv4:NlbVip:maxNlbVipLimitReached
ipv4:NlbVip:unsupported-bd-proxy-config
ipv4:NlbVip:unsupported-hw
ipv4:NlbVip:unsupported-pim-config


Fsms
                


Properties Summary
Defined in: ipv4:NlbVip
address:MAC mac  (ipv4:NlbVip:mac)
           Overrides:ip:NlbVip:mac
           The MAC address.
scalar:Bitmask64 mfdmCfgFailedBmp  (ipv4:NlbVip:mfdmCfgFailedBmp)
           NO COMMENTS
scalar:Time mfdmCfgFailedTs  (ipv4:NlbVip:mfdmCfgFailedTs)
           NO COMMENTS
scalar:UByte mfdmCfgState  (ipv4:NlbVip:mfdmCfgState)
           NO COMMENTS
epm:NlbVipMode
          scalar:Uint32
mode  (ipv4:NlbVip:mode)
           Overrides:ip:NlbVip:mode
           The BGP Domain mode.
reference:BinRef monPolDn  (ipv4:NlbVip:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: ip:NlbVip
epm:NlbVipOperSt
          scalar:Bitmask64
encapPgmOperSt  (ip:NlbVip:encapPgmOperSt)
           Operational state
epm:NlbVipOperStQual
          scalar:Bitmask64
encapPgmOperStQual  (ip:NlbVip:encapPgmOperStQual)
           operational state down reason
epm:NlbVipOperStQual
          scalar:Bitmask64
epmVipOperStQual  (ip:NlbVip:epmVipOperStQual)
           operational state down reason
base:Encap fabEncap  (ip:NlbVip:fabEncap)
           The encapsulation used in the fabric to implement flood control.
mcast:GrpIp
          address:Ip
fabEncapGrpIp  (ip:NlbVip:fabEncapGrpIp)
           Multicast group address corresponding to the fabEncap
mcast:GrpIp
          address:Ip
group  (ip:NlbVip:group)
           Multicast group address corresponding to the VIP
epm:NlbVipOperSt
          scalar:Bitmask64
operSt  (ip:NlbVip:operSt)
           The runtime state of the object or policy.
actrl:PcTag
          scalar:Uint32
pcTag  (ip:NlbVip:pcTag)
           The default class ID for unknown unicast traffic terminating on this bridge domain.
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the 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.
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





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.



encapPgmOperSt

Type: epm:NlbVipOperSt
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state
Constants
unsupported 1ull Feature not supported Bit 1, Feature not supported on this hardware
dst-info-pgmed 2ull Egress dest info programmed Bit 2, Dest info programmed
down 4ull Configuration down Bit 3, Config is down
up 8ull Operational programming succeeded Bit 4, Config is up
DEFAULT down(4ull) Configuration down Bit 3, Config is down





encapPgmOperStQual

Type: epm:NlbVipOperStQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
operational state down reason
Constants
vip-used-for-anycast-vip 1024ull VIP is used for anycast vip Bit 11, NLB VIP is same as anycast vip
mac-used-for-anycast 128ull Mac is used as anycast Bit 8, NLB MAC is same as Anycast mac
bd-proxy-unsupported 16ull Bd proxy not supported Bit 5, Bd-proxy mode not supported
dst-info-not-pgmed 1ull Egress Dst Info not programmed Bit 1, Egress Dst Info not programmed.
vip-used-for-svi-ip 256ull VIP is used for svi ip Bit 9, NLB VIP is same as svi ip
unspecified 2ull Unknown Error Bit 2, Unspecified
pim-unsupported 32ull PIM not supported Bit 6, PIM not supported
unsupported 4ull Feature not supported on this h/w Bit 3, Feature not supported on this hardware
vip-used-for-ep-reachability 512ull VIP is used for ep reachability vip Bit 10, NLB VIP is same as ep reachability vip
igmp-group-in-use 64ull Igmp Group in use Bit 7, IGMP Group in use by some other NLB VIP
max-nlb-limit 8ull Max NLB VIP limit reached Bit 4, Max Nlb Vip Limit reached
DEFAULT 0 --- Reason for being down





epmVipOperStQual

Type: epm:NlbVipOperStQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
operational state down reason
Constants
vip-used-for-anycast-vip 1024ull VIP is used for anycast vip Bit 11, NLB VIP is same as anycast vip
mac-used-for-anycast 128ull Mac is used as anycast Bit 8, NLB MAC is same as Anycast mac
bd-proxy-unsupported 16ull Bd proxy not supported Bit 5, Bd-proxy mode not supported
dst-info-not-pgmed 1ull Egress Dst Info not programmed Bit 1, Egress Dst Info not programmed.
vip-used-for-svi-ip 256ull VIP is used for svi ip Bit 9, NLB VIP is same as svi ip
unspecified 2ull Unknown Error Bit 2, Unspecified
pim-unsupported 32ull PIM not supported Bit 6, PIM not supported
unsupported 4ull Feature not supported on this h/w Bit 3, Feature not supported on this hardware
vip-used-for-ep-reachability 512ull VIP is used for ep reachability vip Bit 10, NLB VIP is same as ep reachability vip
igmp-group-in-use 64ull Igmp Group in use Bit 7, IGMP Group in use by some other NLB VIP
max-nlb-limit 8ull Max NLB VIP limit reached Bit 4, Max Nlb Vip Limit reached
DEFAULT 0 --- Reason for being down





fabEncap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The encapsulation used in the fabric to implement flood control.



fabEncapGrpIp

Type: mcast:GrpIp
Primitive Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Multicast group address corresponding to the fabEncap



group

Type: mcast:GrpIp
Primitive Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Multicast group address corresponding to the VIP



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





mac

Type: address:MAC

Overrides:ip:NlbVip:mac
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The MAC address.



mfdmCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
ipv4:NlbViplcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
ipv4:NlbVippcTag_failed_flag 1024ull --- NO COMMENTS
ipv4:NlbVipmodTs_failed_flag 1152921504606846976ull --- NO COMMENTS
ipv4:NlbVipmac_failed_flag 128ull --- NO COMMENTS
ipv4:NlbVipmonPolDn_failed_flag 16384ull --- NO COMMENTS
ipv4:NlbVipfabEncap_failed_flag 16ull --- NO COMMENTS
ipv4:NlbVipname_failed_flag 1ull --- NO COMMENTS
ipv4:NlbVipmode_failed_flag 256ull --- NO COMMENTS
ipv4:NlbVipfabEncapGrpIp_failed_flag 32ull --- NO COMMENTS
ipv4:NlbVipgroup_failed_flag 64ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





mfdmCfgFailedTs

Type: scalar:Time

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



mfdmCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
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





mode

Type: epm:NlbVipMode
Primitive Type: scalar:Uint32

Overrides:ip:NlbVip:mode
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The BGP Domain mode.
Constants
mode-uc 1u NLB in unicast mode Unicast mode
mode-mcast--static 2u NLB in static multicast mode Static Multicast mode
mode-mcast-igmp 3u NLB in IGMP mode Dynamic Multicast mode
DEFAULT mode-uc(1u) NLB in unicast mode Unicast mode





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:nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



operSt

Type: epm:NlbVipOperSt
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unsupported 1ull Feature not supported Bit 1, Feature not supported on this hardware
dst-info-pgmed 2ull Egress dest info programmed Bit 2, Dest info programmed
down 4ull Configuration down Bit 3, Config is down
up 8ull Operational programming succeeded Bit 4, Config is up
DEFAULT down(4ull) Configuration down Bit 3, Config is down





pcTag

Type: actrl:PcTag
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 --- Policy control tag





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.