Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class ip:NlbVip (ABSTRACT)

Class ID:13168
Class Label: Config Load Balancer VIP Mode
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: no (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 ]

NLB MO

Naming Rules 


DN FORMAT:


Diagram

Super Mo: nw:Ep,
Sub Mos: ipv4:NlbVip, ipv6:NlbVip,


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
 
 		 
 		 
 		 ├
 		[V] ipv6:NlbVip  This MO indicates RouteEP is an NLB


Events


Faults


Fsms


Properties Summary
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
address:MAC mac  (ip:NlbVip:mac)
           The MAC address.
epm:NlbVipMode
          scalar:Uint32 		mode  (ip:NlbVip:mode)
           The BGP Domain mode.
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: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


mac

Type: address:MAC

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


mode

Type: epm:NlbVipMode
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
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




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.







Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail