Class dhcp:Entity (CONCRETE)

Class ID:2708
Class Label: DHCP Entity
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-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 ]

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

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ 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...          ├ dhcp:Entity Holds DHCP control plane entity information. top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ 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...    ├ dhcp:Entity Holds DHCP control plane entity information.

Contained Hierarchy

dhcp:Entity Holds DHCP control plane entity information.  ├ dhcp:Inst The DHCP instance information. There is only one instance of DHCP relay currently running in the system.    ├ dhcp:BootStrapLoader       ├ 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.    ├ dhcp:ClientIf Used for showing client functionality on the interface.      ├ dhcp:ClientAddr The DHCP address received for the client.        ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:ClientResp The DHCP client response.        ├ 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        ├ dhcptlv:Complex The Complex type, length, and value (TLV), which contains basic TLVs.          ├ dhcptlv:Ip The IP type, length, and value (TLV).          ├ dhcptlv:Mac The Mac type, length, and value (TLV).          ├ dhcptlv:Text The text type, length, and value (TLV).          ├ dhcptlv:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).          ├ dhcptlv:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).          ├ dhcptlv:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).          ├ dhcptlv:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).        ├ dhcptlv:Ip The IP type, length, and value (TLV).        ├ dhcptlv:Mac The Mac type, length, and value (TLV).        ├ dhcptlv:Text The text type, length, and value (TLV).        ├ dhcptlv:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).        ├ dhcptlv:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).        ├ dhcptlv:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).        ├ dhcptlv:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:MsgStats The DHCP message statistics.        ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:MsgStatsv6         ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:PseudoIf The Psuedo Interface definition.        ├ dhcptlvpol:Complex The Complex type, length, and value (TLV).          ├ dhcptlvpol:Ip The IP type, length, and value (TLV).          ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).          ├ dhcptlvpol:Text The text type, length, and value (TLV).          ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).          ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).          ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).          ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).        ├ dhcptlvpol:Ip The IP type, length, and value (TLV).        ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).        ├ dhcptlvpol:Text The text type, length, and value (TLV).        ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).        ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).        ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).        ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).        ├ nw:RtPathToIf A target relation to the interface information.      ├ 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.      ├ dhcptlvpol:Complex The Complex type, length, and value (TLV).        ├ dhcptlvpol:Ip The IP type, length, and value (TLV).        ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).        ├ dhcptlvpol:Text The text type, length, and value (TLV).        ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).        ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).        ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).        ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).      ├ dhcptlvpol:Ip The IP type, length, and value (TLV).      ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).      ├ dhcptlvpol:Text The text type, length, and value (TLV).      ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).      ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).      ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).      ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).      ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ 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.        ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ health:Inst A base class for a health score instance.(Switch only)      ├ nw:RtPathToIf A target relation to the interface information.    ├ dhcp:DiscvryIpRouteDef     ├ dhcp:RelayIf DHCP relay if used for representing relay functionality on the interface.      ├ dhcp:MsgStats The DHCP message statistics.        ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:MsgStatsv6         ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:OptionDef The option definition. Each DHCP option is defined by a unique name, ID, and option data.        ├ dhcp:DiscNode The Discovered DHCP client node.          ├ 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          ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.          ├ 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.            ├ 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            ├ tag:Annotation             ├ tag:Tag           ├ health:Inst A base class for a health score instance.(Switch only)          ├ tag:Annotation           ├ tag:Tag         ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.        ├ 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.        ├ health:Inst A base class for a health score instance.(Switch only)      ├ dhcp:RelayAddr The DHCP relay address.        ├ 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        ├ dhcp:RelayAddrStats The relay address statistics          ├ 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          ├ tag:Annotation           ├ tag:Tag         ├ dhcp:RelayGw         ├ dhcp:RsRelayAddrToProv         ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.        ├ 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.          ├ 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          ├ tag:Annotation           ├ tag:Tag         ├ health:Inst A base class for a health score instance.(Switch only)        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:RelayIfStats The relay interface statistics.        ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ dhcp:RelayIfStatsv6         ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ dhcptlvpol:Complex The Complex type, length, and value (TLV).        ├ dhcptlvpol:Ip The IP type, length, and value (TLV).        ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).        ├ dhcptlvpol:Text The text type, length, and value (TLV).        ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).        ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).        ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).        ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).      ├ dhcptlvpol:Ip The IP type, length, and value (TLV).      ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).      ├ dhcptlvpol:Text The text type, length, and value (TLV).      ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).      ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).      ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).      ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).      ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ health:Inst A base class for a health score instance.(Switch only)      ├ nw:RtPathToIf A target relation to the interface information.    ├ dhcp:ServerIf DHCP server if not supported; defined for completeness.      ├ dhcptlvpol:Complex The Complex type, length, and value (TLV).        ├ dhcptlvpol:Ip The IP type, length, and value (TLV).        ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).        ├ dhcptlvpol:Text The text type, length, and value (TLV).        ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).        ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).        ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).        ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).      ├ dhcptlvpol:Ip The IP type, length, and value (TLV).      ├ dhcptlvpol:Mac The Mac type, length, and value (TLV).      ├ dhcptlvpol:Text The text type, length, and value (TLV).      ├ dhcptlvpol:UByte The 8-bit unsigned integer (UByte) type, length, and value (TLV).      ├ dhcptlvpol:UInt16 The 16-bit unsigned integer (UInt16) type, length, and value (TLV).      ├ dhcptlvpol:UInt32 The 32-bit unsigned integer (UInt32) type, length, and value (TLV).      ├ dhcptlvpol:UInt64 The 64-bit unsigned integer (UInt64) type, length, and value (TLV).      ├ nw:RtPathToIf A target relation to the interface information.    ├ dhcp:ServerInfo       ├ 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      ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ 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.        ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ health:Inst A base class for a health score instance.(Switch only)      ├ tag:Annotation       ├ tag:Tag     ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ health:Inst A base class for a health score instance.(Switch only)  ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ health:Inst A base class for a health score instance.(Switch only)

Inheritance

nw:Item Ignore.  ├ nw:Conn A connection abstraction.    ├ nw:GEp A group endpoint abstraction.      ├ nw:CpEntity The control plane entity abstraction. This object represents a feature or protocol on the switch. For example, OSPF and VPC features.        ├ l3:ProtEntity A layer 3 protocol entity abstraction.          ├ dhcp:Entity Holds DHCP control plane entity information.

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The administrative state of the object or policy.

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

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

A value that indicates how this object was created. For internal use only.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

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

The name of the object.

operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

operSt

Type: nw:EntOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

The runtime state of the object or policy.

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

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

The upgrade status. This property is for internal use only.