| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| agentCircuitId |
The value of this attribute indicates the agent Circuit ID, which is composed in option 82 attribute
type=string access=read-only minimum=0 maximum=255 Displayed(tab/group)=Circuit ID (/Relay Agent Information) |
| agentRemoteId |
The value of this attribute indicates the agent Remote ID, which is composed in option 82 attribute
type=string access=read-only minimum=0 maximum=255 Displayed(tab/group)=Remote ID (/Relay Agent Information) |
| ancpString |
The Value of this attribute indicates the
value of the ancp-string received from either the DHCP
or the Radius server as indicated by the value of Origin Strings.
type=string access=read-only minimum=0 maximum=63 Displayed(tab/group)=ANCP String (Subscriber Details/Residential Subscriber) |
| appProfString |
The Value of this attribute indicates the
application profile string applicable for this DHCP lease state.
type=string access=read-only Displayed(tab/group)=Application Profile String (Subscriber Details/Residential Subscriber) |
| bCastIPAddrType |
The Value of this attribute indicates the address type of broadcast IP
type=rtr.InetAddressType access=read-only |
| bCastIp |
The Value of this attribute indicates the
broadcast IP address received from either the DHCP or the
Radius server as indicated by the value of Origin Lease Info.
The value of this object is ''H when not applicable.
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=Broadcast IP Address (/DHCP Lease General) |
| categoryMapName |
The Value of this attribute indicates the
value of the category map name received from either the
DHCP or the Radius server as indicated by the value of Origin Strings.
type=string access=read-only minimum=1 maximum=32 Displayed(tab/group)=Category Map Name (Subscriber Details/Residential Subscriber) |
| chAddr |
The Value of this attribute indicates the MAC address of the DHCP lease state.
type=MacAddress access=read-only Displayed(tab/group)=Lease State MAC Address (/DHCP Lease General) |
| ciAddr |
The Value of this attribute indicates the IP Address of the DHCP lease state.
type=InetAddress access=read-create Mandatory on create Displayed(tab/group)=IP Address (/DHCP Lease General) |
| ciAddrMaskLen |
The value of this attribute indicates the prefix length of the ciAddr
for a DHCPv6 lease.
type=int access=read-only minimum=0 maximum=128 |
| ciAddrType |
The Value of this attribute indicates the address type of DHCP Lease State Address type.
type=rtr.InetAddressType access=read-create Mandatory on create |
| clientId |
The value of this attribute indicates the DHCPv6 clients unique identifier (DUID)
as generated by the client.
type=string access=read-only minimum=0 maximum=255 Displayed(tab/group)=DHCP6 Client ID (DUID) (DHCP6/DHCP6 Specific) |
| defaultRouter |
The Value of this attribute indicates the
default router received from either the DHCP or the
Radius server as indicated by the value of Origin Lease Info.
The value of this object is ''H when not applicable.
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=Default Router (/DHCP Lease General) |
| defaultRouterTp |
The Value of this attribute indicates the address type of default router
type=rtr.InetAddressType access=read-only |
| dhcpClientAddr |
The value of this attribute indicates the IP address of the DHCP Client that owns
the lease info. In some cases this address can be different from the address specified
in ciAddr, e.g. in case of DHCPv6 prefix delegation.
type=InetAddress access=read-only Displayed(tab/group)=DHCP6 Client Address (DHCP6/DHCP6 Specific) |
| dhcpclientAddrType |
The value of this attribute indicates the address type of DHCP Client Address.
type=rtr.InetAddressType access=read-only |
| encapValue |
When the value of Locale is 'sap', the
object Port ID along with the object
EncapValue, indicates the SAP for which this entry contains information.
This object is otherwise insignificant and contains the value 0.
type=long access=read-only |
| framedNetMask |
The Value of this attribute indicates the
framed IP netmask received from either the DHCP or the
Radius server as indicated by the value of Origin Lease Info.
The value of this object is ''H when not applicable.
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=IP Netmask (/DHCP Lease General) |
| framedNetMaskTp |
The Value of this attribute indicates the address type of framed netmask.
type=rtr.InetAddressType access=read-only |
| iAID |
The value of this attribute indicates the Identity Association ID (IAID)
the address or prefix defined by ciAddr/ciAddrMaskLen has been assigned to.
This object is only meaningful for DHCPv6 leases.
type=int access=read-only Displayed(tab/group)=DHCP6 IAID (DHCP6/DHCP6 Specific) |
| iAIDType |
The value of this attribute indicates the type of IAID.
This object is only meaningful for DHCPv6 leases.
type=ressubscr.DhcpLeaseAidType access=read-only Displayed(tab/group)=DHCP6 IAID Type (DHCP6/DHCP6 Specific) |
| id |
The Value of this attribute specifies the service ID.
type=long access=read-create Mandatory on create Displayed(tab/group)=Service ID (/DHCP Lease General) |
| interfaceId |
The value of this attribute indicates the content of the Interface-id option used for
authentication. This object is only meaningful for DHCPv6 leases.
type=string access=read-only minimum=0 maximum=255 Displayed(tab/group)=DHCP6 Interface ID (DHCP6/DHCP6 Specific) |
| intermediateDestId |
The Value of this attribute indicates the
intermediate destination identifier received from either
the DHCP or the Radius server or the local user database
as indicated by the value of Origin Strings
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Intermediate Destination ID (Subscriber Details/Residential Subscriber) |
| ipoeSessionHost |
The value of this attribute indicates indicates whether or not
this DHCP lease belongs to an IPoE session.
type=int access=read-only Displayed(tab/group)=IPoE Session Host (/DHCP Lease General) enums= 1: true - True 2: false - False |
| leaseSessionTimeout |
The Value of this attribute indicates the
session timeout received from either the DHCP or the
Radius server or the local user database.
type=Time access=read-only units=seconds Displayed(tab/group)=Lease Session Timeout (/DHCP Lease Time) |
| leaseTime |
The Value of this attribute indicates the
lease time received from either the DHCP or the
Radius server or the local user database.
type=Time access=read-only units=seconds Displayed(tab/group)=Lease Time (/DHCP Lease Time) |
| leasesplitActive |
The value of this attribute indicates whether or not the current lease time resulted
from a lease split. If Split Active is 'true', the lease time passed to the client is
determined by the value of the object Dhcp Proxy Lease Time for VPLS SAPs,or
by the value of the object RtrIf DHCPProxy Lease Time for Layer 3 interfaces.
type=ressubscr.LeaseSplitActive access=read-only Displayed(tab/group)=Lease Split Active (/DHCP Lease General) |
| locale |
The Value of this attribute indicates specifies if the
DHCP lease state is learned via a SAP or SDP
type=ressubscr.DhcpLeaseStateLearned access=read-only |
| managedRouteStatus |
The value of this attribute indicates the status of the managed route associated with this lease.
This object is only meaningful for DHCPv6 PD leases.
type=ressubscr.ManagedRouteStatusType access=read-only Displayed(tab/group)=DHCPv6 Managed Route Status (/DHCP Lease General) |
| nakNextRenew |
The value of this attribute indicates the that the system will reply with a DHCP-NAK when the client
sends the next DHCP-REQUEST, whereafter the lease-state will be deleted.
This state is entered upon reception of a FORCE-NAK COA (Change Of Authority) request from RADIUS
for this lease state, which at the same time also triggered the system to send a FORCE-RENEW DHCP
message to the client.
type=ressubscr.DhcpNakNextRenew access=read-only Displayed(tab/group)=NAK Next Renew (/DHCP Lease General) |
| nextHopMacAddr |
The Value of this attribute indicates the MAC address of the next hop of
this DHCP lease state.
type=MacAddress access=read-create Mandatory on create Displayed(tab/group)=Client HW Address (/DHCP Lease General) |
| originLeaseInfo |
The Value of this attribute indicates
which server provided the lease state information.
type=ressubscr.DhcpLeaseOriginSubScrid access=read-only Displayed(tab/group)=Lease Information Origin (Subscriber Details/Residential Subscriber) |
| originString |
The Value of this attribute indicates
which server provided the Sub-profile, SLA profile,
Ancp string and Intermediate Destination ID.
type=ressubscr.DhcpLeaseOriginSubScrid access=read-only Displayed(tab/group)=Subscriber Strings Origin (Subscriber Details/Residential Subscriber) |
| originSubscrId |
The Value of this attribute indicates
which source provided the subscriber-id.
type=ressubscr.DhcpLeaseOriginSubScrid access=read-only Displayed(tab/group)=Subscriber Identification Origin (Subscriber Details/Residential Subscriber) |
| persistKey |
The Value of this attribute indicates a key
value that can be used to track this lease state in the persistence file.
DEPRECATED: 10.0R5 type=long access=read-only |
| poolName |
The value of this attribute indicates the pool name included in the Relay-forward Message.
This object is only meaningful for DHCPv6 leases.
type=string access=read-only minimum=1 maximum=32 Displayed(tab/group)=Pool Name (/DHCP Lease General) |
| portId |
When the value of Locale is 'sap', the
object Port ID along with the object
EncapValue, indicates the SAP for which this entry contains information.
This object is otherwise insignificant and contains the value 0.
type=long access=read-only |
| pppSessionHost |
The value of this attribute indicates indicates whether or not
this DHCP lease belongs to an PPP session.
type=int access=read-only Displayed(tab/group)=PPP Session Host (/DHCP Lease General) enums= 1: true - True 2: false - False |
| primaryDns |
The Value of this attribute indicates the
primary DNS server received from the server indicated
by the value of Origin Lease Info.
The value of this object is ''H when not applicable.
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=Primary DNS Server (DNS and NBNS IP Addresses/DNS and NBNS) |
| primaryDnsType |
The Value of this attribute indicates the address type of primary DNS Server
type=rtr.InetAddressType access=read-only |
| primaryNbns |
The Value of this attribute indicates the
primary NBNS server received from either the DHCP or the
Radius server as indicated by the value of Origin Lease Info.
The value of this object is ''H when not applicable.
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=Primary NBNS Server (DNS and NBNS IP Addresses/DNS and NBNS) |
| primaryNbnsType |
The Value of this attribute indicates the address type of primary NBNS server.
type=rtr.InetAddressType access=read-only |
| radCalledStationId |
The value of this attribute indicates the content of the Called-Station-Id
RADIUS attribute used for authentication.
type=string access=read-only default= minimum=0 maximum=64 Displayed(tab/group)=Called Station ID (/DHCP Lease General) |
| radiusClassAttr |
The value of this attribute indicates the Class attribute returned by the RADIUS server in an
Access-Accept message. If no RADIUS authentication is performed for this lease state,
or RADIUS did not return this attribute, the value of this object is empty.
type=string access=read-only minimum=0 maximum=253 Displayed(tab/group)=RADIUS Class Attribute (/RADIUS) |
| radiusUserName |
The Value of this attribute indicates the User-Name attribute
returned by the RADIUS server in an Access-Accept message.
If RADIUS did not return this attribute, the value of this
object is equal to the User-Name attribute sent in the
original Access-Request message.
If no RADIUS authentication is performed for this session,
the value of this object is empty
type=string access=read-only minimum=0 maximum=253 Displayed(tab/group)=RADIUS User Name (/RADIUS) |
| remainLeaseTime |
The Value of this attribute indicates the
remaining lease time of the DHCP lease state.
type=Time access=read-only Displayed(tab/group)=Remaining Life Time (/DHCP Lease Time) |
| remainingSessionTime |
The Value of this attribute indicates the
time before the host is disconnected.
type=Time access=read-only units=seconds Displayed(tab/group)=Remaining Session Time (/DHCP Lease Time) |
| remoteId |
The value of this attribute indicates the content of the Remote-id option used for
authentication. This object is only meaningful for DHCPv6 leases.
type=string access=read-only minimum=0 maximum=255 Displayed(tab/group)=DHCP6 Remote ID (DHCP6/DHCP6 Specific) |
| ressubscr.DhcpLeaseAccLoopEncap-Set |
type=Children-Set |
| ressubscr.DhcpLeaseBgpEntry-Set |
type=Children-Set |
| ressubscr.DhcpLeaseQosOverride-Set |
type=Children-Set |
| ressubscr.DhcpLeaseStateRadiusClassAttribute-Set |
type=Children-Set |
| retailerInterface |
The Value of this attribute indicates the
interface index of the retailer VPRN interface to
which this DHCP lease belongs. When this object is
non zero, the DHCP lease belongs to a retailer VPRN.
type=string access=read-only Displayed(tab/group)=Retailer Interface ID (Subscriber Details/Business Subscriber) |
| retailerServiceId |
The value of this attribute indicates the service ID of the retailer
VPRN service to which this DHCP lease belongs. When this object is non zero,
the DHCP lease belongs to a retailer VPRN.
type=long access=read-only minimum=0 maximum=2147483650 Displayed(tab/group)=Retailer Service ID (Subscriber Details/Business Subscriber) |
| ripListenerStatus |
Indicates the status of the RIP listener.
type=ressubscr.RipListenerStatus access=read-only Displayed(tab/group)=RIP Listener Status (/RIP Listener) |
| ripPolicyPointer |
Indicates the RIP policy which is used to set up the RIP
listener for this DHCP Lease.
type=Pointer access=read-only Displayed(tab/group)=RIP Policy (/RIP Listener) |
| sapPointer |
Reference to the access interface the ARP host resides on.
type=Pointer access=read-only default= Displayed(tab/group)=SAP (/DHCP Lease General) |
| sdpId |
When the value of Locale is 'sdp', the
object SdpId, along with the object VcId, indicates the SDP Binding for which
this entry contains information. This object is otherwise
insignificant and contains the value 0.
type=int access=read-only default=0 minimum=1 maximum=17407 |
| secondaryDns |
The Value of this attribute indicates the
secondary DNS server received from the server indicated
by the value of Origin Lease Info.
The value of this object is ''H when not applicable.
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=Secondary DNS Server (DNS and NBNS IP Addresses/DNS and NBNS) |
| secondaryDnsType |
The Value of this attribute indicates the address type of secondary DNS Server
type=rtr.InetAddressType access=read-only |
| secondaryNbns |
The Value of this attribute indicates the
secondary NBNS server received from either the DHCP or the
Radius server as indicated by the value of Origin Lease Info.
The value of this object is ''H when not applicable
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=Secondary NBNS Server (DNS and NBNS IP Addresses/DNS and NBNS) |
| secondaryNbnsType |
The Value of this attribute indicates the address type of secondary NBNS server.
type=rtr.InetAddressType access=read-only |
| serverAdd |
The Value of this attribute indicates the IP address
of the DHCP server received from either the DHCP or
the Radius server as indicated by the value of Origin Lease Info.
The value of this object is ''H when not applicable.
type=InetAddress access=read-create default= Mandatory on create Displayed(tab/group)=DHCP Server Address (/DHCP Lease General), DHCP6 Server Address (DHCP6/DHCP6 Specific) |
| serverAddType |
The Value of this attribute indicates the address type of DHCP Server IP Address.
type=rtr.InetAddressType access=read-only |
| serverId |
The value of this attribute indicates the DHCPv6 servers unique identifier (DUID) as generated
by the server. This is only meaningful for DHCPv6 leases.
type=string access=read-only minimum=0 maximum=255 Displayed(tab/group)=DHCP6 Server ID (DUID) (DHCP6/DHCP6 Specific) |
| serverLastRenew |
The Value of this attribute indicates when we last received
a renewal from either the DHCP or the Radius server
type=Date access=read-only Displayed(tab/group)=Server Last Renew Time (/DHCP Lease Time) |
| serverLeaseEnd |
The Value of this attribute indicates
when the server will consider the lease as being expired
type=Date access=read-only Displayed(tab/group)=Server Lease End Time (/DHCP Lease Time) |
| serverLeaseStart |
The Value of this attribute indicates
when this lease was created.
type=Date access=read-only Displayed(tab/group)=Server Lease Start Time (/DHCP Lease Time) |
| sessionTimeout |
The Value of this attribute indicates the
session timeout received from either the DHCP or the
Radius server as indicated by the value of Origin Lease Info.
DEPRECATED: 11.0 R1 - DEPRECATED: This object is replaced by svcDhcpLeaseLeaseTime since release 11.0. type=Time access=read-only Displayed(tab/group)=Session Timeout (/DHCP Lease Time) |
| shcvOperState |
The Value of this attribute indicates the state of
the subscriber host connectivity check for this DHCP lease state.
type=ressubscr.ShcvOperState access=read-only Displayed(tab/group)=SHCV Operational State (/SHCV) |
| shvcChecks |
The value of this attribute indicates the number of host connectivity
check requests for the DHCP lease state.
type=int access=read-only Displayed(tab/group)=SHCV Checks (/SHCV) |
| shvcReplies |
The value of this attribute indicates the number of host connectivity
replies for the DHCP lease state.
type=int access=read-only Displayed(tab/group)=SHCV Replies (/SHCV) |
| shvcReplyTime |
The value of this attribute indicates the time of the last successful
host connectivity check for the DHCP lease state.
type=Time access=read-only Displayed(tab/group)=SHCV Reply Time (/SHCV) |
| slaProfileString |
The Value of this attribute indicates the
SLA profile string applicable for this DHCP lease state.
The value of Origin Strings indicates whether this SLA profile string was received from
the DHCP or from the Radius server.
type=string access=read-only Displayed(tab/group)=SLA Profile String (Subscriber Details/Residential Subscriber) |
| subscrIdentity |
The Value of this attribute indicates the
id of the parent subscriber of this DHCP lease state.
The value of Origin Subscr ID indicates whether this
subscriber identification was received from
the DHCP or from the Radius server.
type=string access=read-only Displayed(tab/group)=Subscriber ID (Subscriber Details/Residential Subscriber) |
| subscrProfString |
The Value of this attribute indicates the
subscriber profile string applicable for this DHCP lease state.
The value of Origin Strings indicates whether this
subscriber profile string was received from
the DHCP or from the Radius server.
type=string access=read-only Displayed(tab/group)=Subscriber Profile String (Subscriber Details/Residential Subscriber) |
| terminationType |
The value of this attribute the indicates the termination type of this lease.
type=pppoe.SessionTerminationType access=read-only Displayed(tab/group)=Termination Type (/DHCP Lease General) |
| uptime |
The Value of this attribute indicates the host uptime.
type=Time access=read-only units=seconds Displayed(tab/group)=Host Uptime (/DHCP Lease Time) |
| vcId |
When the value of Locale is 'sdp', the
object SdpId, along with the object VcId, indicates the SDP Binding for which
this entry contains information. This object is otherwise
insignificant and contains the value 0.
type=long access=read-only |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
retrievingDhcpLeaseStruct
: ressubscr.RetrievingDhcpLeaseStruct - This structure contains the search criteria required to retrieve
DHCP Lease State objects
.
retrieveManagedRoutes
: boolean - (Optional) Specifies if Managed Routes should be retrieved,the default is "true".
The Managed Routes won't be retrieved if Service preferences
"retrieveManagedRoutes"
is
false.
retrieveQoSOvr
: boolean - (Optional) Specifies if QoS Override should be retrieved,the default is "true".
The QoS Override won't be retrieved if Service preferences "retrieveQoSOvr" is
false.
retrieveBgpPeer
: boolean - (Optional) Specifies if BGP Peer should be retrieved,the default is "true".
The BGP Peer won't be retrieved if Service preferences "BGP Peer Info" is
unchecked.
retrieveAcclpEncap
: boolean - (Optional) Specifies if Access Loop Encapsulation should be retrieved,the default is "true".
The Access Loop Encapsulation won't be retrieved if Service preferences "retrieveAcclpEncap" is false.
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
result
: List (generic.CommonManagedEntityInformation) -
ressubscr.DhcpLeaseState.retrieveDhcpLeaseException
| Supported Network Elements | |
|---|---|
| 7750 SR | |
| 7705 SAR Gen 2 | |
| 7705 SAR Hm | |
| 7450 ESS | |
| Product Specifics | |
| 7450 ESS 20.0 | |
| 7450 ESS 21.0 | |
| 7450 ESS 22.0 | |
| 7450 ESS 23.0 | |
| 7450 ESS 24.0 | |
| 7450 ESS 25.0 | |
| 7705 SAR Gen 2 25.0 | |
| 7750 SR 20.0 | |
| 7750 SR 21.0 | |
| 7750 SR 22.0 | |
| 7750 SR 23.0 | |
| 7750 SR 24.0 | |
| 7750 SR 25.0 | |