Overview Package Class Deprecated Help

localuserdb
DhcpHost

An object to configure local user database DHCP host.

public class DhcpHost

Properties
accountingPlcyPointer Specifies the RADIUS accounting policy to be used for generating accounting information.

type=string
default=
Displayed(tab/group)=RADIUS Accounting Policy (/RADIUS Accounting Policies)
combinedEncapTagRangeEndValue Specifies the value of the end label in the range of SAP's allowed on this host.

type=long
access=read-only
default=0
combinedEncapTagRangeStartValue Specifies the value of the start label in the range of SAP's allowed on this host.

type=long
access=read-only
default=0
dhcpAuthPolicyPointer Specifies the RADIUS authentication policy to use to authenticate the DHCP host

type=Pointer
default=
Displayed(tab/group)=Subscriber Authentication Policy
dhcpDomainName Specifies the domain name to use when RADIUS authentication is applicable.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Domain Name
dhcpOption60 Specifies the Vendor-Identifying Vendor Option to match against. Option 60 is encoded as Type - Length - Value. The Value portion of Option 60 in the received DHCP request is used to match against dhcpOption60. If the value of this object is the empty string, then it is not used.

type=string
default=
minimum=0
maximum=64
Displayed(tab/group)=Option 60 (Host Identification)
dhcpServerAddress Specifies the address of the DHCP server to relay to

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Server Address
dhcpServerAddressType Specifies the type of DHCP Server Address

type=rtr.InetAddressType
access=read-only
default=ipv4
dhcpString Specifies the string from the Nokia vendor specific sub-option in option 82 to match against. If the value of this object is the empty string, then it is not used.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=IPoE String (Host Identification)
dhcpV6ServerAddr The value of dhcpV6ServerAddr specifies the IPv6 address of the DHCP server used by the DHCP Relay function on this system.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IPv6 DHCP Server Address (Address/IPv6)
dhcpV6ServerAddrType Specifies the the type of DHCP-V6 Server Address.

type=rtr.InetAddressType
access=read-only
default=ipv6
diamAppPolicyName Specifies the name of the diameter application policy for this host

type=string
default=
minimum=0
maximum=32
diamAuthPolicy Specifies the name of the Diameter authentication policy to be used on this host.

type=Pointer
default=
Displayed(tab/group)=Diameter Authentication Policy
duplAccPlcyPointer Specifies the RADIUS accounting policy to be used for generating duplicate accounting information.

type=string
default=
Displayed(tab/group)=Duplicate RADIUS Accounting Policy (/RADIUS Accounting Policies)
encapTagRangeType Specifies the type of encapsulation protocol configured for the SAP encap tag range start and end values.

type=equipment.PortEncapType
default=unknown
Displayed(tab/group)=Type (Host Identification/Encapsulation Tag Range)
giAddress The value of giAddress specifies the Relay agent IP address.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=GI Address (Address)
giAddressType Specifies the the type of GI Address Address.

type=rtr.InetAddressType
access=read-only
default=ipv4
innerEncapTagRangeEndValue

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Inner End Value (Tag2) (Host Identification/Encapsulation Tag Range)
innerEncapTagRangeStartValue

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Inner Start Value (Tag2) (Host Identification/Encapsulation Tag Range)
ipPrefixAddr Specifies the the IP prefix address used as match in host identification.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IP Address Prefix (Host Identification)
ipPrefixAddrType Specifies the type of address stored in ipPrefixAddr.

type=rtr.InetAddressType
default=ipv6
ipPrefixLen Specifies the the prefix length of the IP prefix.

type=int
default=0
minimum=0
maximum=128
Displayed(tab/group)=Prefix Length (Host Identification)
ipv6Address Specifies the address of the DHCP server to relay to.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IPv6 Address (Address/IPv6)
ipv6AddressType Specifies the address type of the IPv6 Address.

type=rtr.InetAddressType
access=read-only
default=ipv6
ipv6DelegatedPrefixPool Specifies the IPv6 address pool which is used to search for an IPv6 prefix for this host.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=IPv6 Delegated Prefix Pool (Address/IPv6)
ipv6Prefix Specifies the prefix-address of the DHCP server to relay to. A value of 0::0 means that the prefix-address is not configured. The value of ipv6AddressPrefix must be set together with the value of ipv6PrefixLen.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IPv6 Prefix (Address/IPv6)
ipv6PrefixLen Indicates the length of the prefix-address stored in ipv6AddressPrefix. A value of 0 means that tmnxLocUsrDbDhcpIpv6Pfx is not configured. The value of tmnxLocUsrDbDhcpIpv6PfxLen must be set together with the value of ipv6Prefix.

type=int
default=0
minimum=0
maximum=64
Displayed(tab/group)=IPv6 Prefix Length (Address/IPv6)
ipv6ReqDelPfxLen Specifies the number of bits that can be allocated to a Delegated Prefix for IPv6.

type=int
default=0
minimum=0
maximum=64
Displayed(tab/group)=IPv6 Delegated Prefix Length (Address/IPv6)
ipv6SlaacPool Specifies the IPv6 address pool which is used to search for an IPv6 address for this host.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=IPv6 SLAAC Prefix Pool (Address/IPv6)
ipv6SlaacPrefix Specifies the prefix-address used for stateless address autoconfiguration A value of 0::0 means that the prefix-address is not configured. The value of ipv6SlaacPrefix must be set together with the value of ipv6SlaacPrefixLen.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IPv6 SLAAC Prefix (Address/IPv6)
ipv6SlaacPrefixLen Indicates the length of the prefix-address stored in ipv6SlaacPrefix. A value of 0 means that ipv6SlaacPrefix is not configured. The value of ipv6SlaacPrefixLen must be set together with the value of ipv6Prefix.

type=int
default=0
minimum=0
maximum=64
Displayed(tab/group)=Prefix Length (Address/IPv6)
ipv6WanAddressPool Specifies the IPv6 address pool which is used to search for an IPv6 address for this host. If the value of this object is the empty string, then it is not used.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=IPv6 WAN Address Pool (Address/IPv6)
leasePreferredLifeDays leasePreferredLife time in days. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Preferred Life is undefined.

type=int
default=0
minimum=-1
maximum=3650
Displayed(tab/group)=Preferred Life Days (/IPv6 Lease Times)
leasePreferredLifeHours leasePreferredLife time in hours. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Preferred Life is undefined.

type=int
default=0
minimum=-1
maximum=23
Displayed(tab/group)=Hours (/IPv6 Lease Times)
leasePreferredLifeInfinite leasePreferredLifeInfinite specifies that preferred lifetime is infinite.

type=boolean
default=false
leasePreferredLifeMins leasePreferredLife time in minutes. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Preferred Life is undefined.

type=int
default=0
minimum=-1
maximum=59
Displayed(tab/group)=Minutes (/IPv6 Lease Times)
leasePreferredLifeSecs leasePreferredLife time in seconds. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Preferred Life is undefined.

type=long
default=0
minimum=-1
maximum=59
Displayed(tab/group)=Seconds (/IPv6 Lease Times)
leaseRebindTimeDays leaseRebindTime time in days.

type=int
default=0
minimum=-1
maximum=14
Displayed(tab/group)=Rebind Time Days (/IPv6 Lease Times)
leaseRebindTimeHours leaseRebindTime time in hours.

type=int
default=0
minimum=-1
maximum=23
Displayed(tab/group)=Hours (/IPv6 Lease Times)
leaseRebindTimeMins leaseRebindTime time in minutes.

type=int
default=48
minimum=-1
maximum=59
Displayed(tab/group)=Minutes (/IPv6 Lease Times)
leaseRebindTimeSecs leaseRebindTime time in seconds.

type=int
default=0
minimum=-1
maximum=59
Displayed(tab/group)=Seconds (/IPv6 Lease Times)
leaseRebindTimeUndefined leaseRenewTimeUndefined specifies that the rebind-timer must be taken from another source.

type=boolean
default=true
leaseRenewTimeDays leaseRenewTime time in days.

type=int
default=0
minimum=-1
maximum=7
Displayed(tab/group)=Renew Time Days (/IPv6 Lease Times)
leaseRenewTimeHours leaseRenewTime time in hours.

type=int
default=0
minimum=-1
maximum=23
Displayed(tab/group)=Hours (/IPv6 Lease Times)
leaseRenewTimeMins leaseRenewTime time in minutes.

type=int
default=30
minimum=-1
maximum=59
Displayed(tab/group)=Minutes (/IPv6 Lease Times)
leaseRenewTimeSecs leaseRenewTime time in seconds.

type=int
default=0
minimum=-1
maximum=59
Displayed(tab/group)=Seconds (/IPv6 Lease Times)
leaseRenewTimeUndefined leaseRenewTimeUndefined specifies that the renew-timer must be taken from another source.

type=boolean
default=true
leaseValidLifeDays leaseValidLife time in days. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Valid Life is undefined.

type=int
default=0
minimum=-1
maximum=3650
Displayed(tab/group)=Valid Life Days (/IPv6 Lease Times)
leaseValidLifeHours leaseValidLife time in hours. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Valid Life is undefined.

type=int
default=0
minimum=-1
maximum=23
Displayed(tab/group)=Hours (/IPv6 Lease Times)
leaseValidLifeInfinite leaseValidLifeInfinite specifies that valid lifetime is infinite

type=boolean
default=false
leaseValidLifeMins leaseValidLife time in minutes. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Valid Life is undefined.

type=int
default=0
minimum=-1
maximum=59
Displayed(tab/group)=Minutes (/IPv6 Lease Times)
leaseValidLifeSecs leaseValidLife time in seconds. Setting Days, Hours, Minutes, and Seconds all to 0 specifies the Valid Life is undefined.

type=long
default=0
minimum=-1
maximum=59
Displayed(tab/group)=Seconds (/IPv6 Lease Times)
linkAddr The value of linkAddr specifies the DHCP Relay link-address.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IPv6 Link Address (Address/IPv6)
linkAddrType Specifies the the type of Link-Local Address.

type=rtr.InetAddressType
access=read-only
default=ipv6
localuserdb.Dhcp6CustomOption-Set type=Children-Set
localuserdb.LocalUserDbDhcpCustomOption-Set type=Children-Set
localuserdb.RadiusProxyCache-Set type=Children-Set
localuserdb.RelayToClientOption-Set type=Children-Set
localuserdb.RelayToServerOption-Set type=Children-Set
msapGroupIfPfx Specifies the type of prefix to be applied to the value of tmnxLocUsrDbDhcpDefMsapGroupIf when a local user database lookup is being performed.

type=localuserdb.MsapGrpIfPfxSfxType
default=none
Displayed(tab/group)=MSAP Group Interface Prefix (/MSAP Defaults)
msapGroupIfSfx Specifies the type of suffix to be applied to the value of tmnxLocUsrDbDhcpDefMsapGroupIf when a local user database lookup is being performed.

type=localuserdb.MsapGrpIfPfxSfxType
default=none
Displayed(tab/group)=MSAP Group Interface Suffix (/MSAP Defaults)
option60Format The data type represents how the remote Id is specified.

type=localuserdb.Option60Format
default=ascii
Displayed(tab/group)=Option 60 Format (Host Identification)
outerEncapTagRangeEndValue

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Outer End Value (Tag1) (Host Identification/Encapsulation Tag Range)
outerEncapTagRangeStartValue

type=int
default=0
minimum=0
maximum=4095
Displayed(tab/group)=Outer Start Value (Tag1) (Host Identification/Encapsulation Tag Range)
portalName Specifies the name of the WPP portal for this IPoE host

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Portal Name (WPP)
portalServiceId Specifies the VPRN service ID of the associated WPP Portal for this IPoE host

type=long
default=0
minimum=0
maximum=2147483647
Displayed(tab/group)=VPRN Service (WPP)
retailServiceId Specifies the retailer service ID for this host.

type=long
default=0
minimum=0
maximum=2148007978
Displayed(tab/group)=Retail Service ID
ripPolicy Specifies the name of the RIP/RIP-NG policy to be used on this host.

type=Pointer
default=
Displayed(tab/group)=RIP Policy
sapId Specifies the sap ID from the Nokia vendor specific sub-option in option 82 to match against. If the value of this object is the empty string, then it is not used.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=SAP ID (Host Identification)
serviceId Specifies the service ID from the Nokia vendor specific sub-option in option 82 to match against. If the value of this object is 0, then it is not used.

type=long
default=0
minimum=0
maximum=2147483647
Displayed(tab/group)=Service ID (Host Identification)
systemId Specifies the system ID from the Nokia vendor specific sub-option in option 82 to match against. If the value of this object is the empty string, then it is not used.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=System ID (Host Identification)
wppAppProfileName Specifies the initial application profile, to be used during the WPP authentication phase of the IPoE host.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Initial Application Profile (WPP)
wppRestoreDisconnected Specifies if the initial profiles must be restored after the DHCP host has disconnected. The value 'notset' means that nothing is set in the ludb and the group interface config will be used

type=localuserdb.DhcpHostWppRestDisconn
default=notset
Displayed(tab/group)=Restore Initial Profiles On Disconnected (WPP)
wppSlaProfileName Specifies the initial SLA profile, to be used during the WPP authentication phase of the IPoE host.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Initial SLA Profile (WPP)
wppSubProfileName Specifies the initial subscriber profile, to be used during the WPP authentication phase of the IPoE host.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Initial Subscriber Profile (WPP)
  
Properties inherited from localuserdb.LocalUserDbHost
address, addressType, administrativeState, ancpString, applicationProfileString, categoryMapName, circuitId, circuitIdFormat, clientMacAddress, derivedId, groupInterfaceName, hostName, interDestIdString, localUserDbName, localUserDbNamePointer, msapGroupInterfaceName, msapPolicyName, msapServiceId, optionNumber, poolName, poolNameDelimiter, remoteId, remoteIdFormat, secondPoolName, sessionServiceId, slaProfileString, spiGroupId, subscriberIdString, subscriberProfileString, useClientPool, useGiAddress, useGiScope
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 8.0.R1 until 10.0.R1
  • Excluded chassis types: 7450-ESS1, 7450-ESS6, 7450-ESS6V
Supported from 10.0.R1
  • Excluded chassis types: 7450-ESS1
7210 SAS K Supported from 9.0.R3
  • Required Capabilities: NetworkMode
7250 IXR Supported from 13.1.R8
Product Specifics
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7250 IXR (all versions)
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