Class dhcp:ClientResp (CONCRETE)

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

The DHCP client response.

Naming Rules
RN FORMAT: resp

    [1] PREFIX=resp


DN FORMAT: 

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

[1] sys/dhcp/inst/clientif-{[id]}/resp

                


Diagram

Super Mo: dhcp:Resp,
Container Mos: dhcp:ClientIf (deletable:yes),
Contained Mos: aaa:RbacAnnotation, dhcptlv:Complex, dhcptlv:Ip, dhcptlv:Mac, dhcptlv:Text, dhcptlv:UByte, dhcptlv:UInt16, dhcptlv:UInt32, dhcptlv:UInt64, tag:Annotation, tag:Tag,


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] dhcp:Inst The DHCP instance information. There is only one instance of DHCP relay currently running in the system.
 
 
 
 
 
 
 ├
[V] dhcp:ClientIf Used for showing client functionality on the interface.
 
 
 
 
 
 
 
 ├
[V] dhcp:ClientResp The DHCP client response.
[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.
 
 
 ├
[V] dhcp:Inst The DHCP instance information. There is only one instance of DHCP relay currently running in the system.
 
 
 
 ├
[V] dhcp:ClientIf Used for showing client functionality on the interface.
 
 
 
 
 ├
[V] dhcp:ClientResp The DHCP client response.


Contained Hierarchy
[V] dhcp:ClientResp The DHCP client response.
 ├
[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] 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] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] dhcp:Resp The generic DHCP response.
 ├
[V] dhcp:ClientResp The DHCP client response.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: dhcp:ClientResp
mo:Annotation
          string:Basic
annotation  (dhcp:ClientResp:annotation)
           NO COMMENTS
address:MAC chAddr  (dhcp:ClientResp:chAddr)
           Client hardware address
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (dhcp:ClientResp:extMngdBy)
           NO COMMENTS
dhcp:File
          string:Basic
file  (dhcp:ClientResp:file)
           File, location of the boot script file given by the server
address:Ip gwAddr  (dhcp:ClientResp:gwAddr)
           Router IP (option code 3)
dhcp:HostName
          string:Basic
hostName  (dhcp:ClientResp:hostName)
           Host name (option code 12)
nw:IfId
          base:IfIndex
ifId  (dhcp:ClientResp:ifId)
           In case of proxy interface, ifindex of the l3 interface on which the resp received
dhcp:LeaseTime
          scalar:Uint16
leaseTime  (dhcp:ClientResp:leaseTime)
           Lease time (option code 51)
dhcp:MsgT
          scalar:Enum8
msgT  (dhcp:ClientResp:msgT)
           Message type (option code 53)
address:Ip serverId  (dhcp:ClientResp:serverId)
           Server identifier (option code 54)
address:Ip siAddr  (dhcp:ClientResp:siAddr)
           Server ip address, the server that assigned the IP address for the client interface
address:Ip subnetMask  (dhcp:ClientResp:subnetMask)
           Client subnet mask (option code 1)
address:Ip yiAddr  (dhcp:ClientResp:yiAddr)
           Your ip address, the IP address that is assigned to this interface by the DHCP server
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

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



chAddr

Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Client hardware address



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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





file

Type: dhcp:File
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
File, location of the boot script file given by the server



gwAddr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Router IP (option code 3)



hostName

Type: dhcp:HostName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Host name (option code 12)



ifId

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
In case of proxy interface, ifindex of the l3 interface on which the resp received



leaseTime

Type: dhcp:LeaseTime
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Lease time (option code 51)



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





msgT

Type: dhcp:MsgT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Message type (option code 53)
Constants
discover 1 Discover Discover
offer 2 Offer Offer
request 3 Request Request
decline 4 Decline Decline
ack 5 Ack Ack
nak 6 Nak Nak
release 7 Release Release
inform 8 Inform Inform
invalid 255 Invalid Invalid
DEFAULT discover(1) Discover Discover





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.



serverId

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Server identifier (option code 54)



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.






subnetMask

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Client subnet mask (option code 1)



yiAddr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Your ip address, the IP address that is assigned to this interface by the DHCP server