Class dhcp:LeaseDb (CONCRETE)

Class ID:1451
Class Label: Lease Database
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The DHCP Lease Database.

Naming Rules
RN FORMAT: db-{id}

    [1] PREFIX=db- PROPERTY = id




DN FORMAT: 

[0] db-{id}

                


Diagram

Super Mo: l3:ProtDb,
Container Mos: top:Root (deletable:no),
Contained Mos: dhcp:Lease,
Relations From: dhcp:Provider,
Relations: dhcp:RtLeaseDb,


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] dhcp:LeaseDb The DHCP Lease Database.


Contained Hierarchy
[V] dhcp:LeaseDb The DHCP Lease Database.
 ├
[V] dhcp:Lease The DHCP lease record.
 
 ├
[V] dhcp:RsClient Internal object: relation from the dhcpLease to the dhcpClient.
 ├
[V] dhcp:RtLeaseDb A target relation to the DHCP lease database.
 ├
[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:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:Db An abstraction of the database.
 
 
 
 ├
[V] l3:Db A database abstraction.
 
 
 
 
 ├
[V] l3:ProtDb A layer 3 protocol database abstraction.
 
 
 
 
 
 ├
[V] dhcp:LeaseDb The DHCP Lease Database.


Events
                


Faults
                dhcp:LeaseDb:thresholdReached


Fsms
                


Properties Summary
Defined in: dhcp:LeaseDb
dhcp:ConfigIssues
          scalar:Bitmask32
configIssues  (dhcp:LeaseDb:configIssues)
           Bitmask representation of the configuration issues found during the endpoint group deployment.
scalar:Uint32 id  (dhcp:LeaseDb:id)
           Appliance ID
Defined in: nw:Db
naming:Name
          string:Basic
name  (nw:Db: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





configIssues

Type: dhcp:ConfigIssues
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Bitmask representation of the configuration issues found during the endpoint group deployment.
Constants
none 0x0u None NO COMMENTS
Wrong-fabric-id 0x10u Wrong Fabric Id in MO. Make sure to clean reload with Fabric Id change NO COMMENTS
no-ip-addr-available 0x1u Dhcp does not have any more IP addresses to allocate to client. NO COMMENTS
unregistered-switch 0x20u Make sure to register the switch using fabricNodeIdentP NO COMMENTS
invalid-podid 0x2u Invalid Pod Id. Check Pod Setup policy NO COMMENTS
max-vleaf-pending-lease 0x40u Max number of Pending Lease for vLeaf.This usually raise because of DHCP DISCOVER packets flood NO COMMENTS
duplicate-ip 0x4u Dhcp has assigned duplicate ip. Please decommission this client. NO COMMENTS
no-tep-pool-configured 0x8u Provider MO and Subnet MO not present. Check Pod Setup policy NO COMMENTS
DEFAULT none(0x0u) None NO COMMENTS





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.



id

Type: scalar:Uint32

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Appliance ID



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





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





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.



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.