Class dhcp:Client (CONCRETE)

Class ID:1463
Class Label: Client
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-equipment, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: yes (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: true ]

A DHCP client, which allows a device to act as a host requesting configuration parameters, such as an IP address, from a DHCP server.

Naming Rules
RN FORMAT: client-{[id]}

    [1] PREFIX=client- PROPERTY = id




DN FORMAT: 

[0] client-{[id]}

                


Diagram

Super Mo: naming:NamedObject,
Container Mos: top:Root (deletable:yes),
Contained Mos: dhcp:ExtIf,
Relations From: dhcp:Lease, pol:DefRelnHolder,
Relations: dhcp:RtClient, dhcp:RtClientRel,


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:Client A DHCP client, which allows a device to act as a host requesting configuration parameters, such as an IP address, from a DHCP server.


Contained Hierarchy
[V] dhcp:Client A DHCP client, which allows a device to act as a host requesting configuration parameters, such as an IP address, from a DHCP server.
 ├
[V] dhcp:ExtIf  DHCP client l3ext interface
 ├
[V] dhcp:RtClient Internal object: relation from the dhcpLease to the dhcpClient.
 ├
[V] dhcp:RtClientRel A target relation to the DCHP client.
 ├
[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] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] dhcp:Client A DHCP client, which allows a device to act as a host requesting configuration parameters, such as an IP address, from a DHCP server.


Events
                dhcp:Client:dhcp_Client_assignedIpAddress
dhcp:Client:dhcp_Client_clientIpAddrRequestDenied


Faults
                dhcp:Client:addressAssignmentFailed
dhcp:Client:invalidConfiguration


Fsms
                


Properties Summary
Defined in: dhcp:Client
dhcp:Capabilities
          scalar:Bitmask32
capabilities  (dhcp:Client:capabilities)
           Client Capabilities
dhcp:ClientEvent
          scalar:Enum8
clientEvent  (dhcp:Client:clientEvent)
           Client event .. It captures various client configuration update events. It is represented as a bitmask to collect all events and provide feedback to users.
dhcp:ConfigIssues
          scalar:Bitmask32
configIssues  (dhcp:Client:configIssues)
           Bitmask representation of the configuration issues found during the endpoint group deployment.
top:NodeRoleP
          scalar:Enum8
configNodeRole  (dhcp:Client:configNodeRole)
           Configured Node Role
scalar:Bool decomissioned  (dhcp:Client:decomissioned)
           Indicated if the node is decomissioned.
top:FabricId
          scalar:UByte
fabricId  (dhcp:Client:fabricId)
           Fabric Identifier of this client
cap:Version
          string:Basic
fwVer  (dhcp:Client:fwVer)
           Desired fw version for this Client
address:MAC hwAddr  (dhcp:Client:hwAddr)
           hardware address (chaddr) field sent by the client when it acquired its lease
dhcp:ClientId
          string:Basic
id  (dhcp:Client:id)
           The client ID is the client identifier that the client used when it acquired the lease (Serial Number). DHCP clients require client identifiers instead of hardware addresses. The client ID is in dotted-hexadecimal notation and formed by concatenating the media type and the MAC address. For example, the Microsoft client identifier for Ethernet address b708.1388.f166 is 01b7.0813.88f1.66, where 01 represents the Ethernet media type. The client ID may be used when requesting an address from a DHCP server.
address:Ip ip  (dhcp:Client:ip)
           The IP address assigned to the node.
cap:Model
          string:Basic
model  (dhcp:Client:model)
           The Fabric node model.
fabric:NodeId
          scalar:Uint16
nodeId  (dhcp:Client:nodeId)
           The Fabric node identifier.
top:NodeRole
          scalar:Enum8
nodeRole  (dhcp:Client:nodeRole)
           The role of the Fabric node.
top:PodId
          scalar:UByte
podId  (dhcp:Client:podId)
           POD identifier
address:Ip relayIp  (dhcp:Client:relayIp)
           The IP address of the relay gateway
cap:Version
          string:Basic
runningVer  (dhcp:Client:runningVer)
           Running fw version for this Client
scalar:UByte spineLevel  (dhcp:Client:spineLevel)
           Spine level (0, 1, 2)
scalar:Bool supported  (dhcp:Client:supported)
           An indication that the node model is supported.
Defined in: naming:NamedObject
naming:Name
          string:Basic
name  (naming:NamedObject:name)
           The name of the object.
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

capabilities

Type: dhcp:Capabilities
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Client Capabilities
Constants
none 0u None No capabilities enabled
multi-pod-bringup 1u multi-pod-bringup Multi pod bringup without nodeId
DEFAULT none(0u) None No capabilities 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





clientEvent

Type: dhcp:ClientEvent
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Client event .. It captures various client configuration update events. It is represented as a bitmask to collect all events and provide feedback to users.
Constants
none 0 None NO COMMENTS
pending 1 Client IP address request in pending state. NO COMMENTS
assigned 2 Client IP address request successed. NO COMMENTS
denied 3 Client IP address request denied. NO COMMENTS
role-mismatch 4 Node Role mismatch NO COMMENTS
requesting 5 Client IP address requested. NO COMMENTS
DEFAULT pending(1) Client IP address request in pending state. NO COMMENTS





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
no-ip-addr-available 0x1u Dhcp does not have any more IP addresses to allocate to client. NO COMMENTS
invalid-podid 0x2u Invalid pod Id NO COMMENTS
duplicate-ip 0x4u Dhcp has assigned duplicate ip. Please decommission this client. NO COMMENTS
DEFAULT none(0x0u) None NO COMMENTS





configNodeRole

Type: top:NodeRoleP
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Configured Node Role
Constants
unspecified 0 unspecified NO COMMENTS
leaf 2 leaf Leaf
spine 3 spine Spine
DEFAULT unspecified(0) unspecified NO COMMENTS





decomissioned

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Indicated if the node is decomissioned.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.



fabricId

Type: top:FabricId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Fabric Identifier of this client
Constants
defaultValue 1 --- NO COMMENTS





fwVer

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Desired fw version for this Client



hwAddr

Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
hardware address (chaddr) field sent by the client when it acquired its lease



id

Type: dhcp:ClientId
Primitive Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The client ID is the client identifier that the client used when it acquired the lease (Serial Number). DHCP clients require client identifiers instead of hardware addresses. The client ID is in dotted-hexadecimal notation and formed by concatenating the media type and the MAC address. For example, the Microsoft client identifier for Ethernet address b708.1388.f166 is 01b7.0813.88f1.66, where 01 represents the Ethernet media type. The client ID may be used when requesting an address from a DHCP server.



ip

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP address assigned to the node.



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





model

Type: cap:Model
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The Fabric node model.



name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



nodeId

Type: fabric:NodeId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The Fabric node identifier.
Constants
defaultValue 0 --- NO COMMENTS





nodeRole

Type: top:NodeRole
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The role of the Fabric node.
Constants
unsupported 0 unknown NO COMMENTS
controller 1 controller Controller
leaf 2 leaf Leaf
spine 3 spine Spine
vleaf 4 vleaf vLeaf
vip 5 vip VPC IP address
protection-chain 6 protection-chain Protection chain IP
DEFAULT unsupported(0) unknown NO COMMENTS





podId

Type: top:PodId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
POD identifier
Constants
defaultValue 1 --- NO COMMENTS





relayIp

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP address of the relay gateway



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.



runningVer

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Running fw version for this Client



spineLevel

Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Spine level (0, 1, 2)



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.






supported

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An indication that the node model is supported.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS