Class dhcp:Entity (CONCRETE)

Class ID:2708
Class Label: DHCP Entity
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
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: false, HasHealth: true, HasEventRules: false ]

Holds DHCP control plane entity information.

Naming Rules
RN FORMAT: dhcp

    [1] PREFIX=dhcp


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/dhcp

[1] sys/dhcp

                


Diagram

Super Mo: l3:ProtEntity,
Container Mos: top:System (deletable:no),
Contained Mos: dhcp:Inst,


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] dhcp:Entity Holds DHCP control plane entity information.
[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] dhcp:Entity Holds DHCP control plane entity information.


Contained Hierarchy
[V] dhcp:Entity Holds DHCP control plane entity information.
 ├
[V] dhcp:Inst The DHCP instance information. There is only one instance of DHCP relay currently running in the system.
 
 ├
[V] dhcp:BootStrapLoader 
 
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] dhcp:ClientIf Used for showing client functionality on the interface.
 
 
 ├
[V] dhcp:ClientAddr The DHCP address received for the client.
 
 
 ├
[V] dhcp:ClientResp The DHCP client response.
 
 
 
 ├
[V] dhcptlv:Complex The Complex type, length, and value (TLV), which contains basic TLVs.
 
 
 
 
 ├
[V] dhcptlv:Ip The IP type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlv:Mac The Mac type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlv:Text The text type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlv:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlv:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlv:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlv:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlv:Ip The IP type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlv:Mac The Mac type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlv:Text The text type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlv:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlv:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlv:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlv:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 ├
[V] dhcp:MsgStats The DHCP message statistics.
 
 
 ├
[V] dhcp:MsgStatsv6 
 
 
 ├
[V] dhcp:PseudoIf The Psuedo Interface definition.
 
 
 
 ├
[V] dhcptlvpol:Complex The Complex type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 
 ├
[V] nw:RtPathToIf A target relation to the interface information.
 
 
 ├
[V] dhcp:RsPseudoIf A source relation to the abstract layer 3 interface. If the mode is pseudo interface, the list of all interfaces that the dhcp requests is flooded.
 
 
 ├
[V] dhcptlvpol:Complex The Complex type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 ├
[V] nw:RtPathToIf A target relation to the interface information.
 
 ├
[V] dhcp:DiscvryIpRouteDef 
 
 ├
[V] dhcp:RelayIf DHCP relay if used for representing relay functionality on the interface.
 
 
 ├
[V] dhcp:MsgStats The DHCP message statistics.
 
 
 ├
[V] dhcp:MsgStatsv6 
 
 
 ├
[V] dhcp:OptionDef The option definition. Each DHCP option is defined by a unique name, ID, and option data.
 
 
 
 ├
[V] dhcp:DiscNode The Discovered DHCP client node.
 
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 ├
[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:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 
 ├
[V] dhcp:RelayAddr The DHCP relay address.
 
 
 
 ├
[V] dhcp:RelayAddrStats The relay address statistics
 
 
 
 ├
[V] dhcp:RelayGw 
 
 
 
 ├
[V] dhcp:RsRelayAddrToProv 
 
 
 ├
[V] dhcp:RelayIfStats The relay interface statistics.
 
 
 ├
[V] dhcp:RelayIfStatsv6 
 
 
 ├
[V] dhcptlvpol:Complex The Complex type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 ├
[V] nw:RtPathToIf A target relation to the interface information.
 
 ├
[V] dhcp:ServerIf DHCP server if not supported; defined for completeness.
 
 
 ├
[V] dhcptlvpol:Complex The Complex type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Ip The IP type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Mac The Mac type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:Text The text type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).
 
 
 ├
[V] dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).
 
 
 ├
[V] nw:RtPathToIf A target relation to the interface information.
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[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] 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:CpEntity The control plane entity abstraction. This object represents a feature or protocol on the switch. For example, OSPF and VPC features.
 
 
 
 ├
[V] l3:ProtEntity A layer 3 protocol entity abstraction.
 
 
 
 
 ├
[V] dhcp:Entity Holds DHCP control plane entity information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: dhcp:Entity
reference:BinRef monPolDn  (dhcp:Entity:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: nw:CpEntity
nw:AdminSt
          scalar:Enum8
adminSt  (nw:CpEntity:adminSt)
           The administrative state of the object or policy.
naming:Name
          string:Basic
name  (nw:CpEntity:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64
operErr  (nw:CpEntity:operErr)
          
nw:EntOperSt
          scalar:Enum8
operSt  (nw:CpEntity:operSt)
           The runtime state of the object or policy.
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: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.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





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.



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





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: create Category: TopLevelRegular
    Comments:
The name of the object.



operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





operSt

Type: nw:EntOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 unknown Entity state unknown
enabled 1 enabled Entity enabled
disabled 2 disabled Entity disabled
initializing 3 initializing Entity initializing
failed 4 failed Entity enable failed
DEFAULT enabled(1) enabled Entity enabled





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.