Class dhcp:DiscNode (CONCRETE)

Class ID:2705
Class Label: DHCP Discovered Client Node
Encrypted: false - Exportable: true - Persistent: false - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, tenant-protocol-l3]
Read Access: [admin, tenant-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The Discovered DHCP client node.

Naming Rules
RN FORMAT: bd-{[encap]}-{mac}-{[ciAddr]}

    [1] PREFIX=bd- PROPERTY = encap


    [2] PREFIX=- PROPERTY = mac


    [3] PREFIX=- PROPERTY = ciAddr




DN FORMAT: 

        Too Many Containers: 167
                


Containers Hierarchies
Too Many containers: 167


Contained Hierarchy
[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)


Inheritance
[V] dhcp:Node Generic DHCP client node.
 ├
[V] dhcp:DiscNode The Discovered DHCP client node.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: dhcp:DiscNode
address:Ip ciAddr  (dhcp:DiscNode:ciAddr)
           The IP address that is assigned to this client by the DHCP server
base:Encap ctxEncap  (dhcp:DiscNode:ctxEncap)
           Vrf
base:Encap encap  (dhcp:DiscNode:encap)
           EPG Encap
base:Encap fabEncap  (dhcp:DiscNode:fabEncap)
           BD
nw:IfId
          base:IfIndex
ifId  (dhcp:DiscNode:ifId)
           Interface on which the client was discovered
address:MAC mac  (dhcp:DiscNode:mac)
           Client hardware address
reference:BinRef monPolDn  (dhcp:DiscNode:monPolDn)
           The monitoring policy attached to this observable object.
dhcp:NotifStatus
          scalar:Enum8
notifSt  (dhcp:DiscNode:notifSt)
           Notification status
address:Ip siAddr  (dhcp:DiscNode:siAddr)
           Server ip address, the server that assigned the IP address for the client interface
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

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





ciAddr

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
The IP address that is assigned to this client by the DHCP server



ctxEncap

Type: base:Encap

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



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.



encap

Type: base:Encap

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
EPG Encap



fabEncap

Type: base:Encap

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



ifId

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Interface on which the client was discovered



mac

Type: address:MAC

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Comments:
Client hardware address



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.



notifSt

Type: dhcp:NotifStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Notification status
Constants
active 1 Active Active, the notification is active and processing is incomplete
processed 2 Processed processed, the notification has been processed
DEFAULT active(1) Active Active, the notification is active and processing is incomplete





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.



siAddr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Server ip address, the server that assigned the IP address for the client interface



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.